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