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

Thu, 10 Jun 2010 16:08:01 -0700

author
jjg
date
Thu, 10 Jun 2010 16:08:01 -0700
changeset 581
f2fdd52e4e87
parent 554
9d9f26857129
child 672
ea54372637a5
permissions
-rw-r--r--

6944312: Potential rebranding issues in openjdk/langtools repository sources
Reviewed-by: darcy

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;
duke@1 48 import com.sun.tools.javac.code.Symbol.ClassSymbol;
duke@1 49 import com.sun.tools.javac.code.Symbol.TypeSymbol;
duke@1 50 import com.sun.tools.javac.code.Symbol;
duke@1 51 import com.sun.tools.javac.comp.Attr;
duke@1 52 import com.sun.tools.javac.comp.AttrContext;
duke@1 53 import com.sun.tools.javac.comp.Enter;
duke@1 54 import com.sun.tools.javac.comp.Env;
duke@1 55 import com.sun.tools.javac.comp.MemberEnter;
duke@1 56 import com.sun.tools.javac.comp.Resolve;
duke@1 57 import com.sun.tools.javac.model.JavacElements;
jjg@308 58 import com.sun.tools.javac.processing.JavacMessager;
duke@1 59 import com.sun.tools.javac.processing.JavacProcessingEnvironment;
duke@1 60 import com.sun.tools.javac.tree.JCTree.*;
duke@1 61 import com.sun.tools.javac.tree.JCTree;
duke@1 62 import com.sun.tools.javac.tree.TreeCopier;
duke@1 63 import com.sun.tools.javac.tree.TreeInfo;
duke@1 64 import com.sun.tools.javac.tree.TreeMaker;
duke@1 65 import com.sun.tools.javac.util.Context;
jjg@308 66 import com.sun.tools.javac.util.JCDiagnostic;
duke@1 67 import com.sun.tools.javac.util.List;
duke@1 68 import com.sun.tools.javac.util.Log;
duke@1 69 import com.sun.tools.javac.util.Pair;
duke@1 70
duke@1 71 /**
duke@1 72 * Provides an implementation of Trees.
duke@1 73 *
jjg@581 74 * <p><b>This is NOT part of any supported API.
duke@1 75 * If you write code that depends on this, you do so at your own
duke@1 76 * risk. This code and its internal interfaces are subject to change
duke@1 77 * or deletion without notice.</b></p>
duke@1 78 *
duke@1 79 * @author Peter von der Ah&eacute;
duke@1 80 */
duke@1 81 public class JavacTrees extends Trees {
duke@1 82
duke@1 83 private final Resolve resolve;
duke@1 84 private final Enter enter;
duke@1 85 private final Log log;
duke@1 86 private final MemberEnter memberEnter;
duke@1 87 private final Attr attr;
duke@1 88 private final TreeMaker treeMaker;
duke@1 89 private final JavacElements elements;
duke@1 90 private final JavacTaskImpl javacTaskImpl;
duke@1 91
duke@1 92 public static JavacTrees instance(JavaCompiler.CompilationTask task) {
duke@1 93 if (!(task instanceof JavacTaskImpl))
duke@1 94 throw new IllegalArgumentException();
duke@1 95 return instance(((JavacTaskImpl)task).getContext());
duke@1 96 }
duke@1 97
duke@1 98 public static JavacTrees instance(ProcessingEnvironment env) {
duke@1 99 if (!(env instanceof JavacProcessingEnvironment))
duke@1 100 throw new IllegalArgumentException();
duke@1 101 return instance(((JavacProcessingEnvironment)env).getContext());
duke@1 102 }
duke@1 103
duke@1 104 public static JavacTrees instance(Context context) {
duke@1 105 JavacTrees instance = context.get(JavacTrees.class);
duke@1 106 if (instance == null)
duke@1 107 instance = new JavacTrees(context);
duke@1 108 return instance;
duke@1 109 }
duke@1 110
duke@1 111 private JavacTrees(Context context) {
duke@1 112 context.put(JavacTrees.class, this);
duke@1 113 attr = Attr.instance(context);
duke@1 114 enter = Enter.instance(context);
duke@1 115 elements = JavacElements.instance(context);
duke@1 116 log = Log.instance(context);
duke@1 117 resolve = Resolve.instance(context);
duke@1 118 treeMaker = TreeMaker.instance(context);
duke@1 119 memberEnter = MemberEnter.instance(context);
duke@1 120 javacTaskImpl = context.get(JavacTaskImpl.class);
duke@1 121 }
duke@1 122
duke@1 123 public SourcePositions getSourcePositions() {
duke@1 124 return new SourcePositions() {
duke@1 125 public long getStartPosition(CompilationUnitTree file, Tree tree) {
duke@1 126 return TreeInfo.getStartPos((JCTree) tree);
duke@1 127 }
duke@1 128
duke@1 129 public long getEndPosition(CompilationUnitTree file, Tree tree) {
duke@1 130 Map<JCTree,Integer> endPositions = ((JCCompilationUnit) file).endPositions;
duke@1 131 return TreeInfo.getEndPos((JCTree) tree, endPositions);
duke@1 132 }
duke@1 133 };
duke@1 134 }
duke@1 135
duke@1 136 public JCClassDecl getTree(TypeElement element) {
duke@1 137 return (JCClassDecl) getTree((Element) element);
duke@1 138 }
duke@1 139
duke@1 140 public JCMethodDecl getTree(ExecutableElement method) {
duke@1 141 return (JCMethodDecl) getTree((Element) method);
duke@1 142 }
duke@1 143
duke@1 144 public JCTree getTree(Element element) {
duke@1 145 Symbol symbol = (Symbol) element;
duke@1 146 TypeSymbol enclosing = symbol.enclClass();
duke@1 147 Env<AttrContext> env = enter.getEnv(enclosing);
duke@1 148 if (env == null)
duke@1 149 return null;
duke@1 150 JCClassDecl classNode = env.enclClass;
duke@1 151 if (classNode != null) {
duke@1 152 if (TreeInfo.symbolFor(classNode) == element)
duke@1 153 return classNode;
duke@1 154 for (JCTree node : classNode.getMembers())
duke@1 155 if (TreeInfo.symbolFor(node) == element)
duke@1 156 return node;
duke@1 157 }
duke@1 158 return null;
duke@1 159 }
duke@1 160
duke@1 161 public JCTree getTree(Element e, AnnotationMirror a) {
duke@1 162 return getTree(e, a, null);
duke@1 163 }
duke@1 164
duke@1 165 public JCTree getTree(Element e, AnnotationMirror a, AnnotationValue v) {
duke@1 166 Pair<JCTree, JCCompilationUnit> treeTopLevel = elements.getTreeAndTopLevel(e, a, v);
duke@1 167 if (treeTopLevel == null)
duke@1 168 return null;
duke@1 169 return treeTopLevel.fst;
duke@1 170 }
duke@1 171
duke@1 172 public TreePath getPath(CompilationUnitTree unit, Tree node) {
duke@1 173 return TreePath.getPath(unit, node);
duke@1 174 }
duke@1 175
duke@1 176 public TreePath getPath(Element e) {
duke@1 177 return getPath(e, null, null);
duke@1 178 }
duke@1 179
duke@1 180 public TreePath getPath(Element e, AnnotationMirror a) {
duke@1 181 return getPath(e, a, null);
duke@1 182 }
duke@1 183
duke@1 184 public TreePath getPath(Element e, AnnotationMirror a, AnnotationValue v) {
duke@1 185 final Pair<JCTree, JCCompilationUnit> treeTopLevel = elements.getTreeAndTopLevel(e, a, v);
duke@1 186 if (treeTopLevel == null)
duke@1 187 return null;
duke@1 188 return TreePath.getPath(treeTopLevel.snd, treeTopLevel.fst);
duke@1 189 }
duke@1 190
duke@1 191 public Element getElement(TreePath path) {
duke@1 192 Tree t = path.getLeaf();
duke@1 193 return TreeInfo.symbolFor((JCTree) t);
duke@1 194 }
duke@1 195
duke@1 196 public TypeMirror getTypeMirror(TreePath path) {
duke@1 197 Tree t = path.getLeaf();
duke@1 198 return ((JCTree)t).type;
duke@1 199 }
duke@1 200
duke@1 201 public JavacScope getScope(TreePath path) {
duke@1 202 return new JavacScope(getAttrContext(path));
duke@1 203 }
duke@1 204
duke@1 205 public boolean isAccessible(Scope scope, TypeElement type) {
duke@1 206 if (scope instanceof JavacScope && type instanceof ClassSymbol) {
duke@1 207 Env<AttrContext> env = ((JavacScope) scope).env;
duke@1 208 return resolve.isAccessible(env, (ClassSymbol)type);
duke@1 209 } else
duke@1 210 return false;
duke@1 211 }
duke@1 212
duke@1 213 public boolean isAccessible(Scope scope, Element member, DeclaredType type) {
duke@1 214 if (scope instanceof JavacScope
duke@1 215 && member instanceof Symbol
duke@1 216 && type instanceof com.sun.tools.javac.code.Type) {
duke@1 217 Env<AttrContext> env = ((JavacScope) scope).env;
duke@1 218 return resolve.isAccessible(env, (com.sun.tools.javac.code.Type)type, (Symbol)member);
duke@1 219 } else
duke@1 220 return false;
duke@1 221 }
duke@1 222
duke@1 223 private Env<AttrContext> getAttrContext(TreePath path) {
duke@1 224 if (!(path.getLeaf() instanceof JCTree)) // implicit null-check
duke@1 225 throw new IllegalArgumentException();
duke@1 226
duke@1 227 // if we're being invoked via from a JSR199 client, we need to make sure
duke@1 228 // all the classes have been entered; if we're being invoked from JSR269,
duke@1 229 // then the classes will already have been entered.
duke@1 230 if (javacTaskImpl != null) {
duke@1 231 try {
duke@1 232 javacTaskImpl.enter(null);
duke@1 233 } catch (IOException e) {
duke@1 234 throw new Error("unexpected error while entering symbols: " + e);
duke@1 235 }
duke@1 236 }
duke@1 237
duke@1 238
duke@1 239 JCCompilationUnit unit = (JCCompilationUnit) path.getCompilationUnit();
duke@1 240 Copier copier = new Copier(treeMaker.forToplevel(unit));
duke@1 241
duke@1 242 Env<AttrContext> env = null;
duke@1 243 JCMethodDecl method = null;
duke@1 244 JCVariableDecl field = null;
duke@1 245
duke@1 246 List<Tree> l = List.nil();
duke@1 247 TreePath p = path;
duke@1 248 while (p != null) {
duke@1 249 l = l.prepend(p.getLeaf());
duke@1 250 p = p.getParentPath();
duke@1 251 }
duke@1 252
duke@1 253 for ( ; l.nonEmpty(); l = l.tail) {
duke@1 254 Tree tree = l.head;
duke@1 255 switch (tree.getKind()) {
duke@1 256 case COMPILATION_UNIT:
duke@1 257 // System.err.println("COMP: " + ((JCCompilationUnit)tree).sourcefile);
duke@1 258 env = enter.getTopLevelEnv((JCCompilationUnit)tree);
duke@1 259 break;
duke@1 260 case CLASS:
duke@1 261 // System.err.println("CLASS: " + ((JCClassDecl)tree).sym.getSimpleName());
duke@1 262 env = enter.getClassEnv(((JCClassDecl)tree).sym);
duke@1 263 break;
duke@1 264 case METHOD:
duke@1 265 // System.err.println("METHOD: " + ((JCMethodDecl)tree).sym.getSimpleName());
duke@1 266 method = (JCMethodDecl)tree;
duke@1 267 break;
duke@1 268 case VARIABLE:
duke@1 269 // System.err.println("FIELD: " + ((JCVariableDecl)tree).sym.getSimpleName());
duke@1 270 field = (JCVariableDecl)tree;
duke@1 271 break;
duke@1 272 case BLOCK: {
duke@1 273 // System.err.println("BLOCK: ");
duke@1 274 if (method != null)
duke@1 275 env = memberEnter.getMethodEnv(method, env);
duke@1 276 JCTree body = copier.copy((JCTree)tree, (JCTree) path.getLeaf());
duke@1 277 env = attribStatToTree(body, env, copier.leafCopy);
duke@1 278 return env;
duke@1 279 }
duke@1 280 default:
duke@1 281 // System.err.println("DEFAULT: " + tree.getKind());
duke@1 282 if (field != null && field.getInitializer() == tree) {
duke@1 283 env = memberEnter.getInitEnv(field, env);
duke@1 284 JCExpression expr = copier.copy((JCExpression)tree, (JCTree) path.getLeaf());
duke@1 285 env = attribExprToTree(expr, env, copier.leafCopy);
duke@1 286 return env;
duke@1 287 }
duke@1 288 }
duke@1 289 }
duke@1 290 return field != null ? memberEnter.getInitEnv(field, env) : env;
duke@1 291 }
duke@1 292
duke@1 293 private Env<AttrContext> attribStatToTree(JCTree stat, Env<AttrContext>env, JCTree tree) {
duke@1 294 JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
duke@1 295 try {
duke@1 296 return attr.attribStatToTree(stat, env, tree);
duke@1 297 } finally {
duke@1 298 log.useSource(prev);
duke@1 299 }
duke@1 300 }
duke@1 301
duke@1 302 private Env<AttrContext> attribExprToTree(JCExpression expr, Env<AttrContext>env, JCTree tree) {
duke@1 303 JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
duke@1 304 try {
duke@1 305 return attr.attribExprToTree(expr, env, tree);
duke@1 306 } finally {
duke@1 307 log.useSource(prev);
duke@1 308 }
duke@1 309 }
duke@1 310
duke@1 311 /**
duke@1 312 * Makes a copy of a tree, noting the value resulting from copying a particular leaf.
duke@1 313 **/
duke@1 314 static class Copier extends TreeCopier<JCTree> {
duke@1 315 JCTree leafCopy = null;
duke@1 316
duke@1 317 Copier(TreeMaker M) {
duke@1 318 super(M);
duke@1 319 }
duke@1 320
duke@1 321 public <T extends JCTree> T copy(T t, JCTree leaf) {
duke@1 322 T t2 = super.copy(t, leaf);
duke@1 323 if (t == leaf)
duke@1 324 leafCopy = t2;
duke@1 325 return t2;
duke@1 326 }
duke@1 327 }
jjg@110 328
jjg@110 329 /**
jjg@110 330 * Gets the original type from the ErrorType object.
jjg@110 331 * @param errorType The errorType for which we want to get the original type.
jjg@110 332 * @returns TypeMirror corresponding to the original type, replaced by the ErrorType.
jjg@110 333 * noType (type.tag == NONE) is returned if there is no original type.
jjg@110 334 */
jjg@110 335 public TypeMirror getOriginalType(javax.lang.model.type.ErrorType errorType) {
jjg@110 336 if (errorType instanceof com.sun.tools.javac.code.Type.ErrorType) {
jjg@110 337 return ((com.sun.tools.javac.code.Type.ErrorType)errorType).getOriginalType();
jjg@110 338 }
jjg@110 339
jjg@110 340 return com.sun.tools.javac.code.Type.noType;
jjg@110 341 }
jjg@308 342
jjg@308 343 /**
jjg@308 344 * Prints a message of the specified kind at the location of the
jjg@308 345 * tree within the provided compilation unit
jjg@308 346 *
jjg@308 347 * @param kind the kind of message
jjg@308 348 * @param msg the message, or an empty string if none
jjg@308 349 * @param t the tree to use as a position hint
jjg@308 350 * @param root the compilation unit that contains tree
jjg@308 351 */
jjg@308 352 public void printMessage(Diagnostic.Kind kind, CharSequence msg,
jjg@308 353 com.sun.source.tree.Tree t,
jjg@308 354 com.sun.source.tree.CompilationUnitTree root) {
jjg@308 355 JavaFileObject oldSource = null;
jjg@308 356 JavaFileObject newSource = null;
jjg@308 357 JCDiagnostic.DiagnosticPosition pos = null;
jjg@308 358
jjg@308 359 newSource = root.getSourceFile();
jjg@308 360 if (newSource != null) {
jjg@308 361 oldSource = log.useSource(newSource);
jjg@308 362 pos = ((JCTree) t).pos();
jjg@308 363 }
jjg@308 364
jjg@308 365 try {
jjg@308 366 switch (kind) {
jjg@308 367 case ERROR:
jjg@308 368 boolean prev = log.multipleErrors;
jjg@308 369 try {
jjg@308 370 log.error(pos, "proc.messager", msg.toString());
jjg@308 371 } finally {
jjg@308 372 log.multipleErrors = prev;
jjg@308 373 }
jjg@308 374 break;
jjg@308 375
jjg@308 376 case WARNING:
jjg@308 377 log.warning(pos, "proc.messager", msg.toString());
jjg@308 378 break;
jjg@308 379
jjg@308 380 case MANDATORY_WARNING:
jjg@308 381 log.mandatoryWarning(pos, "proc.messager", msg.toString());
jjg@308 382 break;
jjg@308 383
jjg@308 384 default:
jjg@308 385 log.note(pos, "proc.messager", msg.toString());
jjg@308 386 }
jjg@308 387 } finally {
jjg@308 388 if (oldSource != null)
jjg@308 389 log.useSource(oldSource);
jjg@308 390 }
jjg@308 391 }
duke@1 392 }

mercurial