org.antlr.runtime.TokenStream Interface Reference
Public Member Functions | |
| Token | LT (int k) |
| int | range () |
| Token | get (int i) |
| TokenSource | getTokenSource () |
| String | toString (int start, int stop) |
| String | toString (Token start, Token stop) |
Detailed Description
A stream of tokens accessing tokens from a TokenSourceDefinition at line 33 of file TokenStream.java.
Member Function Documentation
| Token org.antlr.runtime.TokenStream.LT | ( | int | k | ) |
Get 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.
Implemented in org.antlr.runtime.BufferedTokenStream, org.antlr.runtime.CommonTokenStream, org.antlr.runtime.debug.DebugTokenStream, and org.antlr.runtime.LegacyCommonTokenStream.
| int org.antlr.runtime.TokenStream.range | ( | ) |
How far ahead has the stream been asked to look? The return value is a valid index from 0..n-1.
Implemented in org.antlr.runtime.BufferedTokenStream, org.antlr.runtime.debug.DebugTokenStream, and org.antlr.runtime.LegacyCommonTokenStream.
| Token org.antlr.runtime.TokenStream.get | ( | int | i | ) |
Get 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.
Implemented in org.antlr.runtime.BufferedTokenStream, org.antlr.runtime.debug.DebugTokenStream, org.antlr.runtime.LegacyCommonTokenStream, and org.antlr.runtime.UnbufferedTokenStream.
| TokenSource org.antlr.runtime.TokenStream.getTokenSource | ( | ) |
Where is this stream pulling tokens from? This is not the name, but the object that provides Token objects.
Implemented in org.antlr.runtime.BufferedTokenStream, org.antlr.runtime.debug.DebugTokenStream, org.antlr.runtime.LegacyCommonTokenStream, and org.antlr.runtime.UnbufferedTokenStream.
| String org.antlr.runtime.TokenStream.toString | ( | int | start, | |
| int | stop | |||
| ) |
Return 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.
Implemented in org.antlr.runtime.BufferedTokenStream, org.antlr.runtime.debug.DebugTokenStream, org.antlr.runtime.LegacyCommonTokenStream, org.antlr.runtime.TokenRewriteStream, and org.antlr.runtime.UnbufferedTokenStream.
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. Most often this will just delegate to the other toString(int,int). This is also parallel with the TreeNodeStream.toString(Object,Object).
Implemented in org.antlr.runtime.BufferedTokenStream, org.antlr.runtime.debug.DebugTokenStream, org.antlr.runtime.LegacyCommonTokenStream, and org.antlr.runtime.UnbufferedTokenStream.
The documentation for this interface was generated from the following file:
- /Users/parrt/antlr/code/antlr/main/runtime/Java/src/main/java/org/antlr/runtime/TokenStream.java
