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 "ANTLRCharStream.h" 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRCharStreamState.h" 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRPtrBuffer.h" 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRStringStream : NSObject < ANTLRCharStream > { 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSString *data; 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger n; 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger p; 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger line; 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger charPositionInLine; 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger markDepth; 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLRPtrBuffer *markers; 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger lastMarker; 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSString *name; 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLRCharStreamState *charState; 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getData,setter=setData:) NSString *data; 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (getter=getP,setter=setP:) NSInteger p; 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (getter=getN,setter=setN:) NSInteger n; 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (getter=getLine,setter=setLine:) NSInteger line; 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (getter=getCharPositionInLine,setter=setCharPositionInLine:) NSInteger charPositionInLine; 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (getter=getMarkDepth,setter=setMarkDepth:) NSInteger markDepth; 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getMarkers, setter=setMarkers:) ANTLRPtrBuffer *markers; 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (getter=getLastMarker,setter=setLastMarker:) NSInteger lastMarker; 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getSourceName, setter=setSourceName:) NSString *name; 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getCharState, setter=setCharState:) ANTLRCharStreamState *charState; 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ newANTLRStringStream; 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ newANTLRStringStream:(NSString *)aString; 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ newANTLRStringStream:(char *)myData Count:(NSInteger)numBytes; 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) init; 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// this initializer copies the string 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithString:(NSString *) theString; 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// This is the preferred constructor as no data is copied 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithStringNoCopy:(NSString *) theString; 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithData:(char *)myData Count:(NSInteger)numBytes; 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) dealloc; 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) copyWithZone:(NSZone *)aZone; 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// reset the stream's state, but keep the data to feed off 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) reset; 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// consume one character from the stream 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) consume; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// look ahead i characters 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) LA:(NSInteger) i; 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) LT:(NSInteger) i; 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// returns the position of the current input symbol 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getIndex; 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// total length of the input data 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) size; 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// seek and rewind in the stream 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) mark; 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) rewind:(NSInteger) marker; 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) rewind; 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) release:(NSInteger) marker; 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) seek:(NSInteger) index; 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// provide the streams data (e.g. for tokens using indices) 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) substring:(NSInteger)startIndex To:(NSInteger)stopIndex; 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) substringWithRange:(NSRange) theRange; 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// used for tracking the current position in the input stream 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getLine; 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setLine:(NSInteger) theLine; 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getCharPositionInLine; 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setCharPositionInLine:(NSInteger) thePos; 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getN; 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setN:(NSInteger)num; 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getP; 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setP:(NSInteger)num; 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRPtrBuffer *)getMarkers; 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setMarkers:(ANTLRPtrBuffer *)aMarkerList; 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)getSourceName; 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)toString; 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// accessors to the raw data of this stream 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) getData; 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setData: (NSString *) aData; 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 127