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@protocol ANTLRTree < NSObject, NSCopying > 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//+ (id<ANTLRTree>) invalidNode; 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRTree>) getChild:(NSUInteger)index; 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSUInteger) getChildCount; 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Tree tracks parent and child index now > 3.0 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRTree>)getParent; 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setParent:(id<ANTLRTree>)t; 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Is there is a node above with token type ttype? */ 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) hasAncestor:(NSInteger)ttype; 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Walk upwards and get first ancestor with this token type. */ 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRTree>) getAncestor:(NSInteger) ttype; 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Return a list of all ancestors of this node. The first node of 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * list is the root and the last is the parent of this node. 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSMutableArray *) getAncestors; 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** This node is what child index? 0..n-1 */ 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getChildIndex; 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setChildIndex:(NSInteger) index; 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Set the parent and child index values for all children */ 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) freshenParentAndChildIndexes; 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Add t as a child to this node. If t is null, do nothing. If t 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * is nil, add all children of t to this' children. 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) addChild:(id<ANTLRTree>) t; 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Set ith child (0..n-1) to t; t must be non-null and non-nil node */ 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setChild:(NSInteger)i With:(id<ANTLRTree>) t; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) deleteChild:(NSInteger) i; 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Delete children from start to stop and replace with t even if t is 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * a list (nil-root tree). num of children can increase or decrease. 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * For huge child lists, inserting children can force walking rest of 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * children to set their childindex; could be slow. 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) replaceChildrenFrom:(NSInteger)startChildIndex To:(NSInteger)stopChildIndex With:(id)t; 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSArray *) getChildren; 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Add t as a child to this node. If t is null, do nothing. If t 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// is nil, add all children of t to this' children. 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) addChildren:(NSArray *) theChildren; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//- (void) removeAllChildren; 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Indicates the node is a nil node but may still have children, meaning 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// the tree is a flat list. 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) isNil; 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** What is the smallest token index (indexing from 0) for this node 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * and its children? 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getTokenStartIndex; 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setTokenStartIndex:(NSInteger) index; 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** What is the largest token index (indexing from 0) for this node 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * and its children? 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getTokenStopIndex; 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setTokenStopIndex:(NSInteger) index; 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRTree>) dupNode; 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) toString; 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark Copying 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) copyWithZone:(NSZone *)aZone; // the children themselves are not copied here! 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) deepCopy; // performs a deepCopyWithZone: with the default zone 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) deepCopyWithZone:(NSZone *)aZone; 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark Tree Parser support 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getType; 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) getText; 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// In case we don't have a token payload, what is the line for errors? 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getLine; 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getCharPositionInLine; 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setCharPositionInLine:(NSInteger)pos; 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#pragma mark Informational 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) treeDescription; 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *) description; 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 124