rve_interface_gen.antlr3.tree.CommonTree Class Reference

Inheritance diagram for rve_interface_gen.antlr3.tree.CommonTree:

List of all members.

Public Member Functions
def	__init__
def	dupNode
def	getCharPositionInLine
def	getChildIndex
def	getLine
def	getParent
def	getText
def	getToken
def	getTokenStartIndex
def	getTokenStopIndex
def	getType
def	isNil
def	setChildIndex
def	setParent
def	setTokenStartIndex
def	setTokenStopIndex
def	setUnknownTokenBoundaries
def	toString
def	toStringTree
Public Attributes
	childIndex
	parent
	startIndex
	stopIndex
	token
Properties
	charPositionInLine = property(getCharPositionInLine)
	line = property(getLine)
	text = property(getText)
	tokenStartIndex = property(getTokenStartIndex, setTokenStartIndex)
	tokenStopIndex = property(getTokenStopIndex, setTokenStopIndex)
	type = property(getType)
Static Private Attributes
	__str__ = toString

---

Detailed Description

@brief A tree node that is wrapper for a Token object.

After 3.0 release
while building tree rewrite stuff, it became clear that computing
parent and child index is very difficult and cumbersome.  Better to
spend the space in every tree node.  If you don't want these extra
fields, it's easy to cut them out in your own BaseTree subclass.

Definition at line 1196 of file tree.py.

---

Constructor & Destructor Documentation

def rve_interface_gen.antlr3.tree.CommonTree.__init__	(		self,
			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. 

Reimplemented from rve_interface_gen.antlr3.tree.BaseTree.

Definition at line 1207 of file tree.py.

---

Member Function Documentation

def rve_interface_gen.antlr3.tree.CommonTree.dupNode

(

self

)

Reimplemented from rve_interface_gen.antlr3.tree.Tree.

Definition at line 1242 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.getCharPositionInLine

(

self

)

Reimplemented from rve_interface_gen.antlr3.tree.BaseTree.

Definition at line 1280 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.getChildIndex

(

self

)

BaseTree doesn't track child indexes.

Reimplemented from rve_interface_gen.antlr3.tree.BaseTree.

Definition at line 1343 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.getLine

(

self

)

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

Reimplemented from rve_interface_gen.antlr3.tree.BaseTree.

Definition at line 1268 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.getParent

(

self

)

BaseTree doesn't track parent pointers.

Reimplemented from rve_interface_gen.antlr3.tree.BaseTree.

Definition at line 1353 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.getText

(

self

)

Reimplemented from rve_interface_gen.antlr3.tree.Tree.

Reimplemented in rve_interface_gen.antlr3.tree.CommonErrorNode.

Definition at line 1259 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.getToken

(

self

)

Definition at line 1238 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.getTokenStartIndex

(

self

)

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

Reimplemented from rve_interface_gen.antlr3.tree.Tree.

Definition at line 1293 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.getTokenStopIndex

(

self

)

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

Reimplemented from rve_interface_gen.antlr3.tree.Tree.

Definition at line 1305 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.getType

(

self

)

Return a token type; needed for tree parsing.

Reimplemented from rve_interface_gen.antlr3.tree.Tree.

Reimplemented in rve_interface_gen.antlr3.tree.CommonErrorNode.

Definition at line 1250 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.isNil

(

self

)

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

Reimplemented from rve_interface_gen.antlr3.tree.BaseTree.

Reimplemented in rve_interface_gen.antlr3.tree.CommonErrorNode.

Definition at line 1246 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.setChildIndex	(		self,
			index
	)

BaseTree doesn't track child indexes.

Reimplemented from rve_interface_gen.antlr3.tree.BaseTree.

Definition at line 1348 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.setParent	(		self,
			t
	)

BaseTree doesn't track parent pointers.

Reimplemented from rve_interface_gen.antlr3.tree.BaseTree.

Definition at line 1358 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.setTokenStartIndex	(		self,
			index
	)

Reimplemented from rve_interface_gen.antlr3.tree.Tree.

Definition at line 1299 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.setTokenStopIndex	(		self,
			index
	)

Reimplemented from rve_interface_gen.antlr3.tree.Tree.

Definition at line 1311 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.setUnknownTokenBoundaries

(

self

)

For every node in this subtree, make sure it's start/stop token's
are set.  Walk depth first, visit bottom up.  Only updates nodes
with at least one token index < 0.

Definition at line 1317 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.toString

(

self

)

Override to say how a node (not a tree) should look as text

Reimplemented from rve_interface_gen.antlr3.tree.BaseTree.

Reimplemented in rve_interface_gen.antlr3.tree.CommonErrorNode.

Definition at line 1363 of file tree.py.

def rve_interface_gen.antlr3.tree.CommonTree.toStringTree

(

self

)

Print out a whole tree not just a node

Reimplemented from rve_interface_gen.antlr3.tree.BaseTree.

Definition at line 1376 of file tree.py.

---

Member Data Documentation

rve_interface_gen::antlr3::tree.CommonTree::__str__ = toString [static, private]

Definition at line 1372 of file tree.py.

rve_interface_gen::antlr3::tree.CommonTree::childIndex

Reimplemented from rve_interface_gen.antlr3.tree.BaseTree.

Definition at line 1207 of file tree.py.

rve_interface_gen::antlr3::tree.CommonTree::parent

Reimplemented from rve_interface_gen.antlr3.tree.BaseTree.

Definition at line 1207 of file tree.py.

rve_interface_gen::antlr3::tree.CommonTree::startIndex

Definition at line 1207 of file tree.py.

rve_interface_gen::antlr3::tree.CommonTree::stopIndex

Definition at line 1207 of file tree.py.

rve_interface_gen::antlr3::tree.CommonTree::token

Definition at line 1207 of file tree.py.

---

Property Documentation

rve_interface_gen::antlr3::tree.CommonTree::charPositionInLine = property(getCharPositionInLine) [static]

Definition at line 1290 of file tree.py.

rve_interface_gen::antlr3::tree.CommonTree::line = property(getLine) [static]

Definition at line 1277 of file tree.py.

rve_interface_gen::antlr3::tree.CommonTree::text = property(getText) [static]

Definition at line 1265 of file tree.py.

rve_interface_gen::antlr3::tree.CommonTree::tokenStartIndex = property(getTokenStartIndex, setTokenStartIndex) [static]

Definition at line 1302 of file tree.py.

rve_interface_gen::antlr3::tree.CommonTree::tokenStopIndex = property(getTokenStopIndex, setTokenStopIndex) [static]

Definition at line 1314 of file tree.py.

rve_interface_gen::antlr3::tree.CommonTree::type = property(getType) [static]

Definition at line 1256 of file tree.py.

---

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

• tree.py