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 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import <Cocoa/Cocoa.h> 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import <Foundation/Foundation.h> 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRIntStream.h" 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "AMutableArray.h" 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// This is an abstract superclass for lexers and parsers. 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define ANTLR_MEMO_RULE_FAILED -2 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define ANTLR_MEMO_RULE_UNKNOWN -1 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define ANTLR_INITIAL_FOLLOW_STACK_SIZE 100 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRMapElement.h" 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRBitSet.h" 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRToken.h" 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRRecognizerSharedState.h" 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRRecognitionException.h" 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRMissingTokenException.h" 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRMismatchedTokenException.h" 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRMismatchedTreeNodeException.h" 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRUnwantedTokenException.h" 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRNoViableAltException.h" 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLREarlyExitException.h" 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRMismatchedSetException.h" 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRMismatchedNotSetException.h" 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRFailedPredicateException.h" 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRBaseRecognizer : NSObject { 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver __strong ANTLRRecognizerSharedState *state; // the state of this recognizer. Might be shared with other recognizers, e.g. in grammar import scenarios. 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver __strong NSString *grammarFileName; // where did the grammar come from. filled in by codegeneration 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver __strong NSString *sourceName; 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver __strong AMutableArray *tokenNames; 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (void) initialize; 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBaseRecognizer *) newANTLRBaseRecognizer; 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBaseRecognizer *) newANTLRBaseRecognizerWithRuleLen:(NSInteger)aLen; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRBaseRecognizer *) newANTLRBaseRecognizer:(ANTLRRecognizerSharedState *)aState; 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (AMutableArray *)getTokenNames; 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (void)setTokenNames:(NSArray *)aTokNamArray; 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (void)setGrammarFileName:(NSString *)aFileName; 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) init; 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithLen:(NSInteger)aLen; 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithState:(ANTLRRecognizerSharedState *)aState; 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) dealloc; 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// simple accessors 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getBacktrackingLevel; 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setBacktrackingLevel:(NSInteger) level; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) getFailed; 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setFailed: (BOOL) flag; 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRRecognizerSharedState *) getState; 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) setState:(ANTLRRecognizerSharedState *) theState; 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// reset this recognizer - might be extended by codegeneration/grammar 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) reset; 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Match needs to return the current input symbol, which gets put 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * into the label for the associated token ref; e.g., x=ID. Token 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * and tree parsers need to return different objects. Rather than test 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * for input stream type or change the IntStream interface, I use 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * a simple method to ask the recognizer to tell me what the current 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * input symbol is. 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This is ignored for lexers. 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) input; 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void)skip; 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// do actual matching of tokens/characters 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) match:(id<ANTLRIntStream>)anInput TokenType:(NSInteger)ttype Follow:(ANTLRBitSet *)follow; 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) matchAny:(id<ANTLRIntStream>)anInput; 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) mismatchIsUnwantedToken:(id<ANTLRIntStream>)anInput TokenType:(NSInteger) ttype; 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) mismatchIsMissingToken:(id<ANTLRIntStream>)anInput Follow:(ANTLRBitSet *)follow; 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// error reporting and recovery 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) reportError:(ANTLRRecognitionException *)e; 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) displayRecognitionError:(AMutableArray *)theTokNams Exception:(ANTLRRecognitionException *)e; 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)getErrorMessage:(ANTLRRecognitionException *)e TokenNames:(AMutableArray *)theTokNams; 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getNumberOfSyntaxErrors; 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)getErrorHeader:(ANTLRRecognitionException *)e; 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)getTokenErrorDisplay:(id<ANTLRToken>)t; 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) emitErrorMessage:(NSString *)msg; 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) recover:(id<ANTLRIntStream>)anInput Exception:(ANTLRRecognitionException *)e; 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// begin hooks for debugger 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) beginResync; 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) endResync; 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// end hooks for debugger 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// compute the bitsets necessary to do matching and recovery 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRBitSet *)computeErrorRecoverySet; 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRBitSet *)computeContextSensitiveRuleFOLLOW; 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRBitSet *)combineFollows:(BOOL) exact; 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRToken>) recoverFromMismatchedToken:(id<ANTLRIntStream>)anInput 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver TokenType:(NSInteger)ttype 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Follow:(ANTLRBitSet *)follow; 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id<ANTLRToken>)recoverFromMismatchedSet:(id<ANTLRIntStream>)anInput 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Exception:(ANTLRRecognitionException *)e 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Follow:(ANTLRBitSet *)follow; 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) getCurrentInputSymbol:(id<ANTLRIntStream>)anInput; 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) getMissingSymbol:(id<ANTLRIntStream>)anInput 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Exception:(ANTLRRecognitionException *)e 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver TokenType:(NSInteger) expectedTokenType 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Follow:(ANTLRBitSet *)follow; 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// helper methods for recovery. try to resync somewhere 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) consumeUntilTType:(id<ANTLRIntStream>)anInput TokenType:(NSInteger)ttype; 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) consumeUntilFollow:(id<ANTLRIntStream>)anInput Follow:(ANTLRBitSet *)bitSet; 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) pushFollow:(ANTLRBitSet *)fset; 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRBitSet *)popFollow; 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// to be used by the debugger to do reporting. maybe hook in incremental stuff here, too. 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (AMutableArray *) getRuleInvocationStack; 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (AMutableArray *) getRuleInvocationStack:(ANTLRRecognitionException *)exception 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Recognizer:(NSString *)recognizerClassName; 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (AMutableArray *) getTokenNames; 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)getGrammarFileName; 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)getSourceName; 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (AMutableArray *) toStrings:(NSArray *)tokens; 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// support for memoization 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getRuleMemoization:(NSInteger)ruleIndex StartIndex:(NSInteger)ruleStartIndex; 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) alreadyParsedRule:(id<ANTLRIntStream>)anInput RuleIndex:(NSInteger)ruleIndex; 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) memoize:(id<ANTLRIntStream>)anInput 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver RuleIndex:(NSInteger)ruleIndex 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver StartIndex:(NSInteger)ruleStartIndex; 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) getRuleMemoizationCacheSize; 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void)traceIn:(NSString *)ruleName Index:(NSInteger)ruleIndex Object:(id)inputSymbol; 167324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void)traceOut:(NSString *)ruleName Index:(NSInteger)ruleIndex Object:(id)inputSymbol; 168324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 169324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 170324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// support for syntactic predicates. these are called indirectly to support funky stuff in grammars, 171324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// like supplying selectors instead of writing code directly into the actions of the grammar. 172324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (BOOL) evaluateSyntacticPredicate:(SEL)synpredFragment; 173324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// stream:(id<ANTLRIntStream>)anInput; 174324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 175324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain) ANTLRRecognizerSharedState *state; 176324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain) NSString *grammarFileName; 177324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain) NSString *sourceName; 178324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain) AMutableArray *tokenNames; 179324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 180324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 181