ANTLR 3 Runtime 3.5.3 · org.antlr.runtime.tree.CommonTreeNodeStream

Modifier and Type	Field and Description
pack-priv TreeAdaptor	adaptor What `TreeAdaptor` was used to build these trees
protected IntArray	calls Stack of indexes used for push/pop calls.
public static final int	DEFAULT_INITIAL_BUFFER_SIZE
protected boolean	hasNilRoot Tree `(nil A B C)` trees like flat `A B C` streams
public static final int	INITIAL_CALL_STACK_SIZE
protected TreeIterator	it The `TreeIterator` we using.
protected int	level Tracks tree depth.
protected Object	previousLocationElement Tracks the last node before the start of `data` which contains position information to provide information for error reporting.
protected Object	root Pull nodes from which tree?
protected TokenStream	tokens If this tree (root) was created from a `TokenStream`, track it.

Access	Constructor and Description
public	CommonTreeNodeStream(Object tree)
public	CommonTreeNodeStream(TreeAdaptor adaptor, Object tree)

Method Summary

Modifier and Type	Method and Description
public Object	get(int i) Implements org.antlr.runtime.tree.TreeNodeStream.get. Get a tree node at an absolute index `i`; 0..n-1.
public Object	getKnownPositionElement(boolean if `false`, this method returns `null` if an element containing exact information about the current position is not available allowApproximateLocation) Implements org.antlr.runtime.tree.PositionTrackingStream.getKnownPositionElement. Returns an element containing position information.
public String	getSourceName() Implements org.antlr.runtime.IntStream.getSourceName. Where are you getting symbols from?
public TokenStream	getTokenStream() Implements org.antlr.runtime.tree.TreeNodeStream.getTokenStream. If the tree associated with this stream was created from a `TokenStream`, you can specify it here.
public TreeAdaptor	getTreeAdaptor() Implements org.antlr.runtime.tree.TreeNodeStream.getTreeAdaptor. What adaptor can tell me how to interpret/navigate nodes and trees.
public Object	getTreeSource() Implements org.antlr.runtime.tree.TreeNodeStream.getTreeSource. Where is this stream pulling nodes from?
public boolean	hasPositionInformation(Object the element to check node) Implements org.antlr.runtime.tree.PositionTrackingStream.hasPositionInformation. Determines if the specified `element` contains concrete position information.
public boolean	isEOF(Object o) Implements abstract org.antlr.runtime.misc.LookaheadStream.isEOF.
public int	LA(int i) Implements org.antlr.runtime.IntStream.LA. Get int at current input pointer + i ahead where i=1 is next int.
public Object	nextElement() Implements abstract org.antlr.runtime.misc.LookaheadStream.nextElement. Pull elements from tree iterator.
public int	pop() Seek back to previous index saved during last `push` call.
public void	push(int index) Make stream jump to a new location, saving old location.
public Object	remove() Overrides org.antlr.runtime.misc.LookaheadStream.remove. Get and remove first element in queue; override `FastQueue#remove()`; it's the same, just checks for backtracking.
public void	replaceChildren(Object parent, int startChildIndex, int stopChildIndex, Object t) Implements org.antlr.runtime.tree.TreeNodeStream.replaceChildren. Replace children of `parent` from index `startChildIndex` to `stopChildIndex` with `t`, which might be a list.
public void	reset() Overrides org.antlr.runtime.misc.LookaheadStream.reset. Implements org.antlr.runtime.tree.TreeNodeStream.reset. Reset the tree node stream in such a way that it acts like a freshly constructed stream.
public void	setTokenStream(TokenStream tokens)
public void	setTreeAdaptor(TreeAdaptor adaptor)
public void	setUniqueNavigationNodes(boolean uniqueNavigationNodes) Implements org.antlr.runtime.tree.TreeNodeStream.setUniqueNavigationNodes. As we flatten the tree, we use `Token#UP`, `Token#DOWN` nodes to represent the tree structure.
public String	toString(Object start, Object stop) Implements org.antlr.runtime.tree.TreeNodeStream.toString. Return the text of all nodes from `start` to `stop`, inclusive.
public String	toTokenTypeString() For debugging; destructive: moves tree iterator to end.

Inherited from org.antlr.runtime.misc.LookaheadStream:: consume fill index LB LT mark release rewind rewind seek size syncAhead

adaptor	back to summary
pack-priv TreeAdaptor adaptor What `TreeAdaptor` was used to build these trees

calls	back to summary
protected IntArray calls Stack of indexes used for push/pop calls.

DEFAULT_INITIAL_BUFFER_SIZE	back to summary
public static final int DEFAULT_INITIAL_BUFFER_SIZE

hasNilRoot	back to summary
protected boolean hasNilRoot Tree `(nil A B C)` trees like flat `A B C` streams

INITIAL_CALL_STACK_SIZE	back to summary
public static final int INITIAL_CALL_STACK_SIZE

it	back to summary
protected TreeIterator it The `TreeIterator` we using.

level	back to summary
protected int level Tracks tree depth. Level=0 means we're at root node level.

previousLocationElement	back to summary
protected Object previousLocationElement Tracks the last node before the start of `data` which contains position information to provide information for error reporting. This is tracked in addition to `prevElement` which may or may not contain position information. See Also `hasPositionInformation`, `RecognitionException#extractInformationFromTreeNodeStream`

root	back to summary
protected Object root Pull nodes from which tree?

tokens	back to summary
protected TokenStream tokens If this tree (root) was created from a `TokenStream`, track it.

CommonTreeNodeStream	back to summary
public CommonTreeNodeStream(Object tree)

CommonTreeNodeStream	back to summary
public CommonTreeNodeStream(TreeAdaptor adaptor, Object tree)

Method Detail

get back to summary

get	back to summary
public Object get(int i) Implements org.antlr.runtime.tree.TreeNodeStream.get. Doc from org.antlr.runtime.tree.TreeNodeStream.get. Get a tree node at an absolute index `i`; 0..n-1. If you don't want to buffer up nodes, then this method makes no sense for you. Annotations @Override

public Object get(int i)

Implements org.antlr.runtime.tree.TreeNodeStream.get.

Doc from org.antlr.runtime.tree.TreeNodeStream.get.

Get a tree node at an absolute index i; 0..n-1. If you don't want to buffer up nodes, then this method makes no sense for you.

Annotations

@Override

getKnownPositionElement back to summary

getKnownPositionElement	back to summary
public Object getKnownPositionElement(boolean allowApproximateLocation) Implements org.antlr.runtime.tree.PositionTrackingStream.getKnownPositionElement. Returns an element containing position information. If `allowApproximateLocation` is `false`, then this method will return the `LT(1)` element if it contains position information, and otherwise return `null`. If `allowApproximateLocation` is `true`, then this method will return the last known element containing position information. Parameters allowApproximateLocation:boolean Doc from org.antlr.runtime.tree.PositionTrackingStream.getKnownPositionElement. if `false`, this method returns `null` if an element containing exact information about the current position is not available Annotations @Override See Also `hasPositionInformation`

public Object getKnownPositionElement(boolean allowApproximateLocation)

Implements org.antlr.runtime.tree.PositionTrackingStream.getKnownPositionElement.

Returns an element containing position information. If allowApproximateLocation is false, then this method will return the LT(1) element if it contains position information, and otherwise return null. If allowApproximateLocation is true, then this method will return the last known element containing position information.

Parameters

allowApproximateLocation:boolean

Doc from org.antlr.runtime.tree.PositionTrackingStream.getKnownPositionElement.

if false, this method returns null if an element containing exact information about the current position is not available

Annotations

@Override

See Also

hasPositionInformation

getSourceName	back to summary
public String getSourceName() Implements org.antlr.runtime.IntStream.getSourceName. Doc from org.antlr.runtime.IntStream.getSourceName. 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. Annotations @Override

getSourceName

back to summary

public String getSourceName()

Implements org.antlr.runtime.IntStream.getSourceName.

Doc from org.antlr.runtime.IntStream.getSourceName.

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.

Annotations

@Override

getTokenStream back to summary

getTokenStream	back to summary
public TokenStream getTokenStream() Implements org.antlr.runtime.tree.TreeNodeStream.getTokenStream. Doc from org.antlr.runtime.tree.TreeNodeStream.getTokenStream. 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. Annotations @Override

public TokenStream getTokenStream()

Implements org.antlr.runtime.tree.TreeNodeStream.getTokenStream.

Doc from org.antlr.runtime.tree.TreeNodeStream.getTokenStream.

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.

Annotations

@Override

getTreeAdaptor	back to summary
public TreeAdaptor getTreeAdaptor() Implements org.antlr.runtime.tree.TreeNodeStream.getTreeAdaptor. Doc from org.antlr.runtime.tree.TreeNodeStream.getTreeAdaptor. What adaptor can tell me how to interpret/navigate nodes and trees. E.g., get text of a node. Annotations @Override

getTreeAdaptor

back to summary

public TreeAdaptor getTreeAdaptor()

Implements org.antlr.runtime.tree.TreeNodeStream.getTreeAdaptor.

Doc from org.antlr.runtime.tree.TreeNodeStream.getTreeAdaptor.

What adaptor can tell me how to interpret/navigate nodes and trees. E.g., get text of a node.

Annotations

@Override

getTreeSource	back to summary
public Object getTreeSource() Implements org.antlr.runtime.tree.TreeNodeStream.getTreeSource. Doc from org.antlr.runtime.tree.TreeNodeStream.getTreeSource. Where is this stream pulling nodes from? This is not the name, but the object that provides node objects. Annotations @Override

getTreeSource

back to summary

public Object getTreeSource()

Implements org.antlr.runtime.tree.TreeNodeStream.getTreeSource.

Doc from org.antlr.runtime.tree.TreeNodeStream.getTreeSource.

Where is this stream pulling nodes from? This is not the name, but the object that provides node objects.

Annotations

@Override

hasPositionInformation back to summary

hasPositionInformation	back to summary
public boolean hasPositionInformation(Object node) Implements org.antlr.runtime.tree.PositionTrackingStream.hasPositionInformation. Doc from org.antlr.runtime.tree.PositionTrackingStream.hasPositionInformation. Determines if the specified `element` contains concrete position information. Parameters node:Object the element to check Returns:boolean `true` if `element` contains concrete position information, otherwise `false` Annotations @Override

public boolean hasPositionInformation(Object node)

Implements org.antlr.runtime.tree.PositionTrackingStream.hasPositionInformation.

Doc from org.antlr.runtime.tree.PositionTrackingStream.hasPositionInformation.

Determines if the specified element contains concrete position information.

Parameters

node:Object: the element to check

Returns:boolean

true if element contains concrete position information, otherwise false

Annotations

@Override

isEOF	back to summary
public boolean isEOF(Object o) Implements abstract org.antlr.runtime.misc.LookaheadStream.isEOF. Annotations @Override

isEOF

back to summary

public boolean isEOF(Object o)

Implements abstract org.antlr.runtime.misc.LookaheadStream.isEOF.

Annotations

@Override

LA	back to summary
public int LA(int i) Implements org.antlr.runtime.IntStream.LA. Doc from org.antlr.runtime.IntStream.LA. 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. Annotations @Override

back to summary

public int LA(int i)

Implements org.antlr.runtime.IntStream.LA.

Doc from org.antlr.runtime.IntStream.LA.

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.

Annotations

@Override

nextElement	back to summary
public Object nextElement() Implements abstract org.antlr.runtime.misc.LookaheadStream.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. Annotations @Override

nextElement

back to summary

public Object nextElement()

Implements abstract org.antlr.runtime.misc.LookaheadStream.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.

Annotations

@Override

pop	back to summary
public int pop() Seek back to previous index saved during last `push` call. Return top of stack (return index).

push	back to summary
public void push(int index) Make stream jump to a new location, saving old location. Switch back with pop().

remove back to summary

remove	back to summary
public Object remove() Overrides org.antlr.runtime.misc.LookaheadStream.remove. Doc from org.antlr.runtime.misc.LookaheadStream.remove. Get and remove first element in queue; override `FastQueue#remove()`; it's the same, just checks for backtracking. Annotations @Override

public Object remove()

Overrides org.antlr.runtime.misc.LookaheadStream.remove.

Doc from org.antlr.runtime.misc.LookaheadStream.remove.

Get and remove first element in queue; override FastQueue#remove(); it's the same, just checks for backtracking.

Annotations

@Override

replaceChildren back to summary

replaceChildren	back to summary
public void replaceChildren(Object parent, int startChildIndex, int stopChildIndex, Object t) Implements org.antlr.runtime.tree.TreeNodeStream.replaceChildren. Doc from org.antlr.runtime.tree.TreeNodeStream.replaceChildren. Replace children of `parent` from index `startChildIndex` to `stopChildIndex` 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. Annotations @Override

public void replaceChildren(Object parent, int startChildIndex, int stopChildIndex, Object t)

Implements org.antlr.runtime.tree.TreeNodeStream.replaceChildren.

Doc from org.antlr.runtime.tree.TreeNodeStream.replaceChildren.

Replace children of parent from index startChildIndex to stopChildIndex 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.

Annotations

@Override

reset	back to summary
public void reset() Overrides org.antlr.runtime.misc.LookaheadStream.reset. Implements org.antlr.runtime.tree.TreeNodeStream.reset. Doc from org.antlr.runtime.tree.TreeNodeStream.reset. Reset the tree node stream in such a way that it acts like a freshly constructed stream. Annotations @Override

reset

back to summary

public void reset()

Overrides org.antlr.runtime.misc.LookaheadStream.reset.

Implements org.antlr.runtime.tree.TreeNodeStream.reset.

Doc from org.antlr.runtime.tree.TreeNodeStream.reset.

Reset the tree node stream in such a way that it acts like a freshly constructed stream.

Annotations

@Override

setTokenStream	back to summary
public void setTokenStream(TokenStream tokens)

setTreeAdaptor	back to summary
public void setTreeAdaptor(TreeAdaptor adaptor)

setUniqueNavigationNodes back to summary

public void setUniqueNavigationNodes(boolean uniqueNavigationNodes)

Implements org.antlr.runtime.tree.TreeNodeStream.setUniqueNavigationNodes.

Doc from org.antlr.runtime.tree.TreeNodeStream.setUniqueNavigationNodes.

As we flatten the tree, we use Token#UP, Token#DOWN nodes to represent the tree structure. When debugging we need unique nodes so we have to instantiate new ones. When doing normal tree parsing, it's slow and a waste of memory to create unique navigation nodes. Default should be false.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString(Object start, Object stop) Implements org.antlr.runtime.tree.TreeNodeStream.toString. Doc from org.antlr.runtime.tree.TreeNodeStream.toString. 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. Annotations @Override

public String toString(Object start, Object stop)

Implements org.antlr.runtime.tree.TreeNodeStream.toString.

Doc from org.antlr.runtime.tree.TreeNodeStream.toString.

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.

Annotations

@Override

toTokenTypeString	back to summary
public String toTokenTypeString() For debugging; destructive: moves tree iterator to end.

public Class CommonTreeNodeStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail