Package org.antlr.v4.tool

Class Alternative

java.lang.Object

org.antlr.v4.tool.Alternative

All Implemented Interfaces:

AttributeResolver

public class Alternative
extends Object
implements AttributeResolver

An outermost alternative for a rule. We don't track inner alternatives.

Field Summary

Fields

Modifier and Type	Field	Description
List<ActionAST>	actions	Track all executable actions other than named actions like @init and catch/finally (not in an alt).
int	altNum	What alternative number is this outermost alt? 1..n
AltAST	ast
org.stringtemplate.v4.misc.MultiMap<String,LabelElementPair>	labelDefs	A list of all LabelElementPair attached to tokens like id=ID, ids+=ID
Rule	rule
org.stringtemplate.v4.misc.MultiMap<String,GrammarAST>	ruleRefs
org.stringtemplate.v4.misc.MultiMap<String,GrammarAST>	ruleRefsInActions
org.stringtemplate.v4.misc.MultiMap<String,TerminalAST>	tokenRefs
org.stringtemplate.v4.misc.MultiMap<String,GrammarAST>	tokenRefsInActions

Constructor Summary

Constructors

Constructor	Description
Alternative(Rule r, int altNum)

Method Summary

Modifier and Type	Method	Description
LabelElementPair	getAnyLabelDef(String x)
boolean	resolvesToAttributeDict(String x, ActionAST node)
boolean	resolvesToLabel(String x, ActionAST node)
boolean	resolvesToListLabel(String x, ActionAST node)
boolean	resolvesToToken(String x, ActionAST node)
Attribute	resolveToAttribute(String x, String y, ActionAST node)	$x.y, x can be surrounding rule, token/rule/label ref.
Attribute	resolveToAttribute(String x, ActionAST node)	$x Attribute: rule arguments, return values, predefined rule prop.
Rule	resolveToRule(String x)	x can be ruleref or rule label.

Methods inherited from class java.lang.Object

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

Field Details

rule

public Rule rule

ast

public AltAST ast

altNum

public int altNum

What alternative number is this outermost alt? 1..n

tokenRefs

public org.stringtemplate.v4.misc.MultiMap<String,TerminalAST> tokenRefs

tokenRefsInActions

public org.stringtemplate.v4.misc.MultiMap<String,GrammarAST> tokenRefsInActions

ruleRefs

public org.stringtemplate.v4.misc.MultiMap<String,GrammarAST> ruleRefs

ruleRefsInActions

public org.stringtemplate.v4.misc.MultiMap<String,GrammarAST> ruleRefsInActions

labelDefs

public org.stringtemplate.v4.misc.MultiMap<String,LabelElementPair> labelDefs

A list of all LabelElementPair attached to tokens like id=ID, ids+=ID

actions

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 alt

Constructor Details

Alternative

public Alternative(Rule r,
 int altNum)

Method Details

resolvesToToken

public boolean resolvesToToken(String x,
 ActionAST node)

Specified by:

resolvesToToken in interface AttributeResolver

resolvesToAttributeDict

public boolean resolvesToAttributeDict(String x,
 ActionAST node)

Specified by:

resolvesToAttributeDict in interface AttributeResolver

resolveToAttribute

public Attribute resolveToAttribute(String x,
 ActionAST node)

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

Specified by:

resolveToAttribute in interface AttributeResolver

resolveToAttribute

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

$x.y, x can be surrounding rule, token/rule/label ref. y is visible attr in that dictionary. Can't see args on rule refs.

Specified by:

resolveToAttribute in interface AttributeResolver

resolvesToLabel

public boolean resolvesToLabel(String x,
 ActionAST node)

Specified by:

resolvesToLabel in interface AttributeResolver

resolvesToListLabel

public boolean resolvesToListLabel(String x,
 ActionAST node)

Specified by:

resolvesToListLabel in interface AttributeResolver

getAnyLabelDef

public LabelElementPair getAnyLabelDef(String x)

resolveToRule

public Rule resolveToRule(String x)

x can be ruleref or rule label.