1 /*
2 * Copyright (c) 1999, 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package com.sun.tools.javac.tree;
27
28 import com.sun.tools.javac.util.*;
29 import com.sun.tools.javac.tree.JCTree.*;
30
31 /** A subclass of Tree.Visitor, this class defines
32 * a general tree translator pattern. Translation proceeds recursively in
33 * left-to-right order down a tree, constructing translated nodes by
34 * overwriting existing ones. There is one visitor method in this class
35 * for every possible kind of tree node. To obtain a specific
36 * translator, it suffices to override those visitor methods which
37 * do some interesting work. The translator class itself takes care of all
38 * navigational aspects.
39 *
40 * <p><b>This is NOT part of any supported API.
41 * If you write code that depends on this, you do so at your own risk.
42 * This code and its internal interfaces are subject to change or
43 * deletion without notice.</b>
44 */
45 public class TreeTranslator extends JCTree.Visitor {
46
47 /** Visitor result field: a tree
48 */
49 protected JCTree result;
50
51 /** Visitor method: Translate a single node.
52 */
53 @SuppressWarnings("unchecked")
54 public <T extends JCTree> T translate(T tree) {
55 if (tree == null) {
56 return null;
57 } else {
58 tree.accept(this);
59 JCTree tmpResult = this.result;
60 this.result = null;
61 return (T)tmpResult; // XXX cast
62 }
63 }
64
65 /** Visitor method: translate a list of nodes.
66 */
67 public <T extends JCTree> List<T> translate(List<T> trees) {
68 if (trees == null) return null;
69 for (List<T> l = trees; l.nonEmpty(); l = l.tail)
70 l.head = translate(l.head);
71 return trees;
72 }
73
74 /** Visitor method: translate a list of variable definitions.
75 */
76 public List<JCVariableDecl> translateVarDefs(List<JCVariableDecl> trees) {
77 for (List<JCVariableDecl> l = trees; l.nonEmpty(); l = l.tail)
78 l.head = translate(l.head);
79 return trees;
80 }
81
82 /** Visitor method: translate a list of type parameters.
83 */
84 public List<JCTypeParameter> translateTypeParams(List<JCTypeParameter> trees) {
85 for (List<JCTypeParameter> l = trees; l.nonEmpty(); l = l.tail)
86 l.head = translate(l.head);
87 return trees;
88 }
89
90 /** Visitor method: translate a list of case parts of switch statements.
91 */
92 public List<JCCase> translateCases(List<JCCase> trees) {
93 for (List<JCCase> l = trees; l.nonEmpty(); l = l.tail)
94 l.head = translate(l.head);
95 return trees;
96 }
97
98 /** Visitor method: translate a list of catch clauses in try statements.
99 */
100 public List<JCCatch> translateCatchers(List<JCCatch> trees) {
101 for (List<JCCatch> l = trees; l.nonEmpty(); l = l.tail)
102 l.head = translate(l.head);
103 return trees;
104 }
105
106 /** Visitor method: translate a list of catch clauses in try statements.
107 */
108 public List<JCAnnotation> translateAnnotations(List<JCAnnotation> trees) {
109 for (List<JCAnnotation> l = trees; l.nonEmpty(); l = l.tail)
110 l.head = translate(l.head);
111 return trees;
112 }
113
114 /* ***************************************************************************
115 * Visitor methods
116 ****************************************************************************/
117
118 public void visitTopLevel(JCCompilationUnit tree) {
119 tree.defs = translate(tree.defs);
120 result = tree;
121 }
122
123 public void visitPackageDef(JCPackageDecl tree) {
124 tree.annotations = translate(tree.annotations);
125 tree.pid = translate(tree.pid);
126 result = tree;
127 }
128
129 public void visitImport(JCImport tree) {
130 tree.qualid = translate(tree.qualid);
131 result = tree;
132 }
133
134 public void visitClassDef(JCClassDecl tree) {
135 tree.mods = translate(tree.mods);
136 tree.typarams = translateTypeParams(tree.typarams);
137 tree.extending = translate(tree.extending);
138 tree.implementing = translate(tree.implementing);
139 tree.defs = translate(tree.defs);
140 result = tree;
141 }
142
143 public void visitMethodDef(JCMethodDecl tree) {
144 tree.mods = translate(tree.mods);
145 tree.restype = translate(tree.restype);
146 tree.typarams = translateTypeParams(tree.typarams);
147 tree.recvparam = translate(tree.recvparam);
148 tree.params = translateVarDefs(tree.params);
149 tree.thrown = translate(tree.thrown);
150 tree.body = translate(tree.body);
151 result = tree;
152 }
153
154 public void visitVarDef(JCVariableDecl tree) {
155 tree.mods = translate(tree.mods);
156 tree.nameexpr = translate(tree.nameexpr);
157 tree.vartype = translate(tree.vartype);
158 tree.init = translate(tree.init);
159 result = tree;
160 }
161
162 public void visitSkip(JCSkip tree) {
163 result = tree;
164 }
165
166 public void visitBlock(JCBlock tree) {
167 tree.stats = translate(tree.stats);
168 result = tree;
169 }
170
171 public void visitDoLoop(JCDoWhileLoop tree) {
172 tree.body = translate(tree.body);
173 tree.cond = translate(tree.cond);
174 result = tree;
175 }
176
177 public void visitWhileLoop(JCWhileLoop tree) {
178 tree.cond = translate(tree.cond);
179 tree.body = translate(tree.body);
180 result = tree;
181 }
182
183 public void visitForLoop(JCForLoop tree) {
184 tree.init = translate(tree.init);
185 tree.cond = translate(tree.cond);
186 tree.step = translate(tree.step);
187 tree.body = translate(tree.body);
188 result = tree;
189 }
190
191 public void visitForeachLoop(JCEnhancedForLoop tree) {
192 tree.var = translate(tree.var);
193 tree.expr = translate(tree.expr);
194 tree.body = translate(tree.body);
195 result = tree;
196 }
197
198 public void visitLabelled(JCLabeledStatement tree) {
199 tree.body = translate(tree.body);
200 result = tree;
201 }
202
203 public void visitSwitch(JCSwitch tree) {
204 tree.selector = translate(tree.selector);
205 tree.cases = translateCases(tree.cases);
206 result = tree;
207 }
208
209 public void visitCase(JCCase tree) {
210 tree.pats = translate(tree.pats);
211 tree.stats = translate(tree.stats);
212 result = tree;
213 }
214
215 public void visitSwitchExpression(JCSwitchExpression tree) {
216 tree.selector = translate(tree.selector);
217 tree.cases = translateCases(tree.cases);
218 result = tree;
219 }
220
221 public void visitSynchronized(JCSynchronized tree) {
222 tree.lock = translate(tree.lock);
223 tree.body = translate(tree.body);
224 result = tree;
225 }
226
227 public void visitTry(JCTry tree) {
228 tree.resources = translate(tree.resources);
229 tree.body = translate(tree.body);
230 tree.catchers = translateCatchers(tree.catchers);
231 tree.finalizer = translate(tree.finalizer);
232 result = tree;
233 }
234
235 public void visitCatch(JCCatch tree) {
236 tree.param = translate(tree.param);
237 tree.body = translate(tree.body);
238 result = tree;
239 }
240
241 public void visitConditional(JCConditional tree) {
242 tree.cond = translate(tree.cond);
243 tree.truepart = translate(tree.truepart);
244 tree.falsepart = translate(tree.falsepart);
245 result = tree;
246 }
247
248 public void visitIf(JCIf tree) {
249 tree.cond = translate(tree.cond);
250 tree.thenpart = translate(tree.thenpart);
251 tree.elsepart = translate(tree.elsepart);
252 result = tree;
253 }
254
255 public void visitExec(JCExpressionStatement tree) {
256 tree.expr = translate(tree.expr);
257 result = tree;
258 }
259
260 public void visitBreak(JCBreak tree) {
261 result = tree;
262 }
263
264 public void visitContinue(JCContinue tree) {
265 result = tree;
266 }
267
268 public void visitReturn(JCReturn tree) {
269 tree.expr = translate(tree.expr);
270 result = tree;
271 }
272
273 public void visitThrow(JCThrow tree) {
274 tree.expr = translate(tree.expr);
275 result = tree;
276 }
277
278 public void visitAssert(JCAssert tree) {
279 tree.cond = translate(tree.cond);
280 tree.detail = translate(tree.detail);
281 result = tree;
282 }
283
284 public void visitApply(JCMethodInvocation tree) {
285 tree.meth = translate(tree.meth);
286 tree.args = translate(tree.args);
287 result = tree;
288 }
289
290 public void visitNewClass(JCNewClass tree) {
291 tree.encl = translate(tree.encl);
292 tree.clazz = translate(tree.clazz);
293 tree.args = translate(tree.args);
294 tree.def = translate(tree.def);
295 result = tree;
296 }
297
298 public void visitLambda(JCLambda tree) {
299 tree.params = translate(tree.params);
300 tree.body = translate(tree.body);
301 result = tree;
302 }
303
304 public void visitNewArray(JCNewArray tree) {
305 tree.annotations = translate(tree.annotations);
306 List<List<JCAnnotation>> dimAnnos = List.nil();
307 for (List<JCAnnotation> origDimAnnos : tree.dimAnnotations)
308 dimAnnos = dimAnnos.append(translate(origDimAnnos));
309 tree.dimAnnotations = dimAnnos;
310 tree.elemtype = translate(tree.elemtype);
311 tree.dims = translate(tree.dims);
312 tree.elems = translate(tree.elems);
313 result = tree;
314 }
315
316 public void visitParens(JCParens tree) {
317 tree.expr = translate(tree.expr);
318 result = tree;
319 }
320
321 public void visitAssign(JCAssign tree) {
322 tree.lhs = translate(tree.lhs);
323 tree.rhs = translate(tree.rhs);
324 result = tree;
325 }
326
327 public void visitAssignop(JCAssignOp tree) {
328 tree.lhs = translate(tree.lhs);
329 tree.rhs = translate(tree.rhs);
330 result = tree;
331 }
332
333 public void visitUnary(JCUnary tree) {
334 tree.arg = translate(tree.arg);
335 result = tree;
336 }
337
338 public void visitBinary(JCBinary tree) {
339 tree.lhs = translate(tree.lhs);
340 tree.rhs = translate(tree.rhs);
341 result = tree;
342 }
343
344 public void visitTypeCast(JCTypeCast tree) {
345 tree.clazz = translate(tree.clazz);
346 tree.expr = translate(tree.expr);
347 result = tree;
348 }
349
350 public void visitTypeTest(JCInstanceOf tree) {
351 tree.expr = translate(tree.expr);
352 tree.clazz = translate(tree.clazz);
353 result = tree;
354 }
355
356 public void visitIndexed(JCArrayAccess tree) {
357 tree.indexed = translate(tree.indexed);
358 tree.index = translate(tree.index);
359 result = tree;
360 }
361
362 public void visitSelect(JCFieldAccess tree) {
363 tree.selected = translate(tree.selected);
364 result = tree;
365 }
366
367 public void visitReference(JCMemberReference tree) {
368 tree.expr = translate(tree.expr);
369 result = tree;
370 }
371
372 public void visitIdent(JCIdent tree) {
373 result = tree;
374 }
375
376 public void visitLiteral(JCLiteral tree) {
377 result = tree;
378 }
379
380 public void visitTypeIdent(JCPrimitiveTypeTree tree) {
381 result = tree;
382 }
383
384 public void visitTypeArray(JCArrayTypeTree tree) {
385 tree.elemtype = translate(tree.elemtype);
386 result = tree;
387 }
388
389 public void visitTypeApply(JCTypeApply tree) {
390 tree.clazz = translate(tree.clazz);
391 tree.arguments = translate(tree.arguments);
392 result = tree;
393 }
394
395 public void visitTypeUnion(JCTypeUnion tree) {
396 tree.alternatives = translate(tree.alternatives);
397 result = tree;
398 }
399
400 public void visitTypeIntersection(JCTypeIntersection tree) {
401 tree.bounds = translate(tree.bounds);
402 result = tree;
403 }
404
405 public void visitTypeParameter(JCTypeParameter tree) {
406 tree.annotations = translate(tree.annotations);
407 tree.bounds = translate(tree.bounds);
408 result = tree;
409 }
410
411 @Override
412 public void visitWildcard(JCWildcard tree) {
413 tree.kind = translate(tree.kind);
414 tree.inner = translate(tree.inner);
415 result = tree;
416 }
417
418 @Override
419 public void visitTypeBoundKind(TypeBoundKind tree) {
420 result = tree;
421 }
422
423 public void visitErroneous(JCErroneous tree) {
424 result = tree;
425 }
426
427 public void visitLetExpr(LetExpr tree) {
428 tree.defs = translate(tree.defs);
429 tree.expr = translate(tree.expr);
430 result = tree;
431 }
432
433 public void visitModifiers(JCModifiers tree) {
434 tree.annotations = translateAnnotations(tree.annotations);
435 result = tree;
436 }
437
438 public void visitAnnotation(JCAnnotation tree) {
439 tree.annotationType = translate(tree.annotationType);
440 tree.args = translate(tree.args);
441 result = tree;
442 }
443
444 public void visitAnnotatedType(JCAnnotatedType tree) {
445 tree.annotations = translate(tree.annotations);
446 tree.underlyingType = translate(tree.underlyingType);
447 result = tree;
448 }
449
450 public void visitTree(JCTree tree) {
451 throw new AssertionError(tree);
452 }
453 }