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

Mon, 14 Nov 2011 15:11:10 -0800

author
ksrini
date
Mon, 14 Nov 2011 15:11:10 -0800
changeset 1138
7375d4979bd3
parent 1127
ca49d50318dc
child 1210
62e611704863
permissions
-rw-r--r--

7106166: (javac) re-factor EndPos parser
Reviewed-by: jjg

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

mercurial