| Modifier and Type | Field and Description |
|---|---|
| protected int | channel
Skip tokens on any channel but this one; this is how we skip whitespace... |
| protected Map | channelOverrideMap
Map<tokentype, channel> to override some Tokens' channel numbers |
| protected boolean | discardOffChannelTokens
By default, track all incoming tokens |
| protected Set | discardSet
Set<tokentype>; discard any tokens with this type |
| protected int | lastMarker
Track the last mark() call result value for use in rewind(). |
| protected int | p
The index into the tokens list of the current token (next token to consume). |
| protected int | |
| protected List | tokens
Record every single token pulled from the source so we can reproduce chunks of it later. |
| protected TokenSource |
| Access | Constructor and Description |
|---|---|
| public | |
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | consume()
Implements org. |
| public void | |
| public void | |
| protected void | |
| public Token | get(int i)
Implements org. |
| public List | |
| public String | getSourceName()
Implements org. |
| public List | |
| public List | |
| public List | |
| public List | |
| public List | |
| public TokenSource | getTokenSource()
Implements org. |
| public int | index()
Implements org. |
| public int | LA(int i)
Implements org. |
| protected Token | |
| public Token | LT(int k)
Implements org. |
| public int | mark()
Implements org. |
| public int | range()
Implements org. |
| public void | release(int marker)
Implements org. |
| public void | |
| public void | rewind(int marker)
Implements org. |
| public void | rewind()
Implements org. |
| public void | seek(int index)
Implements org. |
| public void | |
| public void | 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. |
| public int | size()
Implements org. |
| protected int | |
| protected int | |
| public String | |
| public String | toString(int start, int stop)
Implements org. |
| public String | toString(Token start, Token stop)
Implements org. |
| channel | back to summary |
|---|---|
| protected int channel Skip tokens on any channel but this one; this is how we skip whitespace... | |
| channelOverrideMap | back to summary |
|---|---|
| protected Map<Integer, Integer> channelOverrideMap Map<tokentype, channel> to override some Tokens' channel numbers | |
| discardOffChannelTokens | back to summary |
|---|---|
| protected boolean discardOffChannelTokens By default, track all incoming tokens | |
| discardSet | back to summary |
|---|---|
| protected Set<Integer> discardSet Set<tokentype>; discard any tokens with this type | |
| lastMarker | back to summary |
|---|---|
| protected int lastMarker Track the last mark() call result value for use in rewind(). | |
| p | back to summary |
|---|---|
| protected int p The index into the tokens list of the current token (next token to consume). p==-1 indicates that the tokens list is empty | |
| range | back to summary |
|---|---|
| protected int range | |
| tokens | back to summary |
|---|---|
| protected List<Token> tokens Record every single token pulled from the source so we can reproduce chunks of it later. | |
| tokenSource | back to summary |
|---|---|
| protected TokenSource tokenSource | |
| LegacyCommonTokenStream | back to summary |
|---|---|
| public LegacyCommonTokenStream() | |
| LegacyCommonTokenStream | back to summary |
|---|---|
| public LegacyCommonTokenStream(TokenSource tokenSource) | |
| LegacyCommonTokenStream | back to summary |
|---|---|
| public LegacyCommonTokenStream(TokenSource tokenSource, int channel) | |
| consume | back to summary |
|---|---|
| public void consume() Implements org. 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.
| |
| discardOffChannelTokens | back to summary |
|---|---|
| public void discardOffChannelTokens(boolean discardOffChannelTokens) | |
| discardTokenType | back to summary |
|---|---|
| public void discardTokenType(int ttype) | |
| fillBuffer | back to summary |
|---|---|
| protected void fillBuffer() 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. | |
| get | back to summary |
|---|---|
| public Token get(int i) Implements org. Return absolute token i; ignore which channel the tokens are on; that is, count all tokens not just on-channel tokens.
| |
| get | back to summary |
|---|---|
| public List Get all tokens from start..stop inclusively | |
| getSourceName | back to summary |
|---|---|
| public String getSourceName() Implements org. Doc from org. 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.
| |
| getTokens | back to summary |
|---|---|
| public List | |
| getTokens | back to summary |
|---|---|
| public List | |
| getTokens | back to summary |
|---|---|
| public List 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. | |
| getTokens | back to summary |
|---|---|
| public List | |
| getTokens | back to summary |
|---|---|
| public List | |
| getTokenSource | back to summary |
|---|---|
| public TokenSource getTokenSource() Implements org. Doc from org. Where is this stream pulling tokens from? This is not the name, but the object that provides Token objects.
| |
| index | back to summary |
|---|---|
| public int index() Implements org. Doc from org. 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.
| |
| LA | back to summary |
|---|---|
| public int LA(int i) Implements org. Doc from org. 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.
| |
| LB | back to summary |
|---|---|
| protected Token LB(int k) Look backwards k tokens on-channel tokens | |
| LT | back to summary |
|---|---|
| public Token LT(int k) Implements org. Get the ith token from the current position 1..n where k=1 is the first symbol of lookahead.
| |
| mark | back to summary |
|---|---|
| public int mark() Implements org. Doc from org. 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.
| |
| range | back to summary |
|---|---|
| public int range() Implements org. Doc from org. How far ahead has the stream been asked to look? The return value is a valid index from 0..n-1.
| |
| release | back to summary |
|---|---|
| public void release(int marker) Implements org. Doc from org. 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.
| |
| reset | back to summary |
|---|---|
| public void reset() | |
| rewind | back to summary |
|---|---|
| public void rewind(int marker) Implements org. Doc from org. 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.
| |
| rewind | back to summary |
|---|---|
| public void rewind() Implements org. Doc from org. 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).
| |
| seek | back to summary |
|---|---|
| public void seek(int index) Implements org. Doc from org. 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.
| |
| setTokenSource | back to summary |
|---|---|
| public void setTokenSource(TokenSource tokenSource) Reset this token stream by setting its token source. | |
| setTokenTypeChannel | back to summary |
|---|---|
| public void 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. | |
| size | back to summary |
|---|---|
| public int size() Implements org. Doc from org. 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.
| |
| skipOffTokenChannels | back to summary |
|---|---|
| protected int skipOffTokenChannels(int i) Given a starting index, return the index of the first on-channel token. | |
| skipOffTokenChannelsReverse | back to summary |
|---|---|
| protected int skipOffTokenChannelsReverse(int i) | |
| toString | back to summary |
|---|---|
| public String toString() Overrides java. Doc from java. Returns a string representation of the object. | |
| toString | back to summary |
|---|---|
| public String toString(int start, int stop) Implements org. Doc from org. 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.
| |
| toString | back to summary |
|---|---|
| public String toString(Token start, Token stop) Implements org. Doc from org. 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).
| |