Uses of Class
org.antlr.tool.Rule

Packages that use Rule

Package	Description
org.antlr
org.antlr.analysis
org.antlr.codegen
org.antlr.grammar.v3
org.antlr.tool

Uses of Rule in org.antlr

Methods in org.antlr with parameters of type Rule

Modifier and Type	Method	Description
protected void	Tool.writeDOTFile(Grammar g, Rule r, java.lang.String dot)

Uses of Rule in org.antlr.analysis

Fields in org.antlr.analysis declared as Rule

Modifier and Type	Field	Description
Rule	NFAState.enclosingRule	What rule do we live in?
Rule	RuleClosureTransition.rule	Ptr to the rule definition object for this rule ref

Fields in org.antlr.analysis with type parameters of type Rule

Modifier and Type	Field	Description
java.util.Map<Rule,LookaheadSet>	LL1Analyzer.FOLLOWCache

Methods in org.antlr.analysis with parameters of type Rule

Modifier and Type	Method	Description
protected int	LL1Analyzer._detectConfoundingPredicates(NFAState s, Rule enclosingRule, boolean chaseFollowTransitions)
LookaheadSet	LL1Analyzer.FOLLOW(Rule r)

Constructors in org.antlr.analysis with parameters of type Rule

Constructor	Description
RuleClosureTransition(Rule rule, NFAState ruleStart, NFAState followState)

Uses of Rule in org.antlr.codegen

Methods in org.antlr.codegen with parameters of type Rule

Modifier and Type	Method	Description
void	CodeGenerator.issueInvalidAttributeError(java.lang.String x, java.lang.String y, Rule enclosingRule, org.antlr.runtime.Token actionToken, int outerAltNum)
void	CodeGenerator.issueInvalidAttributeError(java.lang.String x, Rule enclosingRule, org.antlr.runtime.Token actionToken, int outerAltNum)
void	CodeGenerator.issueInvalidScopeError(java.lang.String x, java.lang.String y, Rule enclosingRule, org.antlr.runtime.Token actionToken, int outerAltNum)
void	CodeGenerator.translateActionAttributeReferencesForSingleScope(Rule r, java.util.Map<java.lang.String,java.lang.Object> scopeActions)	Use for translating rule @init{...} actions that have no scope

Uses of Rule in org.antlr.grammar.v3

Fields in org.antlr.grammar.v3 declared as Rule

Modifier and Type	Field	Description
(package private) Rule	ActionAnalysis.enclosingRule
(package private) Rule	ActionTranslator.enclosingRule

Methods in org.antlr.grammar.v3 with parameters of type Rule

Modifier and Type	Method	Description
void	DefineGrammarItemsWalker.ruleAction(Rule r)
void	DefineGrammarItemsWalker.ruleScopeSpec(Rule r)

Uses of Rule in org.antlr.tool

Fields in org.antlr.tool declared as Rule

Modifier and Type	Field	Description
(package private) Rule	NFAFactory.currentRule
Rule	RuleLabelScope.referencedRule

Fields in org.antlr.tool with type parameters of type Rule

Modifier and Type	Field	Description
java.util.Collection<? extends java.util.Collection<? extends Rule>>	LeftRecursionCyclesMessage.cycles
protected java.util.Set<Rule>	Grammar.delegatedRuleReferences	The list of all rules referenced in this grammar, not defined here, and defined in a delegate grammar.
protected java.util.Set<Rule>	Grammar.leftRecursiveRules	A list of all rules that are in any left-recursive cycle.
protected java.util.LinkedHashMap<java.lang.String,Rule>	Grammar.nameToRuleMap	Map a rule to it's Rule object
protected java.util.Vector<Rule>	CompositeGrammar.ruleIndexToRuleList	Map a rule index to its name; use a Vector on purpose as new collections stuff won't let me setSize and make it grow.
protected java.util.Set<Rule>	GrammarSanity.visitedDuringRecursionCheck	The checkForLeftRecursion method needs to track what rules it has visited to track infinite recursion.

Methods in org.antlr.tool that return Rule

Modifier and Type	Method	Description
Rule	NFAFactory.getCurrentRule()
Rule	Grammar.getLocallyDefinedRule(java.lang.String ruleName)
Rule	Grammar.LabelElementPair.getReferencedRule()
Rule	CompositeGrammar.getRule(java.lang.String ruleName)
Rule	CompositeGrammarTree.getRule(java.lang.String ruleName)	Find a rule by looking in current grammar then down towards the delegate grammars.
Rule	Grammar.getRule(java.lang.String ruleName)
Rule	Grammar.getRule(java.lang.String scopeName, java.lang.String ruleName)

Methods in org.antlr.tool that return types with arguments of type Rule

Modifier and Type	Method	Description
java.util.List<? extends java.util.Collection<? extends Rule>>	Grammar.checkAllRulesForLeftRecursion()
java.util.List<java.util.Set<Rule>>	GrammarSanity.checkAllRulesForLeftRecursion()	Check all rules for infinite left recursion before analysis.
java.util.Set<? extends Rule>	CompositeGrammar.getAllImportedRules(Grammar g)	Get all rule definitions from all direct/indirect delegate grammars of g.
java.util.Set<? extends Rule>	Grammar.getAllImportedRules()	Get set of all rules imported from all delegate grammars even if indirectly delegated.
java.util.Set<Rule>	Grammar.getDelegatedRuleReferences()
java.util.Set<? extends Rule>	CompositeGrammar.getDelegatedRules(Grammar g)	Get set of rules for grammar g that need to have manual delegation methods.
java.util.Set<? extends Rule>	Grammar.getDelegatedRules()	Get the set of Rules that need to have manual delegations like "void rule() { importedGrammar.rule(); }" If this grammar is master, get list of all rule definitions from all delegate grammars.
java.util.Set<Rule>	Grammar.getLeftRecursiveRules()	Return a list of left-recursive rules; no analysis can be done successfully on these.
java.util.Collection<Rule>	Grammar.getRules()

Methods in org.antlr.tool with parameters of type Rule

Modifier and Type	Method	Description
protected void	GrammarSanity.addRulesToCycle(Rule targetRule, Rule enclosingRule, java.util.List<java.util.Set<Rule>> listOfRecursiveCycles)	enclosingRuleName calls targetRuleName, find the cycle containing the target and add the caller.
StateCluster	NFAFactory.build_RuleRef(Rule refDef, NFAState ruleStart)	For reference to rule r, build o-e->(r) o where (r) is the start of rule r and the trailing o is not linked to from rule ref state directly (it's done thru the transition(0) RuleClosureTransition.
protected void	NameSpaceChecker.checkForLabelConflict(Rule r, org.antlr.runtime.Token label)	Make sure a label doesn't conflict with another symbol.
boolean	NameSpaceChecker.checkForLabelTypeMismatch(Rule r, org.antlr.runtime.Token label, int type)	If type of previous label differs from new label's type, that's an error.
protected void	NameSpaceChecker.checkForRuleArgumentAndReturnValueConflicts(Rule r)
protected void	NameSpaceChecker.checkForRuleDefinitionProblems(Rule r)
void	NameSpaceChecker.checkForRuleScopeAttributeConflict(Rule r, Attribute attribute)	Check for collision of a rule-scope dynamic attribute with: arg, return value, rule name itself.
protected void	Grammar.defineLabel(Rule r, org.antlr.runtime.Token label, GrammarAST element, int type)	Define a label defined in a rule r; check the validity then ask the Rule object to actually define it.
void	NFAFactory.setCurrentRule(Rule currentRule)

Method parameters in org.antlr.tool with type arguments of type Rule

Modifier and Type	Method	Description
protected void	GrammarSanity.addRulesToCycle(Rule targetRule, Rule enclosingRule, java.util.List<java.util.Set<Rule>> listOfRecursiveCycles)	enclosingRuleName calls targetRuleName, find the cycle containing the target and add the caller.
int	NFAFactory.build_EOFStates(java.util.Collection<Rule> rules)	add an EOF transition to any rule end NFAState that points to nothing (i.e., for all those rules not invoked by another rule).
static void	ErrorManager.leftRecursionCycles(java.util.Collection<? extends java.util.Set<? extends Rule>> cycles)
protected boolean	GrammarSanity.traceStatesLookingForLeftRecursion(NFAState s, java.util.Set<NFAState> visitedStates, java.util.List<java.util.Set<Rule>> listOfRecursiveCycles)	From state s, look for any transition to a rule that is currently being traced.

Constructors in org.antlr.tool with parameters of type Rule

Constructor	Description
RuleLabelScope(Rule referencedRule, org.antlr.runtime.Token actionToken)

Constructor parameters in org.antlr.tool with type arguments of type Rule

Constructor	Description
LeftRecursionCyclesMessage(java.util.Collection<? extends java.util.Collection<? extends Rule>> cycles)