Package org.antlr.runtime.tree
Class CommonTreeNodeStream
- All Implemented Interfaces:
IntStream
,TreeNodeStream
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) TreeAdaptor
What tree adaptor was used to build these treesprotected IntArray
Stack of indexes used for push/pop callsstatic final int
protected boolean
Tree (nil A B C) trees like flat A B C streamsstatic final int
protected TreeIterator
The tree iterator we usingprotected int
Tracks tree depth.protected Object
Pull nodes from which tree?protected TokenStream
If this tree (root) was created from a token stream, track it.Fields inherited from class org.antlr.runtime.misc.LookaheadStream
eof, eofElementIndex, lastMarker, markDepth, UNINITIALIZED_EOF_ELEMENT_INDEX
-
Constructor Summary
ConstructorsConstructorDescriptionCommonTreeNodeStream
(Object tree) CommonTreeNodeStream
(TreeAdaptor adaptor, Object tree) -
Method Summary
Modifier and TypeMethodDescriptionWhere are you getting symbols from? Normally, implementations will pass the buck all the way to the lexer who can ask its input stream for the file name or whatever.If the tree associated with this stream was created from a TokenStream, you can specify it here.What adaptor can tell me how to interpret/navigate nodes and trees.Where is this stream pulling nodes from? This is not the name, but the object that provides node objects.int
LA
(int i) Get int at current input pointer + i ahead where i=1 is next int.Pull elements from tree iterator.int
pop()
Seek back to previous index saved during last push() call.void
push
(int index) Make stream jump to a new location, saving old location.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.void
reset()
Reset the tree node stream in such a way that it acts like a freshly constructed stream.void
setTokenStream
(TokenStream tokens) void
setTreeAdaptor
(TreeAdaptor adaptor) void
setUniqueNavigationNodes
(boolean uniqueNavigationNodes) As we flatten the tree, we use UP, DOWN nodes to represent the tree structure.Return the text of all nodes from start to stop, inclusive.For debugging; destructive: moves tree iterator to end.Methods inherited from class org.antlr.runtime.misc.LookaheadStream
consume, fill, getCurrentSymbol, index, LB, LT, mark, release, remove, rewind, rewind, seek, size, sync
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.antlr.runtime.IntStream
consume, index, mark, release, rewind, rewind, seek, size
Methods inherited from interface org.antlr.runtime.tree.TreeNodeStream
get, LT
-
Field Details
-
DEFAULT_INITIAL_BUFFER_SIZE
public static final int DEFAULT_INITIAL_BUFFER_SIZE- See Also:
-
INITIAL_CALL_STACK_SIZE
public static final int INITIAL_CALL_STACK_SIZE- See Also:
-
root
Pull nodes from which tree? -
tokens
If this tree (root) was created from a token stream, track it. -
adaptor
TreeAdaptor adaptorWhat tree adaptor was used to build these trees -
it
The tree iterator we using -
calls
Stack of indexes used for push/pop calls -
hasNilRoot
protected boolean hasNilRootTree (nil A B C) trees like flat A B C streams -
level
protected int levelTracks tree depth. Level=0 means we're at root node level.
-
-
Constructor Details
-
CommonTreeNodeStream
-
CommonTreeNodeStream
-
-
Method Details
-
reset
public void reset()Description copied from interface:TreeNodeStream
Reset the tree node stream in such a way that it acts like a freshly constructed stream.- Specified by:
reset
in interfaceTreeNodeStream
- Overrides:
reset
in classLookaheadStream<Object>
-
nextElement
Pull elements from tree iterator. Track tree level 0..max_level. If nil rooted tree, don't give initial nil and DOWN nor final UP.- Specified by:
nextElement
in classLookaheadStream<Object>
-
getTreeSource
Description copied from interface:TreeNodeStream
Where is this stream pulling nodes from? This is not the name, but the object that provides node objects.- Specified by:
getTreeSource
in interfaceTreeNodeStream
-
getSourceName
Description copied from interface:IntStream
Where are you getting symbols from? Normally, implementations will pass the buck all the way to the lexer who can ask its input stream for the file name or whatever.- Specified by:
getSourceName
in interfaceIntStream
-
getTokenStream
Description copied from interface:TreeNodeStream
If the tree associated with this stream was created from a TokenStream, you can specify it here. Used to do rule $text attribute in tree parser. Optional unless you use tree parser rule text attribute or output=template and rewrite=true options.- Specified by:
getTokenStream
in interfaceTreeNodeStream
-
setTokenStream
-
getTreeAdaptor
Description copied from interface:TreeNodeStream
What adaptor can tell me how to interpret/navigate nodes and trees. E.g., get text of a node.- Specified by:
getTreeAdaptor
in interfaceTreeNodeStream
-
setTreeAdaptor
-
LA
public int LA(int i) Description copied from interface:IntStream
Get int at current input pointer + i ahead where i=1 is next int. Negative indexes are allowed. LA(-1) is previous token (token just matched). LA(-i) where i is before first token should yield -1, invalid char / EOF. -
push
public void push(int index) Make stream jump to a new location, saving old location. Switch back with pop(). -
pop
public int pop()Seek back to previous index saved during last push() call. Return top of stack (return index). -
replaceChildren
Description copied from interface:TreeNodeStream
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. The stream is notified because it is walking the tree and might need to know you are monkeying with the underlying tree. Also, it might be able to modify the node stream to avoid restreaming for future phases. 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.- Specified by:
replaceChildren
in interfaceTreeNodeStream
-
toString
Description copied from interface:TreeNodeStream
Return the text of all nodes from start to stop, inclusive. If the stream does not buffer all the nodes then it can still walk recursively from start until stop. You can always return null or "" too, but users should not access $ruleLabel.text in an action of course in that case.- Specified by:
toString
in interfaceTreeNodeStream
-
toTokenTypeString
For debugging; destructive: moves tree iterator to end.
-