org.antlr.runtime.CommonTokenStream Class Reference
Public Member Functions | |
| CommonTokenStream () | |
| CommonTokenStream (TokenSource tokenSource) | |
| CommonTokenStream (TokenSource tokenSource, int channel) | |
| void | setTokenSource (TokenSource tokenSource) |
| void | consume () |
| void | setTokenTypeChannel (int ttype, int channel) |
| void | discardTokenType (int ttype) |
| void | discardOffChannelTokens (boolean discardOffChannelTokens) |
| List | getTokens () |
| List | getTokens (int start, int stop) |
| List | getTokens (int start, int stop, BitSet types) |
| List | getTokens (int start, int stop, List types) |
| List | getTokens (int start, int stop, int ttype) |
| Token | LT (int k) |
| Token | get (int i) |
| int | LA (int i) |
| int | mark () |
| void | release (int marker) |
| int | size () |
| int | index () |
| void | rewind (int marker) |
| void | rewind () |
| void | reset () |
| void | seek (int index) |
| TokenSource | getTokenSource () |
| String | getSourceName () |
| String | toString () |
| String | toString (int start, int stop) |
| String | toString (Token start, Token stop) |
Protected Member Functions | |
| void | fillBuffer () |
| int | skipOffTokenChannels (int i) |
| int | skipOffTokenChannelsReverse (int i) |
| Token | LB (int k) |
Protected Attributes | |
| TokenSource | tokenSource |
| List | tokens |
| Map | channelOverrideMap |
| Set | discardSet |
| int | channel = Token.DEFAULT_CHANNEL |
| boolean | discardOffChannelTokens = false |
| int | lastMarker |
| int | p = -1 |
Detailed Description
The most common stream of tokens is one where every token is buffered up and tokens are prefiltered for a certain channel (the parser will only see these tokens and cannot change the filter channel number during the parse).TODO: how to access the full token stream? How to track all tokens matched per rule?
Definition at line 39 of file CommonTokenStream.java.
Constructor & Destructor Documentation
| org.antlr.runtime.CommonTokenStream.CommonTokenStream | ( | ) |
Definition at line 67 of file CommonTokenStream.java.
| org.antlr.runtime.CommonTokenStream.CommonTokenStream | ( | TokenSource | tokenSource | ) |
Definition at line 71 of file CommonTokenStream.java.
| org.antlr.runtime.CommonTokenStream.CommonTokenStream | ( | TokenSource | tokenSource, | |
| int | channel | |||
| ) |
Definition at line 76 of file CommonTokenStream.java.
Member Function Documentation
| void org.antlr.runtime.CommonTokenStream.setTokenSource | ( | TokenSource | tokenSource | ) |
Reset this token stream by setting its token source.
Definition at line 82 of file CommonTokenStream.java.
| void org.antlr.runtime.CommonTokenStream.fillBuffer | ( | ) | [protected] |
Load all tokens from the token source and put in tokens. This is done upon first LT request because you might want to set some token type / channel overrides before filling buffer.
Definition at line 93 of file CommonTokenStream.java.
| void org.antlr.runtime.CommonTokenStream.consume | ( | ) |
Move the input pointer to the next incoming token. The stream must become active with LT(1) available. consume() simply moves the input pointer so that LT(1) points at the next input symbol. Consume at least one token.
Walk past any token not on the channel the parser is listening to.
Implements org.antlr.runtime.IntStream.
Definition at line 133 of file CommonTokenStream.java.
| int org.antlr.runtime.CommonTokenStream.skipOffTokenChannels | ( | int | i | ) | [protected] |
Given a starting index, return the index of the first on-channel token.
Definition at line 143 of file CommonTokenStream.java.
| int org.antlr.runtime.CommonTokenStream.skipOffTokenChannelsReverse | ( | int | i | ) | [protected] |
Definition at line 151 of file CommonTokenStream.java.
| void org.antlr.runtime.CommonTokenStream.setTokenTypeChannel | ( | int | ttype, | |
| int | channel | |||
| ) |
A simple filter mechanism whereby you can tell this token stream to force all tokens of type ttype to be on channel. For example, when interpreting, we cannot exec actions so we need to tell the stream to force all WS and NEWLINE to be a different, ignored channel.
Definition at line 164 of file CommonTokenStream.java.
| void org.antlr.runtime.CommonTokenStream.discardTokenType | ( | int | ttype | ) |
Definition at line 171 of file CommonTokenStream.java.
| void org.antlr.runtime.CommonTokenStream.discardOffChannelTokens | ( | boolean | discardOffChannelTokens | ) |
Definition at line 178 of file CommonTokenStream.java.
| List org.antlr.runtime.CommonTokenStream.getTokens | ( | ) |
Definition at line 182 of file CommonTokenStream.java.
| List org.antlr.runtime.CommonTokenStream.getTokens | ( | int | start, | |
| int | stop | |||
| ) |
Definition at line 189 of file CommonTokenStream.java.
| List org.antlr.runtime.CommonTokenStream.getTokens | ( | int | start, | |
| int | stop, | |||
| BitSet | types | |||
| ) |
Given a start and stop index, return a List of all tokens in the token type BitSet. Return null if no tokens were found. This method looks at both on and off channel tokens.
Definition at line 197 of file CommonTokenStream.java.
| List org.antlr.runtime.CommonTokenStream.getTokens | ( | int | start, | |
| int | stop, | |||
| List | types | |||
| ) |
Definition at line 225 of file CommonTokenStream.java.
| List org.antlr.runtime.CommonTokenStream.getTokens | ( | int | start, | |
| int | stop, | |||
| int | ttype | |||
| ) |
Definition at line 229 of file CommonTokenStream.java.
| Token org.antlr.runtime.CommonTokenStream.LT | ( | int | k | ) |
Get the ith token from the current position 1..n where k=1 is the first symbol of lookahead.
Implements org.antlr.runtime.TokenStream.
Definition at line 236 of file CommonTokenStream.java.
| Token org.antlr.runtime.CommonTokenStream.LB | ( | int | k | ) | [protected] |
Look backwards k tokens on-channel tokens
Definition at line 266 of file CommonTokenStream.java.
| Token org.antlr.runtime.CommonTokenStream.get | ( | int | i | ) |
Return absolute token i; ignore which channel the tokens are on; that is, count all tokens not just on-channel tokens.
Implements org.antlr.runtime.TokenStream.
Definition at line 295 of file CommonTokenStream.java.
| int org.antlr.runtime.CommonTokenStream.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 CommonTokenStream.java.
| int org.antlr.runtime.CommonTokenStream.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 CommonTokenStream.java.
| void org.antlr.runtime.CommonTokenStream.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 CommonTokenStream.java.
| int org.antlr.runtime.CommonTokenStream.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 315 of file CommonTokenStream.java.
| int org.antlr.runtime.CommonTokenStream.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 319 of file CommonTokenStream.java.
| void org.antlr.runtime.CommonTokenStream.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 323 of file CommonTokenStream.java.
| void org.antlr.runtime.CommonTokenStream.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 327 of file CommonTokenStream.java.
| void org.antlr.runtime.CommonTokenStream.reset | ( | ) |
Definition at line 331 of file CommonTokenStream.java.
| void org.antlr.runtime.CommonTokenStream.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 336 of file CommonTokenStream.java.
| TokenSource org.antlr.runtime.CommonTokenStream.getTokenSource | ( | ) |
Where is this stream pulling tokens from? This is not the name, but the object that provides Token objects.
Implements org.antlr.runtime.TokenStream.
Definition at line 340 of file CommonTokenStream.java.
| String org.antlr.runtime.CommonTokenStream.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 344 of file CommonTokenStream.java.
| String org.antlr.runtime.CommonTokenStream.toString | ( | ) |
Reimplemented in org.antlr.runtime.TokenRewriteStream.
Definition at line 348 of file CommonTokenStream.java.
| String org.antlr.runtime.CommonTokenStream.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.
Implements org.antlr.runtime.TokenStream.
Reimplemented in org.antlr.runtime.TokenRewriteStream.
Definition at line 355 of file CommonTokenStream.java.
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).
Implements org.antlr.runtime.TokenStream.
Definition at line 373 of file CommonTokenStream.java.
Member Data Documentation
Definition at line 40 of file CommonTokenStream.java.
List org.antlr.runtime.CommonTokenStream.tokens [protected] |
Record every single token pulled from the source so we can reproduce chunks of it later.
Definition at line 45 of file CommonTokenStream.java.
Map org.antlr.runtime.CommonTokenStream.channelOverrideMap [protected] |
Map<tokentype, channel> to override some Tokens' channel numbers
Definition at line 48 of file CommonTokenStream.java.
Set org.antlr.runtime.CommonTokenStream.discardSet [protected] |
Set<tokentype>; discard any tokens with this type
Definition at line 51 of file CommonTokenStream.java.
int org.antlr.runtime.CommonTokenStream.channel = Token.DEFAULT_CHANNEL [protected] |
Skip tokens on any channel but this one; this is how we skip whitespace...
Definition at line 54 of file CommonTokenStream.java.
boolean org.antlr.runtime.CommonTokenStream.discardOffChannelTokens = false [protected] |
By default, track all incoming tokens
Definition at line 57 of file CommonTokenStream.java.
int org.antlr.runtime.CommonTokenStream.lastMarker [protected] |
Track the last mark() call result value for use in rewind().
Definition at line 60 of file CommonTokenStream.java.
int org.antlr.runtime.CommonTokenStream.p = -1 [protected] |
The index into the tokens list of the current token (next token to consume). p==-1 indicates that the tokens list is empty
Definition at line 65 of file CommonTokenStream.java.
The documentation for this class was generated from the following file:
- /Users/parrt/antlr/code/antlr/main/runtime/Java/src/org/antlr/runtime/CommonTokenStream.java
