org.antlr.runtime.debug.DebugTreeAdaptor Class Reference

Inheritance diagram for org.antlr.runtime.debug.DebugTreeAdaptor:

Collaboration diagram for org.antlr.runtime.debug.DebugTreeAdaptor:

List of all members.

Public Member Functions

DebugTreeAdaptor (DebugEventListener dbg, TreeAdaptor adaptor)

Object create (Token payload)

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

Object dupTree (Object tree)

Object dupNode (Object treeNode)

Object nil ()

boolean isNil (Object tree)

void addChild (Object t, Object child)

Object becomeRoot (Object newRoot, Object oldRoot)

Object rulePostProcessing (Object root)

void addChild (Object t, Token child)

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)

Token getToken (Object t)

void setTokenBoundaries (Object t, Token startToken, Token stopToken)

int getTokenStartIndex (Object t)

int getTokenStopIndex (Object t)

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)

Object getParent (Object t)

int getChildIndex (Object t)

void setParent (Object t, Object parent)

void setChildIndex (Object t, int index)

void replaceChildren (Object parent, int startChildIndex, int stopChildIndex, Object t)

DebugEventListener getDebugListener ()

void setDebugListener (DebugEventListener dbg)

TreeAdaptor getTreeAdaptor ()

Protected Member Functions

void simulateTreeConstruction (Object t)

Protected Attributes

DebugEventListener dbg

TreeAdaptor adaptor

Detailed Description

A TreeAdaptor proxy that fires debugging events to a DebugEventListener delegate and uses the TreeAdaptor delegate to do the actual work. All AST events are triggered by this adaptor; no code gen changes are needed in generated rules. Debugging events are triggered *after* invoking tree adaptor routines.

Trees created with actions in rewrite actions like "-> ^(ADD {foo} {bar})" cannot be tracked as they might not use the adaptor to create foo, bar. The debug listener has to deal with tree node IDs for which it did not see a createNode event. A single <unknown> node is sufficient even if it represents a whole tree.

Definition at line 47 of file DebugTreeAdaptor.java.

Constructor & Destructor Documentation

org.antlr.runtime.debug.DebugTreeAdaptor.DebugTreeAdaptor	(	DebugEventListener	dbg,
		TreeAdaptor	adaptor
	)

Definition at line 51 of file DebugTreeAdaptor.java.

Member Function Documentation

Object org.antlr.runtime.debug.DebugTreeAdaptor.create ( Token payload )

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.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 56 of file DebugTreeAdaptor.java.

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

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.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 66 of file DebugTreeAdaptor.java.

Object org.antlr.runtime.debug.DebugTreeAdaptor.dupTree ( Object tree )

Duplicate tree recursively, using dupNode() for each node

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 76 of file DebugTreeAdaptor.java.

void org.antlr.runtime.debug.DebugTreeAdaptor.simulateTreeConstruction ( Object t ) [protected]

^(A B C): emit create A, create B, add child, ...

Definition at line 86 of file DebugTreeAdaptor.java.

Object org.antlr.runtime.debug.DebugTreeAdaptor.dupNode ( Object treeNode )

Duplicate a single tree node. Override if you want another kind of node to be built.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 96 of file DebugTreeAdaptor.java.

Object org.antlr.runtime.debug.DebugTreeAdaptor.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 102 of file DebugTreeAdaptor.java.

boolean org.antlr.runtime.debug.DebugTreeAdaptor.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 108 of file DebugTreeAdaptor.java.

void org.antlr.runtime.debug.DebugTreeAdaptor.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. Do nothing if t or child is null.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 112 of file DebugTreeAdaptor.java.

Object org.antlr.runtime.debug.DebugTreeAdaptor.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 120 of file DebugTreeAdaptor.java.

Object org.antlr.runtime.debug.DebugTreeAdaptor.rulePostProcessing ( Object root )

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

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 126 of file DebugTreeAdaptor.java.

void org.antlr.runtime.debug.DebugTreeAdaptor.addChild	(	Object	t,
		Token	child
	)

Definition at line 130 of file DebugTreeAdaptor.java.

Object org.antlr.runtime.debug.DebugTreeAdaptor.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 135 of file DebugTreeAdaptor.java.

Object org.antlr.runtime.debug.DebugTreeAdaptor.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 142 of file DebugTreeAdaptor.java.

Object org.antlr.runtime.debug.DebugTreeAdaptor.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 148 of file DebugTreeAdaptor.java.

Object org.antlr.runtime.debug.DebugTreeAdaptor.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 154 of file DebugTreeAdaptor.java.

int org.antlr.runtime.debug.DebugTreeAdaptor.getType ( Object t )

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

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 160 of file DebugTreeAdaptor.java.

void org.antlr.runtime.debug.DebugTreeAdaptor.setType	(	Object	t,
		int	type
	)

Node constructors can set the type of a node

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 164 of file DebugTreeAdaptor.java.

String org.antlr.runtime.debug.DebugTreeAdaptor.getText ( Object t )

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 168 of file DebugTreeAdaptor.java.

void org.antlr.runtime.debug.DebugTreeAdaptor.setText	(	Object	t,
		String	text
	)

Node constructors can set the text of a node

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 172 of file DebugTreeAdaptor.java.

Token org.antlr.runtime.debug.DebugTreeAdaptor.getToken ( Object t )

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

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 176 of file DebugTreeAdaptor.java.

void org.antlr.runtime.debug.DebugTreeAdaptor.setTokenBoundaries	(	Object	t,
		Token	startToken,
		Token	stopToken
	)

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.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 180 of file DebugTreeAdaptor.java.

int org.antlr.runtime.debug.DebugTreeAdaptor.getTokenStartIndex ( Object t )

Get the token start index for this subtree; return -1 if no such index

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 189 of file DebugTreeAdaptor.java.

int org.antlr.runtime.debug.DebugTreeAdaptor.getTokenStopIndex ( Object t )

Get the token stop index for this subtree; return -1 if no such index

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 193 of file DebugTreeAdaptor.java.

Object org.antlr.runtime.debug.DebugTreeAdaptor.getChild	(	Object	t,
		int	i
	)

Get a child 0..n-1 node

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 197 of file DebugTreeAdaptor.java.

void org.antlr.runtime.debug.DebugTreeAdaptor.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 201 of file DebugTreeAdaptor.java.

Object org.antlr.runtime.debug.DebugTreeAdaptor.deleteChild	(	Object	t,
		int	i
	)

Remove ith child and shift children down from right.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 205 of file DebugTreeAdaptor.java.

int org.antlr.runtime.debug.DebugTreeAdaptor.getChildCount ( Object t )

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

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 209 of file DebugTreeAdaptor.java.

int org.antlr.runtime.debug.DebugTreeAdaptor.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 213 of file DebugTreeAdaptor.java.

Object org.antlr.runtime.debug.DebugTreeAdaptor.getParent ( Object t )

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.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 217 of file DebugTreeAdaptor.java.

int org.antlr.runtime.debug.DebugTreeAdaptor.getChildIndex ( Object t )

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.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 221 of file DebugTreeAdaptor.java.

void org.antlr.runtime.debug.DebugTreeAdaptor.setParent	(	Object	t,
		Object	parent
	)

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 225 of file DebugTreeAdaptor.java.

void org.antlr.runtime.debug.DebugTreeAdaptor.setChildIndex	(	Object	t,
		int	index
	)

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 229 of file DebugTreeAdaptor.java.

void org.antlr.runtime.debug.DebugTreeAdaptor.replaceChildren	(	Object	parent,
		int	startChildIndex,
		int	stopChildIndex,
		Object	t
	)

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.

Implements org.antlr.runtime.tree.TreeAdaptor.

Definition at line 233 of file DebugTreeAdaptor.java.

DebugEventListener org.antlr.runtime.debug.DebugTreeAdaptor.getDebugListener ( )

Definition at line 239 of file DebugTreeAdaptor.java.

void org.antlr.runtime.debug.DebugTreeAdaptor.setDebugListener ( DebugEventListener dbg )

Definition at line 243 of file DebugTreeAdaptor.java.

TreeAdaptor org.antlr.runtime.debug.DebugTreeAdaptor.getTreeAdaptor ( )

Definition at line 247 of file DebugTreeAdaptor.java.

Member Data Documentation

DebugEventListener org.antlr.runtime.debug.DebugTreeAdaptor.dbg [protected]

Definition at line 48 of file DebugTreeAdaptor.java.

TreeAdaptor org.antlr.runtime.debug.DebugTreeAdaptor.adaptor [protected]

Definition at line 49 of file DebugTreeAdaptor.java.

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

/Users/parrt/antlr/code/antlr/main/runtime/Java/src/org/antlr/runtime/debug/DebugTreeAdaptor.java


Public Member Functions
	DebugTreeAdaptor (DebugEventListener dbg, TreeAdaptor adaptor)
Object	create (Token payload)
Object	errorNode (TokenStream input, Token start, Token stop, RecognitionException e)
Object	dupTree (Object tree)
Object	dupNode (Object treeNode)
Object	nil ()
boolean	isNil (Object tree)
void	addChild (Object t, Object child)
Object	becomeRoot (Object newRoot, Object oldRoot)
Object	rulePostProcessing (Object root)
void	addChild (Object t, Token child)
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)
Token	getToken (Object t)
void	setTokenBoundaries (Object t, Token startToken, Token stopToken)
int	getTokenStartIndex (Object t)
int	getTokenStopIndex (Object t)
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)
Object	getParent (Object t)
int	getChildIndex (Object t)
void	setParent (Object t, Object parent)
void	setChildIndex (Object t, int index)
void	replaceChildren (Object parent, int startChildIndex, int stopChildIndex, Object t)
DebugEventListener	getDebugListener ()
void	setDebugListener (DebugEventListener dbg)
TreeAdaptor	getTreeAdaptor ()
Protected Member Functions
void	simulateTreeConstruction (Object t)
Protected Attributes
DebugEventListener	dbg
TreeAdaptor	adaptor