// [The "BSD licence"]
// Copyright (c) 2006-2007 Kay Roepke 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 <Foundation/Foundation.h>
#import "Token.h"
#import "CharStream.h"

@interface CommonToken : NSObject < Token > {
	__strong NSString *text;
	NSInteger type;
	// information about the Token's position in the input stream
	NSUInteger line;
	NSUInteger charPositionInLine;
	NSUInteger channel;
	// this token's position in the TokenStream
	NSInteger index;
	
	// indices into the CharStream to avoid copying the text
	// can manually override the text by using -setText:
	NSInteger startIndex;
	NSInteger stopIndex;
	// the actual input stream this token was found in
	__strong id<CharStream> input;
}

+ (void) initialize;
+ (NSInteger) DEFAULT_CHANNEL;
+ (id<Token>)INVALID_TOKEN;
+ (NSInteger) INVALID_TOKEN_TYPE;
+ (id<Token>) newToken;
+ (id<Token>) newToken:(id<CharStream>)anInput
                       Type:(NSInteger)aTType
                    Channel:(NSInteger)aChannel
                      Start:(NSInteger)aStart
                       Stop:(NSInteger)aStop;
+ (id<Token>) newToken:(TokenType)aType;
+ (id<Token>) newToken:(NSInteger)tokenType Text:(NSString *)tokenText;
+ (id<Token>) newTokenWithToken:(CommonToken *)fromToken;
+ (id<Token>) eofToken;
+ (id<Token>) skipToken;
+ (id<Token>) invalidToken;
+ (TokenChannel) defaultChannel;

// designated initializer. This is used as the default way to initialize a Token in the generated code.
- (id) init;
- (id) initWithInput:(id<CharStream>)anInput
                                Type:(NSInteger)aTType
                             Channel:(NSInteger)aChannel
                               Start:(NSInteger)theStart
                                Stop:(NSInteger)theStop;
- (id) initWithToken:(id<Token>)aToken;
- (id) initWithType:(TokenType)aType;
- (id) initWithType:(TokenType)aTType Text:(NSString *)tokenText;

//---------------------------------------------------------- 
//  text 
//---------------------------------------------------------- 
- (NSString *)text;
- (void) setText:(NSString *)aText;

//---------------------------------------------------------- 
//  charPositionInLine 
//---------------------------------------------------------- 
- (NSUInteger) getCharPositionInLine;
- (void) setCharPositionInLine:(NSUInteger)aCharPositionInLine;

//---------------------------------------------------------- 
//  line 
//---------------------------------------------------------- 
- (NSUInteger) getLine;
- (void) setLine:(NSUInteger)aLine;

//---------------------------------------------------------- 
//  type 
//---------------------------------------------------------- 
- (NSInteger)type;
- (void) setType:(NSInteger)aType;

//---------------------------------------------------------- 
//  channel 
//---------------------------------------------------------- 
- (NSUInteger)channel;
- (void) setChannel:(NSUInteger)aChannel;

//---------------------------------------------------------- 
//  input 
//---------------------------------------------------------- 
- (id<CharStream>)input;
- (void) setInput:(id<CharStream>)anInput;

- (NSInteger)getStart;
- (void) setStart: (NSInteger)aStart;

- (NSInteger)getStop;
- (void) setStop: (NSInteger) aStop;

// the index of this Token into the TokenStream
- (NSInteger)getTokenIndex;
- (void) setTokenIndex:(NSInteger)aTokenIndex;

// conform to NSCopying
- (id) copyWithZone:(NSZone *)theZone;

- (NSString *) description;
- (NSString *) toString;

@property (retain, getter = text, setter = setText:) NSString *text;
@property (assign) NSInteger type;
@property (assign, getter = line, setter = setLine:) NSUInteger line;
@property (assign, getter=charPositionInLine, setter = setCharPositionInLine:) NSUInteger charPositionInLine;
@property (assign) NSUInteger channel;
@property (assign) NSInteger index;
@property (assign, getter=getStart, setter=setStart:) NSInteger startIndex;
@property (assign, getter=getStop, setter=setStop:) NSInteger stopIndex;
@property (retain) id<CharStream> input;

@end