1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** \file 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Defines the the class interface for an antlr3 INTSTREAM. 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Certain functionality (such as DFAs for instance) abstract the stream of tokens 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * or characters in to a steam of integers. Hence this structure should be included 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * in any stream that is able to provide the output as a stream of integers (which is anything 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * basically. 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * There are no specific implementations of the methods in this interface in general. Though 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * for purposes of casting and so on, it may be necesssary to implement a function with 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the signature in this interface which abstracts the base immplementation. In essence though 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the base stream provides a pointer to this interface, within which it installs its 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * normal match() functions and so on. Interaces such as DFA are then passed the pANTLR3_INT_STREAM 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * and can treat any input as an int stream. 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * For instance, a lexer implements a pANTLR3_BASE_RECOGNIZER, within which there is a pANTLR3_INT_STREAM. 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * However, a pANTLR3_INPUT_STREAM also provides a pANTLR3_INT_STREAM, which it has constructed from 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * it's normal interface when it was created. This is then pointed at by the pANTLR_BASE_RECOGNIZER 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * when it is intialized with a pANTLR3_INPUT_STREAM. 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Similarly if a pANTLR3_BASE_RECOGNIZER is initialized with a pANTLR3_TOKEN_STREAM, then the 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * pANTLR3_INT_STREAM is taken from the pANTLR3_TOKEN_STREAM. 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * If a pANTLR3_BASE_RECOGNIZER is initialized with a pANTLR3_TREENODE_STREAM, then guess where 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the pANTLR3_INT_STREAM comes from? 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Note that because the context pointer points to the actual interface structure that is providing 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the ANTLR3_INT_STREAM it is defined as a (void *) in this interface. There is no direct implementation 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * of an ANTLR3_INT_STREAM (unless someone did not understand what I was doing here =;?P 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#ifndef _ANTLR3_INTSTREAM_H 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define _ANTLR3_INTSTREAM_H 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// [The "BSD licence"] 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Copyright (c) 2005-2009 Jim Idle, Temporal Wave LLC 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// http://www.temporal-wave.com 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// http://www.linkedin.com/in/jimidle 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// All rights reserved. 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Redistribution and use in source and binary forms, with or without 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// modification, are permitted provided that the following conditions 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// are met: 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 1. Redistributions of source code must retain the above copyright 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer. 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 2. Redistributions in binary form must reproduce the above copyright 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer in the 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// documentation and/or other materials provided with the distribution. 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 3. The name of the author may not be used to endorse or promote products 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// derived from this software without specific prior written permission. 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include <antlr3defs.h> 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include <antlr3commontoken.h> 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Type indicator for a character stream 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * \remark if a custom stream is created but it can be treated as 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * a char stream, then you may OR in this value to your type indicator 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define ANTLR3_CHARSTREAM 0x0001 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Type indicator for a Token stream 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * \remark if a custom stream is created but it can be treated as 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * a token stream, then you may OR in this value to your type indicator 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define ANTLR3_TOKENSTREAM 0x0002 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Type indicator for a common tree node stream 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * \remark if a custom stream is created but it can be treated as 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * a common tree node stream, then you may OR in this value to your type indicator 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define ANTLR3_COMMONTREENODE 0x0004 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Type mask for input stream so we can switch in the above types 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * \remark DO NOT USE 0x0000 as a stream type! 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define ANTLR3_INPUT_MASK 0x0007 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#ifdef __cplusplus 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverextern "C" { 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#endif 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvertypedef struct ANTLR3_INT_STREAM_struct 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Input stream type indicator. Sometimes useful for error reporting etc. 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_UINT32 type; 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Potentially useful in error reporting and so on, this string is 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * an identification of the input source. It may be NULL, so anything 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * attempting to access it needs to check this and substitute a sensible 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * default. 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver pANTLR3_STRING streamName; 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Pointer to the super structure that contains this interface. This 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * will usually be a token stream or a tree stream. 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void * super; 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Last marker position allocated 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_MARKER lastMarker; 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // Return a string that identifies the input source 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver pANTLR3_STRING (*getSourceName) (struct ANTLR3_INT_STREAM_struct * intStream); 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Consume the next 'ANTR3_UINT32' in the stream 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void (*consume) (struct ANTLR3_INT_STREAM_struct * intStream); 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Get ANTLR3_UINT32 at current input pointer + i ahead where i=1 is next ANTLR3_UINT32 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_UINT32 (*_LA) (struct ANTLR3_INT_STREAM_struct * intStream, ANTLR3_INT32 i); 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Tell the stream to start buffering if it hasn't already. Return 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * current input position, index(), or some other marker so that 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * when passed to rewind() you get back to the same spot. 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * rewind(mark()) should not affect the input cursor. 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_MARKER (*mark) (struct ANTLR3_INT_STREAM_struct * intStream); 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Return the current input symbol index 0..n where n indicates the 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * last symbol has been read. 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_MARKER (*index) (struct ANTLR3_INT_STREAM_struct * intStream); 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Reset the stream so that next call to index would return marker. 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * The marker will usually be index() but it doesn't have to be. It's 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * just a marker to indicate what state the stream was in. This is 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * essentially calling release() and seek(). If there are markers 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * created after this marker argument, this routine must unroll them 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * like a stack. Assume the state the stream was in when this marker 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * was created. 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void (*rewind) (struct ANTLR3_INT_STREAM_struct * intStream, ANTLR3_MARKER marker); 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Reset the stream to the last marker position, witouh destryoing the 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * last marker position. 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void (*rewindLast) (struct ANTLR3_INT_STREAM_struct * intStream); 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** You may want to commit to a backtrack but don't want to force the 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * stream to keep bookkeeping objects around for a marker that is 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * no longer necessary. This will have the same behavior as 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * rewind() except it releases resources without the backward seek. 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void (*release) (struct ANTLR3_INT_STREAM_struct * intStream, ANTLR3_MARKER mark); 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Set the input cursor to the position indicated by index. This is 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * normally used to seek ahead in the input stream. No buffering is 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * required to do this unless you know your stream will use seek to 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * move backwards such as when backtracking. 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This is different from rewind in its multi-directional 167324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * requirement and in that its argument is strictly an input cursor (index). 168324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 169324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * For char streams, seeking forward must update the stream state such 170324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * as line number. For seeking backwards, you will be presumably 171324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * backtracking using the mark/rewind mechanism that restores state and 172324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * so this method does not need to update state when seeking backwards. 173324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 174324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Currently, this method is only used for efficient backtracking, but 175324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * in the future it may be used for incremental parsing. 176324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 177324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void (*seek) (struct ANTLR3_INT_STREAM_struct * intStream, ANTLR3_MARKER index); 178324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 179324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Only makes sense for streams that buffer everything up probably, but 180324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * might be useful to display the entire stream or for testing. 181324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 182324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_UINT32 (*size) (struct ANTLR3_INT_STREAM_struct * intStream); 183324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 184324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Because the indirect call, though small in individual cases can 185324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * mount up if there are thousands of tokens (very large input streams), callers 186324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * of size can optionally use this cached size field. 187324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 188324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_UINT32 cachedSize; 189324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 190324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Frees any resources that were allocated for the implementation of this 191324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * interface. Usually this is just releasing the memory allocated 192324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * for the structure itself, but it may of course do anything it need to 193324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * so long as it does not stamp on anything else. 194324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 195324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void (*free) (struct ANTLR3_INT_STREAM_struct * stream); 196324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 197324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 198324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ANTLR3_INT_STREAM; 199324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 200324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#ifdef __cplusplus 201324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 202324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#endif 203324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 204324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#endif 205324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 206