Implements org.antlr.runtime.IntStream.consume.

Annotations

@Override

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

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

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

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

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

Implements org.antlr.runtime.IntStream.index.

Doc from org.antlr.runtime.IntStream.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.

Annotations

@Override

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

Implements org.antlr.runtime.tree.TreeNodeStream.LT.

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

Get tree node at current input pointer + k ahead where k==1 is next node. k<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 k<=n, return null. Return null for LT(0) and any index that results in an absolute address that is negative.

This is analogous to TokenStream#LT, but this returns a tree node instead of a Token. Makes code generation identical for both parser and tree grammars.

Annotations

@Override

Implements org.antlr.runtime.IntStream.mark.

Doc from org.antlr.runtime.IntStream.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.

Annotations

@Override

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

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

Implements org.antlr.runtime.IntStream.release.

Doc from org.antlr.runtime.IntStream.release.

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.

Annotations

@Override

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

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

Implements org.antlr.runtime.IntStream.rewind.

Doc from org.antlr.runtime.IntStream.rewind.

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.

Annotations

@Override

Implements org.antlr.runtime.IntStream.rewind.

Doc from org.antlr.runtime.IntStream.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).

Annotations

@Override

Implements org.antlr.runtime.IntStream.seek.

Doc from org.antlr.runtime.IntStream.seek.

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.

Annotations

@Override

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

Implements org.antlr.runtime.IntStream.size.

Doc from org.antlr.runtime.IntStream.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.

Annotations

@Override

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

Debugging

Used for testing, just return the token type stream