org.antlr.runtime.tree.BaseTreeAdaptor Class Reference

Inheritance diagram for org.antlr.runtime.tree.BaseTreeAdaptor:

Collaboration diagram for org.antlr.runtime.tree.BaseTreeAdaptor:

List of all members.

Public Member Functions

Object nil ()

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

boolean isNil (Object tree)

Object dupTree (Object tree)

Object dupTree (Object t, Object parent)

void addChild (Object t, Object child)

Object becomeRoot (Object newRoot, Object oldRoot)

Object rulePostProcessing (Object root)

Object becomeRoot (Token newRoot, Object oldRoot)

Object create (int tokenType, Token fromToken)

Object create (int tokenType, Token fromToken, String text)

Object create (int tokenType, String text)

int getType (Object t)

void setType (Object t, int type)

String getText (Object t)

void setText (Object t, String text)

Object getChild (Object t, int i)

void setChild (Object t, int i, Object child)

Object deleteChild (Object t, int i)

int getChildCount (Object t)

int getUniqueID (Object node)

abstract Token createToken (int tokenType, String text)

abstract Token createToken (Token fromToken)

Protected Attributes

Map treeToUniqueIDMap

int uniqueNodeID = 1

Detailed Description

A TreeAdaptor that works with any Tree implementation.

Definition at line 38 of file BaseTreeAdaptor.java.

Member Function Documentation

Object org.antlr.runtime.tree.BaseTreeAdaptor.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);"

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 46 of file BaseTreeAdaptor.java.

Object org.antlr.runtime.tree.BaseTreeAdaptor.errorNode	(	TokenStream	input,
		Token	start,
		Token	stop,
		RecognitionException	e
	)

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.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 61 of file BaseTreeAdaptor.java.

boolean org.antlr.runtime.tree.BaseTreeAdaptor.isNil ( Object tree )

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

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 69 of file BaseTreeAdaptor.java.

Object org.antlr.runtime.tree.BaseTreeAdaptor.dupTree ( Object tree )

Duplicate tree recursively, using dupNode() for each node

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 73 of file BaseTreeAdaptor.java.

Object org.antlr.runtime.tree.BaseTreeAdaptor.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.

Definition at line 81 of file BaseTreeAdaptor.java.

void org.antlr.runtime.tree.BaseTreeAdaptor.addChild	(	Object	t,
		Object	child
	)

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.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 105 of file BaseTreeAdaptor.java.

Object org.antlr.runtime.tree.BaseTreeAdaptor.becomeRoot	(	Object	newRoot,
		Object	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.

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.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 137 of file BaseTreeAdaptor.java.

Object org.antlr.runtime.tree.BaseTreeAdaptor.rulePostProcessing ( Object root )

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

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 161 of file BaseTreeAdaptor.java.

Object org.antlr.runtime.tree.BaseTreeAdaptor.becomeRoot	(	Token	newRoot,
		Object	oldRoot
	)

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.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 178 of file BaseTreeAdaptor.java.

Object org.antlr.runtime.tree.BaseTreeAdaptor.create	(	int	tokenType,
		Token	fromToken
	)

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

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 182 of file BaseTreeAdaptor.java.

Object org.antlr.runtime.tree.BaseTreeAdaptor.create	(	int	tokenType,
		Token	fromToken,
		String	text
	)

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

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 190 of file BaseTreeAdaptor.java.

Object org.antlr.runtime.tree.BaseTreeAdaptor.create	(	int	tokenType,
		String	text
	)

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

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 198 of file BaseTreeAdaptor.java.

int org.antlr.runtime.tree.BaseTreeAdaptor.getType ( Object t )

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

Implements org.antlr.runtime.tree.TreeAdaptor.

Reimplemented in org.antlr.runtime.tree.CommonTreeAdaptor.

Definition at line 204 of file BaseTreeAdaptor.java.

void org.antlr.runtime.tree.BaseTreeAdaptor.setType	(	Object	t,
		int	type
	)

Node constructors can set the type of a node

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 209 of file BaseTreeAdaptor.java.

String org.antlr.runtime.tree.BaseTreeAdaptor.getText ( Object t )

Implements org.antlr.runtime.tree.TreeAdaptor.

Reimplemented in org.antlr.runtime.tree.CommonTreeAdaptor.

Definition at line 213 of file BaseTreeAdaptor.java.

void org.antlr.runtime.tree.BaseTreeAdaptor.setText	(	Object	t,
		String	text
	)

Node constructors can set the text of a node

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 217 of file BaseTreeAdaptor.java.

Object org.antlr.runtime.tree.BaseTreeAdaptor.getChild	(	Object	t,
		int	i
	)

Get a child 0..n-1 node

Implements org.antlr.runtime.tree.TreeAdaptor.

Reimplemented in org.antlr.runtime.tree.CommonTreeAdaptor.

Definition at line 221 of file BaseTreeAdaptor.java.

void org.antlr.runtime.tree.BaseTreeAdaptor.setChild	(	Object	t,
		int	i,
		Object	child
	)

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

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 225 of file BaseTreeAdaptor.java.

Object org.antlr.runtime.tree.BaseTreeAdaptor.deleteChild	(	Object	t,
		int	i
	)

Remove ith child and shift children down from right.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 229 of file BaseTreeAdaptor.java.

int org.antlr.runtime.tree.BaseTreeAdaptor.getChildCount ( Object t )

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

Implements org.antlr.runtime.tree.TreeAdaptor.

Reimplemented in org.antlr.runtime.tree.CommonTreeAdaptor.

Definition at line 233 of file BaseTreeAdaptor.java.

int org.antlr.runtime.tree.BaseTreeAdaptor.getUniqueID ( Object node )

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.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 237 of file BaseTreeAdaptor.java.

abstract Token org.antlr.runtime.tree.BaseTreeAdaptor.createToken	(	int	tokenType,
		String	text
	)			`[pure virtual]`

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.

Implemented in org.antlr.runtime.tree.CommonTreeAdaptor.

abstract Token org.antlr.runtime.tree.BaseTreeAdaptor.createToken ( Token fromToken ) [pure virtual]

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.

Implemented in org.antlr.runtime.tree.CommonTreeAdaptor.

Member Data Documentation

Map org.antlr.runtime.tree.BaseTreeAdaptor.treeToUniqueIDMap [protected]

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.

Definition at line 43 of file BaseTreeAdaptor.java.

int org.antlr.runtime.tree.BaseTreeAdaptor.uniqueNodeID = 1 [protected]

Definition at line 44 of file BaseTreeAdaptor.java.

The documentation for this class was generated from the following file:

/Users/parrt/antlr/code/antlr/main/runtime/Java/src/org/antlr/runtime/tree/BaseTreeAdaptor.java


Public Member Functions
Object	nil ()
Object	errorNode (TokenStream input, Token start, Token stop, RecognitionException e)
boolean	isNil (Object tree)
Object	dupTree (Object tree)
Object	dupTree (Object t, Object parent)
void	addChild (Object t, Object child)
Object	becomeRoot (Object newRoot, Object oldRoot)
Object	rulePostProcessing (Object root)
Object	becomeRoot (Token newRoot, Object oldRoot)
Object	create (int tokenType, Token fromToken)
Object	create (int tokenType, Token fromToken, String text)
Object	create (int tokenType, String text)
int	getType (Object t)
void	setType (Object t, int type)
String	getText (Object t)
void	setText (Object t, String text)
Object	getChild (Object t, int i)
void	setChild (Object t, int i, Object child)
Object	deleteChild (Object t, int i)
int	getChildCount (Object t)
int	getUniqueID (Object node)
abstract Token	createToken (int tokenType, String text)
abstract Token	createToken (Token fromToken)
Protected Attributes
Map	treeToUniqueIDMap
int	uniqueNodeID = 1