1 // 2 // ParseTree.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 <Foundation/Foundation.h> 33 #import "BaseTree.h" 34 #import "CommonToken.h" 35 #import "AMutableArray.h" 36 37 @interface ParseTree : BaseTree <BaseTree> { 38 __strong id<Token> payload; 39 __strong AMutableArray *hiddenTokens; 40 } 41 /** A record of the rules used to match a token sequence. The tokens 42 * end up as the leaves of this tree and rule nodes are the interior nodes. 43 * This really adds no functionality, it is just an alias for CommonTree 44 * that is more meaningful (specific) and holds a String to display for a node. 45 */ 46 + (id<BaseTree>)newParseTree:(id<Token>)label; 47 - (id)initWithLabel:(id<Token>)label; 48 49 - (id<BaseTree>)dupNode; 50 - (NSInteger)type; 51 - (NSString *)text; 52 - (NSInteger)getTokenStartIndex; 53 - (void)setTokenStartIndex:(NSInteger)index; 54 - (NSInteger)getTokenStopIndex; 55 - (void)setTokenStopIndex:(NSInteger)index; 56 - (NSString *)description; 57 - (NSString *)toString; 58 - (NSString *)toStringWithHiddenTokens; 59 - (NSString *)toInputString; 60 - (void)_toStringLeaves:(NSMutableString *)buf; 61 62 @property (retain) id<Token> payload; 63 @property (retain) AMutableArray *hiddenTokens; 64 @end 65