1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/* 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * [The "BSD licence"] 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Copyright (c) 2005-2008 Terence Parr 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * All rights reserved. 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Conversion to C#: 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Copyright (c) 2008-2009 Sam Harwell, Pixel Mine, Inc. 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * All rights reserved. 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Redistribution and use in source and binary forms, with or without 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * modification, are permitted provided that the following conditions 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * are met: 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 1. Redistributions of source code must retain the above copyright 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * notice, this list of conditions and the following disclaimer. 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 2. Redistributions in binary form must reproduce the above copyright 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * notice, this list of conditions and the following disclaimer in the 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * documentation and/or other materials provided with the distribution. 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 3. The name of the author may not be used to endorse or promote products 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * derived from this software without specific prior written permission. 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvernamespace Antlr.Runtime 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * A simple stream of integers used when all I care about is the char 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * or token type sequence (such as interpretation). 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public interface IIntStream 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void Consume(); 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Get int at current input pointer + i ahead where i=1 is next int. 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Negative indexes are allowed. LA(-1) is previous token (token 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * just matched). LA(-i) where i is before first token should 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * yield -1, invalid char / EOF. 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int LA( int i ); 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Tell the stream to start buffering if it hasn't already. Return 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * current input position, Index, or some other marker so that 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * when passed to rewind() you get back to the same spot. 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * rewind(mark()) should not affect the input cursor. The Lexer 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * track line/col info as well as input index so its markers are 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * not pure input indexes. Same for tree node streams. 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int Mark(); 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Return the current input symbol index 0..n where n indicates the 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * last symbol has been read. The index is the symbol about to be 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * read not the most recently read symbol. 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int Index 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Reset the stream so that next call to index would return marker. 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * The marker will usually be Index but it doesn't have to be. It's 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * just a marker to indicate what state the stream was in. This is 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * essentially calling release() and seek(). If there are markers 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * created after this marker argument, this routine must unroll them 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * like a stack. Assume the state the stream was in when this marker 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * was created. 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void Rewind( int marker ); 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Rewind to the input position of the last marker. 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Used currently only after a cyclic DFA and just 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * before starting a sem/syn predicate to get the 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * input position back to the start of the decision. 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Do not "pop" the marker off the state. mark(i) 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * and rewind(i) should balance still. It is 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * like invoking rewind(last marker) but it should not "pop" 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the marker off. It's like seek(last marker's input position). 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void Rewind(); 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * You may want to commit to a backtrack but don't want to force the 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * stream to keep bookkeeping objects around for a marker that is 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * no longer necessary. This will have the same behavior as 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * rewind() except it releases resources without the backward seek. 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This must throw away resources for all markers back to the marker 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * argument. So if you're nested 5 levels of mark(), and then release(2) 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * you have to release resources for depths 2..5. 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void Release( int marker ); 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Set the input cursor to the position indicated by index. This is 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * normally used to seek ahead in the input stream. No buffering is 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * required to do this unless you know your stream will use seek to 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * move backwards such as when backtracking. 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * <remarks> 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This is different from rewind in its multi-directional 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * requirement and in that its argument is strictly an input cursor (index). 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * For char streams, seeking forward must update the stream state such 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * as line number. For seeking backwards, you will be presumably 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * backtracking using the mark/rewind mechanism that restores state and 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * so this method does not need to update state when seeking backwards. 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Currently, this method is only used for efficient backtracking using 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * memoization, but in the future it may be used for incremental parsing. 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * The index is 0..n-1. A seek to position i means that LA(1) will 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * return the ith symbol. So, seeking to 0 means LA(1) will return the 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * first element in the stream. 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </remarks> 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void Seek( int index ); 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Only makes sense for streams that buffer everything up probably, but 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * might be useful to display the entire stream or for testing. This 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * value includes a single EOF. 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int Count 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Where are you getting symbols from? Normally, implementations will 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * pass the buck all the way to the lexer who can ask its input stream 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * for the file name or whatever. 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver string SourceName 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 162