ANTLRCommonTreeNodeStream.h revision 324c4644fee44b9898524c09511bd33c3f12e2df
18d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// [The "BSD licence"] 28d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// Copyright (c) 2006-2007 Kay Roepke 2010 Alan Condit 38d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// All rights reserved. 48d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// 5c5ec7f57ead87efa365800228aa0b09a12d9e6c4Dmitry Shmidt// Redistribution and use in source and binary forms, with or without 6c5ec7f57ead87efa365800228aa0b09a12d9e6c4Dmitry Shmidt// modification, are permitted provided that the following conditions 78d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// are met: 88d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// 1. Redistributions of source code must retain the above copyright 98d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// notice, this list of conditions and the following disclaimer. 108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// 2. Redistributions in binary form must reproduce the above copyright 118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// notice, this list of conditions and the following disclaimer in the 128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// documentation and/or other materials provided with the distribution. 132e67f06149ff649fb6f8782bad041d3d9124685eDmitry Shmidt// 3. The name of the author may not be used to endorse or promote products 148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// derived from this software without specific prior written permission. 158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// 168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 1975ecf5267604f166b85a7ee2cf0d9cb682966680Jouni Malinen// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 2061d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 2161d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2275ecf5267604f166b85a7ee2cf0d9cb682966680Jouni Malinen// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23d5e4923d04122f81300fa68fb07d64ede28fd44dDmitry Shmidt// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2475ecf5267604f166b85a7ee2cf0d9cb682966680Jouni Malinen// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 2575ecf5267604f166b85a7ee2cf0d9cb682966680Jouni Malinen// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#import <Cocoa/Cocoa.h> 288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#import "ANTLRCommonTree.h" 298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#import "ANTLRCommonTreeNodeStream.h" 308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#import "ANTLRLookaheadStream.h" 318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#import "ANTLRTreeNodeStream.h" 328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#import "ANTLRTreeIterator.h" 338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#import "ANTLRIntArray.h" 348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt@interface ANTLRCommonTreeNodeStream : ANTLRLookaheadStream <ANTLRTreeNodeStream> { 368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define DEFAULT_INITIAL_BUFFER_SIZE 100 378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define INITIAL_CALL_STACK_SIZE 10 388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** Pull nodes from which tree? */ 408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtid root; 418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** If this tree (root) was created from a token stream, track it. */ 438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtid <ANTLRTokenStream> tokens; 448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** What tree adaptor was used to build these trees */ 468d520ff1dc2da35cdca849e982051b86468016d8Dmitry ShmidtANTLRCommonTreeAdaptor *adaptor; 478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** The tree iterator we using */ 498d520ff1dc2da35cdca849e982051b86468016d8Dmitry ShmidtANTLRTreeIterator *it; 5061d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** Stack of indexes used for push/pop calls */ 5261d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry ShmidtANTLRIntArray *calls; 5361d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 5461d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt/** Tree (nil A B C) trees like flat A B C streams */ 5561d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry ShmidtBOOL hasNilRoot; 5661d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 572e67f06149ff649fb6f8782bad041d3d9124685eDmitry Shmidt/** Tracks tree depth. Level=0 means we're at root node level. */ 582e67f06149ff649fb6f8782bad041d3d9124685eDmitry ShmidtNSInteger level; 592e67f06149ff649fb6f8782bad041d3d9124685eDmitry Shmidt} 6061d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt@property (retain, getter=getRoot, setter=setRoot:) ANTLRCommonTree *root; 618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt@property (retain, getter=getTokens,setter=setTokens:) id<ANTLRTokenStream> tokens; 628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt@property (retain, getter=getTreeAdaptor, setter=setTreeAdaptor:) ANTLRCommonTreeAdaptor *adaptor; 638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt+ (ANTLRCommonTreeNodeStream *) newANTLRCommonTreeNodeStream:(ANTLRCommonTree *)theTree; 658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt+ (ANTLRCommonTreeNodeStream *) newANTLRCommonTreeNodeStream:(id<ANTLRTreeAdaptor>)anAdaptor Tree:(ANTLRCommonTree *)theTree; 668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 6704949598a23f501be6eec21697465fd46a28840aDmitry Shmidt- (id) initWithTree:(ANTLRCommonTree *)theTree; 6804949598a23f501be6eec21697465fd46a28840aDmitry Shmidt 698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt- (id) initWithTreeAdaptor:(id<ANTLRTreeAdaptor>)adaptor Tree:(ANTLRCommonTree *)theTree; 708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt- (void) reset; 728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** Pull elements from tree iterator. Track tree level 0..max_level. 748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * If nil rooted tree, don't give initial nil and DOWN nor final UP. 758d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt- (id) nextElement; 778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt- (BOOL) isEOF:(id<ANTLRTree>) o; 7961d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt- (void) setUniqueNavigationNodes:(BOOL) uniqueNavigationNodes; 8061d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 8161d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt- (id) getTreeSource; 8261d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 8361d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt- (NSString *) getSourceName; 842e67f06149ff649fb6f8782bad041d3d9124685eDmitry Shmidt 852e67f06149ff649fb6f8782bad041d3d9124685eDmitry Shmidt- (id<ANTLRTokenStream>) getTokenStream; 862e67f06149ff649fb6f8782bad041d3d9124685eDmitry Shmidt 878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt- (void) setTokenStream:(id<ANTLRTokenStream>) tokens; 888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt- (ANTLRCommonTreeAdaptor *) getTreeAdaptor; 908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt- (void) setTreeAdaptor:(ANTLRCommonTreeAdaptor *) adaptor; 928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 9361d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt- (NSInteger) LA:(NSInteger) i; 9461d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 9561d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt /** Make stream jump to a new location, saving old location. 968d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Switch back with pop(). 978d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 9861d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt- (ANTLRCommonTree *)getNode:(NSInteger) i; 9961d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 10061d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt- (void) push:(NSInteger) index; 10161d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 10261d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt /** Seek back to previous index saved during last push() call. 10361d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt * Return top of stack (return index). 10461d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt */ 10561d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt- (NSInteger) pop; 10661d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 10761d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt// TREE REWRITE INTERFACE 10861d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 10961d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt- (void) replaceChildren:(id)parent From:(NSInteger)startChildIndex To:(NSInteger)stopChildIndex With:(id) t; 11061d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 11161d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt- (NSString *) toStringFromNode:(id<ANTLRTree>)startNode ToNode:(id<ANTLRTree>)stopNode; 11261d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 11361d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt/** For debugging; destructive: moves tree iterator to end. */ 11461d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt- (NSString *) toTokenTypeString; 11561d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 11661d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt@end 11761d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt