1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
|
<?xml version="1.0" encoding="UTF-8"?>
<templates><template id="ASTAbstractRule.cu" name="ASTAbstractRule.cu" description="ASTAbstractRule CompilationUnit template" context="org.eclipse.gymnast.generators.ast.primordial.templates.JavaRuleCompUnit" enabled="true" deleted="false" autoinsert="true">package ${astPackageName};
/**
*
* ${generatedBy}
*/
public abstract class ${typeName} ${extends} {
/**
* Construct a new ${typeName}.
*/
public ${typeName}() {
super();
}
${ASTVisitorClass_acceptImpl}
}</template><template id="ASTBaseClass.cu" name="ASTBaseClass.cu" description="ASTBaseClass CompilationUnit template" context="org.eclipse.gymnast.generators.ast.primordial.templates.JavaCompUnit" enabled="true" deleted="false" autoinsert="true">package ${astPackageName};
import org.eclipse.gymnast.runtime.core.ast.ASTNode;
import org.eclipse.gymnast.runtime.core.ast.ASTNodeImpl;
import org.eclipse.gymnast.runtime.core.ast.TokenInfo;
/**
* The superclass of all ASTNodes for language ${astName}.
*
* ${generatedBy}
*/
public abstract class ${astBaseClassName} extends ${astBaseClassBaseName} {
protected ${astBaseClassName} _parent;
/**
* @return the parent of this ASTNode or null if this is the root node of a tree
*/
public ASTNode getParent() {
return _parent;
}
/**
* Construct a new ${astBaseClassName}.
*/
public ${astBaseClassName}() {
super();
}
/**
* Construct a new ${astBaseClassName}.
*
* @param token a Token to initialize the offset and text for this node.
*/
public ${astBaseClassName}(TokenInfo tokenInfo) {
super(tokenInfo);
}
/**
* The external entry point used to initiate the visitor on this node.
*
* @param visitor the Visitor to visit this node tree
*/
public final void accept(${astVisitorClassName} visitor) {
visitor.preVisit(this);
acceptImpl(visitor);
visitor.postVisit(this);
}
/**
* This method can be overridden by subclasses which should provide exactly
* the same implementation. Here <code>this</code> refers to the generic node
* class, but in the subclass implementations <code>this</code> will refer to
* the specific subclass type. Thus the correct specific <code>beginVisit</code>
* and <code>endVisit</code> methods will be invoked for each subclass and the
* generic methods will be invoked for subclasses that don't need specific visitor
* behavior.
*/
public void acceptImpl(${astVisitorClassName} visitor) {
boolean visitChildren = visitor.beginVisit(this);
if (visitChildren) visitChildren(visitor);
visitor.endVisit(this);
}
/**
* Iterate through the children of this node and accept the visitor on each.
*/
protected void visitChildren(${astVisitorClassName} visitor) {
for (int i = 0; i < getChildCount(); i++) {
ASTNode child = getChild(i);
if (child instanceof ${astBaseClassName}) {
${astBaseClassName} c = (${astBaseClassName})child;
c.accept(visitor);
}
}
}
}
</template><template id="ASTContainerRule.cu" name="ASTContainerRule.cu" description="ASTContainerRule CompilationUnit template" context="org.eclipse.gymnast.generators.ast.primordial.templates.JavaRuleCompUnit" enabled="true" deleted="false" autoinsert="true">package ${astPackageName};
import org.eclipse.gymnast.runtime.core.ast.ASTNode;
/**
*
* ${generatedBy}
*/
public ${typeKind} ${typeName} ${extends} ${implements} {
${^foreach_KeywordLiteral} public static final String KW_${literal_UC} = "${literal}";
${^END}
${^foreach_ChildElement} private ${childType} _${childName};
${^END}
${^foreach_ChildElement} public ${childType} getAs${childName_UC}() {
return _${childName};
}
${^END}
${^foreach_ChildElement} public boolean isChild${childName_UC}() {
return _${childName} != null;
}
${^END}
/**
* @return the number of children of this ASTNode
*/
public int getChildCount() {
int count = 0;
${^foreach_ChildElement} if (_${childName} != null) count++;
${^END}
return count;
}
/**
* @param index the index of a child ASTNode to get
* @return the child ASTNode at the given index
* @throws IndexOutOfBoundsException when the index is out of bounds
*/
public ASTNode getChild(int index) {
if (index != 0) throw new IndexOutOfBoundsException();
${^foreach_ChildElement} if (_${childName} != null) return _${childName};
${^END}
throw new IndexOutOfBoundsException();
}
/**
* Construct a new ${typeName}.
*/
public ${typeName}() {
super();
}
${^foreach_ChildElement} public void initAs${childName_UC}(${childTypeOrToken} ${childName}) {
if (_${childName}._parent != null) throw new RuntimeException();
_${childName}._parent = this;
_${childName} = ${childName};
}
${^END}
${ASTVisitorClass_acceptImpl}
}
</template><template id="ASTListRule.cu" name="ASTListRule.cu" description="ASTListRule CompilationUnit template" context="org.eclipse.gymnast.generators.ast.primordial.templates.JavaRuleCompUnit" enabled="true" deleted="false" autoinsert="true">package ${astPackageName};
import java.util.ArrayList;
import org.eclipse.gymnast.runtime.core.ast.ASTNode;
import org.eclipse.gymnast.runtime.core.ast.TokenInfo;
/**
*
* ${generatedBy}
*/
public ${typeKind} ${typeName} ${extends} {
private ArrayList _children = new ArrayList();
/**
* @return the number of children of this ASTNode
*/
public int getChildCount() {
return _children.size();
}
/**
* @param index the index of a child ASTNode to get
* @return the child ASTNode at the given index
* @throws IndexOutOfBoundsException when the index is out of bounds
*/
public ASTNode getChild(int index) {
return (ASTNode)_children.get(index);
}
/**
* Add a child to this list.
*/
public void addChild(${astBaseClassName} child) {
if (child == null) return;
if (child._parent != null) throw new RuntimeException();
_children.add(child);
child._parent = this;
}
/**
* Wrap the provided Token in a ${astTokenClassName}
* and add it as a child of this node.
*
* @param token the Token to be added as a child of this node
*/
public void addChild(TokenInfo tokenInfo) {
addChild(new ${astTokenClassName}(tokenInfo));
}
/**
* Construct a new ${typeName}.
*/
public ${typeName}() {
super();
}
${ASTVisitorClass_acceptImpl}
}
</template><template id="ASTSequenceRule.cu" name="ASTSequenceRule.cu" description="ASTSequenceRule CompilationUnit template" context="org.eclipse.gymnast.generators.ast.primordial.templates.JavaRuleCompUnit" enabled="true" deleted="false" autoinsert="true">package ${astPackageName};
import org.eclipse.gymnast.runtime.core.ast.ASTNode;
import org.eclipse.gymnast.runtime.core.ast.TokenInfo;
/**
*
* ${generatedBy}
*/
public ${typeKind} ${typeName} ${extends} ${implements} {
${^foreach_KeywordLiteral} public static final String KW_${literal_UC} = "${literal}";
${^END}
${^foreach_ChildElement} private ${childType} _${childName};
${^END}
${^foreach_ChildElement} public ${childType} get${childName_UC}() {
return _${childName};
}
${^END}
/**
* @return the number of children of this ASTNode
*/
public int getChildCount() {
int count = 0;
${^foreach_ChildElement} if (_${childName} != null) count++;
${^END}
return count;
}
/**
* @param index the index of a child ASTNode to get
* @return the child ASTNode at the given index
* @throws IndexOutOfBoundsException when the index is out of bounds
*/
public ASTNode getChild(int index) {
int count = -1;
${^foreach_ChildElement} if ((_${childName} != null) && (++count == index)) return _${childName};
${^END}
throw new IndexOutOfBoundsException();
}
/**
* Construct a new ${typeName}.
*/
public ${typeName}(
${^foreach_ChildElement} ${childTypeOrToken} ${childName}${comma}
${^END} ) {
super();
${^foreach_ChildElement} if (${childName} != null) {
_${childName} = ${initExpr};
if (_${childName}._parent != null) throw new RuntimeException();
_${childName}._parent = this;
}
${^END}
}
${ASTVisitorClass_acceptImpl}
}
</template><template id="ASTTokenClass.cu" name="ASTTokenClass.cu" description="ASTTokenClass CompilationUnit template" context="org.eclipse.gymnast.generators.ast.primordial.templates.JavaCompUnit" enabled="true" deleted="false" autoinsert="true">package ${astPackageName};
import org.eclipse.gymnast.runtime.core.ast.ASTNode;
import org.eclipse.gymnast.runtime.core.ast.TokenInfo;
/**
* Represents a token in the language grammar.
* Can be subclassed to represent specific token subgroups.
*
* ${generatedBy}
*/
public class ${astTokenClassName} extends ${astBaseClassName} {
/**
* @return the number of children of this ASTNode
*/
public final int getChildCount() {
// token rules cannot have children!
return 0;
}
/**
* @param index the index of a child ASTNode to get
* @return the child ASTNode at the given index
* @throws IndexOutOfBoundsException when the index is out of bounds
*/
public final ASTNode getChild(int index) {
// token rules cannot have children!
throw new IndexOutOfBoundsException();
}
/**
* Construct a new ${astTokenClassName}
*/
public ${astTokenClassName}(TokenInfo tokenInfo) {
super(tokenInfo);
}
${ASTVisitorClass_acceptImpl}
}
</template><template id="ASTTokenRule.cu" name="ASTTokenRule.cu" description="ASTTokenRule CompilationUnit template" context="org.eclipse.gymnast.generators.ast.primordial.templates.JavaRuleCompUnit" enabled="true" deleted="false" autoinsert="true">package ${astPackageName};
import org.eclipse.gymnast.runtime.core.ast.TokenInfo;
/**
*
* ${generatedBy}
*/
public class ${typeName} extends ${astTokenClassName} {
${^foreach_KeywordLiteral} public static final String KW_${literal_UC} = "${literal}";
${^END}
/**
* Construct a new ${typeName}.
*/
public ${typeName}(TokenInfo tokenInfo) {
super(tokenInfo);
}
${ASTVisitorClass_acceptImpl}
}</template><template id="ASTVisitorClass.cu" name="ASTVisitorClass.cu" description="ASTVisitorClass CompilationUnit template" context="org.eclipse.gymnast.generators.ast.primordial.templates.JavaCompUnit" enabled="true" deleted="false" autoinsert="true">package ${astPackageName};
/**
* A Visitor pattern stub implementation for language ${astName}.
*
* ${generatedBy}
*/
public class ${astVisitorClassName} {
/**
* The external entry point used to perform a visit beginning at the given node.
*
* @param node the ${astBaseClassName} to visit
*/
public final void visit(${astBaseClassName} node) {
node.accept(this);
}
/**
* Called just before <code>beginVisit</code> for each node being visited.
* This may be overridden to provide special behavior at that point in processing.
*
* @param node the ${astBaseClassName} currently being visited
*/
public void preVisit(${astBaseClassName} node) {
}
/**
* Called just after <code>endVisit</code> for each node being visited.
* This may be overridden to provide special behavior at that point in processing.
*
* @param node the ${astBaseClassName} currently being visited
*/
public void postVisit(${astBaseClassName} node) {
}
/**
* This is called, for each node being visited, just after <code>preVisit</code> and
* before (optionally) visiting the children of the node.
* This <code>beginVisit</code> method is the generic one called for node types that
* don't provide a specific overloaded form of <code>beginVisit</code>.
* This may be overridden to provide special behavior at that point in processing.
*
* @param node the ${astBaseClassName} currently being visited
* @return true to visit the children of the node, false to prevent visiting the children of the node
*/
public boolean beginVisit(${astBaseClassName} node) {
return true;
}
/**
* This is called, for each node being visited, after <code>beginVisit</code> and
* (optionally) visiting the children of the node and before <code>postVisit</code>.
* This <code>endVisit</code> method is the generic one called for node types that
* don't provide a specific overloaded form of <code>endVisit</code>.
* This may be overridden to provide special behavior at that point in processing.
*
* @param node the ${astBaseClassName} currently being visited
*/
public void endVisit(${astBaseClassName} node) {
}
/**
* This is called, for each node being visited, just after <code>preVisit</code> and
* before (optionally) visiting the children of the node.
* This <code>beginVisit</code> method is the specific one called for nodes
* of type <code>${astTokenClassName}</code>
* This may be overridden to provide special behavior at that point in processing.
*
* @param tokenNode the node currently being visited
* @return true to visit the children of the node, false to prevent visiting the children of the node
*/
public boolean beginVisit(${astTokenClassName} tokenNode) {
return beginVisit((${astBaseClassName})tokenNode);
}
/**
* This is called, for each node being visited, after <code>beginVisit</code> and
* (optionally) visiting the children of the node and before <code>postVisit</code>.
* This <code>endVisit</code> method is the specific one called for nodes
* of type <code>${astTokenClassName}</code>
* This may be overridden to provide special behavior at that point in processing.
*
* @param tokenNode the node currently being visited
*/
public void endVisit(${astTokenClassName} tokenNode) {
endVisit((${astBaseClassName})tokenNode);
}
${^foreach_Rule} /**
* This is called, for each node being visited, just after <code>preVisit</code> and
* before (optionally) visiting the children of the node.
* This <code>beginVisit</code> method is the specific one called for nodes
* of type <code>${ruleName_UC}</code>
* This may be overridden to provide special behavior at that point in processing.
*
* @param ${ruleName_LC} the node currently being visited
* @return true to visit the children of the node, false to prevent visiting the children of the node
*/
public boolean beginVisit(${ruleName_UC} ${ruleName_LC}) {
return beginVisit((${ruleBaseClassName})${ruleName_LC});
}
/**
* This is called, for each node being visited, after <code>beginVisit</code> and
* (optionally) visiting the children of the node and before <code>postVisit</code>.
* This <code>endVisit</code> method is the specific one called for nodes
* of type <code>${ruleName_UC}</code>
* This may be overridden to provide special behavior at that point in processing.
*
* @param ${ruleName_LC} the node currently being visited
*/
public void endVisit(${ruleName_UC} ${ruleName_LC}) {
endVisit((${ruleBaseClassName})${ruleName_LC});
}
${^END}
}</template><template id="ASTVisitorClass_acceptImpl" name="ASTVisitorClass_acceptImpl" description="acceptImpl method for the visitor framework" context="org.eclipse.gymnast.generators.ast.primordial.templates.JavaMethod" enabled="true" deleted="false" autoinsert="true"> /**
* This method overrides the superclass <code>acceptImpl</code> providing
* the same implementation. Here <code>this</code> refers to this specific node
* class, so the <code>beginVisit</code> and <code>endVisit</code> methods
* specific to this type in the visitor will be invoked.
*/
public void acceptImpl(${astVisitorClassName} visitor) {
boolean visitChildren = visitor.beginVisit(this);
if (visitChildren) visitChildren(visitor);
visitor.endVisit(this);
}</template></templates>
|
