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 "ANTLRTree.h" 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@protocol ANTLRBaseTree <ANTLRTree> 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getChildren, setter=setChildren) NSMutableArray *children; 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id<ANTLRBaseTree>) newANTLRBaseTree; 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id<ANTLRBaseTree>) newANTLRBaseTree:(id<ANTLRBaseTree>)node; 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRBaseTree>) init; 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRBaseTree>) initWith:(id<ANTLRTree>)node; 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRBaseTree>) getChild:(NSUInteger)i; 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSMutableArray *)getChildren; 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setChildren:(NSMutableArray *)anArray; 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRBaseTree>)getFirstChildWithType:(NSInteger)type; 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSUInteger) getChildCount; 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Add t as a child to this node. If t is null, do nothing. If t 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// is nil, add all children of t to this' children. 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) addChild:(id<ANTLRTree>) tree; 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) addChildren:(NSArray *) theChildren; 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//- (void) removeAllChildren; 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setChild:(NSInteger) i With:(id<ANTLRTree>)t; 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) deleteChild:(NSInteger) i; 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSMutableArray *) createChildrenList; 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) replaceChildrenFrom:(NSInteger)startChildIndex To:(NSInteger)stopChildIndex With:(id) t; 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Indicates the node is a nil node but may still have children, meaning 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// the tree is a flat list. 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) isNil; 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getTokenStartIndex; 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setTokenStartIndex:(NSInteger) index; 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getTokenStopIndex; 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setTokenStopIndex:(NSInteger) index; 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) freshenParentAndChildIndexes; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) freshenParentAndChildIndexes:(NSInteger) offset; 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) sanityCheckParentAndChildIndexes; 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) sanityCheckParentAndChildIndexes:(id<ANTLRTree>) parent At:(NSInteger) i; 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getChildIndex; 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setChildIndex:(NSInteger)i; 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRTree>)getAncestor:(NSInteger)ttype; 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSMutableArray *)getAncestors; 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark Copying 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) copyWithZone:(NSZone *)aZone; // the children themselves are not copied here! 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) deepCopy; // performs a deepCopyWithZone: with the default zone 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) deepCopyWithZone:(NSZone *)aZone; 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark Tree Parser support 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getType; 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) getText; 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// In case we don't have a token payload, what is the line for errors? 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getLine; 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getCharPositionInLine; 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark Informational 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) treeDescription; 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) description; 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toString; 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toStringTree; 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRBaseTree : NSObject <ANTLRTree> 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSMutableArray *children; 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSException *anException; 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getChildren, setter=setChildren) NSMutableArray *children; 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id<ANTLRBaseTree>) newANTLRBaseTree; 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (id<ANTLRBaseTree>) newANTLRBaseTree:(id<ANTLRBaseTree>)node; 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRTree>) init; 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRBaseTree>) initWith:(id<ANTLRTree>)node; 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRBaseTree>) getChild:(NSUInteger)i; 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSMutableArray *)getChildren; 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setChildren:(NSMutableArray *)anArray; 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRBaseTree>)getFirstChildWithType:(NSInteger)type; 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSUInteger) getChildCount; 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//- (void) removeAllChildren; 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Add t as a child to this node. If t is null, do nothing. If t 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// is nil, add all children of t to this' children. 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) addChild:(id<ANTLRTree>) tree; 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) addChildren:(NSArray *) theChildren; 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setChild:(NSInteger) i With:(id<ANTLRTree>)t; 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) deleteChild:(NSInteger) i; 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSMutableArray *) createChildrenList; 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) replaceChildrenFrom:(NSInteger)startChildIndex To:(NSInteger)stopChildIndex With:(id) t; 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Indicates the node is a nil node but may still have children, meaning 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // the tree is a flat list. 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) isNil; 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getTokenStartIndex; 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setTokenStartIndex:(NSInteger) index; 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getTokenStopIndex; 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setTokenStopIndex:(NSInteger) index; 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) freshenParentAndChildIndexes; 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) freshenParentAndChildIndexes:(NSInteger) offset; 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) sanityCheckParentAndChildIndexes; 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) sanityCheckParentAndChildIndexes:(id<ANTLRTree>) parent At:(NSInteger) i; 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getChildIndex; 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setChildIndex:(NSInteger)i; 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) hasAncestor:(NSInteger) ttype; 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRTree>)getAncestor:(NSInteger)ttype; 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSMutableArray *)getAncestors; 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) copyWithZone:(NSZone *)aZone; 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) deepCopy; // performs a deepCopyWithZone: with the default zone 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) deepCopyWithZone:(NSZone *)aZone; 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // Return a token type; needed for tree parsing 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getType; 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) getText; 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // In case we don't have a token payload, what is the line for errors? 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getLine; 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getCharPositionInLine; 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setCharPositionInLine:(NSInteger)pos; 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) treeDescription; 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) description; 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toString; 167324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toStringTree; 168324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 169324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 170324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 171324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRTreeNavigationNode : ANTLRBaseTree { 172324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 173324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) copyWithZone:(NSZone *)aZone; 174324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 175324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 176324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRTreeNavigationNodeDown : ANTLRTreeNavigationNode { 177324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 178324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTreeNavigationNodeDown *) getNavigationNodeDown; 179324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) tokenType; 180324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) description; 181324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 182324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 183324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRTreeNavigationNodeUp : ANTLRTreeNavigationNode { 184324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 185324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTreeNavigationNodeUp *) getNavigationNodeUp; 186324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) tokenType; 187324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) description; 188324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 189324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 190324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRTreeNavigationNodeEOF : ANTLRTreeNavigationNode { 191324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 192324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTreeNavigationNodeEOF *) getNavigationNodeEOF; 193324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) tokenType; 194324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) description; 195324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 196324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 197324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverextern ANTLRTreeNavigationNodeDown *navigationNodeDown; 198324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverextern ANTLRTreeNavigationNodeUp *navigationNodeUp; 199324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverextern ANTLRTreeNavigationNodeEOF *navigationNodeEOF; 200