Antlr.Runtime.Tree.BaseTree Class Reference

A generic tree implementation with no payload. You must subclass to actually have any user data. ANTLR v3 uses a list of children approach instead of the child-sibling approach in v2. A flat tree (a list) is an empty node whose children represent the list. An empty, but non-null node is called "nil". More...

Inheritance diagram for Antlr.Runtime.Tree.BaseTree:

[legend]

Collaboration diagram for Antlr.Runtime.Tree.BaseTree:

[legend]

List of all members.

Public Member Functions

BaseTree ()

BaseTree (ITree node)

Create a new node from an existing node does nothing for BaseTree as there are no fields other than the children list, which cannot be copied as the children are not considered part of this node.

virtual ITree GetChild (int i)

virtual void AddChild (ITree t)

Add t as child of this node.

void AddChildren (IList kids)

Add all elements of kids list as children of this node.

virtual void SetChild (int i, ITree t)

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

virtual object DeleteChild (int i)

virtual void ReplaceChildren (int startChildIndex, int stopChildIndex, object t)

Delete children from start to stop and replace with t even if t is a list (nil-root tree).

virtual void FreshenParentAndChildIndexes ()

Set the parent and child index values for all child of t.

virtual void FreshenParentAndChildIndexes (int offset)

virtual void SanityCheckParentAndChildIndexes ()

virtual void SanityCheckParentAndChildIndexes (ITree parent, int i)

virtual string ToStringTree ()

Print out a whole tree not just a node.

abstract override string ToString ()

Force base classes override and say how a node (not a tree) should look as text.

abstract ITree DupNode ()

Protected Member Functions

virtual internal IList CreateChildrenList ()

Override in a subclass to change the impl of children list.

Protected Attributes

IList children

Properties

virtual int ChildCount [get]

virtual bool IsNil [get]

Indicates the node is a nil node but may still have children, meaning the tree is a flat list.

virtual int Line [get]

In case we don't have a token payload, what is the line for errors?

virtual int CharPositionInLine [get]

IList Children [get]

Get the children internal list of children. Manipulating the list directly is not a supported operation (i.e. you do so at your own risk).

virtual int ChildIndex [get, set]

BaseTree doesn't track child indexes.

virtual ITree Parent [get, set]

BaseTree doesn't track parent pointers.

abstract int Type [get]

Return a token type; needed for tree parsing.

abstract int TokenStartIndex [get, set]

What is the smallest token index (indexing from 0) for this node and its children?

abstract int TokenStopIndex [get, set]

What is the largest token index (indexing from 0) for this node and its children?

abstract string Text [get]

Detailed Description

A generic tree implementation with no payload. You must subclass to actually have any user data. ANTLR v3 uses a list of children approach instead of the child-sibling approach in v2. A flat tree (a list) is an empty node whose children represent the list. An empty, but non-null node is called "nil".

Definition at line 49 of file BaseTree.cs.

Constructor & Destructor Documentation

Antlr.Runtime.Tree.BaseTree.BaseTree ( )

Definition at line 51 of file BaseTree.cs.

Antlr.Runtime.Tree.BaseTree.BaseTree ( ITree node )

Create a new node from an existing node does nothing for BaseTree as there are no fields other than the children list, which cannot be copied as the children are not considered part of this node.

Definition at line 59 of file BaseTree.cs.

Member Function Documentation

virtual ITree Antlr.Runtime.Tree.BaseTree.GetChild ( int i ) [virtual]


Public Member Functions
	BaseTree ()
	BaseTree (ITree node)
	Create a new node from an existing node does nothing for BaseTree as there are no fields other than the children list, which cannot be copied as the children are not considered part of this node.
virtual ITree	GetChild (int i)
virtual void	AddChild (ITree t)
	Add t as child of this node.
void	AddChildren (IList kids)
	Add all elements of kids list as children of this node.
virtual void	SetChild (int i, ITree t)
	Set ith child (0..n-1) to t; t must be non-null and non-nil node.
virtual object	DeleteChild (int i)
virtual void	ReplaceChildren (int startChildIndex, int stopChildIndex, object t)
	Delete children from start to stop and replace with t even if t is a list (nil-root tree).
virtual void	FreshenParentAndChildIndexes ()
	Set the parent and child index values for all child of t.
virtual void	FreshenParentAndChildIndexes (int offset)
virtual void	SanityCheckParentAndChildIndexes ()
virtual void	SanityCheckParentAndChildIndexes (ITree parent, int i)
virtual string	ToStringTree ()
	Print out a whole tree not just a node.
abstract override string	ToString ()
	Force base classes override and say how a node (not a tree) should look as text.
abstract ITree	DupNode ()
Protected Member Functions
virtual internal IList	CreateChildrenList ()
	Override in a subclass to change the impl of children list.
Protected Attributes
IList	children
Properties
virtual int	ChildCount `[get]`
virtual bool	IsNil `[get]`
	Indicates the node is a nil node but may still have children, meaning the tree is a flat list.
virtual int	Line `[get]`
	In case we don't have a token payload, what is the line for errors?
virtual int	CharPositionInLine `[get]`
IList	Children `[get]`
	Get the children internal list of children. Manipulating the list directly is not a supported operation (i.e. you do so at your own risk).
virtual int	ChildIndex `[get, set]`
	BaseTree doesn't track child indexes.
virtual ITree	Parent `[get, set]`
	BaseTree doesn't track parent pointers.
abstract int	Type `[get]`
	Return a token type; needed for tree parsing.
abstract int	TokenStartIndex `[get, set]`
	What is the smallest token index (indexing from 0) for this node and its children?
abstract int	TokenStopIndex `[get, set]`
	What is the largest token index (indexing from 0) for this node and its children?
abstract string	Text `[get]`

virtual void Antlr.Runtime.Tree.BaseTree.SetChild	(	int	i,
		ITree	t
	)			`[virtual]`

virtual void Antlr.Runtime.Tree.BaseTree.ReplaceChildren	(	int	startChildIndex,
		int	stopChildIndex,
		object	t
	)			`[virtual]`

virtual void Antlr.Runtime.Tree.BaseTree.SanityCheckParentAndChildIndexes	(	ITree	parent,
		int	i
	)			`[virtual]`

Antlr.Runtime.Tree.BaseTree Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation