1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// [The "BSD licence"] 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Copyright (c) 2006-2007 Kay Roepke 2010 Alan Condit 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// All rights reserved. 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Redistribution and use in source and binary forms, with or without 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// modification, are permitted provided that the following conditions 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// are met: 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 1. Redistributions of source code must retain the above copyright 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer. 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 2. Redistributions in binary form must reproduce the above copyright 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer in the 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// documentation and/or other materials provided with the distribution. 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 3. The name of the author may not be used to endorse or promote products 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// derived from this software without specific prior written permission. 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import <Cocoa/Cocoa.h> 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRToken.h" 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRCharStream.h" 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRCommonToken : NSObject < ANTLRToken > { 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver __strong NSString *text; 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger type; 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // information about the Token's position in the input stream 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSUInteger line; 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSUInteger charPositionInLine; 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSUInteger channel; 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // this token's position in the TokenStream 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger index; 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // indices into the CharStream to avoid copying the text 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // can manually override the text by using -setText: 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger startIndex; 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger stopIndex; 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // the actual input stream this token was found in 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver __strong id<ANTLRCharStream> input; 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (void) initialize; 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (NSInteger) DEFAULT_CHANNEL; 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id<ANTLRToken>)INVALID_TOKEN; 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (NSInteger) INVALID_TOKEN_TYPE; 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id<ANTLRToken>) newToken; 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id<ANTLRToken>) newToken:(id<ANTLRCharStream>)anInput 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Type:(NSInteger)aTType 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Channel:(NSInteger)aChannel 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Start:(NSInteger)aStart 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Stop:(NSInteger)aStop; 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id<ANTLRToken>) newToken:(ANTLRTokenType)aType; 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id<ANTLRToken>) newToken:(NSInteger)tokenType Text:(NSString *)tokenText; 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id<ANTLRToken>) newTokenWithToken:(ANTLRCommonToken *)fromToken; 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id<ANTLRToken>) eofToken; 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id<ANTLRToken>) skipToken; 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id<ANTLRToken>) invalidToken; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTokenChannel) defaultChannel; 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// designated initializer. This is used as the default way to initialize a Token in the generated code. 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) init; 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithInput:(id<ANTLRCharStream>)anInput 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Type:(NSInteger)aTType 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Channel:(NSInteger)aChannel 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Start:(NSInteger)theStart 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Stop:(NSInteger)theStop; 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithToken:(id<ANTLRToken>)aToken; 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithType:(ANTLRTokenType)aType; 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithType:(ANTLRTokenType)aTType Text:(NSString *)tokenText; 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//---------------------------------------------------------- 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// text 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//---------------------------------------------------------- 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)text; 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setText:(NSString *)aText; 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//---------------------------------------------------------- 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// type 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//---------------------------------------------------------- 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger)type; 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setType:(NSInteger)aType; 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//---------------------------------------------------------- 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// channel 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//---------------------------------------------------------- 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSUInteger)channel; 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setChannel:(NSUInteger)aChannel; 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//---------------------------------------------------------- 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// input 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//---------------------------------------------------------- 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRCharStream>)input; 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setInput:(id<ANTLRCharStream>)anInput; 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger)getStart; 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setStart: (NSInteger)aStart; 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger)getStop; 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setStop: (NSInteger) aStop; 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// the index of this Token into the TokenStream 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger)getTokenIndex; 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setTokenIndex:(NSInteger)aTokenIndex; 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// conform to NSCopying 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) copyWithZone:(NSZone *)theZone; 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) description; 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toString; 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter = text, setter = setText:) NSString *text; 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign) NSInteger type; 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign, getter = line, setter = setLine:) NSUInteger line; 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign, getter=charPositionInLine, setter = setCharPositionInLine:) NSUInteger charPositionInLine; 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign) NSUInteger channel; 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign) NSInteger index; 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign, getter=getStart, setter=setStart:) NSInteger startIndex; 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign, getter=getStop, setter=setStop:) NSInteger stopIndex; 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain) id<ANTLRCharStream> input; 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 130