1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// ANTLRTreeWizard.h 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// ANTLR 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Created by Alan Condit on 6/18/10. 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// [The "BSD licence"] 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Copyright (c) 2010 Alan Condit 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// All rights reserved. 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Redistribution and use in source and binary forms, with or without 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// modification, are permitted provided that the following conditions 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// are met: 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 1. Redistributions of source code must retain the above copyright 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer. 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 2. Redistributions in binary form must reproduce the above copyright 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer in the 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// documentation and/or other materials provided with the distribution. 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 3. The name of the author may not be used to endorse or promote products 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// derived from this software without specific prior written permission. 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import <Cocoa/Cocoa.h> 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRCommonTreeAdaptor.h" 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRCommonTree.h" 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRMapElement.h" 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRMap.h" 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@class ANTLRVisitor; 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@protocol ANTLRContextVisitor <NSObject> 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// TODO: should this be called visit or something else? 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) visit:(id<ANTLRTree>)t Parent:(id<ANTLRTree>)parent ChildIndex:(NSInteger)childIndex Map:(ANTLRMap *)labels; 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRVisitor : NSObject <ANTLRContextVisitor> { 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger action; 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver id actor; 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver id object1; 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver id object2; 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRVisitor *)newANTLRVisitor:(NSInteger)anAction Actor:(id)anActor Object:(id)anObject1 Object:(id)anObject2; 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithAction:(NSInteger)anAction Actor:(id)anActor Object:(id)anObject1 Object:(id)anObject2; 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) visit:(id<ANTLRTree>)t; 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) visit:(id<ANTLRTree>)t Parent:(id<ANTLRTree>)parent ChildIndex:(NSInteger)childIndex Map:(ANTLRMap *)labels; 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** When using %label:TOKENNAME in a tree for parse(), we must 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * track the label. 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRTreePattern : ANTLRCommonTree { 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSString *label; 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver BOOL hasTextArg; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getLabel, setter=setLabel:) NSString *label; 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (assign, getter=getHasTextArg, setter=setHasTextArg:) BOOL hasTextArg; 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTreePattern *)newANTLRTreePattern:(id<ANTLRToken>)payload; 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithToken:(id<ANTLRToken>)payload; 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)toString; 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRWildcardTreePattern : ANTLRTreePattern { 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRWildcardTreePattern *)newANTLRWildcardTreePattern:(id<ANTLRToken>)payload; 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithToken:(id<ANTLRToken>)payload; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** This adaptor creates TreePattern objects for use during scan() */ 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRTreePatternTreeAdaptor : ANTLRCommonTreeAdaptor { 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTreePatternTreeAdaptor *)newTreeAdaptor; 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#ifdef DONTUSENOMO 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTreePatternTreeAdaptor *)newTreeAdaptor:(id<ANTLRToken>)payload; 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#endif 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) init; 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#ifdef DONTUSENOMO 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- initWithToken:(id<ANTLRToken>)payload; 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#endif 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRTree>)createTreePattern:(id<ANTLRToken>)payload; 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRTreeWizard : NSObject { 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver id<ANTLRTreeAdaptor> adaptor; 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLRMap *tokenNameToTypeMap; 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTreeWizard *) newANTLRTreeWizard:(id<ANTLRTreeAdaptor>)anAdaptor; 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTreeWizard *)newANTLRTreeWizard:(id<ANTLRTreeAdaptor>)adaptor Map:(ANTLRMap *)aTokenNameToTypeMap; 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTreeWizard *)newANTLRTreeWizard:(id<ANTLRTreeAdaptor>)adaptor TokenNames:(NSArray *)theTokNams; 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTreeWizard *)newANTLRTreeWizardWithTokenNames:(NSArray *)theTokNams; 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) init; 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithAdaptor:(id<ANTLRTreeAdaptor>)adaptor; 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithAdaptor:(id<ANTLRTreeAdaptor>)adaptor Map:(ANTLRMap *)tokenNameToTypeMap; 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithTokenNames:(NSArray *)theTokNams; 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithTokenNames:(id<ANTLRTreeAdaptor>)anAdaptor TokenNames:(NSArray *)theTokNams; 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRMap *)computeTokenTypes:(NSArray *)theTokNams; 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger)getTokenType:(NSString *)tokenName; 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRMap *)index:(id<ANTLRTree>)t; 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) _index:(id<ANTLRTree>)t Map:(ANTLRMap *)m; 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSMutableArray *)find:(id<ANTLRTree>) t Pattern:(NSString *)pattern; 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRTreeWizard *)findFirst:(id<ANTLRTree>) t Type:(NSInteger)ttype; 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRTreeWizard *)findFirst:(id<ANTLRTree>) t Pattern:(NSString *)pattern; 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) visit:(id<ANTLRTree>)t Type:(NSInteger)ttype Visitor:(ANTLRVisitor *)visitor; 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) _visit:(id<ANTLRTree>)t 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Parent:(id<ANTLRTree>)parent 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ChildIndex:(NSInteger)childIndex 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Type:(NSInteger)ttype 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Visitor:(ANTLRVisitor *)visitor; 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void)visit:(id<ANTLRTree>)t Pattern:(NSString *)pattern Visitor:(ANTLRVisitor *)visitor; 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL)parse:(id<ANTLRTree>)t Pattern:(NSString *)pattern Map:(ANTLRMap *)labels; 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) parse:(id<ANTLRTree>) t Pattern:(NSString *)pattern; 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) _parse:(id<ANTLRTree>)t1 Pattern:(ANTLRTreePattern *)tpattern Map:(ANTLRMap *)labels; 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRTree>) createTree:(NSString *)pattern; 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL)equals:(id)t1 O2:(id)t2 Adaptor:(id<ANTLRTreeAdaptor>)anAdaptor; 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL)equals:(id)t1 O2:(id)t2; 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) _equals:(id)t1 O2:(id)t2 Adaptor:(id<ANTLRTreeAdaptor>)anAdaptor; 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 135