src/share/classes/com/sun/tools/javac/api/JavacTrees.java

Tue, 09 Sep 2008 10:28:21 -0700

author
jjg
date
Tue, 09 Sep 2008 10:28:21 -0700
changeset 110
91eea580fbe9
parent 1
9a66ca7c79fa
child 117
24a47c3062fe
permissions
-rw-r--r--

6557752: Original type of an AST should be made available even if it is replaced with an ErrorType
Reviewed-by: mcimadamore

     1 /*
     2  * Copyright 2005-2006 Sun Microsystems, Inc.  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.  Sun designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    22  * CA 95054 USA or visit www.sun.com if you need additional information or
    23  * have any questions.
    24  */
    26 package com.sun.tools.javac.api;
    28 import java.io.IOException;
    29 import java.util.Map;
    30 import javax.annotation.processing.ProcessingEnvironment;
    31 import javax.lang.model.element.AnnotationMirror;
    32 import javax.lang.model.element.AnnotationValue;
    33 import javax.lang.model.element.Element;
    34 import javax.lang.model.element.ExecutableElement;
    35 import javax.lang.model.element.TypeElement;
    36 import javax.lang.model.type.DeclaredType;
    37 import javax.lang.model.type.TypeMirror;
    38 import javax.tools.JavaCompiler;
    39 import javax.tools.JavaFileObject;
    41 import com.sun.source.tree.CompilationUnitTree;
    42 import com.sun.source.tree.Scope;
    43 import com.sun.source.tree.Tree;
    44 import com.sun.source.util.SourcePositions;
    45 import com.sun.source.util.TreePath;
    46 import com.sun.source.util.Trees;
    47 import com.sun.tools.javac.code.Symbol.ClassSymbol;
    48 import com.sun.tools.javac.code.Symbol.TypeSymbol;
    49 import com.sun.tools.javac.code.Symbol;
    50 import com.sun.tools.javac.comp.Attr;
    51 import com.sun.tools.javac.comp.AttrContext;
    52 import com.sun.tools.javac.comp.Enter;
    53 import com.sun.tools.javac.comp.Env;
    54 import com.sun.tools.javac.comp.MemberEnter;
    55 import com.sun.tools.javac.comp.Resolve;
    56 import com.sun.tools.javac.model.JavacElements;
    57 import com.sun.tools.javac.processing.JavacProcessingEnvironment;
    58 import com.sun.tools.javac.tree.JCTree.*;
    59 import com.sun.tools.javac.tree.JCTree;
    60 import com.sun.tools.javac.tree.TreeCopier;
    61 import com.sun.tools.javac.tree.TreeInfo;
    62 import com.sun.tools.javac.tree.TreeMaker;
    63 import com.sun.tools.javac.util.Context;
    64 import com.sun.tools.javac.util.List;
    65 import com.sun.tools.javac.util.Log;
    66 import com.sun.tools.javac.util.Pair;
    68 /**
    69  * Provides an implementation of Trees.
    70  *
    71  * <p><b>This is NOT part of any API supported by Sun Microsystems.
    72  * If you write code that depends on this, you do so at your own
    73  * risk.  This code and its internal interfaces are subject to change
    74  * or deletion without notice.</b></p>
    75  *
    76  * @author Peter von der Ah&eacute;
    77  */
    78 public class JavacTrees extends Trees {
    80     private final Resolve resolve;
    81     private final Enter enter;
    82     private final Log log;
    83     private final MemberEnter memberEnter;
    84     private final Attr attr;
    85     private final TreeMaker treeMaker;
    86     private final JavacElements elements;
    87     private final JavacTaskImpl javacTaskImpl;
    89     public static JavacTrees instance(JavaCompiler.CompilationTask task) {
    90         if (!(task instanceof JavacTaskImpl))
    91             throw new IllegalArgumentException();
    92         return instance(((JavacTaskImpl)task).getContext());
    93     }
    95     public static JavacTrees instance(ProcessingEnvironment env) {
    96         if (!(env instanceof JavacProcessingEnvironment))
    97             throw new IllegalArgumentException();
    98         return instance(((JavacProcessingEnvironment)env).getContext());
    99     }
   101     public static JavacTrees instance(Context context) {
   102         JavacTrees instance = context.get(JavacTrees.class);
   103         if (instance == null)
   104             instance = new JavacTrees(context);
   105         return instance;
   106     }
   108     private JavacTrees(Context context) {
   109         context.put(JavacTrees.class, this);
   110         attr = Attr.instance(context);
   111         enter = Enter.instance(context);
   112         elements = JavacElements.instance(context);
   113         log = Log.instance(context);
   114         resolve = Resolve.instance(context);
   115         treeMaker = TreeMaker.instance(context);
   116         memberEnter = MemberEnter.instance(context);
   117         javacTaskImpl = context.get(JavacTaskImpl.class);
   118     }
   120     public SourcePositions getSourcePositions() {
   121         return new SourcePositions() {
   122                 public long getStartPosition(CompilationUnitTree file, Tree tree) {
   123                     return TreeInfo.getStartPos((JCTree) tree);
   124                 }
   126                 public long getEndPosition(CompilationUnitTree file, Tree tree) {
   127                     Map<JCTree,Integer> endPositions = ((JCCompilationUnit) file).endPositions;
   128                     return TreeInfo.getEndPos((JCTree) tree, endPositions);
   129                 }
   130             };
   131     }
   133     public JCClassDecl getTree(TypeElement element) {
   134         return (JCClassDecl) getTree((Element) element);
   135     }
   137     public JCMethodDecl getTree(ExecutableElement method) {
   138         return (JCMethodDecl) getTree((Element) method);
   139     }
   141     public JCTree getTree(Element element) {
   142         Symbol symbol = (Symbol) element;
   143         TypeSymbol enclosing = symbol.enclClass();
   144         Env<AttrContext> env = enter.getEnv(enclosing);
   145         if (env == null)
   146             return null;
   147         JCClassDecl classNode = env.enclClass;
   148         if (classNode != null) {
   149             if (TreeInfo.symbolFor(classNode) == element)
   150                 return classNode;
   151             for (JCTree node : classNode.getMembers())
   152                 if (TreeInfo.symbolFor(node) == element)
   153                     return node;
   154         }
   155         return null;
   156     }
   158     public JCTree getTree(Element e, AnnotationMirror a) {
   159         return getTree(e, a, null);
   160     }
   162     public JCTree getTree(Element e, AnnotationMirror a, AnnotationValue v) {
   163         Pair<JCTree, JCCompilationUnit> treeTopLevel = elements.getTreeAndTopLevel(e, a, v);
   164         if (treeTopLevel == null)
   165             return null;
   166         return treeTopLevel.fst;
   167     }
   169     public TreePath getPath(CompilationUnitTree unit, Tree node) {
   170         return TreePath.getPath(unit, node);
   171     }
   173     public TreePath getPath(Element e) {
   174         return getPath(e, null, null);
   175     }
   177     public TreePath getPath(Element e, AnnotationMirror a) {
   178         return getPath(e, a, null);
   179     }
   181     public TreePath getPath(Element e, AnnotationMirror a, AnnotationValue v) {
   182         final Pair<JCTree, JCCompilationUnit> treeTopLevel = elements.getTreeAndTopLevel(e, a, v);
   183         if (treeTopLevel == null)
   184             return null;
   185         return TreePath.getPath(treeTopLevel.snd, treeTopLevel.fst);
   186     }
   188     public Element getElement(TreePath path) {
   189         Tree t = path.getLeaf();
   190         return TreeInfo.symbolFor((JCTree) t);
   191     }
   193     public TypeMirror getTypeMirror(TreePath path) {
   194         Tree t = path.getLeaf();
   195         return ((JCTree)t).type;
   196     }
   198     public JavacScope getScope(TreePath path) {
   199         return new JavacScope(getAttrContext(path));
   200     }
   202     public boolean isAccessible(Scope scope, TypeElement type) {
   203         if (scope instanceof JavacScope && type instanceof ClassSymbol) {
   204             Env<AttrContext> env = ((JavacScope) scope).env;
   205             return resolve.isAccessible(env, (ClassSymbol)type);
   206         } else
   207             return false;
   208     }
   210     public boolean isAccessible(Scope scope, Element member, DeclaredType type) {
   211         if (scope instanceof JavacScope
   212                 && member instanceof Symbol
   213                 && type instanceof com.sun.tools.javac.code.Type) {
   214             Env<AttrContext> env = ((JavacScope) scope).env;
   215             return resolve.isAccessible(env, (com.sun.tools.javac.code.Type)type, (Symbol)member);
   216         } else
   217             return false;
   218     }
   220     private Env<AttrContext> getAttrContext(TreePath path) {
   221         if (!(path.getLeaf() instanceof JCTree))  // implicit null-check
   222             throw new IllegalArgumentException();
   224         // if we're being invoked via from a JSR199 client, we need to make sure
   225         // all the classes have been entered; if we're being invoked from JSR269,
   226         // then the classes will already have been entered.
   227         if (javacTaskImpl != null) {
   228             try {
   229                 javacTaskImpl.enter(null);
   230             } catch (IOException e) {
   231                 throw new Error("unexpected error while entering symbols: " + e);
   232             }
   233         }
   236         JCCompilationUnit unit = (JCCompilationUnit) path.getCompilationUnit();
   237         Copier copier = new Copier(treeMaker.forToplevel(unit));
   239         Env<AttrContext> env = null;
   240         JCMethodDecl method = null;
   241         JCVariableDecl field = null;
   243         List<Tree> l = List.nil();
   244         TreePath p = path;
   245         while (p != null) {
   246             l = l.prepend(p.getLeaf());
   247             p = p.getParentPath();
   248         }
   250         for ( ; l.nonEmpty(); l = l.tail) {
   251             Tree tree = l.head;
   252             switch (tree.getKind()) {
   253                 case COMPILATION_UNIT:
   254 //                    System.err.println("COMP: " + ((JCCompilationUnit)tree).sourcefile);
   255                     env = enter.getTopLevelEnv((JCCompilationUnit)tree);
   256                     break;
   257                 case CLASS:
   258 //                    System.err.println("CLASS: " + ((JCClassDecl)tree).sym.getSimpleName());
   259                     env = enter.getClassEnv(((JCClassDecl)tree).sym);
   260                     break;
   261                 case METHOD:
   262 //                    System.err.println("METHOD: " + ((JCMethodDecl)tree).sym.getSimpleName());
   263                     method = (JCMethodDecl)tree;
   264                     break;
   265                 case VARIABLE:
   266 //                    System.err.println("FIELD: " + ((JCVariableDecl)tree).sym.getSimpleName());
   267                     field = (JCVariableDecl)tree;
   268                     break;
   269                 case BLOCK: {
   270 //                    System.err.println("BLOCK: ");
   271                     if (method != null)
   272                         env = memberEnter.getMethodEnv(method, env);
   273                     JCTree body = copier.copy((JCTree)tree, (JCTree) path.getLeaf());
   274                     env = attribStatToTree(body, env, copier.leafCopy);
   275                     return env;
   276                 }
   277                 default:
   278 //                    System.err.println("DEFAULT: " + tree.getKind());
   279                     if (field != null && field.getInitializer() == tree) {
   280                         env = memberEnter.getInitEnv(field, env);
   281                         JCExpression expr = copier.copy((JCExpression)tree, (JCTree) path.getLeaf());
   282                         env = attribExprToTree(expr, env, copier.leafCopy);
   283                         return env;
   284                     }
   285             }
   286         }
   287         return field != null ? memberEnter.getInitEnv(field, env) : env;
   288     }
   290     private Env<AttrContext> attribStatToTree(JCTree stat, Env<AttrContext>env, JCTree tree) {
   291         JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
   292         try {
   293             return attr.attribStatToTree(stat, env, tree);
   294         } finally {
   295             log.useSource(prev);
   296         }
   297     }
   299     private Env<AttrContext> attribExprToTree(JCExpression expr, Env<AttrContext>env, JCTree tree) {
   300         JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
   301         try {
   302             return attr.attribExprToTree(expr, env, tree);
   303         } finally {
   304             log.useSource(prev);
   305         }
   306     }
   308     /**
   309      * Makes a copy of a tree, noting the value resulting from copying a particular leaf.
   310      **/
   311     static class Copier extends TreeCopier<JCTree> {
   312         JCTree leafCopy = null;
   314         Copier(TreeMaker M) {
   315             super(M);
   316         }
   318         public <T extends JCTree> T copy(T t, JCTree leaf) {
   319             T t2 = super.copy(t, leaf);
   320             if (t == leaf)
   321                 leafCopy = t2;
   322             return t2;
   323         }
   324     }
   326     /**
   327      * Gets the original type from the ErrorType object.
   328      * @param errorType The errorType for which we want to get the original type.
   329      * @returns TypeMirror corresponding to the original type, replaced by the ErrorType.
   330      *          noType (type.tag == NONE) is returned if there is no original type.
   331      */
   332     public TypeMirror getOriginalType(javax.lang.model.type.ErrorType errorType) {
   333         if (errorType instanceof com.sun.tools.javac.code.Type.ErrorType) {
   334             return ((com.sun.tools.javac.code.Type.ErrorType)errorType).getOriginalType();
   335         }
   337         return com.sun.tools.javac.code.Type.noType;
   338     }
   339 }

mercurial