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