ANTLR 4.13.1 · org.antlr.v4.tool.Rule

Modifier and Type	Field and Description
public int	actionIndex
public List<ActionAST>	actions Track all executable actions other than named actions like @init and catch/finally (not in an alt).
public Alternative[]	alt 1..n alts
public AttributeDict	args
public RuleAST	ast
public final boolean	caseInsensitive If null then use value from global option that is false by default
public List<GrammarAST>	exceptions Track exception handlers; points at "catch" node of (catch exception action) don't track finally action
public ActionAST	finallyAction
public final Grammar	g In which grammar does this rule live?
public int	index All rules have unique index 0..n-1
public boolean	isStartRule
public AttributeDict	locals
public final String	mode If we're in a lexer grammar, we might be in a mode
public List<GrammarAST>	modifiers
public final String	name
public Map<String, ActionAST>	namedActions Map a name to an action for this rule like @init {...}.
public final int	numberOfAlts
public static final AttributeDict	predefinedRulePropertiesDict Rule refs have a predefined set of attributes as well as the return values and args.
public AttributeDict	retvals
public static final Set<String>	validLexerCommands

Access	Constructor and Description
public	Rule(Grammar g, String name, RuleAST ast, int numberOfAlts)
public	Rule(Grammar g, String name, RuleAST ast, int numberOfAlts, String lexerMode, boolean caseInsensitive)

Method Summary

Modifier and Type	Method and Description
public void	defineActionInAlt(int currentAlt, ActionAST actionAST)
public void	defineLexerAction(ActionAST actionAST) Lexer actions are numbered across rules 0..n-1
public void	definePredicateInAlt(int currentAlt, PredAST predAST)
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Map<String, List<Pair<Integer, AltAST>>>	getAltLabels() Get `#` labels.
public LabelElementPair	getAnyLabelDef(String x)
public MultiMap<String, LabelElementPair>	getElementLabelDefs()
public Set<String>	getElementLabelNames()
public int	getOriginalNumberOfAlts() Used for recursive rules (subclass), which have 1 alt, but many original alts
public AttributeDict	getPredefinedScope(LabelType ltype)
public Set<String>	getTokenRefs()
public List<AltAST>	getUnlabeledAltASTs()
public boolean	hasAltSpecificContexts()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isFragment()
public Attribute	resolveRetvalOrProperty(String y)
public boolean	resolvesToAttributeDict(String x, ActionAST node) Implements org.antlr.v4.tool.AttributeResolver.resolvesToAttributeDict.
public boolean	resolvesToLabel(String x, ActionAST node) Implements org.antlr.v4.tool.AttributeResolver.resolvesToLabel.
public boolean	resolvesToListLabel(String x, ActionAST node) Implements org.antlr.v4.tool.AttributeResolver.resolvesToListLabel.
public boolean	resolvesToToken(String x, ActionAST node) Implements org.antlr.v4.tool.AttributeResolver.resolvesToToken.
public Attribute	resolveToAttribute(String x, ActionAST node) Implements org.antlr.v4.tool.AttributeResolver.resolveToAttribute. $x Attribute: rule arguments, return values, predefined rule prop.
public Attribute	resolveToAttribute(String x, String y, ActionAST node) Implements org.antlr.v4.tool.AttributeResolver.resolveToAttribute. $x.y Attribute: x is surrounding rule, label ref (in any alts)
public Rule	resolveToRule(String x)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

actionIndex	back to summary
public int actionIndex

actions	back to summary
public List<ActionAST> actions Track all executable actions other than named actions like @init and catch/finally (not in an alt). Also tracks predicates, rewrite actions. We need to examine these actions before code generation so that we can detect refs to $rule.attr etc... This tracks per rule; Alternative objs also track per alt.

alt	back to summary
public Alternative[] alt 1..n alts

args	back to summary
public AttributeDict args

ast	back to summary
public RuleAST ast

caseInsensitive	back to summary
public final boolean caseInsensitive If null then use value from global option that is false by default

exceptions	back to summary
public List<GrammarAST> exceptions Track exception handlers; points at "catch" node of (catch exception action) don't track finally action

finallyAction	back to summary
public ActionAST finallyAction

g	back to summary
public final Grammar g In which grammar does this rule live?

index	back to summary
public int index All rules have unique index 0..n-1

isStartRule	back to summary
public boolean isStartRule

locals	back to summary
public AttributeDict locals

mode	back to summary
public final String mode If we're in a lexer grammar, we might be in a mode

modifiers	back to summary
public List<GrammarAST> modifiers

name	back to summary
public final String name

namedActions	back to summary
public Map<String, ActionAST> namedActions Map a name to an action for this rule like @init {...}. The code generator will use this to fill holes in the rule template. I track the AST node for the action in case I need the line number for errors.

numberOfAlts	back to summary
public final int numberOfAlts

predefinedRulePropertiesDict	back to summary
public static final AttributeDict predefinedRulePropertiesDict Rule refs have a predefined set of attributes as well as the return values and args. These must be consistent with ActionTranslator.rulePropToModelMap, ...

retvals	back to summary
public AttributeDict retvals

validLexerCommands	back to summary
public static final Set<String> validLexerCommands

Constructor Detail

Rule	back to summary
public Rule(Grammar g, String name, RuleAST ast, int numberOfAlts)

Rule	back to summary
public Rule(Grammar g, String name, RuleAST ast, int numberOfAlts, String lexerMode, boolean caseInsensitive)

Method Detail

defineActionInAlt	back to summary
public void defineActionInAlt(int currentAlt, ActionAST actionAST)

defineLexerAction	back to summary
public void defineLexerAction(ActionAST actionAST) Lexer actions are numbered across rules 0..n-1

definePredicateInAlt	back to summary
public void definePredicateInAlt(int currentAlt, PredAST predAST)

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAltLabels	back to summary
public Map<String, List<Pair<Integer, AltAST>>> getAltLabels() Get `#` labels. The keys of the map are the labels applied to outer alternatives of a lexer rule, and the values are collections of pairs (alternative number and `AltAST`) identifying the alternatives with this label. Unlabeled alternatives are not included in the result.

getAnyLabelDef	back to summary
public LabelElementPair getAnyLabelDef(String x)

getElementLabelDefs	back to summary
public MultiMap<String, LabelElementPair> getElementLabelDefs()

getElementLabelNames	back to summary
public Set<String> getElementLabelNames()

getOriginalNumberOfAlts	back to summary
public int getOriginalNumberOfAlts() Used for recursive rules (subclass), which have 1 alt, but many original alts

getPredefinedScope	back to summary
public AttributeDict getPredefinedScope(LabelType ltype)

getTokenRefs	back to summary
public Set<String> getTokenRefs()

getUnlabeledAltASTs	back to summary
public List<AltAST> getUnlabeledAltASTs()

hasAltSpecificContexts	back to summary
public boolean hasAltSpecificContexts()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isFragment	back to summary
public boolean isFragment()

resolveRetvalOrProperty	back to summary
public Attribute resolveRetvalOrProperty(String y)

resolvesToAttributeDict	back to summary
public boolean resolvesToAttributeDict(String x, ActionAST node) Implements org.antlr.v4.tool.AttributeResolver.resolvesToAttributeDict. Annotations @Override

resolvesToAttributeDict

back to summary

public boolean resolvesToAttributeDict(String x, ActionAST node)

Implements org.antlr.v4.tool.AttributeResolver.resolvesToAttributeDict.

Annotations

@Override

resolvesToLabel	back to summary
public boolean resolvesToLabel(String x, ActionAST node) Implements org.antlr.v4.tool.AttributeResolver.resolvesToLabel. Annotations @Override

resolvesToLabel

back to summary

public boolean resolvesToLabel(String x, ActionAST node)

Implements org.antlr.v4.tool.AttributeResolver.resolvesToLabel.

Annotations

@Override

resolvesToListLabel	back to summary
public boolean resolvesToListLabel(String x, ActionAST node) Implements org.antlr.v4.tool.AttributeResolver.resolvesToListLabel. Annotations @Override

resolvesToListLabel

back to summary

public boolean resolvesToListLabel(String x, ActionAST node)

Implements org.antlr.v4.tool.AttributeResolver.resolvesToListLabel.

Annotations

@Override

resolvesToToken	back to summary
public boolean resolvesToToken(String x, ActionAST node) Implements org.antlr.v4.tool.AttributeResolver.resolvesToToken. Annotations @Override

resolvesToToken

back to summary

public boolean resolvesToToken(String x, ActionAST node)

Implements org.antlr.v4.tool.AttributeResolver.resolvesToToken.

Annotations

@Override

resolveToAttribute	back to summary
public Attribute resolveToAttribute(String x, ActionAST node) Implements org.antlr.v4.tool.AttributeResolver.resolveToAttribute. $x Attribute: rule arguments, return values, predefined rule prop. Annotations @Override

resolveToAttribute

back to summary

public Attribute resolveToAttribute(String x, ActionAST node)

Implements org.antlr.v4.tool.AttributeResolver.resolveToAttribute.

$x Attribute: rule arguments, return values, predefined rule prop.

Annotations

@Override

resolveToAttribute	back to summary
public Attribute resolveToAttribute(String x, String y, ActionAST node) Implements org.antlr.v4.tool.AttributeResolver.resolveToAttribute. $x.y Attribute: x is surrounding rule, label ref (in any alts) Annotations @Override

resolveToAttribute

back to summary

public Attribute resolveToAttribute(String x, String y, ActionAST node)

Implements org.antlr.v4.tool.AttributeResolver.resolveToAttribute.

$x.y Attribute: x is surrounding rule, label ref (in any alts)

Annotations

@Override

resolveToRule	back to summary
public Rule resolveToRule(String x)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

public Class Rule

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail