Antlr.Runtime.Debug.DebugTreeAdaptor Class Reference

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

Inheritance diagram for Antlr.Runtime.Debug.DebugTreeAdaptor:

[legend]

Collaboration diagram for Antlr.Runtime.Debug.DebugTreeAdaptor:

[legend]

List of all members.

Public Member Functions

DebugTreeAdaptor (IDebugEventListener dbg, ITreeAdaptor adaptor)

object Create (IToken payload)

Create a tree node from Token object; for CommonTree type trees, then the token just becomes the payload.

Object ErrorNode (ITokenStream input, IToken start, IToken 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.

object DupTree (object tree)

Duplicate tree recursively, using DupNode() for each node.

object DupNode (object treeNode)

Duplicate a single tree node.

object GetNilNode ()

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

bool IsNil (object tree)

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

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

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

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

void AddChild (object t, IToken child)

object BecomeRoot (IToken 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.

object Create (int tokenType, IToken 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].

object Create (int tokenType, IToken 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"].

object 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"].

int GetNodeType (object t)

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

void SetNodeType (object t, int type)

Node constructors can set the type of a node.

string GetNodeText (object t)

void SetNodeText (object t, string text)

Node constructors can set the text of a node.

IToken GetToken (object treeNode)

Return the token object from which this node was created.

void SetTokenBoundaries (object t, IToken startToken, IToken stopToken)

Where are the bounds in the input token stream for this node and all children?

int GetTokenStartIndex (object t)

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

int GetTokenStopIndex (object t)

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

object GetChild (object t, int i)

Get a child 0..n-1 node.

void SetChild (object t, int i, object child)

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

object DeleteChild (object t, int i)

Remove ith child and shift children down from right.

int GetChildCount (object t)

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

int GetUniqueID (object node)

For identifying trees. How to identify nodes so we can say "add node to a prior node"?

object GetParent (object t)

Who is the parent node of this node; if null, implies node is root.

int GetChildIndex (object t)

What index is this node in the child list? Range: 0..n-1.

void SetParent (object t, object parent)

void SetChildIndex (object t, int index)

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

Protected Member Functions

void SimulateTreeConstruction (Object t)

Protected Attributes

IDebugEventListener dbg

ITreeAdaptor adaptor

Properties

IDebugEventListener DebugListener [get, set]

ITreeAdaptor TreeAdaptor [get]

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 54 of file DebugTreeAdaptor.cs.

Constructor & Destructor Documentation

Antlr.Runtime.Debug.DebugTreeAdaptor.DebugTreeAdaptor	(	IDebugEventListener	dbg,
		ITreeAdaptor	adaptor
	)

Definition at line 59 of file DebugTreeAdaptor.cs.

Member Function Documentation

object Antlr.Runtime.Debug.DebugTreeAdaptor.Create ( IToken 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 Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 65 of file DebugTreeAdaptor.cs.

Object Antlr.Runtime.Debug.DebugTreeAdaptor.ErrorNode	(	ITokenStream	input,
		IToken	start,
		IToken	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 Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 76 of file DebugTreeAdaptor.cs.

object Antlr.Runtime.Debug.DebugTreeAdaptor.DupTree ( object tree )

Duplicate tree recursively, using DupNode() for each node.

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 86 of file DebugTreeAdaptor.cs.

void Antlr.Runtime.Debug.DebugTreeAdaptor.SimulateTreeConstruction ( Object t ) [protected]

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

Definition at line 97 of file DebugTreeAdaptor.cs.

object Antlr.Runtime.Debug.DebugTreeAdaptor.DupNode ( object treeNode )

Duplicate a single tree node.

Override if you want another kind of node to be built.

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 107 of file DebugTreeAdaptor.cs.

object Antlr.Runtime.Debug.DebugTreeAdaptor.GetNilNode ( )

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 Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 114 of file DebugTreeAdaptor.cs.

bool Antlr.Runtime.Debug.DebugTreeAdaptor.IsNil ( object tree )

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

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 121 of file DebugTreeAdaptor.cs.

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

This is for construction and I'm not sure it's completely general for a tree's addChild method to work this way. Make sure you differentiate between your tree's addChild and this parser tree construction addChild if it's not ok to move children to t with a simple assignment.

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 126 of file DebugTreeAdaptor.cs.

object 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 Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 136 of file DebugTreeAdaptor.cs.

object 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 Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 143 of file DebugTreeAdaptor.cs.

void Antlr.Runtime.Debug.DebugTreeAdaptor.AddChild	(	object	t,
		IToken	child
	)

Definition at line 148 of file DebugTreeAdaptor.cs.

object Antlr.Runtime.Debug.DebugTreeAdaptor.BecomeRoot	(	IToken	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.

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 154 of file DebugTreeAdaptor.cs.

object Antlr.Runtime.Debug.DebugTreeAdaptor.Create	(	int	tokenType,
		IToken	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 Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 162 of file DebugTreeAdaptor.cs.

object Antlr.Runtime.Debug.DebugTreeAdaptor.Create	(	int	tokenType,
		IToken	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 Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 169 of file DebugTreeAdaptor.cs.

object 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 Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 176 of file DebugTreeAdaptor.cs.

int Antlr.Runtime.Debug.DebugTreeAdaptor.GetNodeType ( object t )

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

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 183 of file DebugTreeAdaptor.cs.

void Antlr.Runtime.Debug.DebugTreeAdaptor.SetNodeType	(	object	t,
		int	type
	)

Node constructors can set the type of a node.

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 188 of file DebugTreeAdaptor.cs.

string Antlr.Runtime.Debug.DebugTreeAdaptor.GetNodeText ( object t )

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 193 of file DebugTreeAdaptor.cs.

void Antlr.Runtime.Debug.DebugTreeAdaptor.SetNodeText	(	object	t,
		string	text
	)

Node constructors can set the text of a node.

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 198 of file DebugTreeAdaptor.cs.

IToken Antlr.Runtime.Debug.DebugTreeAdaptor.GetToken ( object treeNode )

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. BaseRecognizer.GetErrorMessage

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 203 of file DebugTreeAdaptor.cs.

void Antlr.Runtime.Debug.DebugTreeAdaptor.SetTokenBoundaries	(	object	t,
		IToken	startToken,
		IToken	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 Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 208 of file DebugTreeAdaptor.cs.

int Antlr.Runtime.Debug.DebugTreeAdaptor.GetTokenStartIndex ( object t )

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

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 219 of file DebugTreeAdaptor.cs.

int Antlr.Runtime.Debug.DebugTreeAdaptor.GetTokenStopIndex ( object t )

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

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 224 of file DebugTreeAdaptor.cs.

object Antlr.Runtime.Debug.DebugTreeAdaptor.GetChild	(	object	t,
		int	i
	)

Get a child 0..n-1 node.

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 229 of file DebugTreeAdaptor.cs.

void 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 Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 234 of file DebugTreeAdaptor.cs.

object Antlr.Runtime.Debug.DebugTreeAdaptor.DeleteChild	(	object	t,
		int	i
	)

Remove ith child and shift children down from right.

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 239 of file DebugTreeAdaptor.cs.

int Antlr.Runtime.Debug.DebugTreeAdaptor.GetChildCount ( object t )

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

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 244 of file DebugTreeAdaptor.cs.

int 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. Ok, we could:

Number the nodes as they are created?
Use the original framework assigned hashcode that's unique across instances of a given type. WARNING: This is usually implemented either as IL to make a non-virt call to object.GetHashCode() or by via a call to System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode(). Both have issues especially on .NET 1.x and Mono.

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 249 of file DebugTreeAdaptor.cs.

object 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 Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 254 of file DebugTreeAdaptor.cs.

int 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 Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 259 of file DebugTreeAdaptor.cs.

void Antlr.Runtime.Debug.DebugTreeAdaptor.SetParent	(	object	t,
		object	parent
	)

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 264 of file DebugTreeAdaptor.cs.

void Antlr.Runtime.Debug.DebugTreeAdaptor.SetChildIndex	(	object	t,
		int	index
	)

Implements Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 269 of file DebugTreeAdaptor.cs.

void 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 Antlr.Runtime.Tree.ITreeAdaptor.

Definition at line 274 of file DebugTreeAdaptor.cs.

Member Data Documentation

IDebugEventListener Antlr.Runtime.Debug.DebugTreeAdaptor.dbg [protected]

Definition at line 56 of file DebugTreeAdaptor.cs.

ITreeAdaptor Antlr.Runtime.Debug.DebugTreeAdaptor.adaptor [protected]

Definition at line 57 of file DebugTreeAdaptor.cs.

Property Documentation

IDebugEventListener Antlr.Runtime.Debug.DebugTreeAdaptor.DebugListener [get, set]

Definition at line 282 of file DebugTreeAdaptor.cs.

ITreeAdaptor Antlr.Runtime.Debug.DebugTreeAdaptor.TreeAdaptor [get]

Definition at line 288 of file DebugTreeAdaptor.cs.

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

/Users/parrt/antlr/code/antlr/main/runtime/CSharp/Sources/Antlr3.Runtime/Antlr.Runtime.Debug/DebugTreeAdaptor.cs


Public Member Functions
	DebugTreeAdaptor (IDebugEventListener dbg, ITreeAdaptor adaptor)
object	Create (IToken payload)
	Create a tree node from Token object; for CommonTree type trees, then the token just becomes the payload.
Object	ErrorNode (ITokenStream input, IToken start, IToken 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.
object	DupTree (object tree)
	Duplicate tree recursively, using DupNode() for each node.
object	DupNode (object treeNode)
	Duplicate a single tree node.
object	GetNilNode ()
	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);".
bool	IsNil (object tree)
	Is tree considered a nil node used to make lists of child nodes?
void	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.
object	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.
object	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.
void	AddChild (object t, IToken child)
object	BecomeRoot (IToken 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.
object	Create (int tokenType, IToken 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].
object	Create (int tokenType, IToken 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"].
object	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"].
int	GetNodeType (object t)
	For tree parsing, I need to know the token type of a node.
void	SetNodeType (object t, int type)
	Node constructors can set the type of a node.
string	GetNodeText (object t)
void	SetNodeText (object t, string text)
	Node constructors can set the text of a node.
IToken	GetToken (object treeNode)
	Return the token object from which this node was created.
void	SetTokenBoundaries (object t, IToken startToken, IToken stopToken)
	Where are the bounds in the input token stream for this node and all children?
int	GetTokenStartIndex (object t)
	Get the token start index for this subtree; return -1 if no such index.
int	GetTokenStopIndex (object t)
	Get the token stop index for this subtree; return -1 if no such index.
object	GetChild (object t, int i)
	Get a child 0..n-1 node.
void	SetChild (object t, int i, object child)
	Set ith child (0..n-1) to t; t must be non-null and non-nil node.
object	DeleteChild (object t, int i)
	Remove ith child and shift children down from right.
int	GetChildCount (object t)
	How many children? If 0, then this is a leaf node.
int	GetUniqueID (object node)
	For identifying trees. How to identify nodes so we can say "add node to a prior node"?
object	GetParent (object t)
	Who is the parent node of this node; if null, implies node is root.
int	GetChildIndex (object t)
	What index is this node in the child list? Range: 0..n-1.
void	SetParent (object t, object parent)
void	SetChildIndex (object t, int index)
void	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.
Protected Member Functions
void	SimulateTreeConstruction (Object t)
Protected Attributes
IDebugEventListener	dbg
ITreeAdaptor	adaptor
Properties
IDebugEventListener	DebugListener `[get, set]`
ITreeAdaptor	TreeAdaptor `[get]`