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#import <Cocoa/Cocoa.h> 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRTokenStream.h" 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRTokenSource.h" 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRBitSet.h" 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRCommonToken.h" 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "AMutableArray.h" 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRBufferedTokenStream : NSObject <ANTLRTokenStream> 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver__strong id<ANTLRTokenSource> tokenSource; 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Record every single token pulled from the source so we can reproduce 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * chunks of it later. The buffer in LookaheadStream overlaps sometimes 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * as its moving window moves through the input. This list captures 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * everything so we can access complete input text. 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver__strong AMutableArray *tokens; 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Track the last mark() call result value for use in rewind(). */ 46324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverNSInteger lastMarker; 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** The index into the tokens list of the current token (next token 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * to consume). tokens[index] should be LT(1). index=-1 indicates need 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * to initialize with first token. The ctor doesn't get a token. 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * First call to LT(1) or whatever gets the first token and sets index=0; 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 53324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverNSInteger index; 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 55324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverNSInteger range; // how deep have we gone? 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getTokenSource,setter=setTokenSource:) id<ANTLRTokenSource> tokenSource; 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getTokens,setter=setTokens:) AMutableArray *tokens; 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign, getter=getLastMarker,setter=setLastMarker:) NSInteger lastMarker; 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign) NSInteger index; 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign, getter=getRange,setter=setRange:) NSInteger range; 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBufferedTokenStream *) newANTLRBufferedTokenStream; 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBufferedTokenStream *) newANTLRBufferedTokenStreamWith:(id<ANTLRTokenSource>)aSource; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithTokenSource:(id<ANTLRTokenSource>)aSource; 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void)dealloc; 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) copyWithZone:(NSZone *)aZone; 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSUInteger)charPositionInLine; 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSUInteger)line; 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getRange; 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setRange:(NSInteger)anInt; 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) mark; 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) release:(NSInteger) marker; 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) rewind:(NSInteger) marker; 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) rewind; 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) reset; 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) seek:(NSInteger) anIndex; 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) size; 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) consume; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) sync:(NSInteger) i; 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) fetch:(NSInteger) n; 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRToken>) getToken:(NSInteger) i; 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (AMutableArray *)getFrom:(NSInteger)startIndex To:(NSInteger) stopIndex; 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) LA:(NSInteger)i; 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRToken>) LB:(NSInteger) k; 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRToken>) LT:(NSInteger) k; 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setup; 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRTokenSource>) getTokenSource; 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setTokenSource:(id<ANTLRTokenSource>) aTokenSource; 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (AMutableArray *)getTokens; 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) getSourceName; 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (AMutableArray *)getTokensFrom:(NSInteger)startIndex To:(NSInteger)stopIndex; 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (AMutableArray *)getTokensFrom:(NSInteger)startIndex To:(NSInteger)stopIndex With:(ANTLRBitSet *)types; 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (AMutableArray *)getTokensFrom:(NSInteger)startIndex To:(NSInteger)stopIndex WithList:(AMutableArray *)types; 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (AMutableArray *)getTokensFrom:(NSInteger)startIndex To:(NSInteger)stopIndex WithType:(NSInteger)ttype; 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toString; 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toStringFromStart:(NSInteger)startIndex ToEnd:(NSInteger)stopIndex; 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toStringFromToken:(id<ANTLRToken>)startIndex ToToken:(id<ANTLRToken>)stopIndex; 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) fill; 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 103