1//
2//  ANTLRTreeIterator.h
3//  ANTLR
4//
5//  Created by Ian Michell on 26/04/2010.
6// [The "BSD licence"]
7// Copyright (c) 2010 Ian Michell 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 "ANTLRCommonTreeAdaptor.h"
34#import "ANTLRFastQueue.h"
35#import "ANTLRTreeAdaptor.h"
36#import "ANTLRTree.h"
37
38@interface ANTLRTreeIterator : NSObject
39{
40	BOOL firstTime;
41	__strong id<ANTLRTreeAdaptor> adaptor;
42	__strong id<ANTLRBaseTree> root;
43	__strong id<ANTLRBaseTree> tree;
44
45	__strong ANTLRFastQueue *nodes;
46	__strong id<ANTLRBaseTree> up;
47	__strong id<ANTLRBaseTree> down;
48	__strong id<ANTLRBaseTree> eof;
49}
50
51@property BOOL firstTime;
52@property(retain) id<ANTLRTreeAdaptor> adaptor;
53@property(retain) id<ANTLRBaseTree> root;
54@property(retain) id<ANTLRBaseTree> tree;
55@property(retain) ANTLRFastQueue *nodes;
56@property(retain, readwrite) id<ANTLRBaseTree> up;
57@property(retain, readwrite) id<ANTLRBaseTree> down;
58@property(retain, readwrite) id<ANTLRBaseTree> eof;
59
60+ newANTRLTreeIterator;
61+ (ANTLRTreeIterator *) newANTRLTreeIteratorWithAdaptor:(ANTLRCommonTreeAdaptor *)adaptor
62                                                andTree:(id<ANTLRBaseTree>)tree;
63- (id) init;
64- (id) initWithTree:(id<ANTLRBaseTree>) t;
65- (id) initWithTreeAdaptor:(id<ANTLRTreeAdaptor>) a andTree:(id<ANTLRBaseTree>) t;
66
67- (void) reset;
68- (BOOL) hasNext;
69- (id) nextObject;
70- (NSArray *) allObjects;
71
72@end
73