antlr3.tree.Tree Class Reference
Abstract baseclass for tree nodes. More...
Public Member Functions | |
| def | getChild |
| def | getChildCount |
| def | getParent |
| Tree tracks parent and child index now > 3.0. | |
| def | setParent |
| Tree tracks parent and child index now > 3.0. | |
| def | getChildIndex |
| This node is what child index? 0. | |
| def | setChildIndex |
| This node is what child index? 0. | |
| def | freshenParentAndChildIndexes |
| Set the parent and child index values for all children. | |
| def | addChild |
| Add t as a child to this node. | |
| def | setChild |
| Set ith child (0. | |
| def | deleteChild |
| def | replaceChildren |
| Delete children from start to stop and replace with t even if t is a list (nil-root tree). | |
| def | isNil |
| Indicates the node is a nil node but may still have children, meaning the tree is a flat list. | |
| def | getTokenStartIndex |
| What is the smallest token index (indexing from 0) for this node and its children? | |
| def | setTokenStartIndex |
| def | getTokenStopIndex |
| What is the largest token index (indexing from 0) for this node and its children? | |
| def | setTokenStopIndex |
| def | dupNode |
| def | getType |
| Return a token type; needed for tree parsing. | |
| def | getText |
| def | getLine |
| In case we don't have a token payload, what is the line for errors? | |
| def | getCharPositionInLine |
| def | toStringTree |
| def | toString |
Detailed Description
Abstract baseclass for tree nodes.What does a tree look like? ANTLR has a number of support classes such as CommonTreeNodeStream that work on these kinds of trees. You don't have to make your trees implement this interface, but if you do, you'll be able to use more support code.
NOTE: When constructing trees, ANTLR can build any kind of tree; it can even use Token objects as trees if you add a child list to your tokens.
This is a tree node without any payload; just navigation and factory stuff.
Definition at line 114 of file tree.py.
Member Function Documentation
| def antlr3.tree.Tree.getChild | ( | self, | ||
| i | ||||
| ) |
| def antlr3.tree.Tree.getChildCount | ( | self | ) |
| def antlr3.tree.Tree.getParent | ( | self | ) |
Tree tracks parent and child index now > 3.0.
Reimplemented in antlr3.tree.BaseTree, and antlr3.tree.CommonTree.
| def antlr3.tree.Tree.setParent | ( | self, | ||
| t | ||||
| ) |
Tree tracks parent and child index now > 3.0.
Reimplemented in antlr3.tree.BaseTree, and antlr3.tree.CommonTree.
| def antlr3.tree.Tree.getChildIndex | ( | self | ) |
This node is what child index? 0.
.n-1
Reimplemented in antlr3.tree.BaseTree, and antlr3.tree.CommonTree.
| def antlr3.tree.Tree.setChildIndex | ( | self, | ||
| index | ||||
| ) |
This node is what child index? 0.
.n-1
Reimplemented in antlr3.tree.BaseTree, and antlr3.tree.CommonTree.
| def antlr3.tree.Tree.freshenParentAndChildIndexes | ( | self | ) |
| def antlr3.tree.Tree.addChild | ( | self, | ||
| t | ||||
| ) |
Add t as a child to this node.
If t is null, do nothing. If t is nil, add all children of t to this' children.
Reimplemented in antlr3.tree.BaseTree.
| def antlr3.tree.Tree.setChild | ( | self, | ||
| i, | ||||
| t | ||||
| ) |
Set ith child (0.
.n-1) to t; t must be non-null and non-nil node
Reimplemented in antlr3.tree.BaseTree.
| def antlr3.tree.Tree.deleteChild | ( | self, | ||
| i | ||||
| ) |
| def antlr3.tree.Tree.replaceChildren | ( | self, | ||
| startChildIndex, | ||||
| stopChildIndex, | ||||
| t | ||||
| ) |
Delete children from start to stop and replace with t even if t is a list (nil-root tree).
num of children can increase or decrease. For huge child lists, inserting children can force walking rest of children to set their childindex; could be slow.
Reimplemented in antlr3.tree.BaseTree.
| def antlr3.tree.Tree.isNil | ( | self | ) |
Indicates the node is a nil node but may still have children, meaning the tree is a flat list.
Reimplemented in antlr3.tree.BaseTree, antlr3.tree.CommonTree, and antlr3.tree.CommonErrorNode.
| def antlr3.tree.Tree.getTokenStartIndex | ( | self | ) |
What is the smallest token index (indexing from 0) for this node and its children?
Reimplemented in antlr3.tree.CommonTree.
| def antlr3.tree.Tree.setTokenStartIndex | ( | self, | ||
| index | ||||
| ) |
| def antlr3.tree.Tree.getTokenStopIndex | ( | self | ) |
What is the largest token index (indexing from 0) for this node and its children?
Reimplemented in antlr3.tree.CommonTree.
| def antlr3.tree.Tree.setTokenStopIndex | ( | self, | ||
| index | ||||
| ) |
| def antlr3.tree.Tree.dupNode | ( | self | ) |
| def antlr3.tree.Tree.getType | ( | self | ) |
Return a token type; needed for tree parsing.
Reimplemented in antlr3.tree.CommonTree, and antlr3.tree.CommonErrorNode.
| def antlr3.tree.Tree.getText | ( | self | ) |
Reimplemented in antlr3.tree.CommonTree, and antlr3.tree.CommonErrorNode.
| def antlr3.tree.Tree.getLine | ( | self | ) |
In case we don't have a token payload, what is the line for errors?
Reimplemented in antlr3.tree.BaseTree, and antlr3.tree.CommonTree.
| def antlr3.tree.Tree.getCharPositionInLine | ( | self | ) |
Reimplemented in antlr3.tree.BaseTree, and antlr3.tree.CommonTree.
| def antlr3.tree.Tree.toStringTree | ( | self | ) |
Reimplemented in antlr3.tree.BaseTree, and antlr3.tree.CommonTree.
| def antlr3.tree.Tree.toString | ( | self | ) |
Reimplemented in antlr3.tree.BaseTree, antlr3.tree.CommonTree, antlr3.tree.CommonErrorNode, and antlr3.treewizard.TreePattern.
The documentation for this class was generated from the following file:
- antlr3/tree.py
