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 "ANTLRTreeAdaptor.h" 29 30// TODO: this should be separated into stream and enumerator classes 31@interface ANTLRRewriteRuleElementStream : NSObject { 32 NSInteger cursor; 33 BOOL dirty; ///< indicates whether the stream should return copies of its elements, set to true after a call to -reset 34 BOOL isSingleElement; 35 id singleElement; 36 __strong AMutableArray *elements; 37 38 __strong NSString *elementDescription; 39 __strong id<ANTLRTreeAdaptor> treeAdaptor; 40} 41 42@property (assign) NSInteger cursor; 43@property (assign) BOOL dirty; 44@property (assign) BOOL isSingleElement; 45@property (assign) id singleElement; 46@property (assign) AMutableArray *elements; 47@property (assign) NSString *elementDescription; 48@property (retain) id<ANTLRTreeAdaptor> treeAdaptor; 49 50+ (ANTLRRewriteRuleElementStream*) newANTLRRewriteRuleElementStream:(id<ANTLRTreeAdaptor>)aTreeAdaptor 51 description:(NSString *)anElementDescription; 52+ (ANTLRRewriteRuleElementStream*) newANTLRRewriteRuleElementStream:(id<ANTLRTreeAdaptor>)aTreeAdaptor 53 description:(NSString *)anElementDescription 54 element:(id)anElement; 55+ (ANTLRRewriteRuleElementStream*) newANTLRRewriteRuleElementStream:(id<ANTLRTreeAdaptor>)aTreeAdaptor 56 description:(NSString *)anElementDescription 57 elements:(NSArray *)theElements; 58 59- (id) initWithTreeAdaptor:(id<ANTLRTreeAdaptor>)aTreeAdaptor description:(NSString *)anElementDescription; 60- (id) initWithTreeAdaptor:(id<ANTLRTreeAdaptor>)aTreeAdaptor description:(NSString *)anElementDescription element:(id)anElement; 61- (id) initWithTreeAdaptor:(id<ANTLRTreeAdaptor>)aTreeAdaptor description:(NSString *)anElementDescription elements:(NSArray *)theElements; 62 63- (void)reset; 64 65- (id<ANTLRTreeAdaptor>) getTreeAdaptor; 66- (void) setTreeAdaptor:(id<ANTLRTreeAdaptor>)aTreeAdaptor; 67 68- (void) addElement:(id)anElement; 69- (NSInteger) size; 70 71- (BOOL) hasNext; 72- (id<ANTLRBaseTree>) nextTree; 73- (id<ANTLRBaseTree>) _next; // internal: TODO: redesign if necessary. maybe delegate 74 75- (id) copyElement:(id)element; 76- (id) toTree:(id)element; 77 78- (NSString *) getDescription; 79- (void) setDescription:(NSString *)description; 80 81@end 82 83