• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //
2 //  ANTLRParseTree.h
3 //  ANTLR
4 //
5 //  Created by Alan Condit on 7/12/10.
6 // [The "BSD licence"]
7 // Copyright (c) 2010 Alan Condit
8 // All rights reserved.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions
12 // are met:
13 // 1. Redistributions of source code must retain the above copyright
14 //    notice, this list of conditions and the following disclaimer.
15 // 2. Redistributions in binary form must reproduce the above copyright
16 //    notice, this list of conditions and the following disclaimer in the
17 //    documentation and/or other materials provided with the distribution.
18 // 3. The name of the author may not be used to endorse or promote products
19 //    derived from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 // IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 // NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 // THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 
32 #import <Cocoa/Cocoa.h>
33 #import "ANTLRBaseTree.h"
34 #import "ANTLRCommonToken.h"
35 
36 @interface ANTLRParseTree : ANTLRBaseTree {
37 	id<ANTLRToken> payload;
38 	NSMutableArray *hiddenTokens;
39 }
40 /** A record of the rules used to match a token sequence.  The tokens
41  *  end up as the leaves of this tree and rule nodes are the interior nodes.
42  *  This really adds no functionality, it is just an alias for CommonTree
43  *  that is more meaningful (specific) and holds a String to display for a node.
44  */
45 + (ANTLRParseTree *)newANTLRParseTree:(id<ANTLRToken>)label;
46 - (id)initWithLabel:(id<ANTLRToken>)label;
47 
48 - (id<ANTLRTree>)dupNode;
49 - (NSInteger)getType;
50 - (NSString *)getText;
51 - (NSInteger)getTokenStartIndex;
52 - (void)setTokenStartIndex:(NSInteger)index;
53 - (NSInteger)getTokenStopIndex;
54 - (void)setTokenStopIndex:(NSInteger)index;
55 - (NSString *)toString;
56 - (NSString *)toStringWithHiddenTokens;
57 - (NSString *)toInputString;
58 - (void)_toStringLeaves:(NSMutableString *)buf;
59 
60 @end
61