--- /dev/null
+/** \file\r
+ * Contains the base functions that all recognizers require.\r
+ * Any function can be overridden by a lexer/parser/tree parser or by the\r
+ * ANTLR3 programmer.\r
+ * \r
+ * \addtogroup pANTLR3_BASE_RECOGNIZER\r
+ * @{\r
+ */\r
+#include <antlr3baserecognizer.h>\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
+#ifdef ANTLR3_WINDOWS\r
+#pragma warning( disable : 4100 )\r
+#endif\r
+\r
+/* Interface functions -standard implementations cover parser and treeparser\r
+ * almost completely but are overridden by the parser or tree parser as needed. Lexer overrides\r
+ * most of these functions.\r
+ */\r
+static void beginResync (pANTLR3_BASE_RECOGNIZER recognizer);\r
+static pANTLR3_BITSET computeErrorRecoverySet (pANTLR3_BASE_RECOGNIZER recognizer);\r
+static void endResync (pANTLR3_BASE_RECOGNIZER recognizer);\r
+static void beginBacktrack (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_UINT32 level);\r
+static void endBacktrack (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_UINT32 level, ANTLR3_BOOLEAN successful);\r
+\r
+static void * match (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_UINT32 ttype, pANTLR3_BITSET_LIST follow);\r
+static void matchAny (pANTLR3_BASE_RECOGNIZER recognizer);\r
+static void mismatch (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_UINT32 ttype, pANTLR3_BITSET_LIST follow);\r
+static ANTLR3_BOOLEAN mismatchIsUnwantedToken (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_INT_STREAM is, ANTLR3_UINT32 ttype);\r
+static ANTLR3_BOOLEAN mismatchIsMissingToken (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_INT_STREAM is, pANTLR3_BITSET_LIST follow);\r
+static void reportError (pANTLR3_BASE_RECOGNIZER recognizer);\r
+static pANTLR3_BITSET computeCSRuleFollow (pANTLR3_BASE_RECOGNIZER recognizer);\r
+static pANTLR3_BITSET combineFollows (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_BOOLEAN exact);\r
+static void displayRecognitionError (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_UINT8 * tokenNames);\r
+static void recover (pANTLR3_BASE_RECOGNIZER recognizer);\r
+static void * recoverFromMismatchedToken (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_UINT32 ttype, pANTLR3_BITSET_LIST follow);\r
+static void * recoverFromMismatchedSet (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_BITSET_LIST follow);\r
+static ANTLR3_BOOLEAN recoverFromMismatchedElement(pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_BITSET_LIST follow);\r
+static void consumeUntil (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_UINT32 tokenType);\r
+static void consumeUntilSet (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_BITSET set);\r
+static pANTLR3_STACK getRuleInvocationStack (pANTLR3_BASE_RECOGNIZER recognizer);\r
+static pANTLR3_STACK getRuleInvocationStackNamed (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_UINT8 name);\r
+static pANTLR3_HASH_TABLE toStrings (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_HASH_TABLE);\r
+static ANTLR3_MARKER getRuleMemoization (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_INTKEY ruleIndex, ANTLR3_MARKER ruleParseStart);\r
+static ANTLR3_BOOLEAN alreadyParsedRule (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_MARKER ruleIndex);\r
+static void memoize (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_MARKER ruleIndex, ANTLR3_MARKER ruleParseStart);\r
+static ANTLR3_BOOLEAN synpred (pANTLR3_BASE_RECOGNIZER recognizer, void * ctx, void (*predicate)(void * ctx));\r
+static void reset (pANTLR3_BASE_RECOGNIZER recognizer);\r
+static void freeBR (pANTLR3_BASE_RECOGNIZER recognizer);\r
+static void * getCurrentInputSymbol (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_INT_STREAM istream);\r
+static void * getMissingSymbol (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_INT_STREAM istream, pANTLR3_EXCEPTION e,\r
+ ANTLR3_UINT32 expectedTokenType, pANTLR3_BITSET_LIST follow);\r
+static ANTLR3_UINT32 getNumberOfSyntaxErrors (pANTLR3_BASE_RECOGNIZER recognizer);\r
+\r
+ANTLR3_API pANTLR3_BASE_RECOGNIZER\r
+antlr3BaseRecognizerNew(ANTLR3_UINT32 type, ANTLR3_UINT32 sizeHint, pANTLR3_RECOGNIZER_SHARED_STATE state)\r
+{\r
+ pANTLR3_BASE_RECOGNIZER recognizer;\r
+\r
+ // Allocate memory for the structure\r
+ //\r
+ recognizer = (pANTLR3_BASE_RECOGNIZER) ANTLR3_MALLOC((size_t)sizeof(ANTLR3_BASE_RECOGNIZER));\r
+\r
+ if (recognizer == NULL)\r
+ {\r
+ // Allocation failed\r
+ //\r
+ return NULL;\r
+ }\r
+\r
+ \r
+ // If we have been supplied with a pre-existing recognizer state\r
+ // then we just install it, otherwise we must create one from scratch\r
+ //\r
+ if (state == NULL)\r
+ {\r
+ recognizer->state = (pANTLR3_RECOGNIZER_SHARED_STATE) ANTLR3_CALLOC(1, (size_t)sizeof(ANTLR3_RECOGNIZER_SHARED_STATE));\r
+\r
+ if (recognizer->state == NULL)\r
+ {\r
+ ANTLR3_FREE(recognizer);\r
+ return NULL;\r
+ }\r
+\r
+ // Initialize any new recognizer state\r
+ //\r
+ recognizer->state->errorRecovery = ANTLR3_FALSE;\r
+ recognizer->state->lastErrorIndex = -1;\r
+ recognizer->state->failed = ANTLR3_FALSE;\r
+ recognizer->state->errorCount = 0;\r
+ recognizer->state->backtracking = 0;\r
+ recognizer->state->following = NULL;\r
+ recognizer->state->ruleMemo = NULL;\r
+ recognizer->state->tokenNames = NULL;\r
+ recognizer->state->sizeHint = sizeHint;\r
+ recognizer->state->tokSource = NULL;\r
+ recognizer->state->tokFactory = NULL;\r
+\r
+ // Rather than check to see if we must initialize\r
+ // the stack every time we are asked for an new rewrite stream\r
+ // we just always create an empty stack and then just\r
+ // free it when the base recognizer is freed.\r
+ //\r
+ recognizer->state->rStreams = antlr3VectorNew(0); // We don't know the size.\r
+\r
+ if (recognizer->state->rStreams == NULL)\r
+ {\r
+ // Out of memory\r
+ //\r
+ ANTLR3_FREE(recognizer->state);\r
+ ANTLR3_FREE(recognizer);\r
+ return NULL;\r
+ }\r
+ }\r
+ else\r
+ {\r
+ // Install the one we were given, and do not reset it here\r
+ // as it will either already have been initialized or will\r
+ // be in a state that needs to be preserved.\r
+ //\r
+ recognizer->state = state;\r
+ }\r
+ \r
+ // Install the BR API\r
+ //\r
+ recognizer->alreadyParsedRule = alreadyParsedRule;\r
+ recognizer->beginResync = beginResync;\r
+ recognizer->combineFollows = combineFollows;\r
+ recognizer->beginBacktrack = beginBacktrack;\r
+ recognizer->endBacktrack = endBacktrack;\r
+ recognizer->computeCSRuleFollow = computeCSRuleFollow;\r
+ recognizer->computeErrorRecoverySet = computeErrorRecoverySet;\r
+ recognizer->consumeUntil = consumeUntil;\r
+ recognizer->consumeUntilSet = consumeUntilSet;\r
+ recognizer->displayRecognitionError = displayRecognitionError;\r
+ recognizer->endResync = endResync;\r
+ recognizer->exConstruct = antlr3MTExceptionNew;\r
+ recognizer->getRuleInvocationStack = getRuleInvocationStack;\r
+ recognizer->getRuleInvocationStackNamed = getRuleInvocationStackNamed;\r
+ recognizer->getRuleMemoization = getRuleMemoization;\r
+ recognizer->match = match;\r
+ recognizer->matchAny = matchAny;\r
+ recognizer->memoize = memoize;\r
+ recognizer->mismatch = mismatch;\r
+ recognizer->mismatchIsUnwantedToken = mismatchIsUnwantedToken;\r
+ recognizer->mismatchIsMissingToken = mismatchIsMissingToken;\r
+ recognizer->recover = recover;\r
+ recognizer->recoverFromMismatchedElement= recoverFromMismatchedElement;\r
+ recognizer->recoverFromMismatchedSet = recoverFromMismatchedSet;\r
+ recognizer->recoverFromMismatchedToken = recoverFromMismatchedToken;\r
+ recognizer->getNumberOfSyntaxErrors = getNumberOfSyntaxErrors;\r
+ recognizer->reportError = reportError;\r
+ recognizer->reset = reset;\r
+ recognizer->synpred = synpred;\r
+ recognizer->toStrings = toStrings;\r
+ recognizer->getCurrentInputSymbol = getCurrentInputSymbol;\r
+ recognizer->getMissingSymbol = getMissingSymbol;\r
+ recognizer->debugger = NULL;\r
+\r
+ recognizer->free = freeBR;\r
+\r
+ /* Initialize variables\r
+ */\r
+ recognizer->type = type;\r
+\r
+\r
+ return recognizer;\r
+}\r
+static void \r
+freeBR (pANTLR3_BASE_RECOGNIZER recognizer)\r
+{\r
+ pANTLR3_EXCEPTION thisE;\r
+\r
+ // Did we have a state allocated?\r
+ //\r
+ if (recognizer->state != NULL)\r
+ {\r
+ // Free any rule memoization we set up\r
+ //\r
+ if (recognizer->state->ruleMemo != NULL)\r
+ {\r
+ recognizer->state->ruleMemo->free(recognizer->state->ruleMemo);\r
+ recognizer->state->ruleMemo = NULL;\r
+ }\r
+\r
+ // Free any exception space we have left around\r
+ //\r
+ thisE = recognizer->state->exception;\r
+ if (thisE != NULL)\r
+ {\r
+ thisE->freeEx(thisE);\r
+ }\r
+\r
+ // Free any rewrite streams we have allocated\r
+ //\r
+ if (recognizer->state->rStreams != NULL)\r
+ {\r
+ recognizer->state->rStreams->free(recognizer->state->rStreams);\r
+ }\r
+\r
+ // Free up any token factory we created (error recovery for instance)\r
+ //\r
+ if (recognizer->state->tokFactory != NULL)\r
+ {\r
+ recognizer->state->tokFactory->close(recognizer->state->tokFactory);\r
+ }\r
+ // Free the shared state memory\r
+ //\r
+ ANTLR3_FREE(recognizer->state);\r
+ }\r
+\r
+ // Free the actual recognizer space\r
+ //\r
+ ANTLR3_FREE(recognizer);\r
+}\r
+\r
+/**\r
+ * Creates a new Mismatched Token Exception and inserts in the recognizer\r
+ * exception stack.\r
+ * \r
+ * \param recognizer\r
+ * Context pointer for this recognizer\r
+ * \r
+ */\r
+ANTLR3_API void\r
+antlr3MTExceptionNew(pANTLR3_BASE_RECOGNIZER recognizer)\r
+{\r
+ /* Create a basic recognition exception structure\r
+ */\r
+ antlr3RecognitionExceptionNew(recognizer);\r
+\r
+ /* Now update it to indicate this is a Mismatched token exception\r
+ */\r
+ recognizer->state->exception->name = ANTLR3_MISMATCHED_EX_NAME;\r
+ recognizer->state->exception->type = ANTLR3_MISMATCHED_TOKEN_EXCEPTION;\r
+\r
+ return;\r
+}\r
+\r
+ANTLR3_API void\r
+antlr3RecognitionExceptionNew(pANTLR3_BASE_RECOGNIZER recognizer)\r
+{\r
+ pANTLR3_EXCEPTION ex;\r
+ pANTLR3_LEXER lexer;\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+\r
+ pANTLR3_INPUT_STREAM ins;\r
+ pANTLR3_INT_STREAM is;\r
+ pANTLR3_COMMON_TOKEN_STREAM cts;\r
+ pANTLR3_TREE_NODE_STREAM tns;\r
+\r
+ ins = NULL;\r
+ cts = NULL;\r
+ tns = NULL;\r
+ is = NULL;\r
+ lexer = NULL;\r
+ parser = NULL;\r
+ tparser = NULL;\r
+\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_LEXER:\r
+\r
+ lexer = (pANTLR3_LEXER) (recognizer->super);\r
+ ins = lexer->input;\r
+ is = ins->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ cts = (pANTLR3_COMMON_TOKEN_STREAM)(parser->tstream->super);\r
+ is = parser->tstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_TREE_PARSER:\r
+\r
+ tparser = (pANTLR3_TREE_PARSER) (recognizer->super);\r
+ tns = tparser->ctnstream->tnstream;\r
+ is = tns->istream;\r
+\r
+ break;\r
+\r
+ default:\r
+\r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function antlr3RecognitionExceptionNew called by unknown parser type - provide override for this function\n");\r
+ return;\r
+\r
+ break;\r
+ }\r
+\r
+ /* Create a basic exception structure\r
+ */\r
+ ex = antlr3ExceptionNew(ANTLR3_RECOGNITION_EXCEPTION,\r
+ (void *)ANTLR3_RECOGNITION_EX_NAME,\r
+ NULL,\r
+ ANTLR3_FALSE);\r
+\r
+ /* Rest of information depends on the base type of the \r
+ * input stream.\r
+ */\r
+ switch (is->type & ANTLR3_INPUT_MASK)\r
+ {\r
+ case ANTLR3_CHARSTREAM:\r
+\r
+ ex->c = is->_LA (is, 1); /* Current input character */\r
+ ex->line = ins->getLine (ins); /* Line number comes from stream */\r
+ ex->charPositionInLine = ins->getCharPositionInLine (ins); /* Line offset also comes from the stream */\r
+ ex->index = is->index (is);\r
+ ex->streamName = ins->fileName;\r
+ ex->message = "Unexpected character";\r
+ break;\r
+\r
+ case ANTLR3_TOKENSTREAM:\r
+\r
+ ex->token = cts->tstream->_LT (cts->tstream, 1); /* Current input token */\r
+ ex->line = ((pANTLR3_COMMON_TOKEN)(ex->token))->getLine (ex->token);\r
+ ex->charPositionInLine = ((pANTLR3_COMMON_TOKEN)(ex->token))->getCharPositionInLine (ex->token);\r
+ ex->index = cts->tstream->istream->index (cts->tstream->istream);\r
+ if (((pANTLR3_COMMON_TOKEN)(ex->token))->type == ANTLR3_TOKEN_EOF)\r
+ {\r
+ ex->streamName = NULL;\r
+ }\r
+ else\r
+ {\r
+ ex->streamName = ((pANTLR3_COMMON_TOKEN)(ex->token))->input->fileName;\r
+ }\r
+ ex->message = "Unexpected token";\r
+ break;\r
+\r
+ case ANTLR3_COMMONTREENODE:\r
+\r
+ ex->token = tns->_LT (tns, 1); /* Current input tree node */\r
+ ex->line = ((pANTLR3_BASE_TREE)(ex->token))->getLine (ex->token);\r
+ ex->charPositionInLine = ((pANTLR3_BASE_TREE)(ex->token))->getCharPositionInLine (ex->token);\r
+ ex->index = tns->istream->index (tns->istream);\r
+\r
+ // Are you ready for this? Deep breath now...\r
+ //\r
+ {\r
+ pANTLR3_COMMON_TREE tnode;\r
+\r
+ tnode = ((pANTLR3_COMMON_TREE)(((pANTLR3_BASE_TREE)(ex->token))->super));\r
+\r
+ if (tnode->token == NULL)\r
+ {\r
+ ex->streamName = ((pANTLR3_BASE_TREE)(ex->token))->strFactory->newStr(((pANTLR3_BASE_TREE)(ex->token))->strFactory, (pANTLR3_UINT8)"-unknown source-");\r
+ }\r
+ else\r
+ {\r
+ if (tnode->token->input == NULL)\r
+ {\r
+ ex->streamName = NULL;\r
+ }\r
+ else\r
+ {\r
+ ex->streamName = tnode->token->input->fileName;\r
+ }\r
+ }\r
+ ex->message = "Unexpected node";\r
+ }\r
+ break;\r
+ }\r
+\r
+ ex->input = is;\r
+ ex->nextException = recognizer->state->exception; /* So we don't leak the memory */\r
+ recognizer->state->exception = ex;\r
+ recognizer->state->error = ANTLR3_TRUE; /* Exception is outstanding */\r
+\r
+ return;\r
+}\r
+\r
+\r
+/// Match current input symbol against ttype. Upon error, do one token\r
+/// insertion or deletion if possible. \r
+/// To turn off single token insertion or deletion error\r
+/// recovery, override mismatchRecover() and have it call\r
+/// plain mismatch(), which does not recover. Then any error\r
+/// in a rule will cause an exception and immediate exit from\r
+/// rule. Rule would recover by resynchronizing to the set of\r
+/// symbols that can follow rule ref.\r
+///\r
+static void *\r
+match( pANTLR3_BASE_RECOGNIZER recognizer,\r
+ ANTLR3_UINT32 ttype, pANTLR3_BITSET_LIST follow)\r
+{\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+ pANTLR3_INT_STREAM is;\r
+ void * matchedSymbol;\r
+\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ tparser = NULL;\r
+ is = parser->tstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_TREE_PARSER:\r
+\r
+ tparser = (pANTLR3_TREE_PARSER) (recognizer->super);\r
+ parser = NULL;\r
+ is = tparser->ctnstream->tnstream->istream;\r
+\r
+ break;\r
+\r
+ default:\r
+ \r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function 'match' called by unknown parser type - provide override for this function\n");\r
+ return ANTLR3_FALSE;\r
+\r
+ break;\r
+ }\r
+\r
+ // Pick up the current input token/node for assignment to labels\r
+ //\r
+ matchedSymbol = recognizer->getCurrentInputSymbol(recognizer, is);\r
+\r
+ if (is->_LA(is, 1) == ttype)\r
+ {\r
+ // The token was the one we were told to expect\r
+ //\r
+ is->consume(is); // Consume that token from the stream\r
+ recognizer->state->errorRecovery = ANTLR3_FALSE; // Not in error recovery now (if we were)\r
+ recognizer->state->failed = ANTLR3_FALSE; // The match was a success\r
+ return matchedSymbol; // We are done\r
+ }\r
+\r
+ // We did not find the expected token type, if we are backtracking then\r
+ // we just set the failed flag and return.\r
+ //\r
+ if (recognizer->state->backtracking > 0)\r
+ {\r
+ // Backtracking is going on\r
+ //\r
+ recognizer->state->failed = ANTLR3_TRUE;\r
+ return matchedSymbol;\r
+ }\r
+\r
+ // We did not find the expected token and there is no backtracking\r
+ // going on, so we mismatch, which creates an exception in the recognizer exception\r
+ // stack.\r
+ //\r
+ matchedSymbol = recognizer->recoverFromMismatchedToken(recognizer, ttype, follow);\r
+ return matchedSymbol;\r
+}\r
+\r
+/// Consumes the next token, whatever it is, and resets the recognizer state\r
+/// so that it is not in error.\r
+///\r
+/// \param recognizer\r
+/// Recognizer context pointer\r
+///\r
+static void\r
+matchAny(pANTLR3_BASE_RECOGNIZER recognizer)\r
+{\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+ pANTLR3_INT_STREAM is;\r
+\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ tparser = NULL;\r
+ is = parser->tstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_TREE_PARSER:\r
+\r
+ tparser = (pANTLR3_TREE_PARSER) (recognizer->super);\r
+ parser = NULL;\r
+ is = tparser->ctnstream->tnstream->istream;\r
+\r
+ break;\r
+\r
+ default:\r
+ \r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function 'matchAny' called by unknown parser type - provide override for this function\n");\r
+ return;\r
+\r
+ break;\r
+ }\r
+ recognizer->state->errorRecovery = ANTLR3_FALSE;\r
+ recognizer->state->failed = ANTLR3_FALSE;\r
+ is->consume(is);\r
+\r
+ return;\r
+}\r
+///\r
+///\r
+static ANTLR3_BOOLEAN\r
+mismatchIsUnwantedToken(pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_INT_STREAM is, ANTLR3_UINT32 ttype)\r
+{\r
+ ANTLR3_UINT32 nextt;\r
+\r
+ nextt = is->_LA(is, 2);\r
+\r
+ if (nextt == ttype)\r
+ {\r
+ if (recognizer->state->exception != NULL)\r
+ {\r
+ recognizer->state->exception->expecting = nextt;\r
+ }\r
+ return ANTLR3_TRUE; // This token is unknown, but the next one is the one we wanted\r
+ }\r
+ else\r
+ {\r
+ return ANTLR3_FALSE; // Neither this token, nor the one following is the one we wanted\r
+ }\r
+}\r
+\r
+///\r
+///\r
+static ANTLR3_BOOLEAN\r
+mismatchIsMissingToken(pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_INT_STREAM is, pANTLR3_BITSET_LIST follow)\r
+{\r
+ ANTLR3_BOOLEAN retcode;\r
+ pANTLR3_BITSET followClone;\r
+ pANTLR3_BITSET viableTokensFollowingThisRule;\r
+\r
+ if (follow == NULL)\r
+ {\r
+ // There is no information about the tokens that can follow the last one\r
+ // hence we must say that the current one we found is not a member of the \r
+ // follow set and does not indicate a missing token. We will just consume this\r
+ // single token and see if the parser works it out from there.\r
+ //\r
+ return ANTLR3_FALSE;\r
+ }\r
+\r
+ followClone = NULL;\r
+ viableTokensFollowingThisRule = NULL;\r
+\r
+ // The C bitset maps are laid down at compile time by the\r
+ // C code generation. Hence we cannot remove things from them\r
+ // and so on. So, in order to remove EOR (if we need to) then\r
+ // we clone the static bitset.\r
+ //\r
+ followClone = antlr3BitsetLoad(follow);\r
+ if (followClone == NULL)\r
+ {\r
+ return ANTLR3_FALSE;\r
+ }\r
+\r
+ // Compute what can follow this grammar reference\r
+ //\r
+ if (followClone->isMember(followClone, ANTLR3_EOR_TOKEN_TYPE))\r
+ {\r
+ // EOR can follow, but if we are not the start symbol, we\r
+ // need to remove it.\r
+ //\r
+ if (recognizer->state->following->vector->count >= 0)\r
+ {\r
+ followClone->remove(followClone, ANTLR3_EOR_TOKEN_TYPE);\r
+ }\r
+\r
+ // Now compute the visiable tokens that can follow this rule, according to context\r
+ // and make them part of the follow set.\r
+ //\r
+ viableTokensFollowingThisRule = recognizer->computeCSRuleFollow(recognizer);\r
+ followClone->borInPlace(followClone, viableTokensFollowingThisRule);\r
+ }\r
+\r
+ /// if current token is consistent with what could come after set\r
+ /// then we know we're missing a token; error recovery is free to\r
+ /// "insert" the missing token\r
+ ///\r
+ /// BitSet cannot handle negative numbers like -1 (EOF) so I leave EOR\r
+ /// in follow set to indicate that the fall of the start symbol is\r
+ /// in the set (EOF can follow).\r
+ ///\r
+ if ( followClone->isMember(followClone, is->_LA(is, 1))\r
+ || followClone->isMember(followClone, ANTLR3_EOR_TOKEN_TYPE)\r
+ )\r
+ {\r
+ retcode = ANTLR3_TRUE;\r
+ }\r
+ else\r
+ {\r
+ retcode = ANTLR3_FALSE;\r
+ }\r
+\r
+ if (viableTokensFollowingThisRule != NULL)\r
+ {\r
+ viableTokensFollowingThisRule->free(viableTokensFollowingThisRule);\r
+ }\r
+ if (followClone != NULL)\r
+ {\r
+ followClone->free(followClone);\r
+ }\r
+\r
+ return retcode;\r
+\r
+}\r
+\r
+/// Factor out what to do upon token mismatch so tree parsers can behave\r
+/// differently. Override and call mismatchRecover(input, ttype, follow)\r
+/// to get single token insertion and deletion. Use this to turn off\r
+/// single token insertion and deletion. Override mismatchRecover\r
+/// to call this instead.\r
+///\r
+/// \remark mismatch only works for parsers and must be overridden for anything else.\r
+///\r
+static void\r
+mismatch(pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_UINT32 ttype, pANTLR3_BITSET_LIST follow)\r
+{\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+ pANTLR3_INT_STREAM is;\r
+\r
+ // Install a mismatched token exception in the exception stack\r
+ //\r
+ antlr3MTExceptionNew(recognizer);\r
+ recognizer->state->exception->expecting = ttype;\r
+\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ tparser = NULL;\r
+ is = parser->tstream->istream;\r
+\r
+ break;\r
+\r
+ default:\r
+ \r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function 'mismatch' called by unknown parser type - provide override for this function\n");\r
+ return;\r
+\r
+ break;\r
+ }\r
+\r
+ if (mismatchIsUnwantedToken(recognizer, is, ttype))\r
+ {\r
+ // Create a basic recognition exception structure\r
+ //\r
+ antlr3RecognitionExceptionNew(recognizer);\r
+ \r
+ // Now update it to indicate this is an unwanted token exception\r
+ //\r
+ recognizer->state->exception->name = ANTLR3_UNWANTED_TOKEN_EXCEPTION_NAME;\r
+ recognizer->state->exception->type = ANTLR3_UNWANTED_TOKEN_EXCEPTION;\r
+\r
+ return;\r
+ }\r
+ \r
+ if (mismatchIsMissingToken(recognizer, is, follow))\r
+ {\r
+ // Create a basic recognition exception structure\r
+ //\r
+ antlr3RecognitionExceptionNew(recognizer);\r
+ \r
+ // Now update it to indicate this is an unwanted token exception\r
+ //\r
+ recognizer->state->exception->name = ANTLR3_MISSING_TOKEN_EXCEPTION_NAME;\r
+ recognizer->state->exception->type = ANTLR3_MISSING_TOKEN_EXCEPTION;\r
+\r
+ return;\r
+ }\r
+\r
+ // Just a mismatched token is all we can dtermine\r
+ //\r
+ antlr3MTExceptionNew(recognizer);\r
+\r
+ return;\r
+}\r
+/// Report a recognition problem.\r
+///\r
+/// This method sets errorRecovery to indicate the parser is recovering\r
+/// not parsing. Once in recovery mode, no errors are generated.\r
+/// To get out of recovery mode, the parser must successfully match\r
+/// a token (after a resync). So it will go:\r
+///\r
+/// 1. error occurs\r
+/// 2. enter recovery mode, report error\r
+/// 3. consume until token found in resynch set\r
+/// 4. try to resume parsing\r
+/// 5. next match() will reset errorRecovery mode\r
+///\r
+/// If you override, make sure to update errorCount if you care about that.\r
+///\r
+static void \r
+reportError (pANTLR3_BASE_RECOGNIZER recognizer)\r
+{\r
+ if (recognizer->state->errorRecovery == ANTLR3_TRUE)\r
+ {\r
+ // Already in error recovery so don't display another error while doing so\r
+ //\r
+ return;\r
+ }\r
+\r
+ // Signal we are in error recovery now\r
+ //\r
+ recognizer->state->errorRecovery = ANTLR3_TRUE;\r
+ \r
+ // Indicate this recognizer had an error while processing.\r
+ //\r
+ recognizer->state->errorCount++;\r
+\r
+ // Call the error display routine\r
+ //\r
+ recognizer->displayRecognitionError(recognizer, recognizer->state->tokenNames);\r
+}\r
+\r
+static void\r
+beginBacktrack (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_UINT32 level)\r
+{\r
+ if (recognizer->debugger != NULL)\r
+ {\r
+ recognizer->debugger->beginBacktrack(recognizer->debugger, level);\r
+ }\r
+}\r
+\r
+static void\r
+endBacktrack (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_UINT32 level, ANTLR3_BOOLEAN successful)\r
+{\r
+ if (recognizer->debugger != NULL)\r
+ {\r
+ recognizer->debugger->endBacktrack(recognizer->debugger, level, successful);\r
+ }\r
+}\r
+static void \r
+beginResync (pANTLR3_BASE_RECOGNIZER recognizer)\r
+{\r
+ if (recognizer->debugger != NULL)\r
+ {\r
+ recognizer->debugger->beginResync(recognizer->debugger);\r
+ }\r
+}\r
+\r
+static void \r
+endResync (pANTLR3_BASE_RECOGNIZER recognizer)\r
+{\r
+ if (recognizer->debugger != NULL)\r
+ {\r
+ recognizer->debugger->endResync(recognizer->debugger);\r
+ }\r
+}\r
+\r
+/// Compute the error recovery set for the current rule.\r
+/// Documentation below is from the Java implementation.\r
+///\r
+/// During rule invocation, the parser pushes the set of tokens that can\r
+/// follow that rule reference on the stack; this amounts to\r
+/// computing FIRST of what follows the rule reference in the\r
+/// enclosing rule. This local follow set only includes tokens\r
+/// from within the rule; i.e., the FIRST computation done by\r
+/// ANTLR stops at the end of a rule.\r
+//\r
+/// EXAMPLE\r
+//\r
+/// When you find a "no viable alt exception", the input is not\r
+/// consistent with any of the alternatives for rule r. The best\r
+/// thing to do is to consume tokens until you see something that\r
+/// can legally follow a call to r *or* any rule that called r.\r
+/// You don't want the exact set of viable next tokens because the\r
+/// input might just be missing a token--you might consume the\r
+/// rest of the input looking for one of the missing tokens.\r
+///\r
+/// Consider grammar:\r
+///\r
+/// a : '[' b ']'\r
+/// | '(' b ')'\r
+/// ;\r
+/// b : c '^' INT ;\r
+/// c : ID\r
+/// | INT\r
+/// ;\r
+///\r
+/// At each rule invocation, the set of tokens that could follow\r
+/// that rule is pushed on a stack. Here are the various "local"\r
+/// follow sets:\r
+///\r
+/// FOLLOW(b1_in_a) = FIRST(']') = ']'\r
+/// FOLLOW(b2_in_a) = FIRST(')') = ')'\r
+/// FOLLOW(c_in_b) = FIRST('^') = '^'\r
+///\r
+/// Upon erroneous input "[]", the call chain is\r
+///\r
+/// a -> b -> c\r
+///\r
+/// and, hence, the follow context stack is:\r
+///\r
+/// depth local follow set after call to rule\r
+/// 0 <EOF> a (from main())\r
+/// 1 ']' b\r
+/// 3 '^' c\r
+///\r
+/// Notice that ')' is not included, because b would have to have\r
+/// been called from a different context in rule a for ')' to be\r
+/// included.\r
+///\r
+/// For error recovery, we cannot consider FOLLOW(c)\r
+/// (context-sensitive or otherwise). We need the combined set of\r
+/// all context-sensitive FOLLOW sets--the set of all tokens that\r
+/// could follow any reference in the call chain. We need to\r
+/// resync to one of those tokens. Note that FOLLOW(c)='^' and if\r
+/// we resync'd to that token, we'd consume until EOF. We need to\r
+/// sync to context-sensitive FOLLOWs for a, b, and c: {']','^'}.\r
+/// In this case, for input "[]", LA(1) is in this set so we would\r
+/// not consume anything and after printing an error rule c would\r
+/// return normally. It would not find the required '^' though.\r
+/// At this point, it gets a mismatched token error and throws an\r
+/// exception (since LA(1) is not in the viable following token\r
+/// set). The rule exception handler tries to recover, but finds\r
+/// the same recovery set and doesn't consume anything. Rule b\r
+/// exits normally returning to rule a. Now it finds the ']' (and\r
+/// with the successful match exits errorRecovery mode).\r
+///\r
+/// So, you can see that the parser walks up call chain looking\r
+/// for the token that was a member of the recovery set.\r
+///\r
+/// Errors are not generated in errorRecovery mode.\r
+///\r
+/// ANTLR's error recovery mechanism is based upon original ideas:\r
+///\r
+/// "Algorithms + Data Structures = Programs" by Niklaus Wirth\r
+///\r
+/// and\r
+///\r
+/// "A note on error recovery in recursive descent parsers":\r
+/// http://portal.acm.org/citation.cfm?id=947902.947905\r
+///\r
+/// Later, Josef Grosch had some good ideas:\r
+///\r
+/// "Efficient and Comfortable Error Recovery in Recursive Descent\r
+/// Parsers":\r
+/// ftp://www.cocolab.com/products/cocktail/doca4.ps/ell.ps.zip\r
+///\r
+/// Like Grosch I implemented local FOLLOW sets that are combined\r
+/// at run-time upon error to avoid overhead during parsing.\r
+///\r
+static pANTLR3_BITSET \r
+computeErrorRecoverySet (pANTLR3_BASE_RECOGNIZER recognizer)\r
+{\r
+ return recognizer->combineFollows(recognizer, ANTLR3_FALSE);\r
+}\r
+\r
+/// Compute the context-sensitive FOLLOW set for current rule.\r
+/// Documentation below is from the Java runtime.\r
+///\r
+/// This is the set of token types that can follow a specific rule\r
+/// reference given a specific call chain. You get the set of\r
+/// viable tokens that can possibly come next (look ahead depth 1)\r
+/// given the current call chain. Contrast this with the\r
+/// definition of plain FOLLOW for rule r:\r
+///\r
+/// FOLLOW(r)={x | S=>*alpha r beta in G and x in FIRST(beta)}\r
+///\r
+/// where x in T* and alpha, beta in V*; T is set of terminals and\r
+/// V is the set of terminals and non terminals. In other words,\r
+/// FOLLOW(r) is the set of all tokens that can possibly follow\r
+/// references to r in///any* sentential form (context). At\r
+/// runtime, however, we know precisely which context applies as\r
+/// we have the call chain. We may compute the exact (rather\r
+/// than covering superset) set of following tokens.\r
+///\r
+/// For example, consider grammar:\r
+///\r
+/// stat : ID '=' expr ';' // FOLLOW(stat)=={EOF}\r
+/// | "return" expr '.'\r
+/// ;\r
+/// expr : atom ('+' atom)* ; // FOLLOW(expr)=={';','.',')'}\r
+/// atom : INT // FOLLOW(atom)=={'+',')',';','.'}\r
+/// | '(' expr ')'\r
+/// ;\r
+///\r
+/// The FOLLOW sets are all inclusive whereas context-sensitive\r
+/// FOLLOW sets are precisely what could follow a rule reference.\r
+/// For input input "i=(3);", here is the derivation:\r
+///\r
+/// stat => ID '=' expr ';'\r
+/// => ID '=' atom ('+' atom)* ';'\r
+/// => ID '=' '(' expr ')' ('+' atom)* ';'\r
+/// => ID '=' '(' atom ')' ('+' atom)* ';'\r
+/// => ID '=' '(' INT ')' ('+' atom)* ';'\r
+/// => ID '=' '(' INT ')' ';'\r
+///\r
+/// At the "3" token, you'd have a call chain of\r
+///\r
+/// stat -> expr -> atom -> expr -> atom\r
+///\r
+/// What can follow that specific nested ref to atom? Exactly ')'\r
+/// as you can see by looking at the derivation of this specific\r
+/// input. Contrast this with the FOLLOW(atom)={'+',')',';','.'}.\r
+///\r
+/// You want the exact viable token set when recovering from a\r
+/// token mismatch. Upon token mismatch, if LA(1) is member of\r
+/// the viable next token set, then you know there is most likely\r
+/// a missing token in the input stream. "Insert" one by just not\r
+/// throwing an exception.\r
+///\r
+static pANTLR3_BITSET \r
+computeCSRuleFollow (pANTLR3_BASE_RECOGNIZER recognizer)\r
+{\r
+ return recognizer->combineFollows(recognizer, ANTLR3_FALSE);\r
+}\r
+\r
+/// Compute the current followset for the input stream.\r
+///\r
+static pANTLR3_BITSET \r
+combineFollows (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_BOOLEAN exact)\r
+{\r
+ pANTLR3_BITSET followSet;\r
+ pANTLR3_BITSET localFollowSet;\r
+ ANTLR3_UINT32 top;\r
+ ANTLR3_UINT32 i;\r
+\r
+ top = recognizer->state->following->size(recognizer->state->following);\r
+\r
+ followSet = antlr3BitsetNew(0);\r
+ localFollowSet = NULL;\r
+\r
+ for (i = top; i>0; i--)\r
+ {\r
+ localFollowSet = antlr3BitsetLoad((pANTLR3_BITSET_LIST) recognizer->state->following->get(recognizer->state->following, i-1));\r
+\r
+ if (localFollowSet != NULL)\r
+ {\r
+ followSet->borInPlace(followSet, localFollowSet);\r
+\r
+ if (exact == ANTLR3_TRUE)\r
+ {\r
+ if (localFollowSet->isMember(localFollowSet, ANTLR3_EOR_TOKEN_TYPE) == ANTLR3_FALSE)\r
+ {\r
+ // Only leave EOR in the set if at top (start rule); this lets us know\r
+ // if we have to include the follow(start rule); I.E., EOF\r
+ //\r
+ if (i>1)\r
+ {\r
+ followSet->remove(followSet, ANTLR3_EOR_TOKEN_TYPE);\r
+ }\r
+ }\r
+ else\r
+ {\r
+ break; // Cannot see End Of Rule from here, just drop out\r
+ }\r
+ }\r
+ localFollowSet->free(localFollowSet);\r
+ localFollowSet = NULL;\r
+ }\r
+ }\r
+\r
+ if (localFollowSet != NULL)\r
+ {\r
+ localFollowSet->free(localFollowSet);\r
+ }\r
+ return followSet;\r
+}\r
+\r
+/// Standard/Example error display method.\r
+/// No generic error message display funciton coudl possibly do everything correctly\r
+/// for all possible parsers. Hence you are provided with this example routine, which\r
+/// you should override in your parser/tree parser to do as you will.\r
+///\r
+/// Here we depart somewhat from the Java runtime as that has now split up a lot\r
+/// of the error display routines into spearate units. However, ther is little advantage\r
+/// to this in the C version as you will probably implement all such routines as a \r
+/// separate translation unit, rather than install them all as pointers to functions\r
+/// in the base recognizer.\r
+///\r
+static void \r
+displayRecognitionError (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_UINT8 * tokenNames)\r
+{\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+ pANTLR3_INT_STREAM is;\r
+ pANTLR3_STRING ttext;\r
+ pANTLR3_STRING ftext;\r
+ pANTLR3_EXCEPTION ex;\r
+ pANTLR3_COMMON_TOKEN theToken;\r
+ pANTLR3_BASE_TREE theBaseTree;\r
+ pANTLR3_COMMON_TREE theCommonTree;\r
+\r
+ // Retrieve some info for easy reading.\r
+ //\r
+ ex = recognizer->state->exception;\r
+ ttext = NULL;\r
+\r
+ // See if there is a 'filename' we can use\r
+ //\r
+ if (ex->streamName == NULL)\r
+ {\r
+ if (((pANTLR3_COMMON_TOKEN)(ex->token))->type == ANTLR3_TOKEN_EOF)\r
+ {\r
+ ANTLR3_FPRINTF(stderr, "-end of input-(");\r
+ }\r
+ else\r
+ {\r
+ ANTLR3_FPRINTF(stderr, "-unknown source-(");\r
+ }\r
+ }\r
+ else\r
+ {\r
+ ftext = ex->streamName->to8(ex->streamName);\r
+ ANTLR3_FPRINTF(stderr, "%s(", ftext->chars);\r
+ }\r
+\r
+ // Next comes the line number\r
+ //\r
+\r
+ ANTLR3_FPRINTF(stderr, "%d) ", recognizer->state->exception->line);\r
+ ANTLR3_FPRINTF(stderr, " : error %d : %s", \r
+ recognizer->state->exception->type,\r
+ (pANTLR3_UINT8) (recognizer->state->exception->message));\r
+\r
+\r
+ // How we determine the next piece is dependent on which thing raised the\r
+ // error.\r
+ //\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ // Prepare the knowledge we know we have\r
+ //\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ tparser = NULL;\r
+ is = parser->tstream->istream;\r
+ theToken = (pANTLR3_COMMON_TOKEN)(recognizer->state->exception->token);\r
+ ttext = theToken->toString(theToken);\r
+\r
+ ANTLR3_FPRINTF(stderr, ", at offset %d", recognizer->state->exception->charPositionInLine);\r
+ if (theToken != NULL)\r
+ {\r
+ if (theToken->type == ANTLR3_TOKEN_EOF)\r
+ {\r
+ ANTLR3_FPRINTF(stderr, ", at <EOF>");\r
+ }\r
+ else\r
+ {\r
+ // Guard against null text in a token\r
+ //\r
+ ANTLR3_FPRINTF(stderr, "\n near %s\n ", ttext == NULL ? (pANTLR3_UINT8)"<no text for the token>" : ttext->chars);\r
+ }\r
+ }\r
+ break;\r
+\r
+ case ANTLR3_TYPE_TREE_PARSER:\r
+\r
+ tparser = (pANTLR3_TREE_PARSER) (recognizer->super);\r
+ parser = NULL;\r
+ is = tparser->ctnstream->tnstream->istream;\r
+ theBaseTree = (pANTLR3_BASE_TREE)(recognizer->state->exception->token);\r
+ ttext = theBaseTree->toStringTree(theBaseTree);\r
+\r
+ if (theBaseTree != NULL)\r
+ {\r
+ theCommonTree = (pANTLR3_COMMON_TREE) theBaseTree->super;\r
+\r
+ if (theCommonTree != NULL)\r
+ {\r
+ theToken = (pANTLR3_COMMON_TOKEN) theBaseTree->getToken(theBaseTree);\r
+ }\r
+ ANTLR3_FPRINTF(stderr, ", at offset %d", theBaseTree->getCharPositionInLine(theBaseTree));\r
+ ANTLR3_FPRINTF(stderr, ", near %s", ttext->chars);\r
+ }\r
+ break;\r
+\r
+ default:\r
+\r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function displayRecognitionError called by unknown parser type - provide override for this function\n");\r
+ return;\r
+ break;\r
+ }\r
+\r
+ // Although this function should generally be provided by the implementation, this one\r
+ // should be as helpful as possible for grammar developers and serve as an example\r
+ // of what you can do with each exception type. In general, when you make up your\r
+ // 'real' handler, you should debug the routine with all possible errors you expect\r
+ // which will then let you be as specific as possible about all circumstances.\r
+ //\r
+ // Note that in the general case, errors thrown by tree parsers indicate a problem\r
+ // with the output of the parser or with the tree grammar itself. The job of the parser\r
+ // is to produce a perfect (in traversal terms) syntactically correct tree, so errors\r
+ // at that stage should really be semantic errors that your own code determines and handles\r
+ // in whatever way is appropriate.\r
+ //\r
+ switch (ex->type)\r
+ {\r
+ case ANTLR3_UNWANTED_TOKEN_EXCEPTION:\r
+\r
+ // Indicates that the recognizer was fed a token which seesm to be\r
+ // spurious input. We can detect this when the token that follows\r
+ // this unwanted token would normally be part of the syntactically\r
+ // correct stream. Then we can see that the token we are looking at\r
+ // is just something that should not be there and throw this exception.\r
+ //\r
+ if (tokenNames == NULL)\r
+ {\r
+ ANTLR3_FPRINTF(stderr, " : Extraneous input...");\r
+ }\r
+ else\r
+ {\r
+ if (ex->expecting == ANTLR3_TOKEN_EOF)\r
+ {\r
+ ANTLR3_FPRINTF(stderr, " : Extraneous input - expected <EOF>\n");\r
+ }\r
+ else\r
+ {\r
+ ANTLR3_FPRINTF(stderr, " : Extraneous input - expected %s ...\n", tokenNames[ex->expecting]);\r
+ }\r
+ }\r
+ break;\r
+\r
+ case ANTLR3_MISSING_TOKEN_EXCEPTION:\r
+\r
+ // Indicates that the recognizer detected that the token we just\r
+ // hit would be valid syntactically if preceeded by a particular \r
+ // token. Perhaps a missing ';' at line end or a missing ',' in an\r
+ // expression list, and such like.\r
+ //\r
+ if (tokenNames == NULL)\r
+ {\r
+ ANTLR3_FPRINTF(stderr, " : Missing token (%d)...\n", ex->expecting);\r
+ }\r
+ else\r
+ {\r
+ if (ex->expecting == ANTLR3_TOKEN_EOF)\r
+ {\r
+ ANTLR3_FPRINTF(stderr, " : Missing <EOF>\n");\r
+ }\r
+ else\r
+ {\r
+ ANTLR3_FPRINTF(stderr, " : Missing %s \n", tokenNames[ex->expecting]);\r
+ }\r
+ }\r
+ break;\r
+\r
+ case ANTLR3_RECOGNITION_EXCEPTION:\r
+\r
+ // Indicates that the recognizer received a token\r
+ // in the input that was not predicted. This is the basic exception type \r
+ // from which all others are derived. So we assume it was a syntax error.\r
+ // You may get this if there are not more tokens and more are needed\r
+ // to complete a parse for instance.\r
+ //\r
+ ANTLR3_FPRINTF(stderr, " : syntax error...\n"); \r
+ break;\r
+\r
+ case ANTLR3_MISMATCHED_TOKEN_EXCEPTION:\r
+\r
+ // We were expecting to see one thing and got another. This is the\r
+ // most common error if we coudl not detect a missing or unwanted token.\r
+ // Here you can spend your efforts to\r
+ // derive more useful error messages based on the expected\r
+ // token set and the last token and so on. The error following\r
+ // bitmaps do a good job of reducing the set that we were looking\r
+ // for down to something small. Knowing what you are parsing may be\r
+ // able to allow you to be even more specific about an error.\r
+ //\r
+ if (tokenNames == NULL)\r
+ {\r
+ ANTLR3_FPRINTF(stderr, " : syntax error...\n");\r
+ }\r
+ else\r
+ {\r
+ if (ex->expecting == ANTLR3_TOKEN_EOF)\r
+ {\r
+ ANTLR3_FPRINTF(stderr, " : expected <EOF>\n");\r
+ }\r
+ else\r
+ {\r
+ ANTLR3_FPRINTF(stderr, " : expected %s ...\n", tokenNames[ex->expecting]);\r
+ }\r
+ }\r
+ break;\r
+\r
+ case ANTLR3_NO_VIABLE_ALT_EXCEPTION:\r
+\r
+ // We could not pick any alt decision from the input given\r
+ // so god knows what happened - however when you examine your grammar,\r
+ // you should. It means that at the point where the current token occurred\r
+ // that the DFA indicates nowhere to go from here.\r
+ //\r
+ ANTLR3_FPRINTF(stderr, " : cannot match to any predicted input...\n");\r
+\r
+ break;\r
+\r
+ case ANTLR3_MISMATCHED_SET_EXCEPTION:\r
+\r
+ {\r
+ ANTLR3_UINT32 count;\r
+ ANTLR3_UINT32 bit;\r
+ ANTLR3_UINT32 size;\r
+ ANTLR3_UINT32 numbits;\r
+ pANTLR3_BITSET errBits;\r
+\r
+ // This means we were able to deal with one of a set of\r
+ // possible tokens at this point, but we did not see any\r
+ // member of that set.\r
+ //\r
+ ANTLR3_FPRINTF(stderr, " : unexpected input...\n expected one of : ");\r
+\r
+ // What tokens could we have accepted at this point in the\r
+ // parse?\r
+ //\r
+ count = 0;\r
+ errBits = antlr3BitsetLoad (ex->expectingSet);\r
+ numbits = errBits->numBits (errBits);\r
+ size = errBits->size (errBits);\r
+\r
+ if (size > 0)\r
+ {\r
+ // However many tokens we could have dealt with here, it is usually\r
+ // not useful to print ALL of the set here. I arbitrarily chose 8\r
+ // here, but you should do whatever makes sense for you of course.\r
+ // No token number 0, so look for bit 1 and on.\r
+ //\r
+ for (bit = 1; bit < numbits && count < 8 && count < size; bit++)\r
+ {\r
+ // TODO: This doesn;t look right - should be asking if the bit is set!!\r
+ //\r
+ if (tokenNames[bit])\r
+ {\r
+ ANTLR3_FPRINTF(stderr, "%s%s", count > 0 ? ", " : "", tokenNames[bit]); \r
+ count++;\r
+ }\r
+ }\r
+ ANTLR3_FPRINTF(stderr, "\n");\r
+ }\r
+ else\r
+ {\r
+ ANTLR3_FPRINTF(stderr, "Actually dude, we didn't seem to be expecting anything here, or at least\n");\r
+ ANTLR3_FPRINTF(stderr, "I could not work out what I was expecting, like so many of us these days!\n");\r
+ }\r
+ }\r
+ break;\r
+\r
+ case ANTLR3_EARLY_EXIT_EXCEPTION:\r
+\r
+ // We entered a loop requiring a number of token sequences\r
+ // but found a token that ended that sequence earlier than\r
+ // we should have done.\r
+ //\r
+ ANTLR3_FPRINTF(stderr, " : missing elements...\n");\r
+ break;\r
+\r
+ default:\r
+\r
+ // We don't handle any other exceptions here, but you can\r
+ // if you wish. If we get an exception that hits this point\r
+ // then we are just going to report what we know about the\r
+ // token.\r
+ //\r
+ ANTLR3_FPRINTF(stderr, " : syntax not recognized...\n");\r
+ break;\r
+ }\r
+\r
+ // Here you have the token that was in error which if this is\r
+ // the standard implementation will tell you the line and offset\r
+ // and also record the address of the start of the line in the\r
+ // input stream. You could therefore print the source line and so on.\r
+ // Generally though, I would expect that your lexer/parser will keep\r
+ // its own map of lines and source pointers or whatever as there\r
+ // are a lot of specific things you need to know about the input\r
+ // to do something like that.\r
+ // Here is where you do it though :-).\r
+ //\r
+}\r
+\r
+/// Return how many syntax errors were detected by this recognizer\r
+///\r
+static ANTLR3_UINT32\r
+getNumberOfSyntaxErrors(pANTLR3_BASE_RECOGNIZER recognizer)\r
+{\r
+ return recognizer->state->errorCount;\r
+}\r
+\r
+/// Recover from an error found on the input stream. Mostly this is\r
+/// NoViableAlt exceptions, but could be a mismatched token that\r
+/// the match() routine could not recover from.\r
+///\r
+static void \r
+recover (pANTLR3_BASE_RECOGNIZER recognizer)\r
+{\r
+ // Used to compute the follow set of tokens\r
+ //\r
+ pANTLR3_BITSET followSet;\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+ pANTLR3_INT_STREAM is;\r
+\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ tparser = NULL;\r
+ is = parser->tstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_TREE_PARSER:\r
+\r
+ tparser = (pANTLR3_TREE_PARSER) (recognizer->super);\r
+ parser = NULL;\r
+ is = tparser->ctnstream->tnstream->istream;\r
+\r
+ break;\r
+\r
+ default:\r
+ \r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function recover called by unknown parser type - provide override for this function\n");\r
+ return;\r
+\r
+ break;\r
+ }\r
+\r
+ // Are we about to repeat the same error?\r
+ //\r
+ if (recognizer->state->lastErrorIndex == is->index(is))\r
+ {\r
+ // The last error was at the same token index point. This must be a case\r
+ // where LT(1) is in the recovery token set so nothing is\r
+ // consumed. Consume a single token so at least to prevent\r
+ // an infinite loop; this is a failsafe.\r
+ //\r
+ is->consume(is);\r
+ }\r
+\r
+ // Record error index position\r
+ //\r
+ recognizer->state->lastErrorIndex = is->index(is);\r
+ \r
+ // Work out the follows set for error recovery\r
+ //\r
+ followSet = recognizer->computeErrorRecoverySet(recognizer);\r
+\r
+ // Call resync hook (for debuggers and so on)\r
+ //\r
+ recognizer->beginResync(recognizer);\r
+\r
+ // Consume tokens until we have resynced to something in the follows set\r
+ //\r
+ recognizer->consumeUntilSet(recognizer, followSet);\r
+\r
+ // End resync hook \r
+ //\r
+ recognizer->endResync(recognizer);\r
+\r
+ // Destroy the temporary bitset we produced.\r
+ //\r
+ followSet->free(followSet);\r
+\r
+ // Reset the inError flag so we don't re-report the exception\r
+ //\r
+ recognizer->state->error = ANTLR3_FALSE;\r
+ recognizer->state->failed = ANTLR3_FALSE;\r
+}\r
+\r
+\r
+/// Attempt to recover from a single missing or extra token.\r
+///\r
+/// EXTRA TOKEN\r
+///\r
+/// LA(1) is not what we are looking for. If LA(2) has the right token,\r
+/// however, then assume LA(1) is some extra spurious token. Delete it\r
+/// and LA(2) as if we were doing a normal match(), which advances the\r
+/// input.\r
+///\r
+/// MISSING TOKEN\r
+///\r
+/// If current token is consistent with what could come after\r
+/// ttype then it is ok to "insert" the missing token, else throw\r
+/// exception For example, Input "i=(3;" is clearly missing the\r
+/// ')'. When the parser returns from the nested call to expr, it\r
+/// will have call chain:\r
+///\r
+/// stat -> expr -> atom\r
+///\r
+/// and it will be trying to match the ')' at this point in the\r
+/// derivation:\r
+///\r
+/// => ID '=' '(' INT ')' ('+' atom)* ';'\r
+/// ^\r
+/// match() will see that ';' doesn't match ')' and report a\r
+/// mismatched token error. To recover, it sees that LA(1)==';'\r
+/// is in the set of tokens that can follow the ')' token\r
+/// reference in rule atom. It can assume that you forgot the ')'.\r
+///\r
+/// The exception that was passed in, in the java implementation is\r
+/// sorted in the recognizer exception stack in the C version. To 'throw' it we set the\r
+/// error flag and rules cascade back when this is set.\r
+///\r
+static void * \r
+recoverFromMismatchedToken (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_UINT32 ttype, pANTLR3_BITSET_LIST follow)\r
+{\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+ pANTLR3_INT_STREAM is;\r
+ void * matchedSymbol;\r
+\r
+ // Invoke the debugger event if there is a debugger listening to us\r
+ //\r
+ if (recognizer->debugger != NULL)\r
+ {\r
+ recognizer->debugger->recognitionException(recognizer->debugger, recognizer->state->exception);\r
+ }\r
+\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ tparser = NULL;\r
+ is = parser->tstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_TREE_PARSER:\r
+\r
+ tparser = (pANTLR3_TREE_PARSER) (recognizer->super);\r
+ parser = NULL;\r
+ is = tparser->ctnstream->tnstream->istream;\r
+\r
+ break;\r
+\r
+ default:\r
+\r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function recoverFromMismatchedToken called by unknown parser type - provide override for this function\n");\r
+ return NULL;\r
+\r
+ break;\r
+ }\r
+\r
+ // Create an exception if we need one\r
+ //\r
+ if (recognizer->state->exception == NULL)\r
+ {\r
+ antlr3RecognitionExceptionNew(recognizer);\r
+ }\r
+\r
+ // If the next token after the one we are looking at in the input stream\r
+ // is what we are looking for then we remove the one we have discovered\r
+ // from the stream by consuming it, then consume this next one along too as\r
+ // if nothing had happened.\r
+ //\r
+ if ( recognizer->mismatchIsUnwantedToken(recognizer, is, ttype) == ANTLR3_TRUE)\r
+ {\r
+ recognizer->state->exception->type = ANTLR3_UNWANTED_TOKEN_EXCEPTION;\r
+ recognizer->state->exception->message = ANTLR3_UNWANTED_TOKEN_EXCEPTION_NAME;\r
+\r
+ // Call resync hook (for debuggers and so on)\r
+ //\r
+ if (recognizer->debugger != NULL)\r
+ {\r
+ recognizer->debugger->beginResync(recognizer->debugger);\r
+ }\r
+\r
+ recognizer->beginResync(recognizer);\r
+\r
+ // "delete" the extra token\r
+ //\r
+ recognizer->beginResync(recognizer);\r
+ is->consume(is);\r
+ recognizer->endResync(recognizer);\r
+ // End resync hook \r
+ //\r
+ if (recognizer->debugger != NULL)\r
+ {\r
+ recognizer->debugger->endResync(recognizer->debugger);\r
+ }\r
+\r
+ // Print out the error after we consume so that ANTLRWorks sees the\r
+ // token in the exception.\r
+ //\r
+ recognizer->reportError(recognizer);\r
+\r
+ // Return the token we are actually matching\r
+ //\r
+ matchedSymbol = recognizer->getCurrentInputSymbol(recognizer, is);\r
+\r
+ // Consume the token that the rule actually expected to get as if everything\r
+ // was hunky dory.\r
+ //\r
+ is->consume(is);\r
+\r
+ recognizer->state->error = ANTLR3_FALSE; // Exception is not outstanding any more\r
+\r
+ return matchedSymbol;\r
+ }\r
+\r
+ // Single token deletion (Unwanted above) did not work\r
+ // so we see if we can insert a token instead by calculating which\r
+ // token would be missing\r
+ //\r
+ if (mismatchIsMissingToken(recognizer, is, follow))\r
+ {\r
+ // We can fake the missing token and proceed\r
+ //\r
+ matchedSymbol = recognizer->getMissingSymbol(recognizer, is, recognizer->state->exception, ttype, follow);\r
+ recognizer->state->exception->type = ANTLR3_MISSING_TOKEN_EXCEPTION;\r
+ recognizer->state->exception->message = ANTLR3_MISSING_TOKEN_EXCEPTION_NAME;\r
+ recognizer->state->exception->token = matchedSymbol;\r
+ recognizer->state->exception->expecting = ttype;\r
+\r
+ // Print out the error after we insert so that ANTLRWorks sees the\r
+ // token in the exception.\r
+ //\r
+ recognizer->reportError(recognizer);\r
+\r
+ recognizer->state->error = ANTLR3_FALSE; // Exception is not outstanding any more\r
+\r
+ return matchedSymbol;\r
+ }\r
+\r
+\r
+ // Neither deleting nor inserting tokens allows recovery\r
+ // must just report the exception.\r
+ //\r
+ recognizer->state->error = ANTLR3_TRUE;\r
+ return NULL;\r
+}\r
+\r
+static void *\r
+recoverFromMismatchedSet (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_BITSET_LIST follow)\r
+{\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+ pANTLR3_INT_STREAM is;\r
+ pANTLR3_COMMON_TOKEN matchedSymbol;\r
+\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ tparser = NULL;\r
+ is = parser->tstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_TREE_PARSER:\r
+\r
+ tparser = (pANTLR3_TREE_PARSER) (recognizer->super);\r
+ parser = NULL;\r
+ is = tparser->ctnstream->tnstream->istream;\r
+\r
+ break;\r
+\r
+ default:\r
+ \r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function recoverFromMismatchedSet called by unknown parser type - provide override for this function\n");\r
+ return NULL;\r
+\r
+ break;\r
+ }\r
+\r
+ if (recognizer->mismatchIsMissingToken(recognizer, is, follow) == ANTLR3_TRUE)\r
+ {\r
+ // We can fake the missing token and proceed\r
+ //\r
+ matchedSymbol = recognizer->getMissingSymbol(recognizer, is, recognizer->state->exception, ANTLR3_TOKEN_INVALID, follow);\r
+ recognizer->state->exception->type = ANTLR3_MISSING_TOKEN_EXCEPTION;\r
+ recognizer->state->exception->token = matchedSymbol;\r
+\r
+ // Print out the error after we insert so that ANTLRWorks sees the\r
+ // token in the exception.\r
+ //\r
+ recognizer->reportError(recognizer);\r
+\r
+ recognizer->state->error = ANTLR3_FALSE; // Exception is not outstanding any more\r
+\r
+ return matchedSymbol;\r
+ }\r
+\r
+ // TODO - Single token deletion like in recoverFromMismatchedToken()\r
+ //\r
+ recognizer->state->error = ANTLR3_TRUE;\r
+ recognizer->state->failed = ANTLR3_TRUE;\r
+ return NULL;\r
+}\r
+\r
+/// This code is factored out from mismatched token and mismatched set\r
+/// recovery. It handles "single token insertion" error recovery for\r
+/// both. No tokens are consumed to recover from insertions. Return\r
+/// true if recovery was possible else return false.\r
+///\r
+static ANTLR3_BOOLEAN \r
+recoverFromMismatchedElement (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_BITSET_LIST followBits)\r
+{\r
+ pANTLR3_BITSET viableToksFollowingRule;\r
+ pANTLR3_BITSET follow;\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+ pANTLR3_INT_STREAM is;\r
+\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ tparser = NULL;\r
+ is = parser->tstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_TREE_PARSER:\r
+\r
+ tparser = (pANTLR3_TREE_PARSER) (recognizer->super);\r
+ parser = NULL;\r
+ is = tparser->ctnstream->tnstream->istream;\r
+\r
+ break;\r
+\r
+ default:\r
+ \r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function recover called by unknown parser type - provide override for this function\n");\r
+ return ANTLR3_FALSE;\r
+\r
+ break;\r
+ }\r
+\r
+ follow = antlr3BitsetLoad(followBits);\r
+\r
+ if (follow == NULL)\r
+ {\r
+ /* The follow set is NULL, which means we don't know what can come \r
+ * next, so we "hit and hope" by just signifying that we cannot\r
+ * recover, which will just cause the next token to be consumed,\r
+ * which might dig us out.\r
+ */\r
+ return ANTLR3_FALSE;\r
+ }\r
+\r
+ /* We have a bitmap for the follow set, hence we can compute \r
+ * what can follow this grammar element reference.\r
+ */\r
+ if (follow->isMember(follow, ANTLR3_EOR_TOKEN_TYPE) == ANTLR3_TRUE)\r
+ {\r
+ /* First we need to know which of the available tokens are viable\r
+ * to follow this reference.\r
+ */\r
+ viableToksFollowingRule = recognizer->computeCSRuleFollow(recognizer);\r
+\r
+ /* Remove the EOR token, which we do not wish to compute with\r
+ */\r
+ follow->remove(follow, ANTLR3_EOR_TOKEN_TYPE);\r
+ viableToksFollowingRule->free(viableToksFollowingRule);\r
+ /* We now have the computed set of what can follow the current token\r
+ */\r
+ }\r
+\r
+ /* We can now see if the current token works with the set of tokens\r
+ * that could follow the current grammar reference. If it looks like it\r
+ * is consistent, then we can "insert" that token by not throwing\r
+ * an exception and assuming that we saw it. \r
+ */\r
+ if ( follow->isMember(follow, is->_LA(is, 1)) == ANTLR3_TRUE)\r
+ {\r
+ /* report the error, but don't cause any rules to abort and stuff\r
+ */\r
+ recognizer->reportError(recognizer);\r
+ if (follow != NULL)\r
+ {\r
+ follow->free(follow);\r
+ }\r
+ recognizer->state->error = ANTLR3_FALSE;\r
+ recognizer->state->failed = ANTLR3_FALSE;\r
+ return ANTLR3_TRUE; /* Success in recovery */\r
+ }\r
+\r
+ if (follow != NULL)\r
+ {\r
+ follow->free(follow);\r
+ }\r
+\r
+ /* We could not find anything viable to do, so this is going to \r
+ * cause an exception.\r
+ */\r
+ return ANTLR3_FALSE;\r
+}\r
+\r
+/// Eat tokens from the input stream until we get one of JUST the right type\r
+///\r
+static void \r
+consumeUntil (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_UINT32 tokenType)\r
+{\r
+ ANTLR3_UINT32 ttype;\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+ pANTLR3_INT_STREAM is;\r
+\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ tparser = NULL;\r
+ is = parser->tstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_TREE_PARSER:\r
+\r
+ tparser = (pANTLR3_TREE_PARSER) (recognizer->super);\r
+ parser = NULL;\r
+ is = tparser->ctnstream->tnstream->istream;\r
+\r
+ break;\r
+\r
+ default:\r
+ \r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function 'consumeUntil' called by unknown parser type - provide override for this function\n");\r
+ return;\r
+\r
+ break;\r
+ }\r
+\r
+ // What do have at the moment?\r
+ //\r
+ ttype = is->_LA(is, 1);\r
+\r
+ // Start eating tokens until we get to the one we want.\r
+ //\r
+ while (ttype != ANTLR3_TOKEN_EOF && ttype != tokenType)\r
+ {\r
+ is->consume(is);\r
+ ttype = is->_LA(is, 1);\r
+ }\r
+}\r
+\r
+/// Eat tokens from the input stream until we find one that\r
+/// belongs to the supplied set.\r
+///\r
+static void \r
+consumeUntilSet (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_BITSET set)\r
+{\r
+ ANTLR3_UINT32 ttype;\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+ pANTLR3_INT_STREAM is;\r
+\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ tparser = NULL;\r
+ is = parser->tstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_TREE_PARSER:\r
+\r
+ tparser = (pANTLR3_TREE_PARSER) (recognizer->super);\r
+ parser = NULL;\r
+ is = tparser->ctnstream->tnstream->istream;\r
+\r
+ break;\r
+\r
+ default:\r
+ \r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function 'consumeUntilSet' called by unknown parser type - provide override for this function\n");\r
+ return;\r
+\r
+ break;\r
+ }\r
+\r
+ // What do have at the moment?\r
+ //\r
+ ttype = is->_LA(is, 1);\r
+\r
+ // Start eating tokens until we get to one we want.\r
+ //\r
+ while (ttype != ANTLR3_TOKEN_EOF && set->isMember(set, ttype) == ANTLR3_FALSE)\r
+ {\r
+ is->consume(is);\r
+ ttype = is->_LA(is, 1);\r
+ }\r
+}\r
+\r
+/** Return the rule invocation stack (how we got here in the parse.\r
+ * In the java version Ter just asks the JVM for all the information\r
+ * but in C we don't get this information, so I am going to do nothing \r
+ * right now.\r
+ */\r
+static pANTLR3_STACK \r
+getRuleInvocationStack (pANTLR3_BASE_RECOGNIZER recognizer)\r
+{\r
+ return NULL;\r
+}\r
+\r
+static pANTLR3_STACK \r
+getRuleInvocationStackNamed (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_UINT8 name)\r
+{\r
+ return NULL;\r
+}\r
+\r
+/** Convenience method for template rewrites - NYI.\r
+ */\r
+static pANTLR3_HASH_TABLE \r
+toStrings (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_HASH_TABLE tokens)\r
+{\r
+ return NULL;\r
+}\r
+\r
+static void ANTLR3_CDECL\r
+freeIntTrie (void * trie)\r
+{\r
+ ((pANTLR3_INT_TRIE)trie)->free((pANTLR3_INT_TRIE)trie);\r
+}\r
+\r
+\r
+/** Pointer to a function to return whether the rule has parsed input starting at the supplied \r
+ * start index before. If the rule has not parsed input starting from the supplied start index,\r
+ * then it will return ANTLR3_MEMO_RULE_UNKNOWN. If it has parsed from the suppled start point\r
+ * then it will return the point where it last stopped parsing after that start point.\r
+ *\r
+ * \remark\r
+ * The rule memos are an ANTLR3_LIST of ANTLR3_LISTS, however if this becomes any kind of performance\r
+ * issue (it probably won't, the hash tables are pretty quick) then we could make a special int only\r
+ * version of the table.\r
+ */\r
+static ANTLR3_MARKER \r
+getRuleMemoization (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_INTKEY ruleIndex, ANTLR3_MARKER ruleParseStart)\r
+{\r
+ /* The rule memos are an ANTLR3_LIST of ANTLR3_LIST.\r
+ */\r
+ pANTLR3_INT_TRIE ruleList;\r
+ ANTLR3_MARKER stopIndex;\r
+ pANTLR3_TRIE_ENTRY entry;\r
+\r
+ /* See if we have a list in the ruleMemos for this rule, and if not, then create one\r
+ * as we will need it eventually if we are being asked for the memo here.\r
+ */\r
+ entry = recognizer->state->ruleMemo->get(recognizer->state->ruleMemo, (ANTLR3_INTKEY)ruleIndex);\r
+\r
+ if (entry == NULL)\r
+ {\r
+ /* Did not find it, so create a new one for it, with a bit depth based on the \r
+ * size of the input stream. We need the bit depth to incorporate the number if\r
+ * bits required to represent the largest possible stop index in the input, which is the\r
+ * last character. An int stream is free to return the largest 64 bit offset if it has\r
+ * no idea of the size, but you should remember that this will cause the leftmost\r
+ * bit match algorithm to run to 63 bits, which will be the whole time spent in the trie ;-)\r
+ */\r
+ ruleList = antlr3IntTrieNew(63); /* Depth is theoretically 64 bits, but probably not ;-) */\r
+\r
+ if (ruleList != NULL)\r
+ {\r
+ recognizer->state->ruleMemo->add(recognizer->state->ruleMemo, (ANTLR3_INTKEY)ruleIndex, ANTLR3_HASH_TYPE_STR, 0, ANTLR3_FUNC_PTR(ruleList), freeIntTrie);\r
+ }\r
+\r
+ /* We cannot have a stopIndex in a trie we have just created of course\r
+ */\r
+ return MEMO_RULE_UNKNOWN;\r
+ }\r
+\r
+ ruleList = (pANTLR3_INT_TRIE) (entry->data.ptr);\r
+\r
+ /* See if there is a stop index associated with the supplied start index.\r
+ */\r
+ stopIndex = 0;\r
+\r
+ entry = ruleList->get(ruleList, ruleParseStart);\r
+ if (entry != NULL)\r
+ {\r
+ stopIndex = (ANTLR3_MARKER)(entry->data.intVal);\r
+ }\r
+\r
+ if (stopIndex == 0)\r
+ {\r
+ return MEMO_RULE_UNKNOWN;\r
+ }\r
+\r
+ return stopIndex;\r
+}\r
+\r
+/** Has this rule already parsed input at the current index in the\r
+ * input stream? Return ANTLR3_TRUE if we have and ANTLR3_FALSE\r
+ * if we have not.\r
+ *\r
+ * This method has a side-effect: if we have seen this input for\r
+ * this rule and successfully parsed before, then seek ahead to\r
+ * 1 past the stop token matched for this rule last time.\r
+ */\r
+static ANTLR3_BOOLEAN \r
+alreadyParsedRule (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_MARKER ruleIndex)\r
+{\r
+ ANTLR3_MARKER stopIndex;\r
+ pANTLR3_LEXER lexer;\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+ pANTLR3_INT_STREAM is;\r
+\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ tparser = NULL;\r
+ lexer = NULL;\r
+ is = parser->tstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_TREE_PARSER:\r
+\r
+ tparser = (pANTLR3_TREE_PARSER) (recognizer->super);\r
+ parser = NULL;\r
+ lexer = NULL;\r
+ is = tparser->ctnstream->tnstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_LEXER:\r
+\r
+ lexer = (pANTLR3_LEXER) (recognizer->super);\r
+ parser = NULL;\r
+ tparser = NULL;\r
+ is = lexer->input->istream;\r
+ break;\r
+\r
+ default:\r
+ \r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function 'alreadyParsedRule' called by unknown parser type - provide override for this function\n");\r
+ return ANTLR3_FALSE;\r
+\r
+ break;\r
+ }\r
+\r
+ /* See if we have a memo marker for this.\r
+ */\r
+ stopIndex = recognizer->getRuleMemoization(recognizer, ruleIndex, is->index(is));\r
+\r
+ if (stopIndex == MEMO_RULE_UNKNOWN)\r
+ {\r
+ return ANTLR3_FALSE;\r
+ }\r
+\r
+ if (stopIndex == MEMO_RULE_FAILED)\r
+ {\r
+ recognizer->state->failed = ANTLR3_TRUE;\r
+ }\r
+ else\r
+ {\r
+ is->seek(is, stopIndex+1);\r
+ }\r
+\r
+ /* If here then the rule was executed for this input already\r
+ */\r
+ return ANTLR3_TRUE;\r
+}\r
+\r
+/** Record whether or not this rule parsed the input at this position\r
+ * successfully.\r
+ */\r
+static void \r
+memoize (pANTLR3_BASE_RECOGNIZER recognizer, ANTLR3_MARKER ruleIndex, ANTLR3_MARKER ruleParseStart)\r
+{\r
+ /* The rule memos are an ANTLR3_LIST of ANTLR3_LIST.\r
+ */\r
+ pANTLR3_INT_TRIE ruleList;\r
+ pANTLR3_TRIE_ENTRY entry;\r
+ ANTLR3_MARKER stopIndex;\r
+ pANTLR3_LEXER lexer;\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+ pANTLR3_INT_STREAM is;\r
+\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ tparser = NULL;\r
+ is = parser->tstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_TREE_PARSER:\r
+\r
+ tparser = (pANTLR3_TREE_PARSER) (recognizer->super);\r
+ parser = NULL;\r
+ is = tparser->ctnstream->tnstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_LEXER:\r
+\r
+ lexer = (pANTLR3_LEXER) (recognizer->super);\r
+ parser = NULL;\r
+ tparser = NULL;\r
+ is = lexer->input->istream;\r
+ break;\r
+\r
+ default:\r
+ \r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function consumeUntilSet called by unknown parser type - provide override for this function\n");\r
+ return;\r
+\r
+ break;\r
+ }\r
+ \r
+ stopIndex = recognizer->state->failed == ANTLR3_TRUE ? MEMO_RULE_FAILED : is->index(is) - 1;\r
+\r
+ entry = recognizer->state->ruleMemo->get(recognizer->state->ruleMemo, (ANTLR3_INTKEY)ruleIndex);\r
+\r
+ if (entry != NULL)\r
+ {\r
+ ruleList = (pANTLR3_INT_TRIE)(entry->data.ptr);\r
+\r
+ /* If we don't already have this entry, append it. The memoize trie does not\r
+ * accept duplicates so it won't add it if already there and we just ignore the\r
+ * return code as we don't care if it is there already.\r
+ */\r
+ ruleList->add(ruleList, ruleParseStart, ANTLR3_HASH_TYPE_INT, stopIndex, NULL, NULL);\r
+ }\r
+}\r
+/** A syntactic predicate. Returns true/false depending on whether\r
+ * the specified grammar fragment matches the current input stream.\r
+ * This resets the failed instance var afterwards.\r
+ */\r
+static ANTLR3_BOOLEAN \r
+synpred (pANTLR3_BASE_RECOGNIZER recognizer, void * ctx, void (*predicate)(void * ctx))\r
+{\r
+ ANTLR3_MARKER start;\r
+ pANTLR3_PARSER parser;\r
+ pANTLR3_TREE_PARSER tparser;\r
+ pANTLR3_INT_STREAM is;\r
+\r
+ switch (recognizer->type)\r
+ {\r
+ case ANTLR3_TYPE_PARSER:\r
+\r
+ parser = (pANTLR3_PARSER) (recognizer->super);\r
+ tparser = NULL;\r
+ is = parser->tstream->istream;\r
+\r
+ break;\r
+\r
+ case ANTLR3_TYPE_TREE_PARSER:\r
+\r
+ tparser = (pANTLR3_TREE_PARSER) (recognizer->super);\r
+ parser = NULL;\r
+ is = tparser->ctnstream->tnstream->istream;\r
+\r
+ break;\r
+\r
+ default:\r
+ \r
+ ANTLR3_FPRINTF(stderr, "Base recognizer function 'synPred' called by unknown parser type - provide override for this function\n");\r
+ return ANTLR3_FALSE;\r
+\r
+ break;\r
+ }\r
+\r
+ /* Begin backtracking so we can get back to where we started after trying out\r
+ * the syntactic predicate.\r
+ */\r
+ start = is->mark(is);\r
+ recognizer->state->backtracking++;\r
+\r
+ /* Try the syntactical predicate\r
+ */\r
+ predicate(ctx);\r
+\r
+ /* Reset\r
+ */\r
+ is->rewind(is, start);\r
+ recognizer->state->backtracking--;\r
+\r
+ if (recognizer->state->failed == ANTLR3_TRUE)\r
+ {\r
+ /* Predicate failed\r
+ */\r
+ recognizer->state->failed = ANTLR3_FALSE;\r
+ return ANTLR3_FALSE;\r
+ }\r
+ else\r
+ {\r
+ /* Predicate was successful\r
+ */\r
+ recognizer->state->failed = ANTLR3_FALSE;\r
+ return ANTLR3_TRUE;\r
+ }\r
+}\r
+\r
+static void\r
+reset(pANTLR3_BASE_RECOGNIZER recognizer)\r
+{\r
+ if (recognizer->state->following != NULL)\r
+ {\r
+ recognizer->state->following->free(recognizer->state->following);\r
+ }\r
+\r
+ // Reset the state flags\r
+ //\r
+ recognizer->state->errorRecovery = ANTLR3_FALSE;\r
+ recognizer->state->lastErrorIndex = -1;\r
+ recognizer->state->failed = ANTLR3_FALSE;\r
+ recognizer->state->errorCount = 0;\r
+ recognizer->state->backtracking = 0;\r
+ recognizer->state->following = NULL;\r
+\r
+ if (recognizer->state != NULL)\r
+ {\r
+ if (recognizer->state->ruleMemo != NULL)\r
+ {\r
+ recognizer->state->ruleMemo->free(recognizer->state->ruleMemo);\r
+ recognizer->state->ruleMemo = antlr3IntTrieNew(15); /* 16 bit depth is enough for 32768 rules! */\r
+ }\r
+ }\r
+ \r
+\r
+ // Install a new following set\r
+ //\r
+ recognizer->state->following = antlr3StackNew(8);\r
+\r
+}\r
+\r
+// Default implementation is for parser and assumes a token stream as supplied by the runtime.\r
+// You MAY need override this function if the standard TOKEN_STREAM is not what you are using.\r
+//\r
+static void * \r
+getCurrentInputSymbol (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_INT_STREAM istream)\r
+{\r
+ return ((pANTLR3_TOKEN_STREAM)istream->super)->_LT((pANTLR3_TOKEN_STREAM)istream->super, 1);\r
+}\r
+\r
+// Default implementation is for parser and assumes a token stream as supplied by the runtime.\r
+// You MAY need override this function if the standard COMMON_TOKEN_STREAM is not what you are using.\r
+//\r
+static void * \r
+getMissingSymbol (pANTLR3_BASE_RECOGNIZER recognizer, pANTLR3_INT_STREAM istream, pANTLR3_EXCEPTION e,\r
+ ANTLR3_UINT32 expectedTokenType, pANTLR3_BITSET_LIST follow)\r
+{\r
+ pANTLR3_TOKEN_STREAM ts;\r
+ pANTLR3_COMMON_TOKEN_STREAM cts;\r
+ pANTLR3_COMMON_TOKEN token;\r
+ pANTLR3_COMMON_TOKEN current;\r
+ pANTLR3_STRING text;\r
+\r
+ // Dereference the standard pointers\r
+ //\r
+ ts = (pANTLR3_TOKEN_STREAM)istream->super;\r
+ cts = (pANTLR3_COMMON_TOKEN_STREAM)ts->super;\r
+ \r
+ // Work out what to use as the current symbol to make a line and offset etc\r
+ // If we are at EOF, we use the token before EOF\r
+ //\r
+ current = ts->_LT(ts, 1);\r
+ if (current->getType(current) == ANTLR3_TOKEN_EOF)\r
+ {\r
+ current = ts->_LT(ts, -1);\r
+ }\r
+\r
+ // Create a new empty token\r
+ //\r
+ if (recognizer->state->tokFactory == NULL)\r
+ {\r
+ // We don't yet have a token factory for making tokens\r
+ // we just need a fake one using the input stream of the current\r
+ // token.\r
+ //\r
+ recognizer->state->tokFactory = antlr3TokenFactoryNew(current->input);\r
+ }\r
+ token = recognizer->state->tokFactory->newToken(recognizer->state->tokFactory);\r
+\r
+ // Set some of the token properties based on the current token\r
+ //\r
+ token->setLine (token, current->getLine(current));\r
+ token->setCharPositionInLine (token, current->getCharPositionInLine(current));\r
+ token->setChannel (token, ANTLR3_TOKEN_DEFAULT_CHANNEL);\r
+ token->setType (token, expectedTokenType);\r
+ token->user1 = current->user1;\r
+ token->user2 = current->user2;\r
+ token->user3 = current->user3;\r
+ token->custom = current->custom;\r
+ token->lineStart = current->lineStart;\r
+ \r
+ // Create the token text that shows it has been inserted\r
+ //\r
+ token->setText8(token, (pANTLR3_UINT8)"<missing ");\r
+ text = token->getText(token);\r
+\r
+ if (text != NULL)\r
+ {\r
+ text->append8(text, (const char *)recognizer->state->tokenNames[expectedTokenType]);\r
+ text->append8(text, (const char *)">");\r
+ }\r
+ \r
+ // Finally return the pointer to our new token\r
+ //\r
+ return token;\r
+}\r
+\r
+\r
+#ifdef ANTLR3_WINDOWS\r
+#pragma warning( default : 4100 )\r
+#endif\r
+\r
+/// @}\r
+///\r
+\r
Code Review / simantics / platform.git / blobdiff