org.antlr.works.editor

Class EditorRules

java.lang.Object

org.antlr.works.editor.EditorRules

All Implemented Interfaces:

XJTreeDelegate

public class EditorRules
extends Object
implements XJTreeDelegate

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EditorRules.RuleMoveDownAction
class	EditorRules.RuleMoveUpAction
static class	EditorRules.RulesTableRenderer
static class	EditorRules.RuleTree
class	EditorRules.RuleTreeMouseListener
class	EditorRules.RuleTreeSelectionListener
static class	EditorRules.RuleTreeUserObject

Field Summary

Fields

Modifier and Type	Field and Description
static Color	HIGHLIGHTED_COLOR
protected boolean	programmaticallySelectingRule
protected XJTree	rulesTree
protected List<String>	rulesTreeExpandedNodes
protected DefaultTreeModel	rulesTreeModel
protected DefaultMutableTreeNode	rulesTreeRootNode
protected EditorRules.RuleTreeUserObject	selectedObject
protected boolean	selectNextRule
protected boolean	sort
protected GrammarWindow	window

Constructor Summary

Constructors

Constructor and Description
EditorRules(GrammarWindow window)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	buildTree(DefaultMutableTreeNode parentNode, List<ElementRule> rules, int from, int to)
void	close()
ElementGroup	findClosingGroupForGroup(ElementGroup group)
DefaultMutableTreeNode	findNodeWithGroupName(String groupName)
DefaultMutableTreeNode	findNodeWithRuleName(String ruleName)
ElementGroup	findOpenGroupClosestToLocation(int location)
void	findTokensToIgnore(boolean reset) This method iterates over all rules and all blocks inside each rule to find a sequence of token equals to "$channel=HIDDEN" or "skip()".
static void	findTokensToIgnore(List<ElementRule> rules, boolean reset)
JScrollPane	getComponent()
ElementRule	getEnclosingRuleAtPosition(int pos)
boolean	getFirstSelectedRuleIgnoredFlag()
GrammarEngine	getGrammarEngine()
ElementRule	getLastLexerRule()
ElementRule	getLastParserRule()
ElementRule	getLastRule()
List<ElementReference>	getReferencesInRule(ElementRule rule)
ElementRule	getRuleAtIndex(int index)
List<ElementRule>	getRules()
List<String>	getRulesStartingWith(String match)
ElementGroup	getSelectedGroup()
List<ElementRule>	getSelectedRules()
List<ElementRule>	getSortedRules()
List<ElementRule>	getSortedRules(List<ElementRule> rules)
void	goToRule(ElementRule rule)
void	ignoreSelectedRules(boolean flag)
boolean	isRuleAtIndex(int index)
boolean	isSorted()
boolean	moveRule(ElementRule sourceRule, ElementRule targetRule, boolean dropAbove)
void	parserDidParse()
void	rebuildTree()
void	refreshRules()
void	rememberSelectedTreeItem()
void	restoreExpandedNodes()
void	restoreSelectedTreeItem()
void	saveExpandedNodes()
void	selectNextRule()
void	selectRuleFromUserAction()
void	selectRuleInTree(ElementRule rule)
ElementRule	selectRuleInTreeAtPosition(int pos)
ElementRule	selectRuleNameInTree(String name)
void	setKeyBindings(ATEKeyBindings keyBindings)
void	setSorted(boolean flag)
void	toggleSorting()
int	xjTreeDragAndDropConstants(XJTree tree)
Cursor	xjTreeDragSourceDefaultCursor(XJTree tree)
boolean	xjTreeDrop(XJTree tree, Object sourceObject, Object targetObject, int dropLocation)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

window

protected GrammarWindow window

programmaticallySelectingRule

protected boolean programmaticallySelectingRule

selectNextRule

protected boolean selectNextRule

rulesTree

protected XJTree rulesTree

rulesTreeRootNode

protected DefaultMutableTreeNode rulesTreeRootNode

rulesTreeModel

protected DefaultTreeModel rulesTreeModel

rulesTreeExpandedNodes

protected List<String> rulesTreeExpandedNodes

selectedObject

protected EditorRules.RuleTreeUserObject selectedObject

sort

protected boolean sort

HIGHLIGHTED_COLOR

public static final Color HIGHLIGHTED_COLOR

Constructor Detail

EditorRules

public EditorRules(GrammarWindow window)

Method Detail

close

public void close()

getComponent

public JScrollPane getComponent()

setKeyBindings

public void setKeyBindings(ATEKeyBindings keyBindings)

getGrammarEngine

public GrammarEngine getGrammarEngine()

isSorted

public boolean isSorted()

setSorted

public void setSorted(boolean flag)

toggleSorting

public void toggleSorting()

ignoreSelectedRules

public void ignoreSelectedRules(boolean flag)

findTokensToIgnore

public void findTokensToIgnore(boolean reset)

This method iterates over all rules and all blocks inside each rule to find a sequence of token equals to "$channel=HIDDEN" or "skip()".

findTokensToIgnore

public static void findTokensToIgnore(List<ElementRule> rules,
                      boolean reset)

getFirstSelectedRuleIgnoredFlag

public boolean getFirstSelectedRuleIgnoredFlag()

refreshRules

public void refreshRules()

getSelectedGroup

public ElementGroup getSelectedGroup()

findOpenGroupClosestToLocation

public ElementGroup findOpenGroupClosestToLocation(int location)

findClosingGroupForGroup

public ElementGroup findClosingGroupForGroup(ElementGroup group)

getRules

public List<ElementRule> getRules()

getSortedRules

public List<ElementRule> getSortedRules()

getSortedRules

public List<ElementRule> getSortedRules(List<ElementRule> rules)

getSelectedRules

public List<ElementRule> getSelectedRules()

getLastRule

public ElementRule getLastRule()

getLastParserRule

public ElementRule getLastParserRule()

getLastLexerRule

public ElementRule getLastLexerRule()

getRulesStartingWith

public List<String> getRulesStartingWith(String match)

getReferencesInRule

public List<ElementReference> getReferencesInRule(ElementRule rule)

getEnclosingRuleAtPosition

public ElementRule getEnclosingRuleAtPosition(int pos)

selectRuleInTreeAtPosition

public ElementRule selectRuleInTreeAtPosition(int pos)

selectRuleNameInTree

public ElementRule selectRuleNameInTree(String name)

getRuleAtIndex

public ElementRule getRuleAtIndex(int index)

isRuleAtIndex

public boolean isRuleAtIndex(int index)

selectNextRule

public void selectNextRule()

selectRuleInTree

public void selectRuleInTree(ElementRule rule)

goToRule

public void goToRule(ElementRule rule)

rebuildTree

public void rebuildTree()

rememberSelectedTreeItem

public void rememberSelectedTreeItem()

restoreSelectedTreeItem

public void restoreSelectedTreeItem()

saveExpandedNodes

public void saveExpandedNodes()

restoreExpandedNodes

public void restoreExpandedNodes()

findNodeWithGroupName

public DefaultMutableTreeNode findNodeWithGroupName(String groupName)

findNodeWithRuleName

public DefaultMutableTreeNode findNodeWithRuleName(String ruleName)

buildTree

protected void buildTree(DefaultMutableTreeNode parentNode,
             List<ElementRule> rules,
             int from,
             int to)

parserDidParse

public void parserDidParse()

moveRule

public boolean moveRule(ElementRule sourceRule,
               ElementRule targetRule,
               boolean dropAbove)

selectRuleFromUserAction

public void selectRuleFromUserAction()

xjTreeDragSourceDefaultCursor

public Cursor xjTreeDragSourceDefaultCursor(XJTree tree)

Specified by:

xjTreeDragSourceDefaultCursor in interface XJTreeDelegate

xjTreeDragAndDropConstants

public int xjTreeDragAndDropConstants(XJTree tree)

Specified by:

xjTreeDragAndDropConstants in interface XJTreeDelegate

xjTreeDrop

public boolean xjTreeDrop(XJTree tree,
                 Object sourceObject,
                 Object targetObject,
                 int dropLocation)

Specified by:

xjTreeDrop in interface XJTreeDelegate