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 Gruvernamespace Antlr.Runtime 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>A stream of tokens accessing tokens from a TokenSource</summary> */ 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public interface ITokenStream : IIntStream 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>Get Token at current input pointer + i ahead where i=1 is next Token. 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * i<0 indicates tokens in the past. So -1 is previous token and -2 is 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * two tokens ago. LT(0) is undefined. For i>=n, return Token.EOFToken. 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Return null for LT(0) and any index that results in an absolute address 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * that is negative.</summary> 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IToken LT( int k ); 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// <summary> 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// How far ahead has the stream been asked to look? The return 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// value is a valid index from 0..n-1. 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// </summary> 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int Range 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Get a token at an absolute index i; 0..n-1. This is really only 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * needed for profiling and debugging and token stream rewriting. 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * If you don't want to buffer up tokens, then this method makes no 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * sense for you. Naturally you can't use the rewrite stream feature. 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * I believe DebugTokenStream can easily be altered to not use 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * this method, removing the dependency. 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IToken Get( int i ); 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Where is this stream pulling tokens from? This is not the name, but 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the object that provides Token objects. 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ITokenSource TokenSource 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Return the text of all tokens from start to stop, inclusive. 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * If the stream does not buffer all the tokens then it can just 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * return "" or null; Users should not access $ruleLabel.text in 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * an action of course in that case. 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver string ToString( int start, int stop ); 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Because the user is not required to use a token with an index stored 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * in it, we must provide a means for two token objects themselves to 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * indicate the start/end location. Most often this will just delegate 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * to the other toString(int,int). This is also parallel with 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the TreeNodeStream.toString(Object,Object). 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver string ToString( IToken start, IToken stop ); 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 96