1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// ANTLRBufferedTreeNodeStream.h 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// ANTLR 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// [The "BSD licence"] 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Copyright (c) 2010 Ian Michell 2010 Alan Condit 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// All rights reserved. 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Redistribution and use in source and binary forms, with or without 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// modification, are permitted provided that the following conditions 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// are met: 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 1. Redistributions of source code must retain the above copyright 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer. 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 2. Redistributions in binary form must reproduce the above copyright 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer in the 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// documentation and/or other materials provided with the distribution. 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 3. The name of the author may not be used to endorse or promote products 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// derived from this software without specific prior written permission. 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import <Cocoa/Cocoa.h> 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRTree.h" 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRCommonTreeAdaptor.h" 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRTokenStream.h" 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRCommonTreeNodeStream.h" 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRLookaheadStream.h" 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRTreeIterator.h" 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRIntArray.h" 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "AMutableArray.h" 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define DEFAULT_INITIAL_BUFFER_SIZE 100 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define INITIAL_CALL_STACK_SIZE 10 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#ifdef DONTUSENOMO 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRStreamIterator : ANTLRTreeIterator 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger idx; 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver __strong ANTLRBufferedTreeNodeStream *input; 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver __strong AMutableArray *nodes; 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id) newANTLRStreamIterator:(ANTLRBufferedTreeNodeStream *) theStream; 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithStream:(ANTLRBufferedTreeNodeStream *) theStream; 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) hasNext; 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) next; 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) remove; 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#endif 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRBufferedTreeNodeStream : NSObject <ANTLRTreeNodeStream> 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver id up; 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver id down; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver id eof; 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver AMutableArray *nodes; 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver id root; // root 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver id<ANTLRTokenStream> tokens; 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLRCommonTreeAdaptor *adaptor; 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver BOOL uniqueNavigationNodes; 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger index; 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger lastMarker; 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLRIntArray *calls; 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSEnumerator *e; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver id currentSymbol; 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getUp, setter=setUp:) id up; 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getDown, setter=setDown:) id down; 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=eof, setter=setEof:) id eof; 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getNodes, setter=setNodes:) AMutableArray *nodes; 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getTreeSource, setter=setTreeSource:) id root; 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getTokenStream, setter=setTokenStream:) id<ANTLRTokenStream> tokens; 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getAdaptor, setter=setAdaptor:) ANTLRCommonTreeAdaptor *adaptor; 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign, getter=getUniqueNavigationNodes, setter=setUniqueNavigationNodes:) BOOL uniqueNavigationNodes; 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign) NSInteger index; 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign, getter=getLastMarker, setter=setLastMarker:) NSInteger lastMarker; 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getCalls, setter=setCalls:) ANTLRIntArray *calls; 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getEnum, setter=setEnum:) NSEnumerator *e; 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getCurrentSymbol, setter=setCurrentSymbol:) id currentSymbol; 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBufferedTreeNodeStream *) newANTLRBufferedTreeNodeStream:(ANTLRCommonTree *)tree; 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBufferedTreeNodeStream *) newANTLRBufferedTreeNodeStream:(id<ANTLRTreeAdaptor>)adaptor Tree:(ANTLRCommonTree *)tree; 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBufferedTreeNodeStream *) newANTLRBufferedTreeNodeStream:(id<ANTLRTreeAdaptor>)adaptor Tree:(ANTLRCommonTree *)tree withBufferSize:(NSInteger)initialBufferSize; 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark Constructor 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithTree:(ANTLRCommonTree *)tree; 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithTreeAdaptor:(ANTLRCommonTreeAdaptor *)anAdaptor Tree:(ANTLRCommonTree *)tree; 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithTreeAdaptor:(ANTLRCommonTreeAdaptor *)anAdaptor Tree:(ANTLRCommonTree *)tree WithBufferSize:(NSInteger)bufferSize; 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void)dealloc; 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) copyWithZone:(NSZone *)aZone; 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// protected methods. DO NOT USE 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark Protected Methods 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) fillBuffer; 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) fillBufferWithTree:(ANTLRCommonTree *) tree; 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getNodeIndex:(ANTLRCommonTree *) node; 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) addNavigationNode:(NSInteger) type; 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) getNode:(NSUInteger) i; 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) LT:(NSInteger) k; 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) getCurrentSymbol; 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) LB:(NSInteger) i; 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark General Methods 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) getSourceName; 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRTokenStream>) getTokenStream; 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setTokenStream:(id<ANTLRTokenStream>) tokens; 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRTreeAdaptor>) getTreeAdaptor; 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setTreeAdaptor:(id<ANTLRTreeAdaptor>) anAdaptor; 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL)getUniqueNavigationNodes; 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setUniqueNavigationNodes:(BOOL)aVal; 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) consume; 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) LA:(NSInteger) i; 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) mark; 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) release:(NSInteger) marker; 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) rewind:(NSInteger) marker; 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) rewind; 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) seek:(NSInteger) idx; 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) push:(NSInteger) i; 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) pop; 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) reset; 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSUInteger) count; 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSEnumerator *) objectEnumerator; 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) replaceChildren:(id)parent From:(NSInteger)startChildIndex To:(NSInteger)stopChildIndex With:(id) t; 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toTokenTypeString; 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toTokenString:(NSInteger)aStart ToEnd:(NSInteger)aStop; 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toStringFromNode:(id)aStart ToNode:(id)aStop; 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// getters and setters 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (AMutableArray *) getNodes; 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) eof; 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void)setEof:(id)anEOF; 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 158