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 #import "IntStream.h" 28 29 #define CharStreamEOF -1 30 31 32 @protocol CharStream < IntStream > 33 34 /** For infinite streams, you don't need this; primarily I'm providing 35 * a useful interface for action code. Just make sure actions don't 36 * use this on streams that don't support it. 37 */ 38 - (NSString *) substringWithRange:(NSRange) theRange; 39 40 /** Get the ith character of lookahead. This is the same usually as 41 * LA(i). This will be used for labels in the generated 42 * lexer code. I'd prefer to return a char here type-wise, but it's 43 * probably better to be 32-bit clean and be consistent with LA. 44 */ 45 - (NSInteger)LT:(NSInteger) i; 46 47 // ANTLR tracks the line information automatically 48 - (NSInteger)getLine; 49 // Because this stream can rewind, we need to be able to reset the line 50 - (void)setLine:(NSInteger)aLine; 51 52 - (void)setCharPositionInLine:(NSInteger)pos; 53 54 55 // The index of the character relative to the beginning of the line 0..n-1 56 - (NSInteger)getCharPositionInLine; 57 58 @end 59