Home | History | Annotate | Download | only in Framework
      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 #import "ANTLRCharStream.h"
     30 #import "ANTLRCharStreamState.h"
     31 #import "ANTLRPtrBuffer.h"
     32 
     33 @interface ANTLRStringStream : NSObject < ANTLRCharStream > {
     34 	NSString *data;
     35 	NSInteger n;
     36 	NSInteger index;
     37 	NSUInteger line;
     38 	NSUInteger charPositionInLine;
     39 	NSInteger markDepth;
     40 	ANTLRPtrBuffer *markers;
     41 	NSInteger lastMarker;
     42 	NSString *name;
     43     ANTLRCharStreamState *charState;
     44 }
     45 
     46 + newANTLRStringStream;
     47 
     48 + newANTLRStringStream:(NSString *)aString;
     49 
     50 + newANTLRStringStream:(char *)myData Count:(NSInteger)numBytes;
     51 
     52 - (id) init;
     53 
     54 // this initializer copies the string
     55 - (id) initWithString:(NSString *) theString;
     56 
     57 // This is the preferred constructor as no data is copied
     58 - (id) initWithStringNoCopy:(NSString *) theString;
     59 
     60 - (id) initWithData:(char *)myData Count:(NSInteger)numBytes;
     61 
     62 - (void) dealloc;
     63 
     64 - (id) copyWithZone:(NSZone *)aZone;
     65 
     66 // reset the stream's state, but keep the data to feed off
     67 - (void) reset;
     68 // consume one character from the stream
     69 - (void) consume;
     70 
     71 // look ahead i characters
     72 - (NSInteger) LA:(NSInteger) i;
     73 - (NSInteger) LT:(NSInteger) i;
     74 
     75 // total length of the input data
     76 - (NSInteger) size;
     77 
     78 // seek and rewind in the stream
     79 - (NSInteger) mark;
     80 - (void) rewind:(NSInteger) marker;
     81 - (void) rewind;
     82 - (void) release:(NSInteger) marker;
     83 - (void) seek:(NSInteger) index;
     84 
     85 // provide the streams data (e.g. for tokens using indices)
     86 - (NSString *) substring:(NSInteger)startIndex To:(NSInteger)stopIndex;
     87 - (NSString *) substringWithRange:(NSRange) theRange;
     88 
     89 - (ANTLRPtrBuffer *)getMarkers;
     90 - (void) setMarkers:(ANTLRPtrBuffer *)aMarkerList;
     91 
     92 - (NSString *)getSourceName;
     93 
     94 - (NSString *)toString;
     95 
     96 // accessors to the raw data of this stream
     97 
     98 @property (retain) NSString *data;
     99 @property (assign) NSInteger index;
    100 @property (assign) NSInteger n;
    101 @property (assign) NSUInteger line;
    102 @property (assign) NSUInteger charPositionInLine;
    103 @property (assign) NSInteger markDepth;
    104 @property (retain) ANTLRPtrBuffer *markers;
    105 @property (assign) NSInteger lastMarker;
    106 @property (retain) NSString *name;
    107 @property (retain) ANTLRCharStreamState *charState;
    108 
    109 @end
    110