Package org.antlr.tool
Class GrammarAST
- java.lang.Object
-
- antlr.BaseAST
-
- org.antlr.tool.GrammarAST
-
- All Implemented Interfaces:
antlr.collections.AST
,Serializable
public class GrammarAST extends antlr.BaseAST
Grammars are first converted to ASTs using this class and then are converted to NFAs via a tree walker. The reader may notice that I have made a very non-OO decision in this class to track variables for many different kinds of nodes. It wastes space for nodes that don't need the values and OO principles cry out for a new class type for each kind of node in my tree. I am doing this on purpose for a variety of reasons. I don't like using the type system for different node types; it yields too many damn class files which I hate. Perhaps if I put them all in one file. Most importantly though I hate all the type casting that would have to go on. I would have all sorts of extra work to do. Ick. Anyway, I'm doing all this on purpose, not out of ignorance. ;)- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected Map<String,Object>
blockOptions
If this is a BLOCK node, track options hereorg.antlr.stringtemplate.StringTemplate
code
if this is a TOKEN_REF or RULE_REF node, this is the code StringTemplate generated for this node.String
enclosingRuleName
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.int
ID
DFA
lookaheadDFA
If this is a decision node, what is the lookahead DFA?NFAState
NFAStartState
What NFA start state was built from this node?NFAState
NFATreeDownState
This is used for TREE_BEGIN nodes to point into the NFA.int
outerAltNum
if this is an ACTION node, this is the outermost enclosing alt num in rule.Set<GrammarAST>
rewriteRefsDeep
Set<GrammarAST>
rewriteRefsShallow
If this is a BLOCK node for a rewrite rule, track referenced elements here.int
ruleStartTokenIndex
If this is a RULE node then track rule's start, stop tokens' index.int
ruleStopTokenIndex
protected IntSet
setValue
If this is a SET node, what are the elements?Map<String,Object>
terminalOptions
antlr.Token
token
This AST node was created from what token?
-
Constructor Summary
Constructors Constructor Description GrammarAST()
GrammarAST(int t, String txt)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GrammarAST
dup(antlr.collections.AST t)
static GrammarAST
dupListNoActions(GrammarAST t, GrammarAST parent)
Duplicate tree including siblings of root.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.boolean
equals(Object ast)
Make nodes unique based upon Token so we can add them to a Set; if not a GrammarAST, check type.GrammarAST
findFirstType(int ttype)
Return a reference to the first node (depth-first) that has token type ttype.Object
getBlockOption(String key)
Map<String,Object>
getBlockOptions()
GrammarAST
getChild(int i)
Get the ith child from 0GrammarAST[]
getChildrenAsArray()
int
getColumn()
GrammarAST
getFirstChildWithType(int ttype)
GrammarAST
getLastChild()
GrammarAST
getLastSibling()
int
getLine()
DFA
getLookaheadDFA()
NFAState
getNFAStartState()
int
getNumberOfChildrenWithType(int ttype)
IntSet
getSetValue()
String
getText()
antlr.Token
getToken()
int
getType()
boolean
hasSameListStructure(antlr.collections.AST t)
boolean
hasSameTreeStructure(antlr.collections.AST t)
See if tree has exact token types and structure; no textvoid
initialize(int i, String s)
void
initialize(antlr.collections.AST ast)
void
initialize(antlr.Token token)
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.void
setBlockOptions(Map<String,Object> blockOptions)
void
setColumn(int col)
void
setLine(int line)
void
setLookaheadDFA(DFA lookaheadDFA)
void
setNFAStartState(NFAState nfaStartState)
String
setOption(Map options, Set legalOptions, Grammar grammar, String key, Object value)
void
setOptions(Grammar grammar, Map options)
void
setSetValue(IntSet setValue)
String
setTerminalOption(Grammar grammar, String key, Object value)
void
setText(String text)
void
setTreeEnclosingRuleNameDeeply(String rname)
void
setType(int type)
-
Methods inherited from class antlr.BaseAST
addChild, decode, encode, equals, equalsList, equalsListPartial, equalsTree, equalsTreePartial, findAll, findAllPartial, getFirstChild, getNextSibling, getNumberOfChildren, getTokenNames, removeChildren, setFirstChild, setNextSibling, setVerboseStringConversion, toString, toStringList, toStringTree, xmlSerialize, xmlSerializeNode, xmlSerializeRootClose, xmlSerializeRootOpen
-
-
-
-
Field Detail
-
ID
public int ID
-
token
public antlr.Token token
This AST node was created from what token?
-
enclosingRuleName
public String enclosingRuleName
-
ruleStartTokenIndex
public int ruleStartTokenIndex
If this is a RULE node then track rule's start, stop tokens' index.
-
ruleStopTokenIndex
public int ruleStopTokenIndex
-
lookaheadDFA
public DFA lookaheadDFA
If this is a decision node, what is the lookahead DFA?
-
NFAStartState
public NFAState NFAStartState
What NFA start state was built from this node?
-
NFATreeDownState
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).
-
followingNFAState
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.
-
setValue
protected IntSet setValue
If this is a SET node, what are the elements?
-
rewriteRefsShallow
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.
-
rewriteRefsDeep
public Set<GrammarAST> rewriteRefsDeep
-
outerAltNum
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.
-
code
public org.antlr.stringtemplate.StringTemplate code
if this is a TOKEN_REF or RULE_REF node, this is the code StringTemplate generated for this node. We need to update it later to add a label if someone does $tokenref or $ruleref in an action.
-
-
Constructor Detail
-
GrammarAST
public GrammarAST()
-
GrammarAST
public GrammarAST(int t, String txt)
-
-
Method Detail
-
setBlockOptions
public void setBlockOptions(Map<String,Object> blockOptions)
- Parameters:
blockOptions
-
-
initialize
public void initialize(int i, String s)
- Specified by:
initialize
in interfaceantlr.collections.AST
- Specified by:
initialize
in classantlr.BaseAST
-
initialize
public void initialize(antlr.collections.AST ast)
- Specified by:
initialize
in interfaceantlr.collections.AST
- Specified by:
initialize
in classantlr.BaseAST
-
initialize
public void initialize(antlr.Token token)
- Specified by:
initialize
in interfaceantlr.collections.AST
- Specified by:
initialize
in classantlr.BaseAST
-
getLookaheadDFA
public DFA getLookaheadDFA()
-
setLookaheadDFA
public void setLookaheadDFA(DFA lookaheadDFA)
-
getToken
public antlr.Token getToken()
-
getNFAStartState
public NFAState getNFAStartState()
-
setNFAStartState
public void setNFAStartState(NFAState nfaStartState)
-
setBlockOption
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.
-
setOption
public String setOption(Map options, Set legalOptions, Grammar grammar, String key, Object value)
-
getText
public String getText()
- Specified by:
getText
in interfaceantlr.collections.AST
- Overrides:
getText
in classantlr.BaseAST
-
setType
public void setType(int type)
- Specified by:
setType
in interfaceantlr.collections.AST
- Overrides:
setType
in classantlr.BaseAST
-
setText
public void setText(String text)
- Specified by:
setText
in interfaceantlr.collections.AST
- Overrides:
setText
in classantlr.BaseAST
-
getType
public int getType()
- Specified by:
getType
in interfaceantlr.collections.AST
- Overrides:
getType
in classantlr.BaseAST
-
getLine
public int getLine()
- Specified by:
getLine
in interfaceantlr.collections.AST
- Overrides:
getLine
in classantlr.BaseAST
-
getColumn
public int getColumn()
- Specified by:
getColumn
in interfaceantlr.collections.AST
- Overrides:
getColumn
in classantlr.BaseAST
-
setLine
public void setLine(int line)
-
setColumn
public void setColumn(int col)
-
getSetValue
public IntSet getSetValue()
-
setSetValue
public void setSetValue(IntSet setValue)
-
getLastChild
public GrammarAST getLastChild()
-
getLastSibling
public GrammarAST getLastSibling()
-
getChild
public GrammarAST getChild(int i)
Get the ith child from 0
-
getFirstChildWithType
public GrammarAST getFirstChildWithType(int ttype)
-
getChildrenAsArray
public GrammarAST[] getChildrenAsArray()
-
findFirstType
public GrammarAST findFirstType(int ttype)
Return a reference to the first node (depth-first) that has token type ttype. Assume 'this' is a root node; don't visit siblings of root. Return null if no node found with ttype.
-
getNumberOfChildrenWithType
public int getNumberOfChildrenWithType(int ttype)
-
equals
public boolean equals(Object ast)
Make nodes unique based upon Token so we can add them to a Set; if not a GrammarAST, check type.
-
hasSameTreeStructure
public boolean hasSameTreeStructure(antlr.collections.AST t)
See if tree has exact token types and structure; no text
-
hasSameListStructure
public boolean hasSameListStructure(antlr.collections.AST t)
-
dup
public static GrammarAST dup(antlr.collections.AST t)
-
dupListNoActions
public static GrammarAST dupListNoActions(GrammarAST t, GrammarAST parent)
Duplicate tree including siblings of root.
-
dupTreeNoActions
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.
-
setTreeEnclosingRuleNameDeeply
public void setTreeEnclosingRuleNameDeeply(String rname)
-
-