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