1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
// [The "BSD licence"]
// Copyright (c) 2006-2007 Kay Roepke 2010 Alan Condit
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// 3. The name of the author may not be used to endorse or promote products
// derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#import <Cocoa/Cocoa.h>
typedef enum {
ANTLRTokenTypeEOF = -1,
ANTLRTokenTypeInvalid,
ANTLRTokenTypeEOR,
ANTLRTokenTypeDOWN,
ANTLRTokenTypeUP,
ANTLRTokenTypeMIN
} ANTLRTokenType;
typedef enum {
ANTLRTokenChannelDefault = 0,
ANTLRTokenChannelHidden = 99
} ANTLRTokenChannel;
#define HIDDEN 99
@protocol ANTLRToken < NSObject, NSCopying >
// The singleton eofToken instance.
+ (id<ANTLRToken>) eofToken;
// The default channel for this class of Tokens
+ (ANTLRTokenChannel) defaultChannel;
// provide hooks to explicitely set the text as opposed to use the indices into the CharStream
- (NSString *) getText;
- (void) setText:(NSString *) theText;
- (NSInteger) getType;
- (void) setType: (NSInteger) aType;
// ANTLR v3 provides automatic line and position tracking. Subclasses do not need to
// override these, if they do not want to store line/pos tracking information
- (NSUInteger) getLine;
- (void) setLine: (NSUInteger) aLine;
- (NSUInteger) getCharPositionInLine;
- (void) setCharPositionInLine: (NSUInteger) aCharPositionInLine;
// explicitely change the channel this Token is on. The default parser implementation
// just sees the defaultChannel
// Common idiom is to put whitespace tokens on channel 99.
- (NSUInteger) getChannel;
- (void) setChannel: (NSUInteger) aChannel;
// the index of this Token into the TokenStream
- (NSUInteger) getTokenIndex;
- (void) setTokenIndex: (NSUInteger) aTokenIndex;
- (NSString *)toString;
@end
|
