ASTTreeParser.stg revision 324c4644fee44b9898524c09511bd33c3f12e2df 
1/*
2 [The "BSD license"]
3 Copyright (c) 2005-2006 Terence Parr
4 Copyright (c) 2008 Ronald Blaschke
5 All rights reserved.
6
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions
9 are met:
10 1. Redistributions of source code must retain the above copyright
11    notice, this list of conditions and the following disclaimer.
12 2. Redistributions in binary form must reproduce the above copyright
13    notice, this list of conditions and the following disclaimer in the
14    documentation and/or other materials provided with the distribution.
15 3. The name of the author may not be used to endorse or promote products
16    derived from this software without specific prior written permission.
17
18 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*/
29
30/** Templates for building ASTs during tree parsing.
31 *
32 *  Deal with many combinations.  Dimensions are:
33 *  Auto build or rewrite
34 *    no label, label, list label  (label/no-label handled together)
35 *    child, root
36 *    token, set, rule, wildcard
37 *
38 *  Each combination has its own template except that label/no label
39 *  is combined into tokenRef, ruleRef, ...
40 */
41group ASTTreeParser;
42
43/** Add a variable to track last element matched */
44ruleDeclarations() ::= <<
45<super.ruleDeclarations()>
46<ASTLabelType> _first_0 = null;
47<ASTLabelType> _last = null;<\n>
48>>
49
50/** What to emit when there is no rewrite rule.  For auto build
51 *  mode, does nothing.
52 */
53noRewrite(rewriteBlockLevel, treeLevel) ::= <<
54<if(backtracking)>if ( state.backtracking==0 ) {<endif>
55<if(rewriteMode)>
56retval.tree = (<ASTLabelType>)_first_0;
57if ( adaptor.getParent(retval.tree)!=null && adaptor.isNil( adaptor.getParent(retval.tree) ) )
58    retval.tree = (<ASTLabelType>)adaptor.getParent(retval.tree);
59<endif>
60<if(backtracking)>}<endif>
61>>
62
63/** match ^(root children) in tree parser; override here to
64 *  add tree construction actions.
65 */
66tree(root, actionsAfterRoot, children, nullableChildList,
67     enclosingTreeLevel, treeLevel) ::= <<
68_last = (<ASTLabelType>)input.LT(1);
69{
70<ASTLabelType> _save_last_<treeLevel> = _last;
71<ASTLabelType> _first_<treeLevel> = null;
72<if(!rewriteMode)>
73<ASTLabelType> root_<treeLevel> = (<ASTLabelType>)adaptor.nil();
74<endif>
75<root:element()>
76<if(rewriteMode)>
77<if(backtracking)>if ( state.backtracking==0 )<endif>
78<if(root.el.rule)>
79if ( _first_<enclosingTreeLevel>==null ) _first_<enclosingTreeLevel> = <root.el.label>.tree;
80<else>
81if ( _first_<enclosingTreeLevel>==null ) _first_<enclosingTreeLevel> = <root.el.label>;
82<endif>
83<endif>
84<actionsAfterRoot:element()>
85<if(nullableChildList)>
86if ( input.LA(1)==Token.DOWN ) {
87    match(input, Token.DOWN, null); <checkRuleBacktrackFailure()>
88    <children:element()>
89    match(input, Token.UP, null); <checkRuleBacktrackFailure()>
90}
91<else>
92match(input, Token.DOWN, null); <checkRuleBacktrackFailure()>
93<children:element()>
94match(input, Token.UP, null); <checkRuleBacktrackFailure()>
95<endif>
96<if(!rewriteMode)>
97adaptor.addChild(root_<enclosingTreeLevel>, root_<treeLevel>);
98<endif>
99_last = _save_last_<treeLevel>;
100}<\n>
101>>
102
103// TOKEN AST STUFF
104
105/** ID! and output=AST (same as plain tokenRef) 'cept add
106 *  setting of _last
107 */
108tokenRefBang(token,label,elementIndex) ::= <<
109_last = (<ASTLabelType>)input.LT(1);
110<super.tokenRef(...)>
111>>
112
113/** ID auto construct */
114tokenRef(token,label,elementIndex,terminalOptions) ::= <<
115_last = (<ASTLabelType>)input.LT(1);
116<super.tokenRef(...)>
117<if(!rewriteMode)>
118<if(backtracking)>if ( state.backtracking==0 ) {<endif>
119<if(terminalOptions.node)>
120<label>_tree = new <terminalOptions.node>(<label>);
121<else>
122<label>_tree = (<ASTLabelType>)adaptor.dupNode(<label>);
123<endif><\n>
124adaptor.addChild(root_<treeLevel>, <label>_tree);
125<if(backtracking)>}<endif>
126<else> <! rewrite mode !>
127<if(backtracking)>if ( state.backtracking==0 )<endif>
128if ( _first_<treeLevel>==null ) _first_<treeLevel> = <label>;
129<endif>
130>>
131
132/** label+=TOKEN auto construct */
133tokenRefAndListLabel(token,label,elementIndex,terminalOptions) ::= <<
134<tokenRef(...)>
135<listLabel(elem=label,...)>
136>>
137
138/** ^(ID ...) auto construct */
139tokenRefRuleRoot(token,label,elementIndex,terminalOptions) ::= <<
140_last = (<ASTLabelType>)input.LT(1);
141<super.tokenRef(...)>
142<if(!rewriteMode)>
143<if(backtracking)>if ( state.backtracking==0 ) {<endif>
144<if(terminalOptions.node)>
145<label>_tree = new <terminalOptions.node>(<label>);
146<else>
147<label>_tree = (<ASTLabelType>)adaptor.dupNode(<label>);
148<endif><\n>
149root_<treeLevel> = (<ASTLabelType>)adaptor.becomeRoot(<label>_tree, root_<treeLevel>);
150<if(backtracking)>}<endif>
151<endif>
152>>
153
154/** Match ^(label+=TOKEN ...) auto construct */
155tokenRefRuleRootAndListLabel(token,label,elementIndex,terminalOptions) ::= <<
156<tokenRefRuleRoot(...)>
157<listLabel(elem=label,...)>
158>>
159
160// SET AST
161
162matchSet(s,label,terminalOptions,elementIndex,postmatchCode) ::= <<
163_last = (<ASTLabelType>)input.LT(1);
164<super.matchSet(..., postmatchCode={
165<if(!rewriteMode)>
166<if(backtracking)>if ( state.backtracking==0 ) {<endif>
167<if(terminalOptions.node)>
168<label>_tree = new <terminalOptions.node>(<label>);
169<else>
170<label>_tree = (<ASTLabelType>)adaptor.dupNode(<label>);
171<endif><\n>
172adaptor.addChild(root_<treeLevel>, <label>_tree);
173<if(backtracking)>}<endif>
174<endif>
175}
176)>
177>>
178
179matchRuleBlockSet(s,label,terminalOptions,elementIndex,postmatchCode,treeLevel="0") ::= <<
180<matchSet(...)>
181<noRewrite()> <! set return tree !>
182>>
183
184matchSetBang(s,label,elementIndex,postmatchCode) ::= <<
185_last = (<ASTLabelType>)input.LT(1);
186<super.matchSet(...)>
187>>
188
189matchSetRuleRoot(s,label,terminalOptions,elementIndex,debug) ::= <<
190<super.matchSet(..., postmatchCode={
191<if(!rewriteMode)>
192<if(backtracking)>if ( state.backtracking==0 ) {<endif>
193<if(terminalOptions.node)>
194<label>_tree = new <terminalOptions.node>(<label>);
195<else>
196<label>_tree = (<ASTLabelType>)adaptor.dupNode(<label>);
197<endif><\n>
198root_<treeLevel> = (<ASTLabelType>)adaptor.becomeRoot(<label>_tree, root_<treeLevel>);
199<if(backtracking)>}<endif>
200<endif>
201}
202)>
203>>
204
205// RULE REF AST
206
207/** rule auto construct */
208ruleRef(rule,label,elementIndex,args,scope) ::= <<
209_last = (<ASTLabelType>)input.LT(1);
210<super.ruleRef(...)>
211<if(backtracking)>if ( state.backtracking==0 ) <endif>
212<if(!rewriteMode)>
213adaptor.addChild(root_<treeLevel>, <label>.getTree());
214<else> <! rewrite mode !>
215if ( _first_<treeLevel>==null ) _first_<treeLevel> = <label>.tree;
216<endif>
217>>
218
219/** x+=rule auto construct */
220ruleRefAndListLabel(rule,label,elementIndex,args,scope) ::= <<
221<ruleRef(...)>
222<listLabel(elem=label+".getTree()",...)>
223>>
224
225/** ^(rule ...) auto construct */
226ruleRefRuleRoot(rule,label,elementIndex,args,scope) ::= <<
227_last = (<ASTLabelType>)input.LT(1);
228<super.ruleRef(...)>
229<if(!rewriteMode)>
230<if(backtracking)>if ( state.backtracking==0 ) <endif>root_<treeLevel> = (<ASTLabelType>)adaptor.becomeRoot(<label>.getTree(), root_<treeLevel>);
231<endif>
232>>
233
234/** ^(x+=rule ...) auto construct */
235ruleRefRuleRootAndListLabel(rule,label,elementIndex,args,scope) ::= <<
236<ruleRefRuleRoot(...)>
237<listLabel(elem=label+".getTree()",...)>
238>>
239
240/** Streams for token refs are tree nodes now; override to
241 *  change nextToken to nextNode.
242 */
243createRewriteNodeFromElement(token,terminalOptions,scope) ::= <<
244<if(terminalOptions.node)>
245new <terminalOptions.node>(stream_<token>.nextNode())
246<else>
247stream_<token>.nextNode()
248<endif>
249>>
250
251ruleCleanUp() ::= <<
252<super.ruleCleanUp()>
253<if(!rewriteMode)>
254<if(backtracking)>if ( state.backtracking==0 ) {<\n><endif>
255retval.tree = (<ASTLabelType>)adaptor.rulePostProcessing(root_0);
256<if(backtracking)>}<endif>
257<endif>
258>>
259