| API Documentation | All Packages | All Classes | Index | Frames | |
| Interface TokenStream | Properties | Methods | |
| Package | org.antlr.runtime |
| Interface | public interface TokenStream extends IntStream |
| Implementors | CommonTokenStream |
| Property | Defined by | ||
|---|---|---|---|
 | index : int Return the current input symbol index 0..n where n indicates the
last symbol has been read.
| IntStream | |
| size : int Only makes sense for streams that buffer everything up probably, but
might be useful to display the entire stream or for testing.
| IntStream | |
| sourceName : String 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.
| IntStream | |
| tokenSource : TokenSource
[read-only] Where is this stream pulling tokens from? This is not the name, but
the object that provides Token objects.
| TokenStream | ||
| Method | Defined by | ||
|---|---|---|---|
|
consume():void
| IntStream | |
|
Get a token at an absolute index i; 0..n-1.
| TokenStream | ||
|
LA(i:int):int
Get int at current input pointer + i ahead where i=1 is next int.
| IntStream | |
|
Get Token at current input pointer + i ahead where i=1 is next Token.
| TokenStream | ||
|
mark():int
Tell the stream to start buffering if it hasn't already.
| IntStream | |
|
release(marker:int):void
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.
| IntStream | |
|
rewind():void
Rewind to the input position of the last marker.
| IntStream | |
|
rewindTo(marker:int):void
Reset the stream so that next call to index would return marker.
| IntStream | |
|
seek(index:int):void
Set the input cursor to the position indicated by index.
| IntStream | |
|
toStringWithRange(start:int, stop:int):String
Return the text of all tokens from start to stop, inclusive.
| TokenStream | ||
|
Because the user is not required to use a token with an index stored
in it, we must provide a means for two token objects themselves to
indicate the start/end location.
| TokenStream | ||
| tokenSource | property |
Hide Inherited Public Properties
Show Inherited Public PropertiestokenSource:TokenSource [read-only]Where is this stream pulling tokens from? This is not the name, but the object that provides Token objects.
Implementation public function get tokenSource():TokenSource
| getToken | () | method |
public function getToken(i:int):TokenGet a token at an absolute index i; 0..n-1. This is really only needed for profiling and debugging and token stream rewriting. If you don't want to buffer up tokens, then this method makes no sense for you. Naturally you can't use the rewrite stream feature. I believe DebugTokenStream can easily be altered to not use this method, removing the dependency.
Parametersi:int |
Token |
| LT | () | method |
public function LT(k:int):TokenGet Token at current input pointer + i ahead where i=1 is next Token. i<0 indicates tokens in the past. So -1 is previous token and -2 is two tokens ago. LT(0) is undefined. For i>=n, return Token.EOFToken. Return null for LT(0) and any index that results in an absolute address that is negative.
Parametersk:int |
Token |
| toStringWithRange | () | method |
public function toStringWithRange(start:int, stop:int):StringReturn the text of all tokens from start to stop, inclusive. If the stream does not buffer all the tokens then it can just return "" or null; Users should not access $ruleLabel.text in an action of course in that case.
Parametersstart:int |
|
stop:int |
String |
| toStringWithTokenRange | () | method |
public function toStringWithTokenRange(start:Token, stop:Token):StringBecause the user is not required to use a token with an index stored in it, we must provide a means for two token objects themselves to indicate the start/end location. Most often this will just delegate to the other toString(int,int). This is also parallel with the TreeNodeStream.toString(Object,Object).
Parametersstart:Token |
|
stop:Token |
String |