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 public interface IToken { 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>Get the text of the token</summary> */ 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver string Text { 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set; 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int Type { 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set; 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>The line number on which this token was matched; line=1..n</summary> */ 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int Line { 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set; 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>The index of the first character relative to the beginning of the line 0..n-1</summary> */ 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int CharPositionInLine { 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set; 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int Channel { 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set; 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int StartIndex { 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set; 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int StopIndex { 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set; 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * An index from 0..n-1 of the token object in the input stream. 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This must be valid in order to use the ANTLRWorks debugger. 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int TokenIndex { 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set; 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * From what character stream was this token created? You don't have to 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * implement but it's nice to know where a Token comes from if you have 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * include files etc... on the input. 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ICharStream InputStream { 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set; 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 96