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 <Cocoa/Cocoa.h>
28 #import "ANTLRBaseRecognizer.h"
29 #import "ANTLRTreeNodeStream.h"
30 #import "ANTLRCommonTreeAdaptor.h"
31 #import "ANTLRMismatchedTreeNodeException.h"
32 
33 @interface ANTLRTreeParser : ANTLRBaseRecognizer {
34 	id<ANTLRTreeNodeStream> input;
35 }
36 
37 @property (retain, getter=getInput, setter=setInput:) id<ANTLRTreeNodeStream> input;
38 
39 + (id) newANTLRTreeParser:(id<ANTLRTreeNodeStream>)anInput;
40 + (id) newANTLRTreeParser:(id<ANTLRTreeNodeStream>)anInput State:(ANTLRRecognizerSharedState *)state;
41 
42 - (id) initWithStream:(id<ANTLRTreeNodeStream>)theInput;
43 - (id) initWithStream:(id<ANTLRTreeNodeStream>)theInput
44                 State:(ANTLRRecognizerSharedState *)state;
45 
46 
47 - (id<ANTLRTreeNodeStream>)getInput;
48 - (void) setInput:(id<ANTLRTreeNodeStream>)anInput;
49 
50 - (void) setTreeNodeStream:(id<ANTLRTreeNodeStream>) anInput;
51 - (id<ANTLRTreeNodeStream>) getTreeNodeStream;
52 
53 - (NSString *)getSourceName;
54 
55 - (id) getCurrentInputSymbol:(id<ANTLRIntStream>) anInput;
56 
57 - (id) getMissingSymbol:(id<ANTLRIntStream>)input
58               Exception:(ANTLRRecognitionException *) e
59           ExpectedToken:(NSInteger) expectedTokenType
60                  BitSet:(ANTLRBitSet *)follow;
61 
62 /** Match '.' in tree parser has special meaning.  Skip node or
63  *  entire tree if node has children.  If children, scan until
64  *  corresponding UP node.
65  */
66 - (void) matchAny:(id<ANTLRIntStream>)ignore;
67 
68 /** We have DOWN/UP nodes in the stream that have no line info; override.
69  *  plus we want to alter the exception type.  Don't try to recover
70  *  from tree parser errors inline...
71  */
72 - (id) recoverFromMismatchedToken:(id<ANTLRIntStream>)anInput
73                              Type:(NSInteger)ttype
74                            Follow:(ANTLRBitSet *)follow;
75 
76 /** Prefix error message with the grammar name because message is
77  *  always intended for the programmer because the parser built
78  *  the input tree not the user.
79  */
80 - (NSString *)getErrorHeader:(ANTLRRecognitionException *)e;
81 
82 - (NSString *)getErrorMessage:(ANTLRRecognitionException *)e TokenNames:(NSArray *) tokenNames;
83 
84 - (void) traceIn:(NSString *)ruleName Index:(NSInteger)ruleIndex;
85 - (void) traceOut:(NSString *)ruleName Index:(NSInteger)ruleIndex;
86 
87 
88 
89 @end
90