]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics.databoard/cpp/DataBoardTest/libantlr3c-3.2/src/antlr3inputstream.c
Migrated source code from Simantics SVN
[simantics/platform.git] / bundles / org.simantics.databoard / cpp / DataBoardTest / libantlr3c-3.2 / src / antlr3inputstream.c
diff --git a/bundles/org.simantics.databoard/cpp/DataBoardTest/libantlr3c-3.2/src/antlr3inputstream.c b/bundles/org.simantics.databoard/cpp/DataBoardTest/libantlr3c-3.2/src/antlr3inputstream.c
new file mode 100644 (file)
index 0000000..a4307ac
--- /dev/null
@@ -0,0 +1,619 @@
+/// \file\r
+/// Base functions to initialize and manipulate any input stream\r
+///\r
+\r
+// [The "BSD licence"]\r
+// Copyright (c) 2005-2009 Jim Idle, Temporal Wave LLC\r
+// http://www.temporal-wave.com\r
+// http://www.linkedin.com/in/jimidle\r
+//\r
+// All rights reserved.\r
+//\r
+// Redistribution and use in source and binary forms, with or without\r
+// modification, are permitted provided that the following conditions\r
+// are met:\r
+// 1. Redistributions of source code must retain the above copyright\r
+//    notice, this list of conditions and the following disclaimer.\r
+// 2. Redistributions in binary form must reproduce the above copyright\r
+//    notice, this list of conditions and the following disclaimer in the\r
+//    documentation and/or other materials provided with the distribution.\r
+// 3. The name of the author may not be used to endorse or promote products\r
+//    derived from this software without specific prior written permission.\r
+//\r
+// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR\r
+// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES\r
+// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.\r
+// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,\r
+// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
+// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\r
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\r
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF\r
+// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
+\r
+#include    <antlr3input.h>\r
+\r
+\r
+// INT Stream API\r
+//\r
+static     void                        antlr3AsciiConsume                      (pANTLR3_INT_STREAM is);\r
+static     ANTLR3_UCHAR    antlr3AsciiLA                               (pANTLR3_INT_STREAM is, ANTLR3_INT32 la);\r
+static     ANTLR3_UCHAR    antlr3AsciiLA_ucase                 (pANTLR3_INT_STREAM is, ANTLR3_INT32 la);\r
+static     ANTLR3_MARKER   antlr3AsciiIndex                    (pANTLR3_INT_STREAM is);\r
+static     ANTLR3_MARKER   antlr3AsciiMark                             (pANTLR3_INT_STREAM is);\r
+static     void                        antlr3AsciiRewind                       (pANTLR3_INT_STREAM is, ANTLR3_MARKER mark);\r
+static     void                        antlr3AsciiRewindLast           (pANTLR3_INT_STREAM is);\r
+static     void                        antlr3AsciiRelease                      (pANTLR3_INT_STREAM is, ANTLR3_MARKER mark);\r
+static     void                        antlr3AsciiSeek                         (pANTLR3_INT_STREAM is, ANTLR3_MARKER seekPoint);\r
+static         pANTLR3_STRING  antlr3AsciiGetSourceName        (pANTLR3_INT_STREAM is);\r
+\r
+// ASCII Charstream API functions\r
+//\r
+static     void                        antlr3InputClose                        (pANTLR3_INPUT_STREAM input);\r
+static     void                        antlr3InputReset                        (pANTLR3_INPUT_STREAM input);\r
+static     void *                      antlr3AsciiLT                           (pANTLR3_INPUT_STREAM input, ANTLR3_INT32 lt);\r
+static     ANTLR3_UINT32   antlr3AsciiSize                             (pANTLR3_INPUT_STREAM input);\r
+static     pANTLR3_STRING  antlr3AsciiSubstr                   (pANTLR3_INPUT_STREAM input, ANTLR3_MARKER start, ANTLR3_MARKER stop);\r
+static     ANTLR3_UINT32   antlr3AsciiGetLine                  (pANTLR3_INPUT_STREAM input);\r
+static     void          *             antlr3AsciiGetLineBuf           (pANTLR3_INPUT_STREAM input);\r
+static     ANTLR3_UINT32   antlr3AsciiGetCharPosition  (pANTLR3_INPUT_STREAM input);\r
+static     void                        antlr3AsciiSetLine                      (pANTLR3_INPUT_STREAM input, ANTLR3_UINT32 line);\r
+static     void                        antlr3AsciiSetCharPosition      (pANTLR3_INPUT_STREAM input, ANTLR3_UINT32 position);\r
+static     void                        antlr3AsciiSetNewLineChar       (pANTLR3_INPUT_STREAM input, ANTLR3_UINT32 newlineChar);\r
+static         void                    antlr3AsciiSetUcaseLA           (pANTLR3_INPUT_STREAM input, ANTLR3_BOOLEAN flag);\r
+\r
+/// \brief Common function to setup function interface for an 8 bit ASCII input stream.\r
+///\r
+/// \param input Input stream context pointer\r
+///\r
+/// \remark\r
+///   - Many of the 8 bit ASCII oriented file stream handling functions will be usable\r
+///     by any or at least some other input streams. Therefore it is perfectly acceptable\r
+///     to call this function to install the ASCII handler then override just those functions\r
+///     that would not work for the particular input encoding, such as consume for instance.\r
+/// \r
+void \r
+antlr3AsciiSetupStream (pANTLR3_INPUT_STREAM input, ANTLR3_UINT32 type)\r
+{\r
+    // Build a string factory for this stream\r
+     //\r
+    input->strFactory  = antlr3StringFactoryNew();\r
+\r
+    // Default stream set up is for ASCII, therefore there is nothing else\r
+    // to do but set it up as such\r
+    //\r
+    antlr3GenericSetupStream(input, type);\r
+}\r
+\r
+\r
+void\r
+antlr3GenericSetupStream  (pANTLR3_INPUT_STREAM input, ANTLR3_UINT32 type)\r
+{\r
+\r
+    /* Install function pointers for an 8 bit ASCII input\r
+     */\r
+\r
+    /* Allocate stream interface\r
+     */\r
+    input->istream                     =  antlr3IntStreamNew();\r
+    input->istream->type    = ANTLR3_CHARSTREAM;\r
+    input->istream->super   =  input;\r
+\r
+    input->istream->type       = type;\r
+\r
+    /* Intstream API\r
+     */\r
+    input->istream->consume                    =  antlr3AsciiConsume;                  /* Consume the next 8 bit character in the buffer                       */\r
+    input->istream->_LA                                =  antlr3AsciiLA;                               /* Return the UTF32 character at offset n (1 based)                     */\r
+    input->istream->index                      =  antlr3AsciiIndex;                    /* Current index (offset from first character                       */\r
+    input->istream->mark                       =  antlr3AsciiMark;                             /* Record the current lex state for later restore                       */\r
+    input->istream->rewind                     =  antlr3AsciiRewind;                   /* How to rewind the input                                                                      */\r
+    input->istream->rewindLast         =  antlr3AsciiRewindLast;               /* How to rewind the input                                                                      */\r
+    input->istream->seek                       =  antlr3AsciiSeek;                             /* How to seek to a specific point in the stream                    */\r
+    input->istream->release                    =  antlr3AsciiRelease;                  /* Reset marks after mark n                                                                     */\r
+       input->istream->getSourceName   =  antlr3AsciiGetSourceName;    // Return a string that names the input source\r
+\r
+       /* Charstream API\r
+     */\r
+    input->close                                       =  antlr3InputClose;                    /* Close down the stream completely                                                                             */\r
+    input->free                                                =  antlr3InputClose;                    /* Synonym for free                                                                                                             */\r
+    input->reset                                       =  antlr3InputReset;                    /* Reset input to start                                                                                                 */\r
+    input->_LT                                         =  antlr3AsciiLT;                               /* Same as _LA for 8 bit Ascii file                                                                             */\r
+    input->size                                                =  antlr3AsciiSize;                             /* Return the size of the input buffer                                                                  */\r
+    input->substr                                      =  antlr3AsciiSubstr;                   /* Return a string from the input stream                                                                */\r
+    input->getLine                                     =  antlr3AsciiGetLine;                  /* Return the current line number in the input stream                                   */\r
+    input->getLineBuf                          =  antlr3AsciiGetLineBuf;           /* Return a pointer to the start of the current line being consumed     */\r
+    input->getCharPositionInLine    =  antlr3AsciiGetCharPosition;  /* Return the offset into the current line of input                                                */\r
+    input->setLine                                     =  antlr3AsciiSetLine;                  /* Set the input stream line number (does not set buffer pointers)          */\r
+    input->setCharPositionInLine    =  antlr3AsciiSetCharPosition;  /* Set the offset in to the current line (does not set any pointers        )   */\r
+    input->SetNewLineChar                      =  antlr3AsciiSetNewLineChar;   /* Set the value of the newline trigger character                                               */\r
+       input->setUcaseLA                               = antlr3AsciiSetUcaseLA;\r
+\r
+       input->charByteSize                             = 1;            // Size in bytes of characters in this stream.\r
+\r
+    /* Initialize entries for tables etc\r
+     */\r
+    input->markers  = NULL;\r
+\r
+    /* Set up the input stream brand new\r
+     */\r
+    input->reset(input);\r
+    \r
+    /* Install default line separator character (it can be replaced\r
+     * by the grammar programmer later)\r
+     */\r
+    input->SetNewLineChar(input, (ANTLR3_UCHAR)'\n');\r
+}\r
+\r
+static pANTLR3_STRING\r
+antlr3AsciiGetSourceName(pANTLR3_INT_STREAM is)\r
+{\r
+       return  is->streamName;\r
+}\r
+\r
+/** \brief Close down an input stream and free any memory allocated by it.\r
+ *\r
+ * \param input Input stream context pointer\r
+ */\r
+static void\r
+antlr3InputClose(pANTLR3_INPUT_STREAM input)\r
+{\r
+    // Close any markers in the input stream\r
+    //\r
+    if (input->markers != NULL)\r
+    {\r
+               input->markers->free(input->markers);\r
+               input->markers = NULL;\r
+    }\r
+\r
+    // Close the string factory\r
+    //\r
+    if (input->strFactory != NULL)\r
+    {\r
+               input->strFactory->close(input->strFactory);\r
+    }\r
+\r
+    // Free the input stream buffer if we allocated it\r
+    //\r
+    if (input->isAllocated && input->data != NULL)\r
+    {\r
+               ANTLR3_FREE(input->data);\r
+               input->data = NULL;\r
+    }\r
+    \r
+    input->istream->free(input->istream);\r
+\r
+    // Finally, free the space for the structure itself\r
+    //\r
+    ANTLR3_FREE(input);\r
+\r
+    // Done\r
+    //\r
+}\r
+\r
+static void            \r
+antlr3AsciiSetUcaseLA          (pANTLR3_INPUT_STREAM input, ANTLR3_BOOLEAN flag)\r
+{\r
+       if      (flag)\r
+       {\r
+               // Return the upper case version of the characters\r
+               //\r
+               input->istream->_LA                 =  antlr3AsciiLA_ucase;\r
+       }\r
+       else\r
+       {\r
+               // Return the raw characters as they are in the buffer\r
+               //\r
+               input->istream->_LA                 =  antlr3AsciiLA;\r
+       }\r
+}\r
+\r
+\r
+/** \brief Reset a re-startable input stream to the start\r
+ *\r
+ * \param input Input stream context pointer\r
+ */\r
+static void\r
+antlr3InputReset(pANTLR3_INPUT_STREAM input)\r
+{\r
+\r
+    input->nextChar            = input->data;  /* Input at first character */\r
+    input->line                        = 1;            /* starts at line 1         */\r
+    input->charPositionInLine  = -1;\r
+    input->currentLine         = input->data;\r
+    input->markDepth           = 0;            /* Reset markers            */\r
+    \r
+    /* Free up the markers table if it is there\r
+     */\r
+    if (input->markers != NULL)\r
+    {\r
+       input->markers->free(input->markers);\r
+    }\r
+\r
+    /* Install a new markers table\r
+     */\r
+    input->markers  = antlr3VectorNew(0);\r
+}\r
+\r
+/** \brief Consume the next character in an 8 bit ASCII input stream\r
+ *\r
+ * \param input Input stream context pointer\r
+ */\r
+static void\r
+antlr3AsciiConsume(pANTLR3_INT_STREAM is)\r
+{\r
+    pANTLR3_INPUT_STREAM input;\r
+\r
+    input   = ((pANTLR3_INPUT_STREAM) (is->super));\r
+\r
+    if ((pANTLR3_UINT8)(input->nextChar) < (((pANTLR3_UINT8)input->data) + input->sizeBuf))\r
+    {  \r
+       /* Indicate one more character in this line\r
+        */\r
+       input->charPositionInLine++;\r
+       \r
+       if  ((ANTLR3_UCHAR)(*((pANTLR3_UINT8)input->nextChar)) == input->newlineChar)\r
+       {\r
+           /* Reset for start of a new line of input\r
+            */\r
+           input->line++;\r
+           input->charPositionInLine   = 0;\r
+           input->currentLine          = (void *)(((pANTLR3_UINT8)input->nextChar) + 1);\r
+       }\r
+\r
+       /* Increment to next character position\r
+        */\r
+       input->nextChar = (void *)(((pANTLR3_UINT8)input->nextChar) + 1);\r
+    }\r
+}\r
+\r
+/** \brief Return the input element assuming an 8 bit ascii input\r
+ *\r
+ * \param[in] input Input stream context pointer\r
+ * \param[in] la 1 based offset of next input stream element\r
+ *\r
+ * \return Next input character in internal ANTLR3 encoding (UTF32)\r
+ */\r
+static ANTLR3_UCHAR \r
+antlr3AsciiLA(pANTLR3_INT_STREAM is, ANTLR3_INT32 la)\r
+{\r
+    pANTLR3_INPUT_STREAM input;\r
+       \r
+    input   = ((pANTLR3_INPUT_STREAM) (is->super));\r
+\r
+    if (( ((pANTLR3_UINT8)input->nextChar) + la - 1) >= (((pANTLR3_UINT8)input->data) + input->sizeBuf))\r
+    {\r
+               return  ANTLR3_CHARSTREAM_EOF;\r
+    }\r
+    else\r
+    {\r
+               return  (ANTLR3_UCHAR)(*((pANTLR3_UINT8)input->nextChar + la - 1));\r
+    }\r
+}\r
+\r
+/** \brief Return the input element assuming an 8 bit ASCII input and\r
+ *         always return the UPPER CASE character.\r
+ *                Note that this is 8 bit and so we assume that the toupper\r
+ *                function will use the correct locale for 8 bits.\r
+ *\r
+ * \param[in] input Input stream context pointer\r
+ * \param[in] la 1 based offset of next input stream element\r
+ *\r
+ * \return Next input character in internal ANTLR3 encoding (UTF32)\r
+ */\r
+static ANTLR3_UCHAR\r
+antlr3AsciiLA_ucase    (pANTLR3_INT_STREAM is, ANTLR3_INT32 la)\r
+{\r
+    pANTLR3_INPUT_STREAM input;\r
+       \r
+    input   = ((pANTLR3_INPUT_STREAM) (is->super));\r
+\r
+    if (( ((pANTLR3_UINT8)input->nextChar) + la - 1) >= (((pANTLR3_UINT8)input->data) + input->sizeBuf))\r
+    {\r
+               return  ANTLR3_CHARSTREAM_EOF;\r
+    }\r
+    else\r
+    {\r
+               return  (ANTLR3_UCHAR)toupper((*((pANTLR3_UINT8)input->nextChar + la - 1)));\r
+    }\r
+}\r
+\r
+\r
+/** \brief Return the input element assuming an 8 bit ascii input\r
+ *\r
+ * \param[in] input Input stream context pointer\r
+ * \param[in] lt 1 based offset of next input stream element\r
+ *\r
+ * \return Next input character in internal ANTLR3 encoding (UTF32)\r
+ */\r
+static void * \r
+antlr3AsciiLT(pANTLR3_INPUT_STREAM input, ANTLR3_INT32 lt)\r
+{\r
+    /* Casting is horrible but it means no warnings and LT should never be called\r
+     * on a character stream anyway I think. If it is then, the void * will need to be \r
+     * cast back in a similar manner. Yuck! But this means that LT for Token streams and\r
+     * tree streams is correct.\r
+     */\r
+    return (ANTLR3_FUNC_PTR(input->istream->_LA(input->istream, lt)));\r
+}\r
+\r
+/** \brief Calculate the current index in the output stream.\r
+ * \param[in] input Input stream context pointer\r
+ */\r
+static ANTLR3_MARKER\r
+antlr3AsciiIndex(pANTLR3_INT_STREAM is)\r
+{\r
+    pANTLR3_INPUT_STREAM input;\r
+\r
+    input   = ((pANTLR3_INPUT_STREAM) (is->super));\r
+\r
+    return  (ANTLR3_MARKER)(((pANTLR3_UINT8)input->nextChar));\r
+}\r
+\r
+/** \brief Return the size of the current input stream, as an Ascii file\r
+ *   which in this case is the total input. Other implementations may provide\r
+ *   more sophisticated implementations to deal with non-recoverable streams \r
+ *   and so on.\r
+ *\r
+ * \param[in] input Input stream context pointer\r
+ */\r
+static ANTLR3_UINT32 \r
+antlr3AsciiSize(pANTLR3_INPUT_STREAM input)\r
+{\r
+    return  input->sizeBuf;\r
+}\r
+\r
+/** \brief Mark the current input point in an Ascii 8 bit stream\r
+ *  such as a file stream, where all the input is available in the\r
+ *  buffer.\r
+ *\r
+ * \param[in] is Input stream context pointer\r
+ */\r
+static ANTLR3_MARKER\r
+antlr3AsciiMark        (pANTLR3_INT_STREAM is)\r
+{\r
+    pANTLR3_LEX_STATE      state;\r
+    pANTLR3_INPUT_STREAM    input;\r
+\r
+    input   = ((pANTLR3_INPUT_STREAM) (is->super));\r
+\r
+    /* New mark point \r
+     */\r
+    input->markDepth++;\r
+\r
+    /* See if we are revisiting a mark as we can just reuse the vector\r
+     * entry if we are, otherwise, we need a new one\r
+     */\r
+    if (input->markDepth > input->markers->count)\r
+    {  \r
+       state   = ANTLR3_MALLOC(sizeof(ANTLR3_LEX_STATE));\r
+\r
+       /* Add it to the table\r
+        */\r
+       input->markers->add(input->markers, state, ANTLR3_FREE_FUNC);   /* No special structure, just free() on delete */\r
+    }\r
+    else\r
+    {\r
+       state   = (pANTLR3_LEX_STATE)input->markers->get(input->markers, input->markDepth - 1);\r
+\r
+       /* Assume no errors for speed, it will just blow up if the table failed\r
+        * for some reasons, hence lots of unit tests on the tables ;-)\r
+        */\r
+    }\r
+\r
+    /* We have created or retrieved the state, so update it with the current\r
+     * elements of the lexer state.\r
+     */\r
+    state->charPositionInLine  = input->charPositionInLine;\r
+    state->currentLine         = input->currentLine;\r
+    state->line                        = input->line;\r
+    state->nextChar            = input->nextChar;\r
+\r
+    is->lastMarker  = input->markDepth;\r
+\r
+    /* And that's it\r
+     */\r
+    return  input->markDepth;\r
+}\r
+/** \brief Rewind the lexer input to the state specified by the last produced mark.\r
+ * \r
+ * \param[in] input Input stream context pointer\r
+ *\r
+ * \remark\r
+ * Assumes ASCII (or at least, 8 Bit) input stream.\r
+ */\r
+static void\r
+antlr3AsciiRewindLast  (pANTLR3_INT_STREAM is)\r
+{\r
+    is->rewind(is, is->lastMarker);\r
+}\r
+\r
+/** \brief Rewind the lexer input to the state specified by the supplied mark.\r
+ * \r
+ * \param[in] input Input stream context pointer\r
+ *\r
+ * \remark\r
+ * Assumes ASCII (or at least, 8 Bit) input stream.\r
+ */\r
+static void\r
+antlr3AsciiRewind      (pANTLR3_INT_STREAM is, ANTLR3_MARKER mark)\r
+{\r
+    pANTLR3_LEX_STATE  state;\r
+    pANTLR3_INPUT_STREAM input;\r
+\r
+    input   = ((pANTLR3_INPUT_STREAM) is->super);\r
+\r
+    /* Perform any clean up of the marks\r
+     */\r
+    input->istream->release(input->istream, mark);\r
+\r
+    /* Find the supplied mark state \r
+     */\r
+    state   = (pANTLR3_LEX_STATE)input->markers->get(input->markers, (ANTLR3_UINT32)(mark - 1));\r
+\r
+    /* Seek input pointer to the requested point (note we supply the void *pointer\r
+     * to whatever is implementing the int stream to seek).\r
+     */\r
+    antlr3AsciiSeek(is, (ANTLR3_MARKER)(state->nextChar));\r
+\r
+    /* Reset to the reset of the information in the mark\r
+     */\r
+    input->charPositionInLine  = state->charPositionInLine;\r
+    input->currentLine         = state->currentLine;\r
+    input->line                        = state->line;\r
+    input->nextChar            = state->nextChar;\r
+\r
+    /* And we are done\r
+     */\r
+}\r
+\r
+/** \brief Rewind the lexer input to the state specified by the supplied mark.\r
+ * \r
+ * \param[in] input Input stream context pointer\r
+ *\r
+ * \remark\r
+ * Assumes ASCII (or at least, 8 Bit) input stream.\r
+ */\r
+static void\r
+antlr3AsciiRelease     (pANTLR3_INT_STREAM is, ANTLR3_MARKER mark)\r
+{\r
+    pANTLR3_INPUT_STREAM input;\r
+\r
+    input   = ((pANTLR3_INPUT_STREAM) (is->super));\r
+\r
+    /* We don't do much here in fact as we never free any higher marks in\r
+     * the hashtable as we just resuse any memory allocated for them.\r
+     */\r
+    input->markDepth   = (ANTLR3_UINT32)(mark - 1);\r
+}\r
+\r
+/** \brief Rewind the lexer input to the state specified by the supplied mark.\r
+ * \r
+ * \param[in] input Input stream context pointer\r
+ *\r
+ * \remark\r
+ * Assumes ASCII (or at least, 8 Bit) input stream.\r
+ */\r
+static void\r
+antlr3AsciiSeek        (pANTLR3_INT_STREAM is, ANTLR3_MARKER seekPoint)\r
+{\r
+       ANTLR3_INT32   count;\r
+       pANTLR3_INPUT_STREAM input;\r
+\r
+       input   = ANTLR3_FUNC_PTR(((pANTLR3_INPUT_STREAM) is->super));\r
+\r
+       /* If the requested seek point is less than the current\r
+       * input point, then we assume that we are resetting from a mark\r
+       * and do not need to scan, but can just set to there.\r
+       */\r
+       if      (seekPoint <= (ANTLR3_MARKER)(input->nextChar))\r
+       {\r
+               input->nextChar = ((pANTLR3_UINT8) seekPoint);\r
+       }\r
+       else\r
+       {\r
+               count   = (ANTLR3_UINT32)(seekPoint - (ANTLR3_MARKER)(input->nextChar));\r
+\r
+               while (count--)\r
+               {\r
+                       is->consume(is);\r
+               }\r
+       }\r
+}\r
+/** Return a substring of the ASCII (8 bit) input stream in\r
+ *  newly allocated memory.\r
+ *\r
+ * \param input Input stream context pointer\r
+ * \param start Offset in input stream where the string starts\r
+ * \param stop  Offset in the input stream where the string ends.\r
+ */\r
+static pANTLR3_STRING\r
+antlr3AsciiSubstr              (pANTLR3_INPUT_STREAM input, ANTLR3_MARKER start, ANTLR3_MARKER stop)\r
+{\r
+       return  input->strFactory->newPtr(input->strFactory, (pANTLR3_UINT8)start, (ANTLR3_UINT32)(stop - start + 1));\r
+}\r
+\r
+/** \brief Return the line number as understood by the 8 bit/ASCII input stream.\r
+ *\r
+ * \param input Input stream context pointer\r
+ * \return     Line number in input stream that we believe we are working on.\r
+ */\r
+static ANTLR3_UINT32   \r
+antlr3AsciiGetLine             (pANTLR3_INPUT_STREAM input)\r
+{\r
+    return  input->line;\r
+}\r
+\r
+/** Return a pointer into the input stream that points at the start\r
+ *  of the current input line as triggered by the end of line character installed\r
+ *  for the stream ('\n' unless told differently).\r
+ *\r
+ * \param[in] input \r
+ */\r
+static void      * \r
+antlr3AsciiGetLineBuf  (pANTLR3_INPUT_STREAM input)\r
+{\r
+    return  input->currentLine;\r
+}\r
+\r
+/** Return the current offset in to the current line in the input stream.\r
+ *\r
+ * \param input Input stream context pointer\r
+ * \return      Current line offset\r
+ */\r
+static ANTLR3_UINT32\r
+antlr3AsciiGetCharPosition     (pANTLR3_INPUT_STREAM input)\r
+{\r
+    return  input->charPositionInLine;\r
+}\r
+\r
+/** Set the current line number as understood by the input stream.\r
+ *\r
+ * \param input Input stream context pointer\r
+ * \param line  Line number to tell the input stream we are on\r
+ *\r
+ * \remark\r
+ *  This function does not change any pointers, it just allows the programmer to set the\r
+ *  line number according to some external criterion, such as finding a lexed directive\r
+ *  like: #nnn "file.c" for instance, such that error reporting and so on in is in sync\r
+ *  with some original source format.\r
+ */\r
+static void\r
+antlr3AsciiSetLine             (pANTLR3_INPUT_STREAM input, ANTLR3_UINT32 line)\r
+{\r
+    input->line        = line;\r
+}\r
+\r
+/** Set the current offset in the current line to be a particular setting.\r
+ *\r
+ * \param[in] input    Input stream context pointer\r
+ * \param[in] position New setting for current offset.\r
+ *\r
+ * \remark\r
+ * This does not set the actual pointers in the input stream, it is purely for reporting\r
+ * purposes and so on as per antlr3AsciiSetLine();\r
+ */\r
+static void\r
+antlr3AsciiSetCharPosition     (pANTLR3_INPUT_STREAM input, ANTLR3_UINT32 position)\r
+{\r
+    input->charPositionInLine = position;\r
+}\r
+\r
+/** Set the newline trigger character in the input stream to the supplied parameter.\r
+ *\r
+ * \param[in] input        Input stream context pointer\r
+ * \param[in] newlineChar   Character to set to be the newline trigger.\r
+ *\r
+ * \remark\r
+ *  - The supplied newLineChar is in UTF32 encoding (which means ASCII and latin1 etc\r
+ *    are the same encodings), but the input stream catered to by this function is 8 bit\r
+ *    only, so it is up to the programmer to ensure that the character supplied is valid.\r
+ */\r
+static void \r
+antlr3AsciiSetNewLineChar      (pANTLR3_INPUT_STREAM input, ANTLR3_UINT32 newlineChar)\r
+{\r
+    input->newlineChar = newlineChar;\r
+}\r
+\r
+\r
+\r