1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/* 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver [The "BSD license"] 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Copyright (c) 2010 Terence Parr 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver All rights reserved. 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Redistribution and use in source and binary forms, with or without 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver modification, are permitted provided that the following conditions 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver are met: 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1. Redistributions of source code must retain the above copyright 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer. 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 2. Redistributions in binary form must reproduce the above copyright 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer in the 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver documentation and/or other materials provided with the distribution. 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 3. The name of the author may not be used to endorse or promote products 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver derived from this software without specific prior written permission. 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver*/ 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 29324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverjavaTypeInitMap ::= [ 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "int":"0", 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "long":"0", 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "float":"0.0f", 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "double":"0.0", 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "boolean":"false", 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "byte":"0", 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "short":"0", 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "char":"0", 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver default:"null" // anything other than an atomic type 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver] 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// System.Boolean.ToString() returns "True" and "False", but the proper C# literals are "true" and "false" 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// The Java version of Boolean returns "true" and "false", so they map to themselves here. 43324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverbooleanLiteral ::= [ 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "True":"true", 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "False":"false", 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "true":"true", 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "false":"false", 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver default:"false" 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver] 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** The overall file structure of a recognizer; stores methods for rules 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * and cyclic DFAs plus support code. 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 54324c4644fee44b9898524c09511bd33c3f12e2dfBen GruveroutputFile(LEXER,PARSER,TREE_PARSER, actionScope, actions, 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver docComment, recognizer, 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver name, tokens, tokenNames, rules, cyclicDFAs, 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bitsets, buildTemplate, buildAST, rewriteMode, profile, 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver backtracking, synpreds, memoize, numRules, 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver fileName, ANTLRVersion, generatedTimestamp, trace, 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver scopes, superClass, literals) ::= 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<< 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// $ANTLR <ANTLRVersion> <fileName> <generatedTimestamp> 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<actions.(actionScope).header> 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@imports> 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport org.antlr.runtime.*; 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(TREE_PARSER)> 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport org.antlr.runtime.tree.*; 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport java.util.Stack; 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport java.util.List; 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport java.util.ArrayList; 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(backtracking)> 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport java.util.Map; 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport java.util.HashMap; 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@end> 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<docComment> 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@SuppressWarnings({"all", "warnings", "unchecked"}) 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<recognizer> 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverlexer(grammar, name, tokens, scopes, rules, numRules, filterMode, labelType="CommonToken", 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver superClass="Lexer") ::= << 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic class <grammar.recognizerName> extends <@superClassName><superClass><@end> { 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <tokens:{it | public static final int <it.name>=<it.type>;}; separator="\n"> 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <scopes:{it |<if(it.isDynamicGlobalScope)><globalAttributeScope(it)><endif>}> 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <actions.lexer.members> 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // delegates 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <grammar.delegates: 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver {g|public <g.recognizerName> <g:delegateName()>;}; separator="\n"> 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // delegators 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <grammar.delegators: 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver {g|public <g.recognizerName> <g:delegateName()>;}; separator="\n"> 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <last(grammar.delegators):{g|public <g.recognizerName> gParent;}> 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public <superClass>[] getDelegates() { 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return new <superClass>[] {<grammar.delegates: {g|<g:delegateName()>}; separator = ", ">}; 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public <grammar.recognizerName>() {} <! needed by subclasses !> 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public <grammar.recognizerName>(CharStream input<grammar.delegators:{g|, <g.recognizerName> <g:delegateName()>}>) { 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this(input, new RecognizerSharedState()<grammar.delegators:{g|, <g:delegateName()>}>); 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public <grammar.recognizerName>(CharStream input, RecognizerSharedState state<grammar.delegators:{g|, <g.recognizerName> <g:delegateName()>}>) { 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver super(input,state); 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(memoize)> 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(grammar.grammarIsRoot)> 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.ruleMemo = new HashMap[<numRules>+1];<\n> <! index from 1..n !> 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <grammar.directDelegates: 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver {g|<g:delegateName()> = new <g.recognizerName>(input, state<trunc(g.delegators):{p|, <p:delegateName()>}>, this);}; separator="\n"> 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <grammar.delegators: 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver {g|this.<g:delegateName()> = <g:delegateName()>;}; separator="\n"> 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <last(grammar.delegators):{g|gParent = <g:delegateName()>;}> 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public String getGrammarFileName() { return "<fileName>"; } 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(filterMode)> 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <filteringNextToken()> 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <rules; separator="\n\n"> 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <synpreds:{p | <lexerSynpred(p)>}> 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <cyclicDFAs:{dfa | protected DFA<dfa.decisionNumber> dfa<dfa.decisionNumber> = new DFA<dfa.decisionNumber>(this);}; separator="\n"> 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <cyclicDFAs:cyclicDFA()> <! dump tables for all DFA !> 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A override of Lexer.nextToken() that backtracks over mTokens() looking 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * for matches. No error can be generated upon error; just rewind, consume 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * a token and then try again. backtracking needs to be set as well. 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Make rule memoization happen only at levels above 1 as we start mTokens 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * at backtracking==1. 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 140324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverfilteringNextToken() ::= << 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic Token nextToken() { 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver while (true) { 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( input.LA(1)==CharStream.EOF ) { 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Token eof = new CommonToken((CharStream)input,Token.EOF, 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Token.DEFAULT_CHANNEL, 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.index(),input.index()); 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver eof.setLine(getLine()); 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver eof.setCharPositionInLine(getCharPositionInLine()); 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return eof; 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.token = null; 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.channel = Token.DEFAULT_CHANNEL; 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.tokenStartCharIndex = input.index(); 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.tokenStartCharPositionInLine = input.getCharPositionInLine(); 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.tokenStartLine = input.getLine(); 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.text = null; 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver try { 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int m = input.mark(); 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.backtracking=1; <! means we won't throw slow exception !> 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.failed=false; 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver mTokens(); 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.backtracking=0; 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <! mTokens backtracks with synpred at backtracking==2 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver and we set the synpredgate to allow actions at level 1. !> 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( state.failed ) { 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.rewind(m); 167324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.consume(); <! advance one char and try again !> 168324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 169324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver else { 170324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver emit(); 171324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return state.token; 172324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 173324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 174324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver catch (RecognitionException re) { 175324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // shouldn't happen in backtracking mode, but... 176324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver reportError(re); 177324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver recover(re); 178324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 179324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 180324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 181324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 182324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic void memoize(IntStream input, 183324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int ruleIndex, 184324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int ruleStartIndex) 185324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 186324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverif ( state.backtracking>1 ) super.memoize(input, ruleIndex, ruleStartIndex); 187324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 188324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 189324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic boolean alreadyParsedRule(IntStream input, int ruleIndex) { 190324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverif ( state.backtracking>1 ) return super.alreadyParsedRule(input, ruleIndex); 191324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverreturn false; 192324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 193324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 194324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 195324c4644fee44b9898524c09511bd33c3f12e2dfBen GruveractionGate() ::= "state.backtracking==0" 196324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 197324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverfilteringActionGate() ::= "state.backtracking==1" 198324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 199324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** How to generate a parser */ 200324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvergenericParser(grammar, name, scopes, tokens, tokenNames, rules, numRules, 201324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bitsets, inputStreamType, superClass, 202324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver labelType, members, rewriteElementType, 203324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver filterMode, ASTLabelType="Object") ::= << 204324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic class <grammar.recognizerName> extends <@superClassName><superClass><@end> { 205324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(grammar.grammarIsRoot)> 206324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static final String[] tokenNames = new String[] { 207324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "\<invalid>", "\<EOR>", "\<DOWN>", "\<UP>", <tokenNames; separator=", "> 208324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver };<\n> 209324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 210324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <tokens:{it |public static final int <it.name>=<it.type>;}; separator="\n"> 211324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 212324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // delegates 213324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <grammar.delegates: {g|public <g.recognizerName> <g:delegateName()>;}; separator="\n"> 214324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public <superClass>[] getDelegates() { 215324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return new <superClass>[] {<grammar.delegates: {g|<g:delegateName()>}; separator = ", ">}; 216324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 217324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 218324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // delegators 219324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <grammar.delegators: 220324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver {g|public <g.recognizerName> <g:delegateName()>;}; separator="\n"> 221324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <last(grammar.delegators):{g|public <g.recognizerName> gParent;}> 222324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 223324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <scopes:{it |<if(it.isDynamicGlobalScope)><globalAttributeScope(it)><endif>}> 224324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 225324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@members> 226324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <! WARNING. bug in ST: this is cut-n-paste into Dbg.stg !> 227324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public <grammar.recognizerName>(<inputStreamType> input<grammar.delegators:{g|, <g.recognizerName> <g:delegateName()>}>) { 228324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this(input, new RecognizerSharedState()<grammar.delegators:{g|, <g:delegateName()>}>); 229324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 230324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public <grammar.recognizerName>(<inputStreamType> input, RecognizerSharedState state<grammar.delegators:{g|, <g.recognizerName> <g:delegateName()>}>) { 231324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver super(input, state); 232324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <parserCtorBody()> 233324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <grammar.directDelegates: 234324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver {g|<g:delegateName()> = new <g.recognizerName>(input, state<trunc(g.delegators):{p|, <p:delegateName()>}>, this);}; separator="\n"> 235324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <grammar.indirectDelegates:{g | <g:delegateName()> = <g.delegator:delegateName()>.<g:delegateName()>;}; separator="\n"> 236324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <last(grammar.delegators):{g|gParent = <g:delegateName()>;}> 237324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 238324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@end> 239324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 240324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public String[] getTokenNames() { return <grammar.composite.rootGrammar.recognizerName>.tokenNames; } 241324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public String getGrammarFileName() { return "<fileName>"; } 242324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 243324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <members> 244324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 245324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <rules; separator="\n\n"> 246324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 247324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<! generate rule/method definitions for imported rules so they 248324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver appear to be defined in this recognizer. !> 249324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // Delegated rules 250324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<grammar.delegatedRules:{ruleDescriptor| 251324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public <returnType()> <ruleDescriptor.name>(<ruleDescriptor.parameterScope:parameterScope()>) throws <ruleDescriptor.throwsSpec; separator=", "> { <if(ruleDescriptor.hasReturnValue)>return <endif><ruleDescriptor.grammar:delegateName()>.<ruleDescriptor.name>(<ruleDescriptor.parameterScope.attributes:{a|<a.name>}; separator=", ">); \}}; separator="\n"> 252324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 253324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <synpreds:{p | <synpred(p)>}> 254324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 255324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <cyclicDFAs:{dfa | protected DFA<dfa.decisionNumber> dfa<dfa.decisionNumber> = new DFA<dfa.decisionNumber>(this);}; separator="\n"> 256324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <cyclicDFAs:cyclicDFA()> <! dump tables for all DFA !> 257324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 258324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <bitsets:{it | <bitset(name={FOLLOW_<it.name>_in_<it.inName><it.tokenIndex>}, 259324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver words64=it.bits)>}> 260324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 261324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 262324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 263324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverparserCtorBody() ::= << 264324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(memoize)> 265324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(grammar.grammarIsRoot)> 266324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverthis.state.ruleMemo = new HashMap[<length(grammar.allImportedRules)>+1];<\n> <! index from 1..n !> 267324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 268324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 269324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<grammar.delegators: 270324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver {g|this.<g:delegateName()> = <g:delegateName()>;}; separator="\n"> 271324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 272324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 273324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverparser(grammar, name, scopes, tokens, tokenNames, rules, numRules, bitsets, 274324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ASTLabelType="Object", superClass="Parser", labelType="Token", 275324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver members={<actions.parser.members>}) ::= << 276324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<genericParser(grammar, name, scopes, tokens, tokenNames, rules, numRules, 277324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bitsets, "TokenStream", superClass, 278324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver labelType, members, "Token", 279324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver false, ASTLabelType)> 280324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 281324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 282324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** How to generate a tree parser; same as parser except the input 283324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * stream is a different type. 284324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 285324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvertreeParser(grammar, name, scopes, tokens, tokenNames, globalAction, rules, 286324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver numRules, bitsets, filterMode, labelType={<ASTLabelType>}, ASTLabelType="Object", 287324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver superClass={<if(filterMode)><if(buildAST)>TreeRewriter<else>TreeFilter<endif><else>TreeParser<endif>}, 288324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver members={<actions.treeparser.members>} 289324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ) ::= << 290324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<genericParser(grammar, name, scopes, tokens, tokenNames, rules, numRules, 291324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bitsets, "TreeNodeStream", superClass, 292324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver labelType, members, "Node", 293324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver filterMode, ASTLabelType)> 294324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 295324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 296324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A simpler version of a rule template that is specific to the imaginary 297324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * rules created for syntactic predicates. As they never have return values 298324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * nor parameters etc..., just give simplest possible method. Don't do 299324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * any of the normal memoization stuff in here either; it's a waste. 300324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * As predicates cannot be inlined into the invoking rule, they need to 301324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * be in a rule by themselves. 302324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 303324c4644fee44b9898524c09511bd33c3f12e2dfBen GruversynpredRule(ruleName, ruleDescriptor, block, description, nakedBlock) ::= 304324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<< 305324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// $ANTLR start <ruleName> 306324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic final void <ruleName>_fragment(<ruleDescriptor.parameterScope:parameterScope()>) throws <ruleDescriptor.throwsSpec:{x|<x>}; separator=", "> { 307324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleLabelDefs()> 308324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(trace)> 309324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver traceIn("<ruleName>_fragment", <ruleDescriptor.index>); 310324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver try { 311324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <block> 312324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 313324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver finally { 314324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver traceOut("<ruleName>_fragment", <ruleDescriptor.index>); 315324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 316324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 317324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <block> 318324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 319324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 320324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// $ANTLR end <ruleName> 321324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 322324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 323324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruversynpred(name) ::= << 324324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic final boolean <name>() { 325324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.backtracking++; 326324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@start()> 327324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int start = input.mark(); 328324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver try { 329324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <name>_fragment(); // can never throw exception 330324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } catch (RecognitionException re) { 331324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver System.err.println("impossible: "+re); 332324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 333324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver boolean success = !state.failed; 334324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.rewind(start); 335324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@stop()> 336324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.backtracking--; 337324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.failed=false; 338324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return success; 339324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver}<\n> 340324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 341324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 342324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerSynpred(name) ::= << 343324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<synpred(name)> 344324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 345324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 346324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleMemoization(name) ::= << 347324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(memoize)> 348324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverif ( state.backtracking>0 && alreadyParsedRule(input, <ruleDescriptor.index>) ) { return <ruleReturnValue()>; } 349324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 350324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 351324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 352324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** How to test for failure and return from rule */ 353324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvercheckRuleBacktrackFailure() ::= << 354324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(backtracking)>if (state.failed) return <ruleReturnValue()>;<endif> 355324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 356324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 357324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** This rule has failed, exit indicating failure during backtrack */ 358324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleBacktrackFailure() ::= << 359324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(backtracking)>if (state.backtracking>0) {state.failed=true; return <ruleReturnValue()>;}<endif> 360324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 361324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 362324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** How to generate code for a rule. This includes any return type 363324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * data aggregates required for multiple return values. 364324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 365324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverrule(ruleName,ruleDescriptor,block,emptyRule,description,exceptions,finally,memoize) ::= << 366324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleAttributeScope(scope=ruleDescriptor.ruleScope)> 367324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<returnScope(scope=ruleDescriptor.returnScope)> 368324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 369324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// $ANTLR start "<ruleName>" 370324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// <fileName>:<description> 371324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic final <returnType()> <ruleName>(<ruleDescriptor.parameterScope:parameterScope()>) throws <ruleDescriptor.throwsSpec:{x|<x>}; separator=", "> { 372324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <if(trace)>traceIn("<ruleName>", <ruleDescriptor.index>);<endif> 373324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleScopeSetUp()> 374324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleDeclarations()> 375324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleLabelDefs()> 376324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleDescriptor.actions.init> 377324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@preamble()> 378324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver try { 379324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleMemoization(name=ruleName)> 380324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <block> 381324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleCleanUp()> 382324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <(ruleDescriptor.actions.after):execAction()> 383324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 384324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(exceptions)> 385324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <exceptions:{e|<catch(decl=e.decl,action=e.action)><\n>}> 386324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 387324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(!emptyRule)> 388324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(actions.(actionScope).rulecatch)> 389324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <actions.(actionScope).rulecatch> 390324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 391324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver catch (RecognitionException re) { 392324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver reportError(re); 393324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver recover(input,re); 394324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@setErrorReturnValue()> 395324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver }<\n> 396324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 397324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 398324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 399324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver finally { 400324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // do for sure before leaving 401324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <if(trace)>traceOut("<ruleName>", <ruleDescriptor.index>);<endif> 402324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <memoize()> 403324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleScopeCleanUp()> 404324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <finally> 405324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 406324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@postamble()> 407324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return <ruleReturnValue()>; 408324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 409324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// $ANTLR end "<ruleName>" 410324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 411324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 412324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvercatch(decl,action) ::= << 413324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvercatch (<e.decl>) { 414324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <e.action> 415324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 416324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 417324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 418324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleDeclarations() ::= << 419324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(ruleDescriptor.hasMultipleReturnValues)> 420324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<returnType()> retval = new <returnType()>(); 421324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverretval.start = input.LT(1);<\n> 422324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 423324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleDescriptor.returnScope.attributes:{ a | 424324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<a.type> <a.name> = <if(a.initValue)><a.initValue><else><initValue(a.type)><endif>; 425324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver}> 426324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 427324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(memoize)> 428324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint <ruleDescriptor.name>_StartIndex = input.index(); 429324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 430324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 431324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 432324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleScopeSetUp() ::= << 433324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleDescriptor.useScopes:{it |<it>_stack.push(new <it>_scope());}; separator="\n"> 434324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleDescriptor.ruleScope:{it |<it.name>_stack.push(new <it.name>_scope());}; separator="\n"> 435324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 436324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 437324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleScopeCleanUp() ::= << 438324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleDescriptor.useScopes:{it |<it>_stack.pop();}; separator="\n"> 439324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleDescriptor.ruleScope:{it |<it.name>_stack.pop();}; separator="\n"> 440324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 441324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 442324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 443324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleLabelDefs() ::= << 444324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<[ruleDescriptor.tokenLabels,ruleDescriptor.tokenListLabels, 445324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ruleDescriptor.wildcardTreeLabels,ruleDescriptor.wildcardTreeListLabels] 446324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver :{it |<labelType> <it.label.text>=null;}; separator="\n" 447324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver> 448324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<[ruleDescriptor.tokenListLabels,ruleDescriptor.ruleListLabels,ruleDescriptor.wildcardTreeListLabels] 449324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver :{it |List list_<it.label.text>=null;}; separator="\n" 450324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver> 451324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleDescriptor.ruleLabels:ruleLabelDef(); separator="\n"> 452324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleDescriptor.ruleListLabels:{ll|RuleReturnScope <ll.label.text> = null;}; separator="\n"> 453324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 454324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 455324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRuleLabelDefs() ::= << 456324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<[ruleDescriptor.tokenLabels, 457324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ruleDescriptor.tokenListLabels, 458324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ruleDescriptor.ruleLabels] 459324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver :{it |<labelType> <it.label.text>=null;}; separator="\n" 460324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver> 461324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleDescriptor.charLabels:{it |int <it.label.text>;}; separator="\n"> 462324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<[ruleDescriptor.tokenListLabels, 463324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ruleDescriptor.ruleListLabels] 464324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver :{it |List list_<it.label.text>=null;}; separator="\n" 465324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver> 466324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 467324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 468324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleReturnValue() ::= <% 469324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(!ruleDescriptor.isSynPred)> 470324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(ruleDescriptor.hasReturnValue)> 471324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(ruleDescriptor.hasSingleReturnValue)> 472324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleDescriptor.singleValueReturnName> 473324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 474324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverretval 475324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 476324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 477324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 478324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver%> 479324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 480324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleCleanUp() ::= << 481324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(ruleDescriptor.hasMultipleReturnValues)> 482324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(!TREE_PARSER)> 483324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverretval.stop = input.LT(-1);<\n> 484324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 485324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 486324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 487324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 488324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermemoize() ::= << 489324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(memoize)> 490324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(backtracking)> 491324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverif ( state.backtracking>0 ) { memoize(input, <ruleDescriptor.index>, <ruleDescriptor.name>_StartIndex); } 492324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 493324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 494324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 495324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 496324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** How to generate a rule in the lexer; naked blocks are used for 497324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * fragment rules. 498324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 499324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRule(ruleName,nakedBlock,ruleDescriptor,block,memoize) ::= << 500324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// $ANTLR start "<ruleName>" 501324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic final void m<ruleName>(<ruleDescriptor.parameterScope:parameterScope()>) throws RecognitionException { 502324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <if(trace)>traceIn("<ruleName>", <ruleDescriptor.index>);<endif> 503324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleScopeSetUp()> 504324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleDeclarations()> 505324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver try { 506324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(nakedBlock)> 507324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleMemoization(name=ruleName)> 508324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <lexerRuleLabelDefs()> 509324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleDescriptor.actions.init> 510324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <block><\n> 511324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 512324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int _type = <ruleName>; 513324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int _channel = DEFAULT_TOKEN_CHANNEL; 514324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleMemoization(name=ruleName)> 515324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <lexerRuleLabelDefs()> 516324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleDescriptor.actions.init> 517324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <block> 518324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleCleanUp()> 519324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.type = _type; 520324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.channel = _channel; 521324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <(ruleDescriptor.actions.after):execAction()> 522324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 523324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 524324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver finally { 525324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // do for sure before leaving 526324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <if(trace)>traceOut("<ruleName>", <ruleDescriptor.index>);<endif> 527324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleScopeCleanUp()> 528324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <memoize()> 529324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 530324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 531324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// $ANTLR end "<ruleName>" 532324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 533324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 534324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** How to generate code for the implicitly-defined lexer grammar rule 535324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * that chooses between lexer rules. 536324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 537324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvertokensRule(ruleName,nakedBlock,args,block,ruleDescriptor) ::= << 538324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic void mTokens() throws RecognitionException { 539324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <block><\n> 540324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 541324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 542324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 543324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// S U B R U L E S 544324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 545324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A (...) subrule with multiple alternatives */ 546324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverblock(alts,decls,decision,enclosingBlockLevel,blockLevel,decisionNumber,maxK,maxAlt,description) ::= << 547324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// <fileName>:<description> 548324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint alt<decisionNumber>=<maxAlt>; 549324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<decls> 550324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@predecision()> 551324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<decision> 552324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@postdecision()> 553324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@prebranch()> 554324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverswitch (alt<decisionNumber>) { 555324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <alts:{a | <altSwitchCase(i,a)>}> 556324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 557324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@postbranch()> 558324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 559324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 560324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A rule block with multiple alternatives */ 561324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleBlock(alts,decls,decision,enclosingBlockLevel,blockLevel,decisionNumber,maxK,maxAlt,description) ::= << 562324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// <fileName>:<description> 563324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint alt<decisionNumber>=<maxAlt>; 564324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<decls> 565324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@predecision()> 566324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<decision> 567324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@postdecision()> 568324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverswitch (alt<decisionNumber>) { 569324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <alts:{a | <altSwitchCase(i,a)>}> 570324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 571324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 572324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 573324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleBlockSingleAlt(alts,decls,decision,enclosingBlockLevel,blockLevel,decisionNumber,description) ::= << 574324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// <fileName>:<description> 575324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<decls> 576324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@prealt()> 577324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<alts> 578324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@postalt()> 579324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 580324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 581324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A special case of a (...) subrule with a single alternative */ 582324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverblockSingleAlt(alts,decls,decision,enclosingBlockLevel,blockLevel,decisionNumber,description) ::= << 583324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// <fileName>:<description> 584324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<decls> 585324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@prealt()> 586324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<alts> 587324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@postalt()> 588324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 589324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 590324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A (..)+ block with 1 or more alternatives */ 591324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverpositiveClosureBlock(alts,decls,decision,enclosingBlockLevel,blockLevel,decisionNumber,maxK,maxAlt,description) ::= << 592324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// <fileName>:<description> 593324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint cnt<decisionNumber>=0; 594324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<decls> 595324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@preloop()> 596324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverloop<decisionNumber>: 597324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverdo { 598324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int alt<decisionNumber>=<maxAlt>; 599324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@predecision()> 600324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <decision> 601324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@postdecision()> 602324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver switch (alt<decisionNumber>) { 603324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <alts:{a | <altSwitchCase(i,a)>}> 604324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver default : 605324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( cnt<decisionNumber> >= 1 ) break loop<decisionNumber>; 606324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleBacktrackFailure()> 607324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver EarlyExitException eee = 608324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver new EarlyExitException(<decisionNumber>, input); 609324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@earlyExitException()> 610324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver throw eee; 611324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 612324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver cnt<decisionNumber>++; 613324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} while (true); 614324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@postloop()> 615324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 616324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 617324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverpositiveClosureBlockSingleAlt ::= positiveClosureBlock 618324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 619324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A (..)* block with 1 or more alternatives */ 620324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverclosureBlock(alts,decls,decision,enclosingBlockLevel,blockLevel,decisionNumber,maxK,maxAlt,description) ::= << 621324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// <fileName>:<description> 622324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<decls> 623324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@preloop()> 624324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverloop<decisionNumber>: 625324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverdo { 626324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int alt<decisionNumber>=<maxAlt>; 627324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@predecision()> 628324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <decision> 629324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@postdecision()> 630324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver switch (alt<decisionNumber>) { 631324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <alts:{a | <altSwitchCase(i,a)>}> 632324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver default : 633324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver break loop<decisionNumber>; 634324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 635324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} while (true); 636324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@postloop()> 637324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 638324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 639324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverclosureBlockSingleAlt ::= closureBlock 640324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 641324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Optional blocks (x)? are translated to (x|) by before code generation 642324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * so we can just use the normal block template 643324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 644324c4644fee44b9898524c09511bd33c3f12e2dfBen GruveroptionalBlock ::= block 645324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 646324c4644fee44b9898524c09511bd33c3f12e2dfBen GruveroptionalBlockSingleAlt ::= block 647324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 648324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A case in a switch that jumps to an alternative given the alternative 649324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * number. A DFA predicts the alternative and then a simple switch 650324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * does the jump to the code that actually matches that alternative. 651324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 652324c4644fee44b9898524c09511bd33c3f12e2dfBen GruveraltSwitchCase(altNum,alt) ::= << 653324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvercase <altNum> : 654324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@prealt()> 655324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <alt> 656324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver break;<\n> 657324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 658324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 659324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** An alternative is just a list of elements; at outermost level */ 660324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruveralt(elements,altNum,description,autoAST,outerAlt,treeLevel,rew) ::= << 661324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// <fileName>:<description> 662324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 663324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@declarations()> 664324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<elements:element()> 665324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<rew> 666324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@cleanup()> 667324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 668324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 669324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 670324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** What to emit when there is no rewrite. For auto build 671324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * mode, does nothing. 672324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 673324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvernoRewrite(rewriteBlockLevel, treeLevel) ::= "" 674324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 675324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// E L E M E N T S 676324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 677324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Dump the elements one per line */ 678324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverelement(e) ::= << 679324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<@prematch()> 680324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<e.el><\n> 681324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 682324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 683324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** match a token optionally with a label in front */ 684324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvertokenRef(token,label,elementIndex,terminalOptions) ::= << 685324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(label)><label>=(<labelType>)<endif>match(input,<token>,FOLLOW_<token>_in_<ruleName><elementIndex>); <checkRuleBacktrackFailure()> 686324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 687324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 688324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** ids+=ID */ 689324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvertokenRefAndListLabel(token,label,elementIndex,terminalOptions) ::= << 690324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<tokenRef(token,label,elementIndex,terminalOptions)> 691324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<listLabel(label, label)> 692324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 693324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 694324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlistLabel(label,elem) ::= << 695324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverif (list_<label>==null) list_<label>=new ArrayList(); 696324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverlist_<label>.add(<elem>);<\n> 697324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 698324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 699324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** match a character */ 700324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvercharRef(char,label) ::= << 701324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(label)> 702324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label> = input.LA(1);<\n> 703324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 704324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermatch(<char>); <checkRuleBacktrackFailure()> 705324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 706324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 707324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** match a character range */ 708324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvercharRangeRef(a,b,label) ::= << 709324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(label)> 710324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label> = input.LA(1);<\n> 711324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 712324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvermatchRange(<a>,<b>); <checkRuleBacktrackFailure()> 713324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 714324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 715324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** For now, sets are interval tests and must be tested inline */ 716324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvermatchSet(s,label,elementIndex,terminalOptions,postmatchCode="") ::= << 717324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(label)> 718324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(LEXER)> 719324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label>= input.LA(1);<\n> 720324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 721324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label>=(<labelType>)input.LT(1);<\n> 722324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 723324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 724324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverif ( <s> ) { 725324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.consume(); 726324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <postmatchCode> 727324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(!LEXER)> 728324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.errorRecovery=false; 729324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 730324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <if(backtracking)>state.failed=false;<endif> 731324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 732324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverelse { 733324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleBacktrackFailure()> 734324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver MismatchedSetException mse = new MismatchedSetException(null,input); 735324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@mismatchedSetException()> 736324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(LEXER)> 737324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver recover(mse); 738324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver throw mse; 739324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 740324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver throw mse; 741324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <! use following code to make it recover inline; remove throw mse; 742324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver recoverFromMismatchedSet(input,mse,FOLLOW_set_in_<ruleName><elementIndex>); 743324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver !> 744324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 745324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver}<\n> 746324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 747324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 748324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvermatchRuleBlockSet ::= matchSet 749324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 750324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvermatchSetAndListLabel(s,label,elementIndex,postmatchCode) ::= << 751324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<matchSet(...)> 752324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<listLabel(label, label)> 753324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 754324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 755324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Match a string literal */ 756324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerStringRef(string,label,elementIndex="0") ::= << 757324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(label)> 758324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint <label>Start = getCharIndex(); 759324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermatch(<string>); <checkRuleBacktrackFailure()> 760324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint <label>StartLine<elementIndex> = getLine(); 761324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint <label>StartCharPos<elementIndex> = getCharPositionInLine(); 762324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label> = new <labelType>(input, Token.INVALID_TOKEN_TYPE, Token.DEFAULT_CHANNEL, <label>Start, getCharIndex()-1); 763324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label>.setLine(<label>StartLine<elementIndex>); 764324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label>.setCharPositionInLine(<label>StartCharPos<elementIndex>); 765324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 766324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermatch(<string>); <checkRuleBacktrackFailure()><\n> 767324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 768324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 769324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 770324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverwildcard(token,label,elementIndex,terminalOptions) ::= << 771324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(label)> 772324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label>=(<labelType>)input.LT(1);<\n> 773324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 774324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvermatchAny(input); <checkRuleBacktrackFailure()> 775324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 776324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 777324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverwildcardAndListLabel(token,label,elementIndex,terminalOptions) ::= << 778324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<wildcard(...)> 779324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<listLabel(label, label)> 780324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 781324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 782324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Match . wildcard in lexer */ 783324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverwildcardChar(label, elementIndex) ::= << 784324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(label)> 785324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label> = input.LA(1);<\n> 786324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 787324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvermatchAny(); <checkRuleBacktrackFailure()> 788324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 789324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 790324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverwildcardCharListLabel(label, elementIndex) ::= << 791324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<wildcardChar(label, elementIndex)> 792324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<listLabel(label, label)> 793324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 794324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 795324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Match a rule reference by invoking it possibly with arguments 796324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * and a return value or values. The 'rule' argument was the 797324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * target rule name, but now is type Rule, whose toString is 798324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * same: the rule name. Now though you can access full rule 799324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * descriptor stuff. 800324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 801324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleRef(rule,label,elementIndex,args,scope) ::= << 802324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverpushFollow(FOLLOW_<rule.name>_in_<ruleName><elementIndex>); 803324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(label)><label>=<endif><if(scope)><scope:delegateName()>.<endif><rule.name>(<args; separator=", ">);<\n> 804324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstate._fsp--; 805324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<checkRuleBacktrackFailure()> 806324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 807324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 808324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** ids+=r */ 809324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleRefAndListLabel(rule,label,elementIndex,args,scope) ::= << 810324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleRef(rule,label,elementIndex,args,scope)> 811324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<listLabel(label, label)> 812324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 813324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 814324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A lexer rule reference. 815324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 816324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * The 'rule' argument was the target rule name, but now 817324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * is type Rule, whose toString is same: the rule name. 818324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Now though you can access full rule descriptor stuff. 819324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 820324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRuleRef(rule,label,args,elementIndex,scope) ::= << 821324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(label)> 822324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint <label>Start<elementIndex> = getCharIndex(); 823324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint <label>StartLine<elementIndex> = getLine(); 824324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint <label>StartCharPos<elementIndex> = getCharPositionInLine(); 825324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(scope)><scope:delegateName()>.<endif>m<rule.name>(<args; separator=", ">); <checkRuleBacktrackFailure()> 826324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label> = new <labelType>(input, Token.INVALID_TOKEN_TYPE, Token.DEFAULT_CHANNEL, <label>Start<elementIndex>, getCharIndex()-1); 827324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label>.setLine(<label>StartLine<elementIndex>); 828324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label>.setCharPositionInLine(<label>StartCharPos<elementIndex>); 829324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 830324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(scope)><scope:delegateName()>.<endif>m<rule.name>(<args; separator=", ">); <checkRuleBacktrackFailure()> 831324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 832324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 833324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 834324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** i+=INT in lexer */ 835324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRuleRefAndListLabel(rule,label,args,elementIndex,scope) ::= << 836324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<lexerRuleRef(rule,label,args,elementIndex,scope)> 837324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<listLabel(label, label)> 838324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 839324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 840324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** EOF in the lexer */ 841324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerMatchEOF(label,elementIndex) ::= << 842324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(label)> 843324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint <label>Start<elementIndex> = getCharIndex(); 844324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint <label>StartLine<elementIndex> = getLine(); 845324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint <label>StartCharPos<elementIndex> = getCharPositionInLine(); 846324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermatch(EOF); <checkRuleBacktrackFailure()> 847324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<labelType> <label> = new <labelType>(input, EOF, Token.DEFAULT_CHANNEL, <label>Start<elementIndex>, getCharIndex()-1); 848324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label>.setLine(<label>StartLine<elementIndex>); 849324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<label>.setCharPositionInLine(<label>StartCharPos<elementIndex>); 850324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 851324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermatch(EOF); <checkRuleBacktrackFailure()> 852324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 853324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 854324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 855324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// used for left-recursive rules 856324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverrecRuleDefArg() ::= "int <recRuleArg()>" 857324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverrecRuleArg() ::= "_p" 858324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverrecRuleAltPredicate(ruleName,opPrec) ::= "<recRuleArg()> \<= <opPrec>" 859324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverrecRuleSetResultAction() ::= "root_0=$<ruleName>_primary.tree;" 860324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverrecRuleSetReturnAction(src,name) ::= "$<name>=$<src>.<name>;" 861324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 862324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** match ^(root children) in tree parser */ 863324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvertree(root, actionsAfterRoot, children, nullableChildList, 864324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver enclosingTreeLevel, treeLevel) ::= << 865324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<root:element()> 866324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<actionsAfterRoot:element()> 867324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(nullableChildList)> 868324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverif ( input.LA(1)==Token.DOWN ) { 869324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver match(input, Token.DOWN, null); <checkRuleBacktrackFailure()> 870324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <children:element()> 871324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver match(input, Token.UP, null); <checkRuleBacktrackFailure()> 872324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 873324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 874324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermatch(input, Token.DOWN, null); <checkRuleBacktrackFailure()> 875324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<children:element()> 876324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermatch(input, Token.UP, null); <checkRuleBacktrackFailure()> 877324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 878324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 879324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 880324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Every predicate is used as a validating predicate (even when it is 881324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * also hoisted into a prediction expression). 882324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 883324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvervalidateSemanticPredicate(pred,description) ::= << 884324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverif ( !(<evalPredicate(pred,description)>) ) { 885324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleBacktrackFailure()> 886324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver throw new FailedPredicateException(input, "<ruleName>", "<description>"); 887324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 888324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 889324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 890324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// F i x e d D F A (if-then-else) 891324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 892324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverdfaState(k,edges,eotPredictsAlt,description,stateNumber,semPredState) ::= << 893324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint LA<decisionNumber>_<stateNumber> = input.LA(<k>);<\n> 894324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<edges; separator="\nelse "> 895324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverelse { 896324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(eotPredictsAlt)> 897324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver alt<decisionNumber>=<eotPredictsAlt>; 898324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 899324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleBacktrackFailure()> 900324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NoViableAltException nvae = 901324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver new NoViableAltException("<description>", <decisionNumber>, <stateNumber>, input);<\n> 902324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@noViableAltException()> 903324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver throw nvae;<\n> 904324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 905324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 906324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 907324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 908324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Same as a normal DFA state except that we don't examine lookahead 909324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * for the bypass alternative. It delays error detection but this 910324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * is faster, smaller, and more what people expect. For (X)? people 911324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * expect "if ( LA(1)==X ) match(X);" and that's it. 912324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 913324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverdfaOptionalBlockState(k,edges,eotPredictsAlt,description,stateNumber,semPredState) ::= << 914324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint LA<decisionNumber>_<stateNumber> = input.LA(<k>);<\n> 915324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<edges; separator="\nelse "> 916324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 917324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 918324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A DFA state that is actually the loopback decision of a closure 919324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * loop. If end-of-token (EOT) predicts any of the targets then it 920324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * should act like a default clause (i.e., no error can be generated). 921324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This is used only in the lexer so that for ('a')* on the end of a rule 922324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * anything other than 'a' predicts exiting. 923324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 924324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverdfaLoopbackState(k,edges,eotPredictsAlt,description,stateNumber,semPredState) ::= << 925324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint LA<decisionNumber>_<stateNumber> = input.LA(<k>);<\n> 926324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<edges; separator="\nelse "><\n> 927324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(eotPredictsAlt)> 928324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(!edges)> 929324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruveralt<decisionNumber>=<eotPredictsAlt>; <! if no edges, don't gen ELSE !> 930324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 931324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverelse { 932324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver alt<decisionNumber>=<eotPredictsAlt>; 933324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver}<\n> 934324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 935324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 936324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 937324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 938324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** An accept state indicates a unique alternative has been predicted */ 939324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverdfaAcceptState(alt) ::= "alt<decisionNumber>=<alt>;" 940324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 941324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A simple edge with an expression. If the expression is satisfied, 942324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * enter to the target state. To handle gated productions, we may 943324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * have to evaluate some predicates for this edge. 944324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 945324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverdfaEdge(labelExpr, targetState, predicates) ::= << 946324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverif ( (<labelExpr>) <if(predicates)>&& (<predicates>)<endif>) { 947324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <targetState> 948324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 949324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 950324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 951324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// F i x e d D F A (switch case) 952324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 953324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A DFA state where a SWITCH may be generated. The code generator 954324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * decides if this is possible: CodeGenerator.canGenerateSwitch(). 955324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 956324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverdfaStateSwitch(k,edges,eotPredictsAlt,description,stateNumber,semPredState) ::= << 957324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverswitch ( input.LA(<k>) ) { 958324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<edges; separator="\n"> 959324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverdefault: 960324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(eotPredictsAlt)> 961324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver alt<decisionNumber>=<eotPredictsAlt>; 962324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 963324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <ruleBacktrackFailure()> 964324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NoViableAltException nvae = 965324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver new NoViableAltException("<description>", <decisionNumber>, <stateNumber>, input);<\n> 966324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@noViableAltException()> 967324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver throw nvae;<\n> 968324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 969324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver}<\n> 970324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 971324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 972324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverdfaOptionalBlockStateSwitch(k,edges,eotPredictsAlt,description,stateNumber,semPredState) ::= << 973324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverswitch ( input.LA(<k>) ) { 974324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <edges; separator="\n"> 975324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver}<\n> 976324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 977324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 978324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverdfaLoopbackStateSwitch(k, edges,eotPredictsAlt,description,stateNumber,semPredState) ::= << 979324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverswitch ( input.LA(<k>) ) { 980324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<edges; separator="\n"><\n> 981324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(eotPredictsAlt)> 982324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverdefault: 983324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver alt<decisionNumber>=<eotPredictsAlt>; 984324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver break;<\n> 985324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 986324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver}<\n> 987324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 988324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 989324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverdfaEdgeSwitch(labels, targetState) ::= << 990324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<labels:{it |case <it>:}; separator="\n"> 991324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 992324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <targetState> 993324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 994324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver break; 995324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 996324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 997324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// C y c l i c D F A 998324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 999324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** The code to initiate execution of a cyclic DFA; this is used 1000324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * in the rule to predict an alt just like the fixed DFA case. 1001324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * The <name> attribute is inherited via the parser, lexer, ... 1002324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 1003324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverdfaDecision(decisionNumber,description) ::= << 1004324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruveralt<decisionNumber> = dfa<decisionNumber>.predict(input); 1005324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 1006324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1007324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/* Dump DFA tables as run-length-encoded Strings of octal values. 1008324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Can't use hex as compiler translates them before compilation. 1009324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * These strings are split into multiple, concatenated strings. 1010324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Java puts them back together at compile time thankfully. 1011324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Java cannot handle large static arrays, so we're stuck with this 1012324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * encode/decode approach. See analysis and runtime DFA for 1013324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the encoding methods. 1014324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 1015324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvercyclicDFA(dfa) ::= << 1016324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final String DFA<dfa.decisionNumber>_eotS = 1017324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "<dfa.javaCompressedEOT; wrap="\"+\n \"">"; 1018324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final String DFA<dfa.decisionNumber>_eofS = 1019324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "<dfa.javaCompressedEOF; wrap="\"+\n \"">"; 1020324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final String DFA<dfa.decisionNumber>_minS = 1021324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "<dfa.javaCompressedMin; wrap="\"+\n \"">"; 1022324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final String DFA<dfa.decisionNumber>_maxS = 1023324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "<dfa.javaCompressedMax; wrap="\"+\n \"">"; 1024324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final String DFA<dfa.decisionNumber>_acceptS = 1025324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "<dfa.javaCompressedAccept; wrap="\"+\n \"">"; 1026324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final String DFA<dfa.decisionNumber>_specialS = 1027324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "<dfa.javaCompressedSpecial; wrap="\"+\n \"">}>"; 1028324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final String[] DFA<dfa.decisionNumber>_transitionS = { 1029324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <dfa.javaCompressedTransition:{s|"<s; wrap="\"+\n\"">"}; separator=",\n"> 1030324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver}; 1031324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1032324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final short[] DFA<dfa.decisionNumber>_eot = DFA.unpackEncodedString(DFA<dfa.decisionNumber>_eotS); 1033324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final short[] DFA<dfa.decisionNumber>_eof = DFA.unpackEncodedString(DFA<dfa.decisionNumber>_eofS); 1034324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final char[] DFA<dfa.decisionNumber>_min = DFA.unpackEncodedStringToUnsignedChars(DFA<dfa.decisionNumber>_minS); 1035324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final char[] DFA<dfa.decisionNumber>_max = DFA.unpackEncodedStringToUnsignedChars(DFA<dfa.decisionNumber>_maxS); 1036324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final short[] DFA<dfa.decisionNumber>_accept = DFA.unpackEncodedString(DFA<dfa.decisionNumber>_acceptS); 1037324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final short[] DFA<dfa.decisionNumber>_special = DFA.unpackEncodedString(DFA<dfa.decisionNumber>_specialS); 1038324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic final short[][] DFA<dfa.decisionNumber>_transition; 1039324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1040324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverstatic { 1041324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int numStates = DFA<dfa.decisionNumber>_transitionS.length; 1042324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver DFA<dfa.decisionNumber>_transition = new short[numStates][]; 1043324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver for (int i=0; i\<numStates; i++) { 1044324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver DFA<dfa.decisionNumber>_transition[i] = DFA.unpackEncodedString(DFA<dfa.decisionNumber>_transitionS[i]); 1045324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 1046324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 1047324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1048324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverclass DFA<dfa.decisionNumber> extends DFA { 1049324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1050324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public DFA<dfa.decisionNumber>(BaseRecognizer recognizer) { 1051324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.recognizer = recognizer; 1052324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.decisionNumber = <dfa.decisionNumber>; 1053324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.eot = DFA<dfa.decisionNumber>_eot; 1054324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.eof = DFA<dfa.decisionNumber>_eof; 1055324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.min = DFA<dfa.decisionNumber>_min; 1056324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.max = DFA<dfa.decisionNumber>_max; 1057324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.accept = DFA<dfa.decisionNumber>_accept; 1058324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.special = DFA<dfa.decisionNumber>_special; 1059324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.transition = DFA<dfa.decisionNumber>_transition; 1060324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 1061324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public String getDescription() { 1062324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return "<dfa.description>"; 1063324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 1064324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@errorMethod()> 1065324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(dfa.specialStateSTs)> 1066324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public int specialStateTransition(int s, IntStream _input) throws NoViableAltException { 1067324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <if(LEXER)> 1068324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IntStream input = _input; 1069324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <endif> 1070324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <if(PARSER)> 1071324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver TokenStream input = (TokenStream)_input; 1072324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <endif> 1073324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <if(TREE_PARSER)> 1074324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver TreeNodeStream input = (TreeNodeStream)_input; 1075324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <endif> 1076324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int _s = s; 1077324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver switch ( s ) { 1078324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <dfa.specialStateSTs:{state | 1079324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver case <i0> : <! compressed special state numbers 0..n-1 !> 1080324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <state>}; separator="\n"> 1081324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 1082324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(backtracking)> 1083324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (state.backtracking>0) {state.failed=true; return -1;}<\n> 1084324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1085324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NoViableAltException nvae = 1086324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver new NoViableAltException(getDescription(), <dfa.decisionNumber>, _s, input); 1087324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver error(nvae); 1088324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver throw nvae; 1089324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver }<\n> 1090324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1091324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver}<\n> 1092324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 1093324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1094324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A state in a cyclic DFA; it's a special state and part of a big switch on 1095324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * state. 1096324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 1097324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvercyclicDFAState(decisionNumber,stateNumber,edges,needErrorClause,semPredState) ::= << 1098324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint LA<decisionNumber>_<stateNumber> = input.LA(1);<\n> 1099324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(semPredState)> <! get next lookahead symbol to test edges, then rewind !> 1100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverint index<decisionNumber>_<stateNumber> = input.index(); 1101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverinput.rewind();<\n> 1102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvers = -1; 1104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<edges; separator="\nelse "> 1105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(semPredState)> <! return input cursor to state before we rewound !> 1106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverinput.seek(index<decisionNumber>_<stateNumber>);<\n> 1107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverif ( s>=0 ) return s; 1109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverbreak; 1110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 1111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Just like a fixed DFA edge, test the lookahead and indicate what 1113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * state to jump to next if successful. 1114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 1115324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvercyclicDFAEdge(labelExpr, targetStateNumber, edgeNumber, predicates) ::= << 1116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverif ( (<labelExpr>) <if(predicates)>&& (<predicates>)<endif>) {s = <targetStateNumber>;}<\n> 1117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 1118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** An edge pointing at end-of-token; essentially matches any char; 1120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * always jump to the target. 1121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 1122324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvereotDFAEdge(targetStateNumber,edgeNumber, predicates) ::= << 1123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvers = <targetStateNumber>;<\n> 1124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 1125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// D F A E X P R E S S I O N S 1128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1129324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverandPredicates(left,right) ::= "(<left>&&<right>)" 1130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1131324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverorPredicates(operands) ::= "(<first(operands)><rest(operands):{o | ||<o>}>)" 1132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1133324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvernotPredicate(pred) ::= "!(<evalPredicate(pred,{})>)" 1134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1135324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverevalPredicate(pred,description) ::= "(<pred>)" 1136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1137324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverevalSynPredicate(pred,description) ::= "<pred>()" 1138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1139324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlookaheadTest(atom,k,atomAsInt) ::= "LA<decisionNumber>_<stateNumber>==<atom>" 1140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Sometimes a lookahead test cannot assume that LA(k) is in a temp variable 1142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * somewhere. Must ask for the lookahead directly. 1143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 1144324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverisolatedLookaheadTest(atom,k,atomAsInt) ::= "input.LA(<k>)==<atom>" 1145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1146324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlookaheadRangeTest(lower,upper,k,rangeNumber,lowerAsInt,upperAsInt) ::= <% 1147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver(LA<decisionNumber>_<stateNumber> >= <lower> && LA<decisionNumber>_<stateNumber> \<= <upper>) 1148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver%> 1149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1150324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverisolatedLookaheadRangeTest(lower,upper,k,rangeNumber,lowerAsInt,upperAsInt) ::= "(input.LA(<k>) >= <lower> && input.LA(<k>) \<= <upper>)" 1151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1152324c4644fee44b9898524c09511bd33c3f12e2dfBen GruversetTest(ranges) ::= << 1153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ranges; separator="||"> 1154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 1155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// A T T R I B U T E S 1157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1158324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverglobalAttributeScope(scope) ::= << 1159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(scope.attributes)> 1160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverprotected static class <scope.name>_scope { 1161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <scope.attributes:{it |<it.decl>;}; separator="\n"> 1162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 1163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverprotected Stack <scope.name>_stack = new Stack();<\n> 1164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 1166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1167324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleAttributeScope(scope) ::= << 1168324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(scope.attributes)> 1169324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverprotected static class <scope.name>_scope { 1170324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <scope.attributes:{it |<it.decl>;}; separator="\n"> 1171324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 1172324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverprotected Stack <scope.name>_stack = new Stack();<\n> 1173324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1174324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 1175324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1176324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverreturnStructName(r) ::= "<r.name>_return" 1177324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1178324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverreturnType() ::= <% 1179324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(ruleDescriptor.hasMultipleReturnValues)> 1180324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleDescriptor.grammar.recognizerName>.<ruleDescriptor:returnStructName()> 1181324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1182324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(ruleDescriptor.hasSingleReturnValue)> 1183324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleDescriptor.singleValueReturnType> 1184324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1185324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvervoid 1186324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1187324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1188324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver%> 1189324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1190324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Generate the Java type associated with a single or multiple return 1191324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * values. 1192324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 1193324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleLabelType(referencedRule) ::= <% 1194324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(referencedRule.hasMultipleReturnValues)> 1195324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<referencedRule.grammar.recognizerName>.<referencedRule.name>_return 1196324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1197324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(referencedRule.hasSingleReturnValue)> 1198324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<referencedRule.singleValueReturnType> 1199324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1200324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvervoid 1201324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1202324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1203324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver%> 1204324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1205324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverdelegateName(d) ::= << 1206324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(d.label)><d.label><else>g<d.name><endif> 1207324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 1208324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1209324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Using a type to init value map, try to init a type; if not in table 1210324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * must be an object, default value is "null". 1211324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 1212324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverinitValue(typeName) ::= << 1213324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<javaTypeInitMap.(typeName)> 1214324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 1215324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1216324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Define a rule label including default value */ 1217324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleLabelDef(label) ::= <% 1218324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<ruleLabelType(referencedRule=label.referencedRule)> <label.label.text> = 1219324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <initValue(typeName=ruleLabelType(referencedRule=label.referencedRule))>;<\n> 1220324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver%> 1221324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1222324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Define a return struct for a rule if the code needs to access its 1223324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * start/stop tokens, tree stuff, attributes, ... Leave a hole for 1224324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * subgroups to stick in members. 1225324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 1226324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverreturnScope(scope) ::= << 1227324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(ruleDescriptor.hasMultipleReturnValues)> 1228324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic static class <ruleDescriptor:returnStructName()> extends <if(TREE_PARSER)>Tree<else>Parser<endif>RuleReturnScope { 1229324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <scope.attributes:{it |public <it.decl>;}; separator="\n"> 1230324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <@ruleReturnMembers()> 1231324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver}; 1232324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1233324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 1234324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1235324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverparameterScope(scope) ::= << 1236324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<scope.attributes:{it |<it.decl>}; separator=", "> 1237324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 1238324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1239324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverparameterAttributeRef(attr) ::= "<attr.name>" 1240324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverparameterSetAttributeRef(attr,expr) ::= "<attr.name> =<expr>;" 1241324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1242324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverscopeAttributeRef(scope,attr,index,negIndex) ::= <% 1243324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(negIndex)> 1244324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver((<scope>_scope)<scope>_stack.elementAt(<scope>_stack.size()-<negIndex>-1)).<attr.name> 1245324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1246324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(index)> 1247324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver((<scope>_scope)<scope>_stack.elementAt(<index>)).<attr.name> 1248324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1249324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver((<scope>_scope)<scope>_stack.peek()).<attr.name> 1250324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1251324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1252324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver%> 1253324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1254324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverscopeSetAttributeRef(scope,attr,expr,index,negIndex) ::= <% 1255324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(negIndex)> 1256324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver((<scope>_scope)<scope>_stack.elementAt(<scope>_stack.size()-<negIndex>-1)).<attr.name> =<expr>; 1257324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1258324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(index)> 1259324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver((<scope>_scope)<scope>_stack.elementAt(<index>)).<attr.name> =<expr>; 1260324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1261324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver((<scope>_scope)<scope>_stack.peek()).<attr.name> =<expr>; 1262324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1263324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1264324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver%> 1265324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1266324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** $x is either global scope or x is rule with dynamic scope; refers 1267324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * to stack itself not top of stack. This is useful for predicates 1268324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * like {$function.size()>0 && $function::name.equals("foo")}? 1269324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 1270324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverisolatedDynamicScopeRef(scope) ::= "<scope>_stack" 1271324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1272324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** reference an attribute of rule; might only have single return value */ 1273324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleLabelRef(referencedRule,scope,attr) ::= <% 1274324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(referencedRule.hasMultipleReturnValues)> 1275324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver(<scope>!=null?<scope>.<attr.name>:<initValue(attr.type)>) 1276324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1277324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<scope> 1278324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1279324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver%> 1280324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1281324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverreturnAttributeRef(ruleDescriptor,attr) ::= <% 1282324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(ruleDescriptor.hasMultipleReturnValues)> 1283324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverretval.<attr.name> 1284324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1285324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<attr.name> 1286324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1287324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver%> 1288324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1289324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverreturnSetAttributeRef(ruleDescriptor,attr,expr) ::= <% 1290324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(ruleDescriptor.hasMultipleReturnValues)> 1291324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverretval.<attr.name> =<expr>; 1292324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1293324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<attr.name> =<expr>; 1294324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1295324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver%> 1296324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1297324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** How to translate $tokenLabel */ 1298324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvertokenLabelRef(label) ::= "<label>" 1299324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1300324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** ids+=ID {$ids} or e+=expr {$e} */ 1301324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlistLabelRef(label) ::= "list_<label>" 1302324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1303324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1304324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// not sure the next are the right approach 1305324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1306324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvertokenLabelPropertyRef_text(scope,attr) ::= "(<scope>!=null?<scope>.getText():null)" 1307324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvertokenLabelPropertyRef_type(scope,attr) ::= "(<scope>!=null?<scope>.getType():0)" 1308324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvertokenLabelPropertyRef_line(scope,attr) ::= "(<scope>!=null?<scope>.getLine():0)" 1309324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvertokenLabelPropertyRef_pos(scope,attr) ::= "(<scope>!=null?<scope>.getCharPositionInLine():0)" 1310324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvertokenLabelPropertyRef_channel(scope,attr) ::= "(<scope>!=null?<scope>.getChannel():0)" 1311324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvertokenLabelPropertyRef_index(scope,attr) ::= "(<scope>!=null?<scope>.getTokenIndex():0)" 1312324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvertokenLabelPropertyRef_tree(scope,attr) ::= "<scope>_tree" 1313324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvertokenLabelPropertyRef_int(scope,attr) ::= "(<scope>!=null?Integer.valueOf(<scope>.getText()):0)" 1314324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1315324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleLabelPropertyRef_start(scope,attr) ::= "(<scope>!=null?((<labelType>)<scope>.start):null)" 1316324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleLabelPropertyRef_stop(scope,attr) ::= "(<scope>!=null?((<labelType>)<scope>.stop):null)" 1317324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleLabelPropertyRef_tree(scope,attr) ::= "(<scope>!=null?((<ASTLabelType>)<scope>.tree):null)" 1318324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleLabelPropertyRef_text(scope,attr) ::= <% 1319324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(TREE_PARSER)> 1320324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver(<scope>!=null?(input.getTokenStream().toString( 1321324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.getTreeAdaptor().getTokenStartIndex(<scope>.start), 1322324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.getTreeAdaptor().getTokenStopIndex(<scope>.start))):null) 1323324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1324324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver(<scope>!=null?input.toString(<scope>.start,<scope>.stop):null) 1325324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1326324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver%> 1327324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1328324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleLabelPropertyRef_st(scope,attr) ::= "(<scope>!=null?<scope>.st:null)" 1329324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1330324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Isolated $RULE ref ok in lexer as it's a Token */ 1331324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRuleLabel(label) ::= "<label>" 1332324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1333324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRuleLabelPropertyRef_type(scope,attr) ::= 1334324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "(<scope>!=null?<scope>.getType():0)" 1335324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRuleLabelPropertyRef_line(scope,attr) ::= 1336324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "(<scope>!=null?<scope>.getLine():0)" 1337324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRuleLabelPropertyRef_pos(scope,attr) ::= 1338324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "(<scope>!=null?<scope>.getCharPositionInLine():-1)" 1339324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRuleLabelPropertyRef_channel(scope,attr) ::= 1340324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "(<scope>!=null?<scope>.getChannel():0)" 1341324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRuleLabelPropertyRef_index(scope,attr) ::= 1342324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "(<scope>!=null?<scope>.getTokenIndex():0)" 1343324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRuleLabelPropertyRef_text(scope,attr) ::= 1344324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "(<scope>!=null?<scope>.getText():null)" 1345324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRuleLabelPropertyRef_int(scope,attr) ::= 1346324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "(<scope>!=null?Integer.valueOf(<scope>.getText()):0)" 1347324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1348324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Somebody may ref $template or $tree or $stop within a rule: 1349324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverrulePropertyRef_start(scope,attr) ::= "((<labelType>)retval.start)" 1350324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverrulePropertyRef_stop(scope,attr) ::= "((<labelType>)retval.stop)" 1351324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverrulePropertyRef_tree(scope,attr) ::= "((<ASTLabelType>)retval.tree)" 1352324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverrulePropertyRef_text(scope,attr) ::= <% 1353324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(TREE_PARSER)> 1354324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverinput.getTokenStream().toString( 1355324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.getTreeAdaptor().getTokenStartIndex(retval.start), 1356324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.getTreeAdaptor().getTokenStopIndex(retval.start)) 1357324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1358324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverinput.toString(retval.start,input.LT(-1)) 1359324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1360324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver%> 1361324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverrulePropertyRef_st(scope,attr) ::= "retval.st" 1362324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1363324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRulePropertyRef_text(scope,attr) ::= "getText()" 1364324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRulePropertyRef_type(scope,attr) ::= "_type" 1365324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRulePropertyRef_line(scope,attr) ::= "state.tokenStartLine" 1366324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRulePropertyRef_pos(scope,attr) ::= "state.tokenStartCharPositionInLine" 1367324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRulePropertyRef_index(scope,attr) ::= "-1" // undefined token index in lexer 1368324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRulePropertyRef_channel(scope,attr) ::= "_channel" 1369324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRulePropertyRef_start(scope,attr) ::= "state.tokenStartCharIndex" 1370324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRulePropertyRef_stop(scope,attr) ::= "(getCharIndex()-1)" 1371324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverlexerRulePropertyRef_int(scope,attr) ::= "Integer.valueOf(<scope>.getText())" 1372324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1373324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// setting $st and $tree is allowed in local rule. everything else 1374324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// is flagged as error 1375324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleSetPropertyRef_tree(scope,attr,expr) ::= "retval.tree =<expr>;" 1376324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverruleSetPropertyRef_st(scope,attr,expr) ::= "retval.st =<expr>;" 1377324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1378324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** How to execute an action (only when not backtracking) */ 1379324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverexecAction(action) ::= <% 1380324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<if(backtracking)> 1381324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverif ( <actions.(actionScope).synpredgate> ) { 1382324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver <action> 1383324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 1384324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<else> 1385324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<action> 1386324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver<endif> 1387324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver%> 1388324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1389324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** How to always execute an action even when backtracking */ 1390324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverexecForcedAction(action) ::= "<action>" 1391324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1392324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// M I S C (properties, etc...) 1393324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1394324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverbitset(name, words64) ::= << 1395324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic static final BitSet <name> = new BitSet(new long[]{<words64:{it |<it>L};separator=",">});<\n> 1396324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver>> 1397324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1398324c4644fee44b9898524c09511bd33c3f12e2dfBen GruvercodeFileExtension() ::= ".java" 1399324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1400324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvertrue_value() ::= "true" 1401324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverfalse_value() ::= "false" 1402