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

Thu, 16 Sep 2010 09:56:25 -0700

author
jjg
date
Thu, 16 Sep 2010 09:56:25 -0700
changeset 682
6e2ccba61117
parent 672
ea54372637a5
child 696
d4df3b6ee729
permissions
-rw-r--r--

6985181: Annotations lost from classfile
Reviewed-by: mcimadamore

duke@1 1 /*
ohair@554 2 * Copyright (c) 2005, 2008, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.tools.javac.api;
duke@1 27
duke@1 28 import java.io.IOException;
duke@1 29 import java.util.Map;
duke@1 30 import javax.annotation.processing.ProcessingEnvironment;
duke@1 31 import javax.lang.model.element.AnnotationMirror;
duke@1 32 import javax.lang.model.element.AnnotationValue;
duke@1 33 import javax.lang.model.element.Element;
duke@1 34 import javax.lang.model.element.ExecutableElement;
duke@1 35 import javax.lang.model.element.TypeElement;
duke@1 36 import javax.lang.model.type.DeclaredType;
duke@1 37 import javax.lang.model.type.TypeMirror;
jjg@308 38 import javax.tools.Diagnostic;
duke@1 39 import javax.tools.JavaCompiler;
duke@1 40 import javax.tools.JavaFileObject;
duke@1 41
duke@1 42 import com.sun.source.tree.CompilationUnitTree;
duke@1 43 import com.sun.source.tree.Scope;
duke@1 44 import com.sun.source.tree.Tree;
duke@1 45 import com.sun.source.util.SourcePositions;
duke@1 46 import com.sun.source.util.TreePath;
duke@1 47 import com.sun.source.util.Trees;
jjg@672 48 import com.sun.tools.javac.code.Flags;
duke@1 49 import com.sun.tools.javac.code.Symbol.ClassSymbol;
duke@1 50 import com.sun.tools.javac.code.Symbol.TypeSymbol;
duke@1 51 import com.sun.tools.javac.code.Symbol;
duke@1 52 import com.sun.tools.javac.comp.Attr;
duke@1 53 import com.sun.tools.javac.comp.AttrContext;
duke@1 54 import com.sun.tools.javac.comp.Enter;
duke@1 55 import com.sun.tools.javac.comp.Env;
duke@1 56 import com.sun.tools.javac.comp.MemberEnter;
duke@1 57 import com.sun.tools.javac.comp.Resolve;
duke@1 58 import com.sun.tools.javac.model.JavacElements;
jjg@308 59 import com.sun.tools.javac.processing.JavacMessager;
duke@1 60 import com.sun.tools.javac.processing.JavacProcessingEnvironment;
duke@1 61 import com.sun.tools.javac.tree.JCTree.*;
duke@1 62 import com.sun.tools.javac.tree.JCTree;
duke@1 63 import com.sun.tools.javac.tree.TreeCopier;
duke@1 64 import com.sun.tools.javac.tree.TreeInfo;
duke@1 65 import com.sun.tools.javac.tree.TreeMaker;
duke@1 66 import com.sun.tools.javac.util.Context;
jjg@308 67 import com.sun.tools.javac.util.JCDiagnostic;
duke@1 68 import com.sun.tools.javac.util.List;
duke@1 69 import com.sun.tools.javac.util.Log;
duke@1 70 import com.sun.tools.javac.util.Pair;
duke@1 71
duke@1 72 /**
duke@1 73 * Provides an implementation of Trees.
duke@1 74 *
jjg@581 75 * <p><b>This is NOT part of any supported API.
duke@1 76 * If you write code that depends on this, you do so at your own
duke@1 77 * risk. This code and its internal interfaces are subject to change
duke@1 78 * or deletion without notice.</b></p>
duke@1 79 *
duke@1 80 * @author Peter von der Ah&eacute;
duke@1 81 */
duke@1 82 public class JavacTrees extends Trees {
duke@1 83
duke@1 84 private final Resolve resolve;
duke@1 85 private final Enter enter;
duke@1 86 private final Log log;
duke@1 87 private final MemberEnter memberEnter;
duke@1 88 private final Attr attr;
duke@1 89 private final TreeMaker treeMaker;
duke@1 90 private final JavacElements elements;
duke@1 91 private final JavacTaskImpl javacTaskImpl;
duke@1 92
duke@1 93 public static JavacTrees instance(JavaCompiler.CompilationTask task) {
duke@1 94 if (!(task instanceof JavacTaskImpl))
duke@1 95 throw new IllegalArgumentException();
duke@1 96 return instance(((JavacTaskImpl)task).getContext());
duke@1 97 }
duke@1 98
duke@1 99 public static JavacTrees instance(ProcessingEnvironment env) {
duke@1 100 if (!(env instanceof JavacProcessingEnvironment))
duke@1 101 throw new IllegalArgumentException();
duke@1 102 return instance(((JavacProcessingEnvironment)env).getContext());
duke@1 103 }
duke@1 104
duke@1 105 public static JavacTrees instance(Context context) {
duke@1 106 JavacTrees instance = context.get(JavacTrees.class);
duke@1 107 if (instance == null)
duke@1 108 instance = new JavacTrees(context);
duke@1 109 return instance;
duke@1 110 }
duke@1 111
duke@1 112 private JavacTrees(Context context) {
duke@1 113 context.put(JavacTrees.class, this);
duke@1 114 attr = Attr.instance(context);
duke@1 115 enter = Enter.instance(context);
duke@1 116 elements = JavacElements.instance(context);
duke@1 117 log = Log.instance(context);
duke@1 118 resolve = Resolve.instance(context);
duke@1 119 treeMaker = TreeMaker.instance(context);
duke@1 120 memberEnter = MemberEnter.instance(context);
duke@1 121 javacTaskImpl = context.get(JavacTaskImpl.class);
duke@1 122 }
duke@1 123
duke@1 124 public SourcePositions getSourcePositions() {
duke@1 125 return new SourcePositions() {
duke@1 126 public long getStartPosition(CompilationUnitTree file, Tree tree) {
duke@1 127 return TreeInfo.getStartPos((JCTree) tree);
duke@1 128 }
duke@1 129
duke@1 130 public long getEndPosition(CompilationUnitTree file, Tree tree) {
duke@1 131 Map<JCTree,Integer> endPositions = ((JCCompilationUnit) file).endPositions;
duke@1 132 return TreeInfo.getEndPos((JCTree) tree, endPositions);
duke@1 133 }
duke@1 134 };
duke@1 135 }
duke@1 136
duke@1 137 public JCClassDecl getTree(TypeElement element) {
duke@1 138 return (JCClassDecl) getTree((Element) element);
duke@1 139 }
duke@1 140
duke@1 141 public JCMethodDecl getTree(ExecutableElement method) {
duke@1 142 return (JCMethodDecl) getTree((Element) method);
duke@1 143 }
duke@1 144
duke@1 145 public JCTree getTree(Element element) {
duke@1 146 Symbol symbol = (Symbol) element;
duke@1 147 TypeSymbol enclosing = symbol.enclClass();
duke@1 148 Env<AttrContext> env = enter.getEnv(enclosing);
duke@1 149 if (env == null)
duke@1 150 return null;
duke@1 151 JCClassDecl classNode = env.enclClass;
duke@1 152 if (classNode != null) {
duke@1 153 if (TreeInfo.symbolFor(classNode) == element)
duke@1 154 return classNode;
duke@1 155 for (JCTree node : classNode.getMembers())
duke@1 156 if (TreeInfo.symbolFor(node) == element)
duke@1 157 return node;
duke@1 158 }
duke@1 159 return null;
duke@1 160 }
duke@1 161
duke@1 162 public JCTree getTree(Element e, AnnotationMirror a) {
duke@1 163 return getTree(e, a, null);
duke@1 164 }
duke@1 165
duke@1 166 public JCTree getTree(Element e, AnnotationMirror a, AnnotationValue v) {
duke@1 167 Pair<JCTree, JCCompilationUnit> treeTopLevel = elements.getTreeAndTopLevel(e, a, v);
duke@1 168 if (treeTopLevel == null)
duke@1 169 return null;
duke@1 170 return treeTopLevel.fst;
duke@1 171 }
duke@1 172
duke@1 173 public TreePath getPath(CompilationUnitTree unit, Tree node) {
duke@1 174 return TreePath.getPath(unit, node);
duke@1 175 }
duke@1 176
duke@1 177 public TreePath getPath(Element e) {
duke@1 178 return getPath(e, null, null);
duke@1 179 }
duke@1 180
duke@1 181 public TreePath getPath(Element e, AnnotationMirror a) {
duke@1 182 return getPath(e, a, null);
duke@1 183 }
duke@1 184
duke@1 185 public TreePath getPath(Element e, AnnotationMirror a, AnnotationValue v) {
duke@1 186 final Pair<JCTree, JCCompilationUnit> treeTopLevel = elements.getTreeAndTopLevel(e, a, v);
duke@1 187 if (treeTopLevel == null)
duke@1 188 return null;
duke@1 189 return TreePath.getPath(treeTopLevel.snd, treeTopLevel.fst);
duke@1 190 }
duke@1 191
duke@1 192 public Element getElement(TreePath path) {
jjg@672 193 JCTree tree = (JCTree) path.getLeaf();
jjg@672 194 Symbol sym = TreeInfo.symbolFor(tree);
jjg@672 195 if (sym == null && TreeInfo.isDeclaration(tree)) {
jjg@672 196 for (TreePath p = path; p != null; p = p.getParentPath()) {
jjg@672 197 JCTree t = (JCTree) p.getLeaf();
jjg@672 198 if (t.getTag() == JCTree.CLASSDEF) {
jjg@672 199 JCClassDecl ct = (JCClassDecl) t;
jjg@672 200 if (ct.sym != null) {
jjg@672 201 if ((ct.sym.flags_field & Flags.UNATTRIBUTED) != 0) {
jjg@672 202 attr.attribClass(ct.pos(), ct.sym);
jjg@672 203 sym = TreeInfo.symbolFor(tree);
jjg@672 204 }
jjg@672 205 break;
jjg@672 206 }
jjg@672 207 }
jjg@672 208 }
jjg@672 209 }
jjg@672 210 return sym;
duke@1 211 }
duke@1 212
duke@1 213 public TypeMirror getTypeMirror(TreePath path) {
duke@1 214 Tree t = path.getLeaf();
duke@1 215 return ((JCTree)t).type;
duke@1 216 }
duke@1 217
duke@1 218 public JavacScope getScope(TreePath path) {
duke@1 219 return new JavacScope(getAttrContext(path));
duke@1 220 }
duke@1 221
duke@1 222 public boolean isAccessible(Scope scope, TypeElement type) {
duke@1 223 if (scope instanceof JavacScope && type instanceof ClassSymbol) {
duke@1 224 Env<AttrContext> env = ((JavacScope) scope).env;
duke@1 225 return resolve.isAccessible(env, (ClassSymbol)type);
duke@1 226 } else
duke@1 227 return false;
duke@1 228 }
duke@1 229
duke@1 230 public boolean isAccessible(Scope scope, Element member, DeclaredType type) {
duke@1 231 if (scope instanceof JavacScope
duke@1 232 && member instanceof Symbol
duke@1 233 && type instanceof com.sun.tools.javac.code.Type) {
duke@1 234 Env<AttrContext> env = ((JavacScope) scope).env;
duke@1 235 return resolve.isAccessible(env, (com.sun.tools.javac.code.Type)type, (Symbol)member);
duke@1 236 } else
duke@1 237 return false;
duke@1 238 }
duke@1 239
duke@1 240 private Env<AttrContext> getAttrContext(TreePath path) {
duke@1 241 if (!(path.getLeaf() instanceof JCTree)) // implicit null-check
duke@1 242 throw new IllegalArgumentException();
duke@1 243
duke@1 244 // if we're being invoked via from a JSR199 client, we need to make sure
duke@1 245 // all the classes have been entered; if we're being invoked from JSR269,
duke@1 246 // then the classes will already have been entered.
duke@1 247 if (javacTaskImpl != null) {
duke@1 248 try {
duke@1 249 javacTaskImpl.enter(null);
duke@1 250 } catch (IOException e) {
duke@1 251 throw new Error("unexpected error while entering symbols: " + e);
duke@1 252 }
duke@1 253 }
duke@1 254
duke@1 255
duke@1 256 JCCompilationUnit unit = (JCCompilationUnit) path.getCompilationUnit();
duke@1 257 Copier copier = new Copier(treeMaker.forToplevel(unit));
duke@1 258
duke@1 259 Env<AttrContext> env = null;
duke@1 260 JCMethodDecl method = null;
duke@1 261 JCVariableDecl field = null;
duke@1 262
duke@1 263 List<Tree> l = List.nil();
duke@1 264 TreePath p = path;
duke@1 265 while (p != null) {
duke@1 266 l = l.prepend(p.getLeaf());
duke@1 267 p = p.getParentPath();
duke@1 268 }
duke@1 269
duke@1 270 for ( ; l.nonEmpty(); l = l.tail) {
duke@1 271 Tree tree = l.head;
duke@1 272 switch (tree.getKind()) {
duke@1 273 case COMPILATION_UNIT:
duke@1 274 // System.err.println("COMP: " + ((JCCompilationUnit)tree).sourcefile);
duke@1 275 env = enter.getTopLevelEnv((JCCompilationUnit)tree);
duke@1 276 break;
duke@1 277 case CLASS:
jjg@682 278 case INTERFACE:
jjg@682 279 case ENUM:
duke@1 280 // System.err.println("CLASS: " + ((JCClassDecl)tree).sym.getSimpleName());
duke@1 281 env = enter.getClassEnv(((JCClassDecl)tree).sym);
duke@1 282 break;
duke@1 283 case METHOD:
duke@1 284 // System.err.println("METHOD: " + ((JCMethodDecl)tree).sym.getSimpleName());
duke@1 285 method = (JCMethodDecl)tree;
duke@1 286 break;
duke@1 287 case VARIABLE:
duke@1 288 // System.err.println("FIELD: " + ((JCVariableDecl)tree).sym.getSimpleName());
duke@1 289 field = (JCVariableDecl)tree;
duke@1 290 break;
duke@1 291 case BLOCK: {
duke@1 292 // System.err.println("BLOCK: ");
duke@1 293 if (method != null)
duke@1 294 env = memberEnter.getMethodEnv(method, env);
duke@1 295 JCTree body = copier.copy((JCTree)tree, (JCTree) path.getLeaf());
duke@1 296 env = attribStatToTree(body, env, copier.leafCopy);
duke@1 297 return env;
duke@1 298 }
duke@1 299 default:
duke@1 300 // System.err.println("DEFAULT: " + tree.getKind());
duke@1 301 if (field != null && field.getInitializer() == tree) {
duke@1 302 env = memberEnter.getInitEnv(field, env);
duke@1 303 JCExpression expr = copier.copy((JCExpression)tree, (JCTree) path.getLeaf());
duke@1 304 env = attribExprToTree(expr, env, copier.leafCopy);
duke@1 305 return env;
duke@1 306 }
duke@1 307 }
duke@1 308 }
duke@1 309 return field != null ? memberEnter.getInitEnv(field, env) : env;
duke@1 310 }
duke@1 311
duke@1 312 private Env<AttrContext> attribStatToTree(JCTree stat, Env<AttrContext>env, JCTree tree) {
duke@1 313 JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
duke@1 314 try {
duke@1 315 return attr.attribStatToTree(stat, env, tree);
duke@1 316 } finally {
duke@1 317 log.useSource(prev);
duke@1 318 }
duke@1 319 }
duke@1 320
duke@1 321 private Env<AttrContext> attribExprToTree(JCExpression expr, Env<AttrContext>env, JCTree tree) {
duke@1 322 JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
duke@1 323 try {
duke@1 324 return attr.attribExprToTree(expr, env, tree);
duke@1 325 } finally {
duke@1 326 log.useSource(prev);
duke@1 327 }
duke@1 328 }
duke@1 329
duke@1 330 /**
duke@1 331 * Makes a copy of a tree, noting the value resulting from copying a particular leaf.
duke@1 332 **/
duke@1 333 static class Copier extends TreeCopier<JCTree> {
duke@1 334 JCTree leafCopy = null;
duke@1 335
duke@1 336 Copier(TreeMaker M) {
duke@1 337 super(M);
duke@1 338 }
duke@1 339
duke@1 340 public <T extends JCTree> T copy(T t, JCTree leaf) {
duke@1 341 T t2 = super.copy(t, leaf);
duke@1 342 if (t == leaf)
duke@1 343 leafCopy = t2;
duke@1 344 return t2;
duke@1 345 }
duke@1 346 }
jjg@110 347
jjg@110 348 /**
jjg@110 349 * Gets the original type from the ErrorType object.
jjg@110 350 * @param errorType The errorType for which we want to get the original type.
jjg@110 351 * @returns TypeMirror corresponding to the original type, replaced by the ErrorType.
jjg@110 352 * noType (type.tag == NONE) is returned if there is no original type.
jjg@110 353 */
jjg@110 354 public TypeMirror getOriginalType(javax.lang.model.type.ErrorType errorType) {
jjg@110 355 if (errorType instanceof com.sun.tools.javac.code.Type.ErrorType) {
jjg@110 356 return ((com.sun.tools.javac.code.Type.ErrorType)errorType).getOriginalType();
jjg@110 357 }
jjg@110 358
jjg@110 359 return com.sun.tools.javac.code.Type.noType;
jjg@110 360 }
jjg@308 361
jjg@308 362 /**
jjg@308 363 * Prints a message of the specified kind at the location of the
jjg@308 364 * tree within the provided compilation unit
jjg@308 365 *
jjg@308 366 * @param kind the kind of message
jjg@308 367 * @param msg the message, or an empty string if none
jjg@308 368 * @param t the tree to use as a position hint
jjg@308 369 * @param root the compilation unit that contains tree
jjg@308 370 */
jjg@308 371 public void printMessage(Diagnostic.Kind kind, CharSequence msg,
jjg@308 372 com.sun.source.tree.Tree t,
jjg@308 373 com.sun.source.tree.CompilationUnitTree root) {
jjg@308 374 JavaFileObject oldSource = null;
jjg@308 375 JavaFileObject newSource = null;
jjg@308 376 JCDiagnostic.DiagnosticPosition pos = null;
jjg@308 377
jjg@308 378 newSource = root.getSourceFile();
jjg@308 379 if (newSource != null) {
jjg@308 380 oldSource = log.useSource(newSource);
jjg@308 381 pos = ((JCTree) t).pos();
jjg@308 382 }
jjg@308 383
jjg@308 384 try {
jjg@308 385 switch (kind) {
jjg@308 386 case ERROR:
jjg@308 387 boolean prev = log.multipleErrors;
jjg@308 388 try {
jjg@308 389 log.error(pos, "proc.messager", msg.toString());
jjg@308 390 } finally {
jjg@308 391 log.multipleErrors = prev;
jjg@308 392 }
jjg@308 393 break;
jjg@308 394
jjg@308 395 case WARNING:
jjg@308 396 log.warning(pos, "proc.messager", msg.toString());
jjg@308 397 break;
jjg@308 398
jjg@308 399 case MANDATORY_WARNING:
jjg@308 400 log.mandatoryWarning(pos, "proc.messager", msg.toString());
jjg@308 401 break;
jjg@308 402
jjg@308 403 default:
jjg@308 404 log.note(pos, "proc.messager", msg.toString());
jjg@308 405 }
jjg@308 406 } finally {
jjg@308 407 if (oldSource != null)
jjg@308 408 log.useSource(oldSource);
jjg@308 409 }
jjg@308 410 }
duke@1 411 }

mercurial