Antlr.Runtime.IIntStream Interface Reference
Public Member Functions | |
| void | Consume () |
| int | LA (int i) |
| *int | Mark () |
| Tell the stream to start buffering if it hasn't already. | |
| int | Index () |
| void | Rewind (int marker) |
| void | Rewind () |
| Rewind to the input position of the last marker. | |
| void | Release (int marker) |
| void | Seek (int index) |
| int | Size () |
| Returns the size of the entire stream. | |
Properties | |
| string | SourceName [get] |
| 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. | |
Detailed Description
A simple stream of integers. This is useful when all we care about is the char or token type sequence (such as for interpretation).Definition at line 44 of file IIntStream.cs.
Member Function Documentation
| void Antlr.Runtime.IIntStream.Consume | ( | ) |
| int Antlr.Runtime.IIntStream.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 or EOF.
Implemented in Antlr.Runtime.ANTLRStringStream, Antlr.Runtime.CommonTokenStream, Antlr.Runtime.Debug.DebugTokenStream, Antlr.Runtime.Debug.DebugTreeNodeStream, Antlr.Runtime.Tree.CommonTreeNodeStream, and Antlr.Runtime.Tree.UnBufferedTreeNodeStream.
| * int Antlr.Runtime.IIntStream.Mark | ( | ) |
Tell the stream to start buffering if it hasn't already.
Executing Rewind(Mark()) on a stream should not affect the input position. The Lexer tracks line/col info as well as input index so its markers are not pure input indexes. Same for tree node streams.
- Returns:
- Return a marker that can be passed to IIntStream.Rewind(int) to return to the current position. This could be the current input position, a value return from IIntStream.Index, or some other marker.
Implemented in Antlr.Runtime.ANTLRStringStream, Antlr.Runtime.CommonTokenStream, Antlr.Runtime.Debug.DebugTokenStream, Antlr.Runtime.Debug.DebugTreeNodeStream, Antlr.Runtime.Tree.CommonTreeNodeStream, and Antlr.Runtime.Tree.UnBufferedTreeNodeStream.
| int Antlr.Runtime.IIntStream.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.
Implemented in Antlr.Runtime.ANTLRStringStream, Antlr.Runtime.CommonTokenStream, Antlr.Runtime.Debug.DebugTokenStream, Antlr.Runtime.Debug.DebugTreeNodeStream, Antlr.Runtime.Tree.CommonTreeNodeStream, and Antlr.Runtime.Tree.UnBufferedTreeNodeStream.
| void Antlr.Runtime.IIntStream.Rewind | ( | int | marker | ) |
Resets the stream so that the next call to IIntStream.Index would return marker.
The marker will usually be IIntStream.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 IIntStream.Release and IIntStream.Seek. If there are other markers created after the specified marker, this routine must unroll them like a stack. Assumes the state the stream was in when this marker was created.
Implemented in Antlr.Runtime.ANTLRStringStream, Antlr.Runtime.CommonTokenStream, Antlr.Runtime.Debug.DebugTokenStream, Antlr.Runtime.Debug.DebugTreeNodeStream, Antlr.Runtime.Tree.CommonTreeNodeStream, and Antlr.Runtime.Tree.UnBufferedTreeNodeStream.
| void Antlr.Runtime.IIntStream.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).
Implemented in Antlr.Runtime.ANTLRStringStream, Antlr.Runtime.CommonTokenStream, Antlr.Runtime.Debug.DebugTokenStream, Antlr.Runtime.Debug.DebugTreeNodeStream, Antlr.Runtime.Tree.CommonTreeNodeStream, and Antlr.Runtime.Tree.UnBufferedTreeNodeStream.
| void Antlr.Runtime.IIntStream.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 IIntStream.Rewind(int) 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.
Implemented in Antlr.Runtime.ANTLRStringStream, Antlr.Runtime.CommonTokenStream, Antlr.Runtime.Debug.DebugTokenStream, Antlr.Runtime.Debug.DebugTreeNodeStream, Antlr.Runtime.Tree.CommonTreeNodeStream, and Antlr.Runtime.Tree.UnBufferedTreeNodeStream.
| void Antlr.Runtime.IIntStream.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 IIntStream.Mark/IIntStream.Rewind(int) 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.
Implemented in Antlr.Runtime.ANTLRStringStream, Antlr.Runtime.CommonTokenStream, Antlr.Runtime.Debug.DebugTokenStream, Antlr.Runtime.Debug.DebugTreeNodeStream, Antlr.Runtime.Tree.CommonTreeNodeStream, and Antlr.Runtime.Tree.UnBufferedTreeNodeStream.
| int Antlr.Runtime.IIntStream.Size | ( | ) |
Returns the size of the entire stream.
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.
Implemented in Antlr.Runtime.ANTLRStringStream, Antlr.Runtime.CommonTokenStream, Antlr.Runtime.Debug.DebugTokenStream, Antlr.Runtime.Debug.DebugTreeNodeStream, Antlr.Runtime.Tree.CommonTreeNodeStream, and Antlr.Runtime.Tree.UnBufferedTreeNodeStream.
Property Documentation
string Antlr.Runtime.IIntStream.SourceName [get] |
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.
Implemented in Antlr.Runtime.ANTLRFileStream, Antlr.Runtime.ANTLRStringStream, Antlr.Runtime.CommonTokenStream, Antlr.Runtime.Debug.DebugTokenStream, Antlr.Runtime.Debug.DebugTreeNodeStream, Antlr.Runtime.Tree.CommonTreeNodeStream, and Antlr.Runtime.Tree.UnBufferedTreeNodeStream.
Definition at line 156 of file IIntStream.cs.
The documentation for this interface was generated from the following file:
- /Users/parrt/antlr/code/antlr/main/runtime/CSharp/Sources/Antlr3.Runtime/Antlr.Runtime/IIntStream.cs
