xref: /aosp_15_r20/external/antlr/runtime/ObjC/Framework/DFA.h (revision 16467b971bd3e2009fad32dd79016f2c7e421deb)
1 // [The "BSD licence"]
2 // Copyright (c) 2006-2007 Kay Roepke 2010 Alan Condit
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions
7 // are met:
8 // 1. Redistributions of source code must retain the above copyright
9 //    notice, this list of conditions and the following disclaimer.
10 // 2. Redistributions in binary form must reproduce the above copyright
11 //    notice, this list of conditions and the following disclaimer in the
12 //    documentation and/or other materials provided with the distribution.
13 // 3. The name of the author may not be used to endorse or promote products
14 //    derived from this software without specific prior written permission.
15 //
16 // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 // IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 // NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 // THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 
27 #import <Foundation/Foundation.h>
28 #import "BaseRecognizer.h"
29 #import "CharStream.h"
30 #import "NoViableAltException.h"
31 
32 @interface DFA : NSObject {
33 	// the tables are set by subclasses to their own static versions.
34 	const NSInteger *eot;
35 	const NSInteger *eof;
36 	const unichar *min;
37 	const unichar *max;
38 	const NSInteger *accept;
39 	const NSInteger *special;
40 	const NSInteger **transition;
41 
42 	__strong BaseRecognizer *recognizer;
43 	NSInteger decisionNumber;
44     NSInteger len;
45 }
46 
47 - (id) initWithRecognizer:(id) theRecognizer;
48 // simulate the DFA using the static tables and predict an alternative
49 - (NSInteger) predict:(id<CharStream>)anInput;
50 - (void) noViableAlt:(NSInteger)state Stream:(id<IntStream>)anInput;
51 
52 - (NSInteger) specialStateTransition:(NSInteger)state Stream:(id<IntStream>)anInput;
53 // - (NSInteger) specialStateTransition:(NSInteger) state;
54 //- (unichar) specialTransition:(unichar) state symbol:(NSInteger) symbol;
55 
56 // hook for debugger support
57 - (void) error:(NoViableAltException *)nvae;
58 
59 - (NSString *) description;
60 - (BOOL) evaluateSyntacticPredicate:(SEL)synpredFragment;
61 
62 + (void) setIsEmittingDebugInfo:(BOOL) shouldEmitDebugInfo;
63 
64 - (NSInteger *) unpackEncodedString:(NSString *)encodedString;
65 - (short *) unpackEncodedStringToUnsignedChars:(NSString *)encodedString;
66 - (NSInteger)getDecision;
67 - (void)setDecision:(NSInteger)aDecison;
68 
69 - (BaseRecognizer *)getRecognizer;
70 - (void)setRecognizer:(BaseRecognizer *)aRecognizer;
71 - (NSInteger)length;
72 
73 @property const NSInteger *eot;
74 @property const NSInteger *eof;
75 @property const unichar *min;
76 @property const unichar *max;
77 @property const NSInteger *accept;
78 @property const NSInteger *special;
79 @property const NSInteger **transition;
80 
81 @property (retain, getter=getRecognizer,setter=setRecognizer:) BaseRecognizer *recognizer;
82 @property (assign, getter=getDecision,setter=setDecision:) NSInteger decisionNumber;
83 @property (assign, getter=getLen,setter=setLen:) NSInteger len;
84 @end
85