1 /*
2  * [The "BSD licence"]
3  * Copyright (c) 2005-2008 Terence Parr
4  * All rights reserved.
5  *
6  * Conversion to C#:
7  * Copyright (c) 2008-2009 Sam Harwell, Pixel Mine, Inc.
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 namespace Antlr.Runtime
34 {
35 
36     public interface IToken
37     {
38         /** <summary>Get the text of the token</summary> */
39         string Text
40         {
41             get;
42             set;
43         }
44 
45         int Type
46         {
47             get;
48             set;
49         }
50 
51         /** <summary>The line number on which this token was matched; line=1..n</summary> */
52         int Line
53         {
54             get;
55             set;
56         }
57 
58         /** <summary>The index of the first character relative to the beginning of the line 0..n-1</summary> */
59         int CharPositionInLine
60         {
61             get;
62             set;
63         }
64 
65         int Channel
66         {
67             get;
68             set;
69         }
70 
71         int StartIndex
72         {
73             get;
74             set;
75         }
76 
77         int StopIndex
78         {
79             get;
80             set;
81         }
82 
83         /** <summary>
84          *  An index from 0..n-1 of the token object in the input stream.
85          *  This must be valid in order to use the ANTLRWorks debugger.
86          *  </summary>
87          */
88         int TokenIndex
89         {
90             get;
91             set;
92         }
93 
94         /** <summary>
95          *  From what character stream was this token created?  You don't have to
96          *  implement but it's nice to know where a Token comes from if you have
97          *  include files etc... on the input.
98          *  </summary>
99          */
100         ICharStream InputStream
101         {
102             get;
103             set;
104         }
105     }
106 }
107