xref: /external/antlr/antlr-3.4/runtime/ObjC/Framework/ANTLRUnbufferedTokenStream.h

//
//  ANTLRUnbufferedTokenStream.h
//  ANTLR
//
//  Created by Alan Condit on 7/12/10.
// [The "BSD licence"]
// Copyright (c) 2010 Alan Condit
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. The name of the author may not be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#import <Cocoa/Cocoa.h>
#import "ANTLRRuntimeException.h"
#import "ANTLRTokenSource.h"
#import "ANTLRLookaheadStream.h"
#import "ANTLRToken.h"

@interface ANTLRUnbufferedTokenStream : ANTLRLookaheadStream {
	id<ANTLRTokenSource> tokenSource;
    NSInteger tokenIndex; // simple counter to set token index in tokens
    NSInteger channel;
}

@property (retain, getter=getTokenSource, setter=setTokenSource:) id<ANTLRTokenSource> tokenSource;
@property (getter=getTokenIndex, setter=setTokenIndex:) NSInteger tokenIndex;
@property (getter=channel, setter=setChannel:) NSInteger channel;

+ (ANTLRUnbufferedTokenStream *)newANTLRUnbufferedTokenStream:(id<ANTLRTokenSource>)aTokenSource;
- (id) init;
- (id) initWithTokenSource:(id<ANTLRTokenSource>)aTokenSource;

- (id<ANTLRToken>)nextElement;
- (BOOL)isEOF:(id<ANTLRToken>) aToken;
- (id<ANTLRTokenSource>)getTokenSource;
- (NSString *)toStringFromStart:(NSInteger)aStart ToEnd:(NSInteger)aStop;
- (NSString *)toStringFromToken:(id<ANTLRToken>)aStart ToEnd:(id<ANTLRToken>)aStop;
- (NSInteger)LA:(NSInteger)anIdx;
- (id<ANTLRToken>)objectAtIndex:(NSInteger)anIdx;
- (NSString *)getSourceName;


@end