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 "ANTLRCommonTree.h" 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRCommonTreeNodeStream.h" 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRLookaheadStream.h" 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRTreeNodeStream.h" 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRTreeIterator.h" 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRIntArray.h" 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRCommonTreeNodeStream : ANTLRLookaheadStream <ANTLRTreeNodeStream> { 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define DEFAULT_INITIAL_BUFFER_SIZE 100 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define INITIAL_CALL_STACK_SIZE 10 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Pull nodes from which tree? */ 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver__strong id root; 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** If this tree (root) was created from a token stream, track it. */ 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver__strong id <ANTLRTokenStream> tokens; 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** What tree adaptor was used to build these trees */ 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver__strong ANTLRCommonTreeAdaptor *adaptor; 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** The tree iterator we using */ 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver__strong ANTLRTreeIterator *it; 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Stack of indexes used for push/pop calls */ 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver__strong ANTLRIntArray *calls; 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Tree (nil A B C) trees like flat A B C streams */ 55324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverBOOL hasNilRoot; 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Tracks tree depth. Level=0 means we're at root node level. */ 58324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverNSInteger level; 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getRoot, setter=setRoot:) ANTLRCommonTree *root; 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getTokens,setter=setTokens:) id<ANTLRTokenStream> tokens; 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getTreeAdaptor, setter=setTreeAdaptor:) ANTLRCommonTreeAdaptor *adaptor; 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign, getter=getLevel, setter=setLevel:) NSInteger level; 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRCommonTreeNodeStream *) newANTLRCommonTreeNodeStream:(ANTLRCommonTree *)theTree; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRCommonTreeNodeStream *) newANTLRCommonTreeNodeStream:(id<ANTLRTreeAdaptor>)anAdaptor Tree:(ANTLRCommonTree *)theTree; 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithTree:(ANTLRCommonTree *)theTree; 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithTreeAdaptor:(id<ANTLRTreeAdaptor>)adaptor Tree:(ANTLRCommonTree *)theTree; 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) reset; 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Pull elements from tree iterator. Track tree level 0..max_level. 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * If nil rooted tree, don't give initial nil and DOWN nor final UP. 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) nextElement; 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) isEOF:(id<ANTLRBaseTree>) obj; 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setUniqueNavigationNodes:(BOOL) uniqueNavigationNodes; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) getTreeSource; 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) getSourceName; 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRTokenStream>) getTokenStream; 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setTokenStream:(id<ANTLRTokenStream>) tokens; 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRCommonTreeAdaptor *) getTreeAdaptor; 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setTreeAdaptor:(ANTLRCommonTreeAdaptor *) adaptor; 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) LA:(NSInteger) i; 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Make stream jump to a new location, saving old location. 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Switch back with pop(). 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRCommonTree *)getNode:(NSInteger) i; 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) push:(NSInteger) index; 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Seek back to previous index saved during last push() call. 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Return top of stack (return index). 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) pop; 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// TREE REWRITE INTERFACE 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) replaceChildren:(id)parent From:(NSInteger)startChildIndex To:(NSInteger)stopChildIndex With:(id) t; 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toStringFromNode:(id<ANTLRBaseTree>)startNode ToNode:(id<ANTLRBaseTree>)stopNode; 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** For debugging; destructive: moves tree iterator to end. */ 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toTokenTypeString; 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain) ANTLRTreeIterator *it; 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain) ANTLRIntArray *calls; 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property BOOL hasNilRoot; 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 121