Home | History | Annotate | Download | only in Headers 
      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 
     28 #import <Cocoa/Cocoa.h>
     29 
     30 typedef enum {
     31 	ANTLRTokenTypeEOF = -1,
     32 	ANTLRTokenTypeInvalid,
     33 	ANTLRTokenTypeEOR,
     34 	ANTLRTokenTypeDOWN,
     35 	ANTLRTokenTypeUP,
     36 	ANTLRTokenTypeMIN
     37 } ANTLRTokenType;
     38 
     39 typedef enum {
     40 	ANTLRTokenChannelDefault = 0,
     41     ANTLRTokenChannelHidden = 99
     42 } ANTLRTokenChannel;
     43 
     44 #define HIDDEN 99
     45 
     46 @protocol ANTLRToken < NSObject, NSCopying >
     47 
     48 // The singleton eofToken instance.
     49 + (id<ANTLRToken>) eofToken;
     50 // The default channel for this class of Tokens
     51 + (ANTLRTokenChannel) defaultChannel;
     52 
     53 // provide hooks to explicitely set the text as opposed to use the indices into the CharStream
     54 - (NSString *) getText;
     55 - (void) setText:(NSString *) theText;
     56 
     57 - (NSInteger) getType;
     58 - (void) setType: (NSInteger) aType;
     59 
     60 // ANTLR v3 provides automatic line and position tracking. Subclasses do not need to
     61 // override these, if they do not want to store line/pos tracking information
     62 - (NSUInteger) getLine;
     63 - (void) setLine: (NSUInteger) aLine;
     64 
     65 - (NSUInteger) getCharPositionInLine;
     66 - (void) setCharPositionInLine: (NSUInteger) aCharPositionInLine;
     67 
     68 // explicitely change the channel this Token is on. The default parser implementation
     69 // just sees the defaultChannel
     70 // Common idiom is to put whitespace tokens on channel 99.
     71 - (NSUInteger) getChannel;
     72 - (void) setChannel: (NSUInteger) aChannel;
     73 
     74 // the index of this Token into the TokenStream
     75 - (NSUInteger) getTokenIndex;
     76 - (void) setTokenIndex: (NSUInteger) aTokenIndex;
     77 - (NSString *)toString;
     78 
     79 @end
     80