org.antlr.runtime.tree.CommonTreeNodeStream Class Reference

Inheritance diagram for org.antlr.runtime.tree.CommonTreeNodeStream:

Collaboration diagram for org.antlr.runtime.tree.CommonTreeNodeStream:

List of all members.

Public Member Functions

CommonTreeNodeStream (Object tree)

CommonTreeNodeStream (TreeAdaptor adaptor, Object tree)

CommonTreeNodeStream (TreeAdaptor adaptor, Object tree, int initialBufferSize)

void fillBuffer (Object t)

Object get (int i)

Object LT (int k)

Object getCurrentSymbol ()

Object getTreeSource ()

String getSourceName ()

TokenStream getTokenStream ()

void setTokenStream (TokenStream tokens)

TreeAdaptor getTreeAdaptor ()

void setTreeAdaptor (TreeAdaptor adaptor)

boolean hasUniqueNavigationNodes ()

void setUniqueNavigationNodes (boolean uniqueNavigationNodes)

void consume ()

int LA (int i)

int mark ()

void release (int marker)

int index ()

void rewind (int marker)

void rewind ()

void seek (int index)

void push (int index)

int pop ()

void reset ()

int size ()

Iterator iterator ()

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

String toString ()

String toTokenString (int start, int stop)

String toString (Object start, Object stop)

Static Public Attributes

static final int DEFAULT_INITIAL_BUFFER_SIZE = 100

static final int INITIAL_CALL_STACK_SIZE = 10

Protected Member Functions

void fillBuffer ()

int getNodeIndex (Object node)

void addNavigationNode (final int ttype)

Object LB (int k)

Protected Attributes

Object down

Object up

Object eof

List nodes

Object root

TokenStream tokens

boolean uniqueNavigationNodes = false

int p = -1

int lastMarker

IntArray calls

Package Attributes

TreeAdaptor adaptor

Classes

class StreamIterator

Detailed Description

A buffered stream of tree nodes. Nodes can be from a tree of ANY kind.

This node stream sucks all nodes out of the tree specified in the constructor during construction and makes pointers into the tree using an array of Object pointers. The stream necessarily includes pointers to DOWN and UP and EOF nodes.

This stream knows how to mark/release for backtracking.

This stream is most suitable for tree interpreters that need to jump around a lot or for tree parsers requiring speed (at cost of memory). There is some duplicated functionality here with UnBufferedTreeNodeStream but just in bookkeeping, not tree walking etc...

See also:: UnBufferedTreeNodeStream

Definition at line 51 of file CommonTreeNodeStream.java.

Constructor & Destructor Documentation

org.antlr.runtime.tree.CommonTreeNodeStream.CommonTreeNodeStream ( Object tree )

Definition at line 116 of file CommonTreeNodeStream.java.

org.antlr.runtime.tree.CommonTreeNodeStream.CommonTreeNodeStream	(	TreeAdaptor	adaptor,
		Object	tree
	)

Definition at line 120 of file CommonTreeNodeStream.java.

org.antlr.runtime.tree.CommonTreeNodeStream.CommonTreeNodeStream	(	TreeAdaptor	adaptor,
		Object	tree,
		int	initialBufferSize
	)

Definition at line 124 of file CommonTreeNodeStream.java.

Member Function Documentation

void org.antlr.runtime.tree.CommonTreeNodeStream.fillBuffer ( ) [protected]

Walk tree with depth-first-search and fill nodes buffer. Don't do DOWN, UP nodes if its a list (t is isNil).

Definition at line 136 of file CommonTreeNodeStream.java.

void org.antlr.runtime.tree.CommonTreeNodeStream.fillBuffer ( Object t )

Definition at line 142 of file CommonTreeNodeStream.java.

int org.antlr.runtime.tree.CommonTreeNodeStream.getNodeIndex ( Object node ) [protected]

What is the stream index for node? 0..n-1 Return -1 if node not found.

Definition at line 166 of file CommonTreeNodeStream.java.

void org.antlr.runtime.tree.CommonTreeNodeStream.addNavigationNode ( final int ttype ) [protected]

As we flatten the tree, we use UP, DOWN nodes to represent the tree structure. When debugging we need unique nodes so instantiate new ones when uniqueNavigationNodes is true.

Definition at line 183 of file CommonTreeNodeStream.java.

Object org.antlr.runtime.tree.CommonTreeNodeStream.get ( int i )

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.

Implements org.antlr.runtime.tree.TreeNodeStream.

Definition at line 204 of file CommonTreeNodeStream.java.

Object org.antlr.runtime.tree.CommonTreeNodeStream.LT ( int k )

Get tree node at current input pointer + i ahead where i=1 is next node. i<0 indicates nodes in the past. So LT(-1) is previous node, but implementations are not required to provide results for k < -1. LT(0) is undefined. For i>=n, return null. Return null for LT(0) and any index that results in an absolute address that is negative.

This is analogus to the LT() method of the TokenStream, but this returns a tree node instead of a token. Makes code gen identical for both parser and tree grammars. :)

Implements org.antlr.runtime.tree.TreeNodeStream.

Definition at line 211 of file CommonTreeNodeStream.java.

Object org.antlr.runtime.tree.CommonTreeNodeStream.getCurrentSymbol ( )

Definition at line 228 of file CommonTreeNodeStream.java.

Object org.antlr.runtime.tree.CommonTreeNodeStream.LB ( int k ) [protected]

Look backwards k nodes

Definition at line 250 of file CommonTreeNodeStream.java.

Object org.antlr.runtime.tree.CommonTreeNodeStream.getTreeSource ( )

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

Implements org.antlr.runtime.tree.TreeNodeStream.

Definition at line 260 of file CommonTreeNodeStream.java.

String org.antlr.runtime.tree.CommonTreeNodeStream.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.

Implements org.antlr.runtime.IntStream.

Definition at line 264 of file CommonTreeNodeStream.java.

TokenStream org.antlr.runtime.tree.CommonTreeNodeStream.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.

Implements org.antlr.runtime.tree.TreeNodeStream.

Definition at line 268 of file CommonTreeNodeStream.java.

void org.antlr.runtime.tree.CommonTreeNodeStream.setTokenStream ( TokenStream tokens )

Definition at line 272 of file CommonTreeNodeStream.java.

TreeAdaptor org.antlr.runtime.tree.CommonTreeNodeStream.getTreeAdaptor ( )

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

Implements org.antlr.runtime.tree.TreeNodeStream.

Definition at line 276 of file CommonTreeNodeStream.java.

void org.antlr.runtime.tree.CommonTreeNodeStream.setTreeAdaptor ( TreeAdaptor adaptor )

Definition at line 280 of file CommonTreeNodeStream.java.

boolean org.antlr.runtime.tree.CommonTreeNodeStream.hasUniqueNavigationNodes ( )

Definition at line 284 of file CommonTreeNodeStream.java.

void org.antlr.runtime.tree.CommonTreeNodeStream.setUniqueNavigationNodes ( boolean uniqueNavigationNodes )

As we flatten the tree, we use UP, 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;

Implements org.antlr.runtime.tree.TreeNodeStream.

Definition at line 288 of file CommonTreeNodeStream.java.

void org.antlr.runtime.tree.CommonTreeNodeStream.consume ( )

Implements org.antlr.runtime.IntStream.

Definition at line 292 of file CommonTreeNodeStream.java.

int org.antlr.runtime.tree.CommonTreeNodeStream.LA ( int i )

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.

Implements org.antlr.runtime.IntStream.

Definition at line 299 of file CommonTreeNodeStream.java.

int org.antlr.runtime.tree.CommonTreeNodeStream.mark ( )

Tell the stream to start buffering if it hasn't already. Return current input position, index(), or some other marker so that when passed to rewind() you get back to the same spot. rewind(mark()) should not affect the input cursor. The Lexer track line/col info as well as input index so its markers are not pure input indexes. Same for tree node streams.

Implements org.antlr.runtime.IntStream.

Definition at line 303 of file CommonTreeNodeStream.java.

void org.antlr.runtime.tree.CommonTreeNodeStream.release ( int marker )

You may want to commit to a backtrack but don't want to force the stream to keep bookkeeping objects around for a marker that is no longer necessary. This will have the same behavior as rewind() except it releases resources without the backward seek. This must throw away resources for all markers back to the marker argument. So if you're nested 5 levels of mark(), and then release(2) you have to release resources for depths 2..5.

Implements org.antlr.runtime.IntStream.

Definition at line 311 of file CommonTreeNodeStream.java.

int org.antlr.runtime.tree.CommonTreeNodeStream.index ( )

Return the current input symbol index 0..n where n indicates the last symbol has been read. The index is the symbol about to be read not the most recently read symbol.

Implements org.antlr.runtime.IntStream.

Definition at line 315 of file CommonTreeNodeStream.java.

void org.antlr.runtime.tree.CommonTreeNodeStream.rewind ( int marker )

Reset the stream so that next call to index would return marker. The marker will usually be index() but it doesn't have to be. It's just a marker to indicate what state the stream was in. This is essentially calling release() and seek(). If there are markers created after this marker argument, this routine must unroll them like a stack. Assume the state the stream was in when this marker was created.

Implements org.antlr.runtime.IntStream.

Definition at line 319 of file CommonTreeNodeStream.java.

void org.antlr.runtime.tree.CommonTreeNodeStream.rewind ( )

Rewind to the input position of the last marker. Used currently only after a cyclic DFA and just before starting a sem/syn predicate to get the input position back to the start of the decision. Do not "pop" the marker off the state. mark(i) and rewind(i) should balance still. It is like invoking rewind(last marker) but it should not "pop" the marker off. It's like seek(last marker's input position).

Implements org.antlr.runtime.IntStream.

Definition at line 323 of file CommonTreeNodeStream.java.

void org.antlr.runtime.tree.CommonTreeNodeStream.seek ( int index )

Set the input cursor to the position indicated by index. This is normally used to seek ahead in the input stream. No buffering is required to do this unless you know your stream will use seek to move backwards such as when backtracking.

This is different from rewind in its multi-directional requirement and in that its argument is strictly an input cursor (index).

For char streams, seeking forward must update the stream state such as line number. For seeking backwards, you will be presumably backtracking using the mark/rewind mechanism that restores state and so this method does not need to update state when seeking backwards.

Currently, this method is only used for efficient backtracking using memoization, but in the future it may be used for incremental parsing.

The index is 0..n-1. A seek to position i means that LA(1) will return the ith symbol. So, seeking to 0 means LA(1) will return the first element in the stream.

Implements org.antlr.runtime.IntStream.

Definition at line 327 of file CommonTreeNodeStream.java.

void org.antlr.runtime.tree.CommonTreeNodeStream.push ( int index )

Make stream jump to a new location, saving old location. Switch back with pop().

Definition at line 337 of file CommonTreeNodeStream.java.

int org.antlr.runtime.tree.CommonTreeNodeStream.pop ( )

Seek back to previous index saved during last push() call. Return top of stack (return index).

Definition at line 348 of file CommonTreeNodeStream.java.

void org.antlr.runtime.tree.CommonTreeNodeStream.reset ( )

Definition at line 354 of file CommonTreeNodeStream.java.

int org.antlr.runtime.tree.CommonTreeNodeStream.size ( )

Only makes sense for streams that buffer everything up probably, but might be useful to display the entire stream or for testing. This value includes a single EOF.

Implements org.antlr.runtime.IntStream.

Definition at line 362 of file CommonTreeNodeStream.java.

Iterator org.antlr.runtime.tree.CommonTreeNodeStream.iterator ( )

Definition at line 369 of file CommonTreeNodeStream.java.

void org.antlr.runtime.tree.CommonTreeNodeStream.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. 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.

Implements org.antlr.runtime.tree.TreeNodeStream.

Definition at line 378 of file CommonTreeNodeStream.java.

String org.antlr.runtime.tree.CommonTreeNodeStream.toString ( )

Used for testing, just return the token type stream

Definition at line 385 of file CommonTreeNodeStream.java.

String org.antlr.runtime.tree.CommonTreeNodeStream.toTokenString	(	int	start,
		int	stop
	)

Debugging

Definition at line 399 of file CommonTreeNodeStream.java.

String org.antlr.runtime.tree.CommonTreeNodeStream.toString	(	Object	start,
		Object	stop
	)

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.

Implements org.antlr.runtime.tree.TreeNodeStream.

Definition at line 412 of file CommonTreeNodeStream.java.

Member Data Documentation

final int org.antlr.runtime.tree.CommonTreeNodeStream.DEFAULT_INITIAL_BUFFER_SIZE = 100 [static]

Definition at line 52 of file CommonTreeNodeStream.java.

final int org.antlr.runtime.tree.CommonTreeNodeStream.INITIAL_CALL_STACK_SIZE = 10 [static]

Definition at line 53 of file CommonTreeNodeStream.java.

Object org.antlr.runtime.tree.CommonTreeNodeStream.down [protected]

Definition at line 78 of file CommonTreeNodeStream.java.

Object org.antlr.runtime.tree.CommonTreeNodeStream.up [protected]

Definition at line 79 of file CommonTreeNodeStream.java.

Object org.antlr.runtime.tree.CommonTreeNodeStream.eof [protected]

Definition at line 80 of file CommonTreeNodeStream.java.

List org.antlr.runtime.tree.CommonTreeNodeStream.nodes [protected]

The complete mapping from stream index to tree node. This buffer includes pointers to DOWN, UP, and EOF nodes. It is built upon ctor invocation. The elements are type Object as we don't what the trees look like.

Load upon first need of the buffer so we can set token types of interest for reverseIndexing. Slows us down a wee bit to do all of the if p==-1 testing everywhere though.

Definition at line 91 of file CommonTreeNodeStream.java.

Object org.antlr.runtime.tree.CommonTreeNodeStream.root [protected]

Pull nodes from which tree?

Definition at line 94 of file CommonTreeNodeStream.java.

TokenStream org.antlr.runtime.tree.CommonTreeNodeStream.tokens [protected]

IF this tree (root) was created from a token stream, track it.

Definition at line 97 of file CommonTreeNodeStream.java.

TreeAdaptor org.antlr.runtime.tree.CommonTreeNodeStream.adaptor [package]

What tree adaptor was used to build these trees

Definition at line 100 of file CommonTreeNodeStream.java.

boolean org.antlr.runtime.tree.CommonTreeNodeStream.uniqueNavigationNodes = false [protected]

Reuse same DOWN, UP navigation nodes unless this is true

Definition at line 103 of file CommonTreeNodeStream.java.

int org.antlr.runtime.tree.CommonTreeNodeStream.p = -1 [protected]

The index into the nodes list of the current node (next node to consume). If -1, nodes array not filled yet.

Definition at line 108 of file CommonTreeNodeStream.java.

int org.antlr.runtime.tree.CommonTreeNodeStream.lastMarker [protected]

Track the last mark() call result value for use in rewind().

Definition at line 111 of file CommonTreeNodeStream.java.

IntArray org.antlr.runtime.tree.CommonTreeNodeStream.calls [protected]

Stack of indexes used for push/pop calls

Definition at line 114 of file CommonTreeNodeStream.java.

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

/Users/parrt/antlr/code/antlr/main/runtime/Java/src/org/antlr/runtime/tree/CommonTreeNodeStream.java


Public Member Functions
	CommonTreeNodeStream (Object tree)
	CommonTreeNodeStream (TreeAdaptor adaptor, Object tree)
	CommonTreeNodeStream (TreeAdaptor adaptor, Object tree, int initialBufferSize)
void	fillBuffer (Object t)
Object	get (int i)
Object	LT (int k)
Object	getCurrentSymbol ()
Object	getTreeSource ()
String	getSourceName ()
TokenStream	getTokenStream ()
void	setTokenStream (TokenStream tokens)
TreeAdaptor	getTreeAdaptor ()
void	setTreeAdaptor (TreeAdaptor adaptor)
boolean	hasUniqueNavigationNodes ()
void	setUniqueNavigationNodes (boolean uniqueNavigationNodes)
void	consume ()
int	LA (int i)
int	mark ()
void	release (int marker)
int	index ()
void	rewind (int marker)
void	rewind ()
void	seek (int index)
void	push (int index)
int	pop ()
void	reset ()
int	size ()
Iterator	iterator ()
void	replaceChildren (Object parent, int startChildIndex, int stopChildIndex, Object t)
String	toString ()
String	toTokenString (int start, int stop)
String	toString (Object start, Object stop)
Static Public Attributes
static final int	DEFAULT_INITIAL_BUFFER_SIZE = 100
static final int	INITIAL_CALL_STACK_SIZE = 10
Protected Member Functions
void	fillBuffer ()
int	getNodeIndex (Object node)
void	addNavigationNode (final int ttype)
Object	LB (int k)
Protected Attributes
Object	down
Object	up
Object	eof
List	nodes
Object	root
TokenStream	tokens
boolean	uniqueNavigationNodes = false
int	p = -1
int	lastMarker
IntArray	calls
Package Attributes
TreeAdaptor	adaptor
Classes
class	StreamIterator