aoqi@0: /*
aoqi@0:  * Copyright (c) 1999, 2014, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.javac.tree;
aoqi@0: 
aoqi@0: import com.sun.tools.javac.util.*;
aoqi@0: import com.sun.tools.javac.tree.JCTree.*;
aoqi@0: 
aoqi@0: /** A subclass of Tree.Visitor, this class defines
aoqi@0:  *  a general tree translator pattern. Translation proceeds recursively in
aoqi@0:  *  left-to-right order down a tree, constructing translated nodes by
aoqi@0:  *  overwriting existing ones. There is one visitor method in this class
aoqi@0:  *  for every possible kind of tree node.  To obtain a specific
aoqi@0:  *  translator, it suffices to override those visitor methods which
aoqi@0:  *  do some interesting work. The translator class itself takes care of all
aoqi@0:  *  navigational aspects.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  */
aoqi@0: public class TreeTranslator extends JCTree.Visitor {
aoqi@0: 
aoqi@0:     /** Visitor result field: a tree
aoqi@0:      */
aoqi@0:     protected JCTree result;
aoqi@0: 
aoqi@0:     /** Visitor method: Translate a single node.
aoqi@0:      */
aoqi@0:     @SuppressWarnings("unchecked")
aoqi@0:     public <T extends JCTree> T translate(T tree) {
aoqi@0:         if (tree == null) {
aoqi@0:             return null;
aoqi@0:         } else {
aoqi@0:             tree.accept(this);
aoqi@0:             JCTree tmpResult = this.result;
aoqi@0:             this.result = null;
aoqi@0:             return (T)tmpResult; // XXX cast
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /** Visitor method: translate a list of nodes.
aoqi@0:      */
aoqi@0:     public <T extends JCTree> List<T> translate(List<T> trees) {
aoqi@0:         if (trees == null) return null;
aoqi@0:         for (List<T> l = trees; l.nonEmpty(); l = l.tail)
aoqi@0:             l.head = translate(l.head);
aoqi@0:         return trees;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**  Visitor method: translate a list of variable definitions.
aoqi@0:      */
aoqi@0:     public List<JCVariableDecl> translateVarDefs(List<JCVariableDecl> trees) {
aoqi@0:         for (List<JCVariableDecl> l = trees; l.nonEmpty(); l = l.tail)
aoqi@0:             l.head = translate(l.head);
aoqi@0:         return trees;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**  Visitor method: translate a list of type parameters.
aoqi@0:      */
aoqi@0:     public List<JCTypeParameter> translateTypeParams(List<JCTypeParameter> trees) {
aoqi@0:         for (List<JCTypeParameter> l = trees; l.nonEmpty(); l = l.tail)
aoqi@0:             l.head = translate(l.head);
aoqi@0:         return trees;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**  Visitor method: translate a list of case parts of switch statements.
aoqi@0:      */
aoqi@0:     public List<JCCase> translateCases(List<JCCase> trees) {
aoqi@0:         for (List<JCCase> l = trees; l.nonEmpty(); l = l.tail)
aoqi@0:             l.head = translate(l.head);
aoqi@0:         return trees;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**  Visitor method: translate a list of catch clauses in try statements.
aoqi@0:      */
aoqi@0:     public List<JCCatch> translateCatchers(List<JCCatch> trees) {
aoqi@0:         for (List<JCCatch> l = trees; l.nonEmpty(); l = l.tail)
aoqi@0:             l.head = translate(l.head);
aoqi@0:         return trees;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**  Visitor method: translate a list of catch clauses in try statements.
aoqi@0:      */
aoqi@0:     public List<JCAnnotation> translateAnnotations(List<JCAnnotation> trees) {
aoqi@0:         for (List<JCAnnotation> l = trees; l.nonEmpty(); l = l.tail)
aoqi@0:             l.head = translate(l.head);
aoqi@0:         return trees;
aoqi@0:     }
aoqi@0: 
aoqi@0: /* ***************************************************************************
aoqi@0:  * Visitor methods
aoqi@0:  ****************************************************************************/
aoqi@0: 
aoqi@0:     public void visitTopLevel(JCCompilationUnit tree) {
aoqi@0:         tree.pid = translate(tree.pid);
aoqi@0:         tree.defs = translate(tree.defs);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitImport(JCImport tree) {
aoqi@0:         tree.qualid = translate(tree.qualid);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitClassDef(JCClassDecl tree) {
aoqi@0:         tree.mods = translate(tree.mods);
aoqi@0:         tree.typarams = translateTypeParams(tree.typarams);
aoqi@0:         tree.extending = translate(tree.extending);
aoqi@0:         tree.implementing = translate(tree.implementing);
aoqi@0:         tree.defs = translate(tree.defs);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitMethodDef(JCMethodDecl tree) {
aoqi@0:         tree.mods = translate(tree.mods);
aoqi@0:         tree.restype = translate(tree.restype);
aoqi@0:         tree.typarams = translateTypeParams(tree.typarams);
aoqi@0:         tree.recvparam = translate(tree.recvparam);
aoqi@0:         tree.params = translateVarDefs(tree.params);
aoqi@0:         tree.thrown = translate(tree.thrown);
aoqi@0:         tree.body = translate(tree.body);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitVarDef(JCVariableDecl tree) {
aoqi@0:         tree.mods = translate(tree.mods);
aoqi@0:         tree.nameexpr = translate(tree.nameexpr);
aoqi@0:         tree.vartype = translate(tree.vartype);
aoqi@0:         tree.init = translate(tree.init);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitSkip(JCSkip tree) {
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitBlock(JCBlock tree) {
aoqi@0:         tree.stats = translate(tree.stats);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitDoLoop(JCDoWhileLoop tree) {
aoqi@0:         tree.body = translate(tree.body);
aoqi@0:         tree.cond = translate(tree.cond);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitWhileLoop(JCWhileLoop tree) {
aoqi@0:         tree.cond = translate(tree.cond);
aoqi@0:         tree.body = translate(tree.body);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitForLoop(JCForLoop tree) {
aoqi@0:         tree.init = translate(tree.init);
aoqi@0:         tree.cond = translate(tree.cond);
aoqi@0:         tree.step = translate(tree.step);
aoqi@0:         tree.body = translate(tree.body);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitForeachLoop(JCEnhancedForLoop tree) {
aoqi@0:         tree.var = translate(tree.var);
aoqi@0:         tree.expr = translate(tree.expr);
aoqi@0:         tree.body = translate(tree.body);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitLabelled(JCLabeledStatement tree) {
aoqi@0:         tree.body = translate(tree.body);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitSwitch(JCSwitch tree) {
aoqi@0:         tree.selector = translate(tree.selector);
aoqi@0:         tree.cases = translateCases(tree.cases);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitCase(JCCase tree) {
aoqi@0:         tree.pat = translate(tree.pat);
aoqi@0:         tree.stats = translate(tree.stats);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitSynchronized(JCSynchronized tree) {
aoqi@0:         tree.lock = translate(tree.lock);
aoqi@0:         tree.body = translate(tree.body);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitTry(JCTry tree) {
aoqi@0:         tree.resources = translate(tree.resources);
aoqi@0:         tree.body = translate(tree.body);
aoqi@0:         tree.catchers = translateCatchers(tree.catchers);
aoqi@0:         tree.finalizer = translate(tree.finalizer);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitCatch(JCCatch tree) {
aoqi@0:         tree.param = translate(tree.param);
aoqi@0:         tree.body = translate(tree.body);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitConditional(JCConditional tree) {
aoqi@0:         tree.cond = translate(tree.cond);
aoqi@0:         tree.truepart = translate(tree.truepart);
aoqi@0:         tree.falsepart = translate(tree.falsepart);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitIf(JCIf tree) {
aoqi@0:         tree.cond = translate(tree.cond);
aoqi@0:         tree.thenpart = translate(tree.thenpart);
aoqi@0:         tree.elsepart = translate(tree.elsepart);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitExec(JCExpressionStatement tree) {
aoqi@0:         tree.expr = translate(tree.expr);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitBreak(JCBreak tree) {
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitContinue(JCContinue tree) {
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitReturn(JCReturn tree) {
aoqi@0:         tree.expr = translate(tree.expr);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitThrow(JCThrow tree) {
aoqi@0:         tree.expr = translate(tree.expr);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitAssert(JCAssert tree) {
aoqi@0:         tree.cond = translate(tree.cond);
aoqi@0:         tree.detail = translate(tree.detail);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitApply(JCMethodInvocation tree) {
aoqi@0:         tree.meth = translate(tree.meth);
aoqi@0:         tree.args = translate(tree.args);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitNewClass(JCNewClass tree) {
aoqi@0:         tree.encl = translate(tree.encl);
aoqi@0:         tree.clazz = translate(tree.clazz);
aoqi@0:         tree.args = translate(tree.args);
aoqi@0:         tree.def = translate(tree.def);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitLambda(JCLambda tree) {
aoqi@0:         tree.params = translate(tree.params);
aoqi@0:         tree.body = translate(tree.body);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitNewArray(JCNewArray tree) {
aoqi@0:         tree.annotations = translate(tree.annotations);
aoqi@0:         List<List<JCAnnotation>> dimAnnos = List.nil();
aoqi@0:         for (List<JCAnnotation> origDimAnnos : tree.dimAnnotations)
aoqi@0:             dimAnnos = dimAnnos.append(translate(origDimAnnos));
aoqi@0:         tree.dimAnnotations = dimAnnos;
aoqi@0:         tree.elemtype = translate(tree.elemtype);
aoqi@0:         tree.dims = translate(tree.dims);
aoqi@0:         tree.elems = translate(tree.elems);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitParens(JCParens tree) {
aoqi@0:         tree.expr = translate(tree.expr);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitAssign(JCAssign tree) {
aoqi@0:         tree.lhs = translate(tree.lhs);
aoqi@0:         tree.rhs = translate(tree.rhs);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitAssignop(JCAssignOp tree) {
aoqi@0:         tree.lhs = translate(tree.lhs);
aoqi@0:         tree.rhs = translate(tree.rhs);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitUnary(JCUnary tree) {
aoqi@0:         tree.arg = translate(tree.arg);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitBinary(JCBinary tree) {
aoqi@0:         tree.lhs = translate(tree.lhs);
aoqi@0:         tree.rhs = translate(tree.rhs);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitTypeCast(JCTypeCast tree) {
aoqi@0:         tree.clazz = translate(tree.clazz);
aoqi@0:         tree.expr = translate(tree.expr);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitTypeTest(JCInstanceOf tree) {
aoqi@0:         tree.expr = translate(tree.expr);
aoqi@0:         tree.clazz = translate(tree.clazz);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitIndexed(JCArrayAccess tree) {
aoqi@0:         tree.indexed = translate(tree.indexed);
aoqi@0:         tree.index = translate(tree.index);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitSelect(JCFieldAccess tree) {
aoqi@0:         tree.selected = translate(tree.selected);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitReference(JCMemberReference tree) {
aoqi@0:         tree.expr = translate(tree.expr);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitIdent(JCIdent tree) {
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitLiteral(JCLiteral tree) {
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitTypeIdent(JCPrimitiveTypeTree tree) {
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitTypeArray(JCArrayTypeTree tree) {
aoqi@0:         tree.elemtype = translate(tree.elemtype);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitTypeApply(JCTypeApply tree) {
aoqi@0:         tree.clazz = translate(tree.clazz);
aoqi@0:         tree.arguments = translate(tree.arguments);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitTypeUnion(JCTypeUnion tree) {
aoqi@0:         tree.alternatives = translate(tree.alternatives);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitTypeIntersection(JCTypeIntersection tree) {
aoqi@0:         tree.bounds = translate(tree.bounds);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitTypeParameter(JCTypeParameter tree) {
aoqi@0:         tree.annotations = translate(tree.annotations);
aoqi@0:         tree.bounds = translate(tree.bounds);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public void visitWildcard(JCWildcard tree) {
aoqi@0:         tree.kind = translate(tree.kind);
aoqi@0:         tree.inner = translate(tree.inner);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public void visitTypeBoundKind(TypeBoundKind tree) {
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitErroneous(JCErroneous tree) {
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitLetExpr(LetExpr tree) {
aoqi@0:         tree.defs = translateVarDefs(tree.defs);
aoqi@0:         tree.expr = translate(tree.expr);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitModifiers(JCModifiers tree) {
aoqi@0:         tree.annotations = translateAnnotations(tree.annotations);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitAnnotation(JCAnnotation tree) {
aoqi@0:         tree.annotationType = translate(tree.annotationType);
aoqi@0:         tree.args = translate(tree.args);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitAnnotatedType(JCAnnotatedType tree) {
aoqi@0:         tree.annotations = translate(tree.annotations);
aoqi@0:         tree.underlyingType = translate(tree.underlyingType);
aoqi@0:         result = tree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitTree(JCTree tree) {
aoqi@0:         throw new AssertionError(tree);
aoqi@0:     }
aoqi@0: }