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