Top Description Fields Constructors Methods
org.antlr.runtime.tree

public abstract Class BaseTreeAdaptor

extends Object
implements TreeAdaptor
Class Inheritance
All Implemented Interfaces
org.antlr.runtime.tree.TreeAdaptor
Known Direct Subclasses
org.antlr.runtime.tree.CommonTreeAdaptor
Imports
org.antlr.runtime.Token, .TokenStream, .RecognitionException, java.util.HashMap, .Map
A TreeAdaptor that works with any Tree implementation.

Field Summary

Modifier and TypeField and Description
protected Map<Object, Integer>
treeToUniqueIDMap

System.identityHashCode() is not always unique; we have to track ourselves.

protected int
uniqueNodeID

Constructor Summary

AccessConstructor and Description
public
BaseTreeAdaptor()

Method Summary

Modifier and TypeMethod and Description
public void
addChild(Object t, Object child)

Implements org.antlr.runtime.tree.TreeAdaptor.addChild.

Add a child to the tree t.
public Object
becomeRoot(Object newRoot, Object oldRoot)

Implements org.antlr.runtime.tree.TreeAdaptor.becomeRoot.

If oldRoot is a nil root, just copy or move the children to newRoot.
public Object
becomeRoot(Token newRoot, Object oldRoot)

Implements org.antlr.runtime.tree.TreeAdaptor.becomeRoot.

Create a node for newRoot make it the root of oldRoot.
public Object
create(int tokenType, Token fromToken)

Implements org.antlr.runtime.tree.TreeAdaptor.create.

Create a new node derived from a token, with a new token type.
public Object
create(int tokenType, Token fromToken, String text)

Implements org.antlr.runtime.tree.TreeAdaptor.create.

Same as create(tokenType,fromToken) except set the text too.
public Object
create(int tokenType, String text)

Implements org.antlr.runtime.tree.TreeAdaptor.create.

Create a new node derived from a token, with a new token type.
public abstract Token
createToken(int tokenType, String text)

Tell me how to create a token for use with imaginary token nodes.

public abstract Token
createToken(Token fromToken)

Tell me how to create a token for use with imaginary token nodes.

public Object
deleteChild(Object t, int i)

Implements org.antlr.runtime.tree.TreeAdaptor.deleteChild.

Remove ith child and shift children down from right.
public Object
dupTree(Object tree)

Implements org.antlr.runtime.tree.TreeAdaptor.dupTree.

Duplicate tree recursively, using dupNode() for each node
public Object
dupTree(Object t, Object parent)

This is generic in the sense that it will work with any kind of tree (not just Tree interface).

public Object
errorNode(TokenStream input, Token start, Token stop, RecognitionException e)

Implements org.antlr.runtime.tree.TreeAdaptor.errorNode.

create tree node that holds the start and stop tokens associated with an error.
public Object
getChild(Object t, int i)

Implements org.antlr.runtime.tree.TreeAdaptor.getChild.

Get a child 0..n-1 node
public int
getChildCount(Object t)

Implements org.antlr.runtime.tree.TreeAdaptor.getChildCount.

How many children?
public String
getText(Object t)

Implements org.antlr.runtime.tree.TreeAdaptor.getText.

public int
getType(Object t)

Implements org.antlr.runtime.tree.TreeAdaptor.getType.

For tree parsing, I need to know the token type of a node
public int
getUniqueID(Object node)

Implements org.antlr.runtime.tree.TreeAdaptor.getUniqueID.

For identifying trees.
public boolean
isNil(Object tree)

Implements org.antlr.runtime.tree.TreeAdaptor.isNil.

Is tree considered a nil node used to make lists of child nodes?
public Object
nil()

Implements org.antlr.runtime.tree.TreeAdaptor.nil.

Return a nil node (an empty but non-null node) that can hold a list of element as the children.
public Object
rulePostProcessing(Object root)

Implements org.antlr.runtime.tree.TreeAdaptor.rulePostProcessing.

Transform ^(nil x) to x and nil to null
public void
setChild(Object t, int i, Object child)

Implements org.antlr.runtime.tree.TreeAdaptor.setChild.

Set ith child (0..n-1) to t; t must be non-null and non-nil node
public void
setText(Object t, String text)

Implements org.antlr.runtime.tree.TreeAdaptor.setText.

Node constructors can set the text of a node
public void
setType(Object t, int type)

Implements org.antlr.runtime.tree.TreeAdaptor.setType.

Node constructors can set the type of a node
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

treeToUniqueIDMapback to summary
protected Map<Object, Integer> treeToUniqueIDMap

System.identityHashCode() is not always unique; we have to track ourselves. That's ok, it's only for debugging, though it's expensive: we have to create a hashtable with all tree nodes in it.

uniqueNodeIDback to summary
protected int uniqueNodeID

Constructor Detail

BaseTreeAdaptorback to summary
public BaseTreeAdaptor()

Method Detail

addChildback to summary
public void addChild(Object t, Object child)

Implements org.antlr.runtime.tree.TreeAdaptor.addChild.

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.

Annotations
@Override
becomeRootback to summary
public Object becomeRoot(Object newRoot, Object oldRoot)

Implements org.antlr.runtime.tree.TreeAdaptor.becomeRoot.

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.

Annotations
@Override
becomeRootback to summary
public Object becomeRoot(Token newRoot, Object oldRoot)

Implements org.antlr.runtime.tree.TreeAdaptor.becomeRoot.

Doc from org.antlr.runtime.tree.TreeAdaptor.becomeRoot.

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.

Annotations
@Override
createback to summary
public Object create(int tokenType, Token fromToken)

Implements org.antlr.runtime.tree.TreeAdaptor.create.

Doc from org.antlr.runtime.tree.TreeAdaptor.create.

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).

Annotations
@Override
createback to summary
public Object create(int tokenType, Token fromToken, String text)

Implements org.antlr.runtime.tree.TreeAdaptor.create.

Doc from org.antlr.runtime.tree.TreeAdaptor.create.

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).

Annotations
@Override
createback to summary
public Object create(int tokenType, String text)

Implements org.antlr.runtime.tree.TreeAdaptor.create.

Doc from org.antlr.runtime.tree.TreeAdaptor.create.

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).

Annotations
@Override
createTokenback to summary
public abstract Token createToken(int tokenType, String text)

Tell me how to create a token for use with imaginary token nodes. For example, there is probably no input symbol associated with imaginary token DECL, but you need to create it as a payload or whatever for the DECL node as in ^(DECL type ID). If you care what the token payload objects' type is, you should override this method and any other createToken variant.

createTokenback to summary
public abstract Token createToken(Token fromToken)

Tell me how to create a token for use with imaginary token nodes. For example, there is probably no input symbol associated with imaginary token DECL, but you need to create it as a payload or whatever for the DECL node as in ^(DECL type ID). This is a variant of createToken where the new token is derived from an actual real input token. Typically this is for converting '{' tokens to BLOCK etc... You'll see r : lc='{' ID+ '}' -> ^(BLOCK[$lc] ID+) ; If you care what the token payload objects' type is, you should override this method and any other createToken variant.

deleteChildback to summary
public Object deleteChild(Object t, int i)

Implements org.antlr.runtime.tree.TreeAdaptor.deleteChild.

Doc from org.antlr.runtime.tree.TreeAdaptor.deleteChild.

Remove ith child and shift children down from right.

Annotations
@Override
dupTreeback to summary
public Object dupTree(Object tree)

Implements org.antlr.runtime.tree.TreeAdaptor.dupTree.

Doc from org.antlr.runtime.tree.TreeAdaptor.dupTree.

Duplicate tree recursively, using dupNode() for each node

Annotations
@Override
dupTreeback to summary
public Object dupTree(Object t, Object parent)

This is generic in the sense that it will work with any kind of tree (not just Tree interface). It invokes the adaptor routines not the tree node routines to do the construction.

errorNodeback to summary
public Object errorNode(TokenStream input, Token start, Token stop, RecognitionException e)

Implements org.antlr.runtime.tree.TreeAdaptor.errorNode.

create tree node that holds the start and stop tokens associated with an error. If you specify your own kind of tree nodes, you will likely have to override this method. CommonTree returns Token.INVALID_TOKEN_TYPE if no token payload but you might have to set token type for diff node type. You don't have to subclass CommonErrorNode; you will likely need to subclass your own tree node class to avoid class cast exception.

Annotations
@Override
getChildback to summary
public Object getChild(Object t, int i)

Implements org.antlr.runtime.tree.TreeAdaptor.getChild.

Doc from org.antlr.runtime.tree.TreeAdaptor.getChild.

Get a child 0..n-1 node

Annotations
@Override
getChildCountback to summary
public int getChildCount(Object t)

Implements org.antlr.runtime.tree.TreeAdaptor.getChildCount.

Doc from org.antlr.runtime.tree.TreeAdaptor.getChildCount.

How many children? If 0, then this is a leaf node

Annotations
@Override
getTextback to summary
public String getText(Object t)

Implements org.antlr.runtime.tree.TreeAdaptor.getText.

Annotations
@Override
getTypeback to summary
public int getType(Object t)

Implements org.antlr.runtime.tree.TreeAdaptor.getType.

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

For tree parsing, I need to know the token type of a node

Annotations
@Override
getUniqueIDback to summary
public int getUniqueID(Object node)

Implements org.antlr.runtime.tree.TreeAdaptor.getUniqueID.

Doc from org.antlr.runtime.tree.TreeAdaptor.getUniqueID.

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.

Annotations
@Override
isNilback to summary
public boolean isNil(Object tree)

Implements org.antlr.runtime.tree.TreeAdaptor.isNil.

Doc from org.antlr.runtime.tree.TreeAdaptor.isNil.

Is tree considered a nil node used to make lists of child nodes?

Annotations
@Override
nilback to summary
public Object nil()

Implements org.antlr.runtime.tree.TreeAdaptor.nil.

Doc from org.antlr.runtime.tree.TreeAdaptor.nil.

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);"

Annotations
@Override
rulePostProcessingback to summary
public Object rulePostProcessing(Object root)

Implements org.antlr.runtime.tree.TreeAdaptor.rulePostProcessing.

Transform ^(nil x) to x and nil to null

Annotations
@Override
setChildback to summary
public void setChild(Object t, int i, Object child)

Implements org.antlr.runtime.tree.TreeAdaptor.setChild.

Doc from org.antlr.runtime.tree.TreeAdaptor.setChild.

Set ith child (0..n-1) to t; t must be non-null and non-nil node

Annotations
@Override
setTextback to summary
public void setText(Object t, String text)

Implements org.antlr.runtime.tree.TreeAdaptor.setText.

Doc from org.antlr.runtime.tree.TreeAdaptor.setText.

Node constructors can set the text of a node

Annotations
@Override
setTypeback to summary
public void setType(Object t, int type)

Implements org.antlr.runtime.tree.TreeAdaptor.setType.

Doc from org.antlr.runtime.tree.TreeAdaptor.setType.

Node constructors can set the type of a node

Annotations
@Override