| Modifier and Type | Field and Description |
|---|---|
| protected TreeAdaptor | |
| protected DebugEventListener |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | addChild(Object t, Object child)
Implements org. |
| public void | |
| public Object | becomeRoot(Object newRoot, Object oldRoot)
Implements org. |
| public Object | becomeRoot(Token newRoot, Object oldRoot)
Implements org. |
| public Object | create(Token payload)
Implements org. |
| public Object | create(int tokenType, Token fromToken)
Implements org. |
| public Object | create(int tokenType, Token fromToken, String text)
Implements org. |
| public Object | create(int tokenType, String text)
Implements org. |
| public Object | deleteChild(Object t, int i)
Implements org. |
| public Object | dupNode(Object treeNode)
Implements org. |
| public Object | dupTree(Object tree)
Implements org. |
| public Object | errorNode(TokenStream input, Token start, Token stop, RecognitionException e)
Implements org. |
| public Object | getChild(Object t, int i)
Implements org. |
| public int | getChildCount(Object t)
Implements org. |
| public int | getChildIndex(Object t)
Implements org. |
| public DebugEventListener | |
| public Object | getParent(Object t)
Implements org. |
| public String | |
| public Token | getToken(Object t)
Implements org. |
| public int | getTokenStartIndex(Object t)
Implements org. |
| public int | getTokenStopIndex(Object t)
Implements org. |
| public TreeAdaptor | |
| public int | getType(Object t)
Implements org. |
| public int | getUniqueID(Object node)
Implements org. |
| public boolean | isNil(Object tree)
Implements org. |
| public Object | nil()
Implements org. |
| public void | replaceChildren(Object parent, int startChildIndex, int stopChildIndex, Object t)
Implements org. |
| public Object | rulePostProcessing(Object root)
Implements org. |
| public void | setChild(Object t, int i, Object child)
Implements org. |
| public void | |
| public void | |
| public void | |
| public void | setText(Object t, String text)
Implements org. |
| public void | setTokenBoundaries(Object t, Token startToken, Token stopToken)
Implements org. |
| public void | setType(Object t, int type)
Implements org. |
| protected void |
| adaptor | back to summary |
|---|---|
| protected TreeAdaptor adaptor | |
| dbg | back to summary |
|---|---|
| protected DebugEventListener dbg | |
| DebugTreeAdaptor | back to summary |
|---|---|
| public DebugTreeAdaptor(DebugEventListener dbg, TreeAdaptor adaptor) | |
| addChild | back to summary |
|---|---|
| public void addChild(Object t, Object child) Implements org. Doc from org. Add a child to the tree t. If child is a flat tree (a list), make all in list children of t. Warning if t has no children, but child does and child isNil then you can decide it is ok to move children to t via t.children = child.children; i.e., without copying the array. Just make sure that this is consistent with have the user will build ASTs. Do nothing if t or child is null.
| |
| addChild | back to summary |
|---|---|
| public void addChild(Object t, Token child) | |
| becomeRoot | back to summary |
|---|---|
| public Object becomeRoot(Object newRoot, Object oldRoot) Implements org. Doc from org. If oldRoot is a nil root, just copy or move the children to newRoot. If not a nil root, make oldRoot a child of newRoot. old=^(nil a b c), new=r yields ^(r a b c) old=^(a b c), new=r yields ^(r ^(a b c)) If newRoot is a nil-rooted single child tree, use the single child as the new root node. old=^(nil a b c), new=^(nil r) yields ^(r a b c) old=^(a b c), new=^(nil r) yields ^(r ^(a b c)) If oldRoot was null, it's ok, just return newRoot (even if isNil). old=null, new=r yields r old=null, new=^(nil r) yields ^(nil r) Return newRoot. Throw an exception if newRoot is not a simple node or nil root with a single child node--it must be a root node. If newRoot is ^(nil x) return x as newRoot. Be advised that it's ok for newRoot to point at oldRoot's children; i.e., you don't have to copy the list. We are constructing these nodes so we should have this control for efficiency.
| |
| becomeRoot | back to summary |
|---|---|
| public Object becomeRoot(Token newRoot, Object oldRoot) Implements org. Doc from org. Create a node for newRoot make it the root of oldRoot. If oldRoot is a nil root, just copy or move the children to newRoot. If not a nil root, make oldRoot a child of newRoot. Return node created for newRoot. Be advised: when debugging ASTs, the DebugTreeAdaptor manually calls create(Token child) and then plain becomeRoot(node, node) because it needs to trap calls to create, but it can't since it delegates to not inherits from the TreeAdaptor.
| |
| create | back to summary |
|---|---|
| public Object create(Token payload) Implements org. Doc from org. Create a tree node from Token object; for CommonTree type trees, then the token just becomes the payload. This is the most common create call. Override if you want another kind of node to be built.
| |
| create | back to summary |
|---|---|
| public Object create(int tokenType, Token fromToken) Implements org. Doc from org. Create a new node derived from a token, with a new token type. This is invoked from an imaginary node ref on right side of a rewrite rule as IMAG[$tokenLabel]. This should invoke createToken(Token).
| |
| create | back to summary |
|---|---|
| public Object create(int tokenType, Token fromToken, String text) Implements org. Doc from org. Same as create(tokenType,fromToken) except set the text too. This is invoked from an imaginary node ref on right side of a rewrite rule as IMAG[$tokenLabel, "IMAG"]. This should invoke createToken(Token).
| |
| create | back to summary |
|---|---|
| public Object create(int tokenType, String text) Implements org. Doc from org. Create a new node derived from a token, with a new token type. This is invoked from an imaginary node ref on right side of a rewrite rule as IMAG["IMAG"]. This should invoke createToken(int,String).
| |
| deleteChild | back to summary |
|---|---|
| public Object deleteChild(Object t, int i) Implements org. Doc from org. Remove ith child and shift children down from right.
| |
| dupNode | back to summary |
|---|---|
| public Object dupNode(Object treeNode) Implements org. Doc from org. Duplicate a single tree node. Override if you want another kind of node to be built.
| |
| dupTree | back to summary |
|---|---|
| public Object dupTree(Object tree) Implements org. Doc from org. Duplicate tree recursively, using dupNode() for each node
| |
| errorNode | back to summary |
|---|---|
| public Object errorNode(TokenStream input, Token start, Token stop, RecognitionException e) Implements org. Doc from org. Return a tree node representing an error. This node records the tokens consumed during error recovery. The start token indicates the input symbol at which the error was detected. The stop token indicates the last symbol consumed during recovery. You must specify the input stream so that the erroneous text can be packaged up in the error node. The exception could be useful to some applications; default implementation stores ptr to it in the CommonErrorNode. This only makes sense during token parsing, not tree parsing. Tree parsing should happen only when parsing and tree construction succeed.
| |
| getChild | back to summary |
|---|---|
| public Object getChild(Object t, int i) Implements org. Doc from org. Get a child 0..n-1 node
| |
| getChildCount | back to summary |
|---|---|
| public int getChildCount(Object t) Implements org. Doc from org. How many children? If 0, then this is a leaf node
| |
| getChildIndex | back to summary |
|---|---|
| public int getChildIndex(Object t) Implements org. Doc from org. What index is this node in the child list? Range: 0..n-1 If your node type doesn't handle this, it's ok but the tree rewrites in tree parsers need this functionality.
| |
| getDebugListener | back to summary |
|---|---|
| public DebugEventListener getDebugListener() | |
| getParent | back to summary |
|---|---|
| public Object getParent(Object t) Implements org. Doc from org. Who is the parent node of this node; if null, implies node is root. If your node type doesn't handle this, it's ok but the tree rewrites in tree parsers need this functionality.
| |
| getText | back to summary |
|---|---|
| public String getText(Object t) Implements org.
| |
| getToken | back to summary |
|---|---|
| public Token getToken(Object t) Implements org. Doc from org. Return the token object from which this node was created. Currently used only for printing an error message. The error display routine in BaseRecognizer needs to display where the input the error occurred. If your tree of limitation does not store information that can lead you to the token, you can create a token filled with the appropriate information and pass that back. See BaseRecognizer.getErrorMessage().
| |
| getTokenStartIndex | back to summary |
|---|---|
| public int getTokenStartIndex(Object t) Implements org. Doc from org. Get the token start index for this subtree; return -1 if no such index
| |
| getTokenStopIndex | back to summary |
|---|---|
| public int getTokenStopIndex(Object t) Implements org. Doc from org. Get the token stop index for this subtree; return -1 if no such index
| |
| getTreeAdaptor | back to summary |
|---|---|
| public TreeAdaptor getTreeAdaptor() | |
| getType | back to summary |
|---|---|
| public int getType(Object t) Implements org. Doc from org. For tree parsing, I need to know the token type of a node
| |
| getUniqueID | back to summary |
|---|---|
| public int getUniqueID(Object node) Implements org. Doc from org. For identifying trees. How to identify nodes so we can say "add node to a prior node"? Even becomeRoot is an issue. Use System.identityHashCode(node) usually.
| |
| isNil | back to summary |
|---|---|
| public boolean isNil(Object tree) Implements org. Doc from org. Is tree considered a nil node used to make lists of child nodes?
| |
| nil | back to summary |
|---|---|
| public Object nil() Implements org. Doc from org. Return a nil node (an empty but non-null node) that can hold a list of element as the children. If you want a flat tree (a list) use "t=adaptor.nil(); t.addChild(x); t.addChild(y);"
| |
| replaceChildren | back to summary |
|---|---|
| public void replaceChildren(Object parent, int startChildIndex, int stopChildIndex, Object t) Implements org. Doc from org. Replace from start to stop child index of parent with t, which might be a list. Number of children may be different after this call. If parent is null, don't do anything; must be at root of overall tree. Can't replace whatever points to the parent externally. Do nothing.
| |
| rulePostProcessing | back to summary |
|---|---|
| public Object rulePostProcessing(Object root) Implements org. Doc from org. Given the root of the subtree created for this rule, post process it to do any simplifications or whatever you want. A required behavior is to convert ^(nil singleSubtree) to singleSubtree as the setting of start/stop indexes relies on a single non-nil root for non-flat trees. Flat trees such as for lists like "idlist : ID+ ;" are left alone unless there is only one ID. For a list, the start/stop indexes are set in the nil node. This method is executed after all rule tree construction and right before setTokenBoundaries().
| |
| setChild | back to summary |
|---|---|
| public void setChild(Object t, int i, Object child) Implements org. Doc from org. Set ith child (0..n-1) to t; t must be non-null and non-nil node
| |
| setChildIndex | back to summary |
|---|---|
| public void setChildIndex(Object t, int index) Implements org.
| |
| setDebugListener | back to summary |
|---|---|
| public void setDebugListener(DebugEventListener dbg) | |
| setParent | back to summary |
|---|---|
| public void setParent(Object t, Object parent) Implements org.
| |
| setText | back to summary |
|---|---|
| public void setText(Object t, String text) Implements org. Doc from org. Node constructors can set the text of a node
| |
| setTokenBoundaries | back to summary |
|---|---|
| public void setTokenBoundaries(Object t, Token startToken, Token stopToken) Implements org. Doc from org. Where are the bounds in the input token stream for this node and all children? Each rule that creates AST nodes will call this method right before returning. Flat trees (i.e., lists) will still usually have a nil root node just to hold the children list. That node would contain the start/stop indexes then.
| |
| setType | back to summary |
|---|---|
| public void setType(Object t, int type) Implements org. Doc from org. Node constructors can set the type of a node
| |
| simulateTreeConstruction | back to summary |
|---|---|
| protected void simulateTreeConstruction(Object t) ^(A B C): emit create A, create B, add child, ... | |