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:
  • Field Details

    • count

      static int count
    • 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?
    • blockOptions

      protected Map<String,Object> blockOptions
      If this is a BLOCK node, track options here
    • 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
    • terminalOptions

      public Map<String,Object> terminalOptions
    • 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 Details

    • GrammarAST

      public GrammarAST()
    • GrammarAST

      public GrammarAST(int t, String txt)
  • Method Details

    • getBlockOptions

      public Map<String,Object> getBlockOptions()
      Returns:
    • setBlockOptions

      public void setBlockOptions(Map<String,Object> blockOptions)
      Parameters:
      blockOptions -
    • initialize

      public void initialize(int i, String s)
      Specified by:
      initialize in interface antlr.collections.AST
      Specified by:
      initialize in class antlr.BaseAST
    • initialize

      public void initialize(antlr.collections.AST ast)
      Specified by:
      initialize in interface antlr.collections.AST
      Specified by:
      initialize in class antlr.BaseAST
    • initialize

      public void initialize(antlr.Token token)
      Specified by:
      initialize in interface antlr.collections.AST
      Specified by:
      initialize in class antlr.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.
    • setTerminalOption

      public String setTerminalOption(Grammar grammar, String key, Object value)
    • setOption

      public String setOption(Map options, Set legalOptions, Grammar grammar, String key, Object value)
    • getBlockOption

      public Object getBlockOption(String key)
    • setOptions

      public void setOptions(Grammar grammar, Map options)
    • getText

      public String getText()
      Specified by:
      getText in interface antlr.collections.AST
      Overrides:
      getText in class antlr.BaseAST
    • setType

      public void setType(int type)
      Specified by:
      setType in interface antlr.collections.AST
      Overrides:
      setType in class antlr.BaseAST
    • setText

      public void setText(String text)
      Specified by:
      setText in interface antlr.collections.AST
      Overrides:
      setText in class antlr.BaseAST
    • getType

      public int getType()
      Specified by:
      getType in interface antlr.collections.AST
      Overrides:
      getType in class antlr.BaseAST
    • getLine

      public int getLine()
      Specified by:
      getLine in interface antlr.collections.AST
      Overrides:
      getLine in class antlr.BaseAST
    • getColumn

      public int getColumn()
      Specified by:
      getColumn in interface antlr.collections.AST
      Overrides:
      getColumn in class antlr.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.
      Overrides:
      equals in class Object
    • 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)