ANTLR 3.5.3 · org.antlr.tool.GrammarAST

Field Summary

Modifier and Type	Field and Description
protected Map<String, Object>	blockOptions If this is a BLOCK node, track options here
public ST	code if this is a TOKEN_REF or RULE_REF node, this is the code ST generated for this node.
pack-priv static int	count
private static final GrammarAST	DescendantDownNode
private static final GrammarAST	DescendantUpNode
public String	enclosingRuleName
public NFAState	followingNFAState Rule ref nodes, token refs, set, and NOT set refs need to track their location in the generated NFA so that local FOLLOW sets can be computed during code gen for automatic error recovery.
public int	ID
public DFA	lookaheadDFA If this is a decision node, what is the lookahead DFA?
public NFAState	NFAStartState What NFA start state was built from this node?
public NFAState	NFATreeDownState This is used for TREE_BEGIN nodes to point into the NFA.
public int	outerAltNum if this is an ACTION node, this is the outermost enclosing alt num in rule.
public Set<GrammarAST>	rewriteRefsDeep
public Set<GrammarAST>	rewriteRefsShallow If this is a BLOCK node for a rewrite rule, track referenced elements here.
protected IntSet	setValue If this is a SET node, what are the elements?
public Map<String, Object>	terminalOptions
private String	textOverride

Inherited from org.antlr.runtime.tree.CommonTree:: childIndex parent startIndex stopIndex token

Constructor Summary

Access	Constructor and Description
public	GrammarAST()
public	GrammarAST(int t, String txt)
public	GrammarAST(Token token)

Method Summary

Modifier and Type	Method and Description
public void	_findAllType(int ttype, List<GrammarAST> nodes)
public static List<Tree>	descendants(Tree root)
public static List<Tree>	descendants(Tree root, boolean insertDownUpNodes)
public static GrammarAST	dup(Tree t)
public Tree	dupNode() Overrides org.antlr.runtime.tree.CommonTree.dupNode. Implements org.antlr.runtime.tree.Tree.dupNode.
public static GrammarAST	dupTree(GrammarAST t)
public static GrammarAST	dupTreeNoActions(GrammarAST t, GrammarAST parent) Duplicate a tree, assuming this is a root node of a tree-- duplicate that node and what's below; ignore siblings of root node.
public boolean	equals(Object the reference object with which to compare. ast) Overrides java.lang.Object.equals. Make nodes unique based upon Token so we can add them to a Set; if not a GrammarAST, check type.
public List<GrammarAST>	findAllType(int ttype)
public GrammarAST	findFirstType(int ttype)
public GrammarAST	getBlockALT(int i)
public Object	getBlockOption(String key)
public Map<String, Object>	getBlockOptions()
public int	getCharPositionInLine() Overrides org.antlr.runtime.tree.CommonTree.getCharPositionInLine. Implements org.antlr.runtime.tree.Tree.getCharPositionInLine.
public GrammarAST[]	getChildrenAsArray()
private static List<GrammarAST>	getChildrenForDupTree(GrammarAST t)
public GrammarAST	getLastChild()
public GrammarAST	getLastSibling()
public int	getLine() Overrides org.antlr.runtime.tree.CommonTree.getLine. Implements org.antlr.runtime.tree.Tree.getLine. In case we don't have a token payload, what is the line for errors?
public DFA	getLookaheadDFA()
public GrammarAST	getNextSibling()
public NFAState	getNFAStartState()
public IntSet	getSetValue()
public String	getText() Overrides org.antlr.runtime.tree.CommonTree.getText. Implements org.antlr.runtime.tree.Tree.getText.
public int	getType() Overrides org.antlr.runtime.tree.CommonTree.getType. Implements org.antlr.runtime.tree.Tree.getType. Return a token type; needed for tree parsing
public int	hashCode() Overrides java.lang.Object.hashCode. Make nodes unique based upon Token so we can add them to a Set; if not a GrammarAST, check type.
public boolean	hasSameTreeStructure(Tree other) See if tree has exact token types and structure; no text
public void	initialize(int i, String s)
public void	initialize(Tree ast)
public void	initialize(Token token)
public String	setBlockOption(Grammar grammar, String key, Object value) Save the option key/value pair and process it; return the key or null if invalid option.
public void	setBlockOptions(Map<String, Object> blockOptions)
public void	setCharPositionInLine(int value)
public void	setLine(int line)
public void	setLookaheadDFA(DFA lookaheadDFA)
public void	setNFAStartState(NFAState nfaStartState)
public String	setOption(Map<String, Object> options, Set<String> legalOptions, Grammar grammar, String key, Object value)
public void	setOptions(Grammar grammar, Map<String, Object> options)
public void	setSetValue(IntSet setValue)
public String	setTerminalOption(Grammar grammar, String key, Object value)
public void	setText(String text)
public void	setTokenBoundaries(Token startToken, Token stopToken) Track start/stop token for subtree root created for a rule.
public void	setTreeEnclosingRuleNameDeeply(String rname)
public void	setType(int type)
public String	toStringList()

Inherited from org.antlr.runtime.tree.CommonTree:: getChildIndex getParent getToken getTokenStartIndex getTokenStopIndex isNil setChildIndex setParent setTokenStartIndex setTokenStopIndex setUnknownTokenBoundaries toString

Field Detail

blockOptions	back to summary
protected Map<String, Object> blockOptions If this is a BLOCK node, track options here

code	back to summary
public ST code if this is a TOKEN_REF or RULE_REF node, this is the code ST generated for this node. We need to update it later to add a label if someone does $tokenref or $ruleref in an action.

count	back to summary
pack-priv static int count

DescendantDownNode	back to summary
private static final GrammarAST DescendantDownNode

DescendantUpNode	back to summary
private static final GrammarAST DescendantUpNode

enclosingRuleName	back to summary
public String enclosingRuleName

followingNFAState	back to summary
public NFAState followingNFAState Rule ref nodes, token refs, set, and NOT set refs need to track their location in the generated NFA so that local FOLLOW sets can be computed during code gen for automatic error recovery.

ID	back to summary
public int ID

lookaheadDFA	back to summary
public DFA lookaheadDFA If this is a decision node, what is the lookahead DFA?

NFAStartState	back to summary
public NFAState NFAStartState What NFA start state was built from this node?

NFATreeDownState	back to summary
public NFAState NFATreeDownState This is used for TREE_BEGIN nodes to point into the NFA. TREE_BEGINs point at left edge of DOWN for LOOK computation purposes (Nullable tree child list needs special code gen when matching).

outerAltNum	back to summary
public int outerAltNum if this is an ACTION node, this is the outermost enclosing alt num in rule. For actions, define.g sets these (used to be codegen.g). We need these set so we can examine actions early, before code gen, for refs to rule predefined properties and rule labels. For most part define.g sets outerAltNum, but codegen.g does the ones for %foo(a={$ID.text}) type refs as the {$ID...} is not seen as an action until code gen pulls apart.

outerAltNum

back to summary

public int outerAltNum

if this is an ACTION node, this is the outermost enclosing alt num in rule. For actions, define.g sets these (used to be codegen.g). We need these set so we can examine actions early, before code gen, for refs to rule predefined properties and rule labels. For most part define.g sets outerAltNum, but codegen.g does the ones for %foo(a={$ID.text}) type refs as the {$ID...} is not seen as an action until code gen pulls apart.

rewriteRefsDeep	back to summary
public Set<GrammarAST> rewriteRefsDeep

rewriteRefsShallow	back to summary
public Set<GrammarAST> rewriteRefsShallow If this is a BLOCK node for a rewrite rule, track referenced elements here. Don't track elements in nested subrules.

setValue	back to summary
protected IntSet setValue If this is a SET node, what are the elements?

terminalOptions	back to summary
public Map<String, Object> terminalOptions

textOverride	back to summary
private String textOverride

Constructor Detail

GrammarAST	back to summary
public GrammarAST()

GrammarAST	back to summary
public GrammarAST(int t, String txt) Annotations @SuppressWarnings:OverridableMethodCallInConstructor

GrammarAST	back to summary
public GrammarAST(Token token) Annotations @SuppressWarnings:OverridableMethodCallInConstructor

Method Detail

_findAllType	back to summary
public void _findAllType(int ttype, List<GrammarAST> nodes)

descendants	back to summary
public static List<Tree> descendants(Tree root)

descendants	back to summary
public static List<Tree> descendants(Tree root, boolean insertDownUpNodes)

dup	back to summary
public static GrammarAST dup(Tree t)

dupNode	back to summary
public Tree dupNode() Overrides org.antlr.runtime.tree.CommonTree.dupNode. Implements org.antlr.runtime.tree.Tree.dupNode. Annotations @Override

dupNode

back to summary

public Tree dupNode()

Overrides org.antlr.runtime.tree.CommonTree.dupNode.

Implements org.antlr.runtime.tree.Tree.dupNode.

Annotations

@Override

dupTree	back to summary
public static GrammarAST dupTree(GrammarAST t)

dupTreeNoActions	back to summary
public static GrammarAST dupTreeNoActions(GrammarAST t, GrammarAST parent) Duplicate a tree, assuming this is a root node of a tree-- duplicate that node and what's below; ignore siblings of root node.

equals back to summary

equals	back to summary
public boolean equals(Object ast) Overrides java.lang.Object.equals. Make nodes unique based upon Token so we can add them to a Set; if not a GrammarAST, check type. Parameters ast:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object ast)

Overrides java.lang.Object.equals.

Make nodes unique based upon Token so we can add them to a Set; if not a GrammarAST, check type.

Parameters

ast:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

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

Annotations

@Override

findAllType	back to summary
public List<GrammarAST> findAllType(int ttype)

findFirstType	back to summary
public GrammarAST findFirstType(int ttype)

getBlockALT	back to summary
public GrammarAST getBlockALT(int i)

getBlockOption	back to summary
public Object getBlockOption(String key)

getBlockOptions	back to summary
public Map<String, Object> getBlockOptions()

getCharPositionInLine	back to summary
public int getCharPositionInLine() Overrides org.antlr.runtime.tree.CommonTree.getCharPositionInLine. Implements org.antlr.runtime.tree.Tree.getCharPositionInLine. Annotations @Override

getCharPositionInLine

back to summary

public int getCharPositionInLine()

Overrides org.antlr.runtime.tree.CommonTree.getCharPositionInLine.

Implements org.antlr.runtime.tree.Tree.getCharPositionInLine.

Annotations

@Override

getChildrenAsArray	back to summary
public GrammarAST[] getChildrenAsArray()

getChildrenForDupTree	back to summary
private static List<GrammarAST> getChildrenForDupTree(GrammarAST t)

getLastChild	back to summary
public GrammarAST getLastChild()

getLastSibling	back to summary
public GrammarAST getLastSibling()

getLine	back to summary
public int getLine() Overrides org.antlr.runtime.tree.CommonTree.getLine. Implements org.antlr.runtime.tree.Tree.getLine. Doc from org.antlr.runtime.tree.Tree.getLine. In case we don't have a token payload, what is the line for errors? Annotations @Override

getLine

back to summary

public int getLine()

Overrides org.antlr.runtime.tree.CommonTree.getLine.

Implements org.antlr.runtime.tree.Tree.getLine.

Doc from org.antlr.runtime.tree.Tree.getLine.

In case we don't have a token payload, what is the line for errors?

Annotations

@Override

getLookaheadDFA	back to summary
public DFA getLookaheadDFA()

getNextSibling	back to summary
public GrammarAST getNextSibling()

getNFAStartState	back to summary
public NFAState getNFAStartState()

getSetValue	back to summary
public IntSet getSetValue()

getText	back to summary
public String getText() Overrides org.antlr.runtime.tree.CommonTree.getText. Implements org.antlr.runtime.tree.Tree.getText. Annotations @Override

getText

back to summary

public String getText()

Overrides org.antlr.runtime.tree.CommonTree.getText.

Implements org.antlr.runtime.tree.Tree.getText.

Annotations

@Override

getType	back to summary
public int getType() Overrides org.antlr.runtime.tree.CommonTree.getType. Implements org.antlr.runtime.tree.Tree.getType. Doc from org.antlr.runtime.tree.Tree.getType. Return a token type; needed for tree parsing Annotations @Override

getType

back to summary

public int getType()

Overrides org.antlr.runtime.tree.CommonTree.getType.

Implements org.antlr.runtime.tree.Tree.getType.

Doc from org.antlr.runtime.tree.Tree.getType.

Return a token type; needed for tree parsing

Annotations

@Override

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Make nodes unique based upon Token so we can add them to a Set; if not a GrammarAST, check type. Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Make nodes unique based upon Token so we can add them to a Set; if not a GrammarAST, check type.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

Annotations

@Override

hasSameTreeStructure	back to summary
public boolean hasSameTreeStructure(Tree other) See if tree has exact token types and structure; no text

initialize	back to summary
public void initialize(int i, String s)

initialize	back to summary
public void initialize(Tree ast)

initialize	back to summary
public void initialize(Token token)

setBlockOption	back to summary
public String setBlockOption(Grammar grammar, String key, Object value) Save the option key/value pair and process it; return the key or null if invalid option.

setBlockOptions	back to summary
public void setBlockOptions(Map<String, Object> blockOptions)

setCharPositionInLine	back to summary
public void setCharPositionInLine(int value)

setLine	back to summary
public void setLine(int line)

setLookaheadDFA	back to summary
public void setLookaheadDFA(DFA lookaheadDFA)

setNFAStartState	back to summary
public void setNFAStartState(NFAState nfaStartState)

setOption	back to summary
public String setOption(Map<String, Object> options, Set<String> legalOptions, Grammar grammar, String key, Object value)

setOptions	back to summary
public void setOptions(Grammar grammar, Map<String, Object> options)

setSetValue	back to summary
public void setSetValue(IntSet setValue)

setTerminalOption	back to summary
public String setTerminalOption(Grammar grammar, String key, Object value)

setText	back to summary
public void setText(String text)

setTokenBoundaries	back to summary
public void setTokenBoundaries(Token startToken, Token stopToken) Track start/stop token for subtree root created for a rule. Only works with Tree nodes. For rules that match nothing, seems like this will yield start=i and stop=i-1 in a nil node. Might be useful info so I'll not force to be i..i.

setTreeEnclosingRuleNameDeeply	back to summary
public void setTreeEnclosingRuleNameDeeply(String rname)

setType	back to summary
public void setType(int type)

toStringList	back to summary
public String toStringList()

public Class GrammarAST

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail