Wed, 23 Jan 2013 13:27:24 -0800
8006775: JSR 308: Compiler changes in JDK8
Reviewed-by: jjg
Contributed-by: mernst@cs.washington.edu, wmdietl@cs.washington.edu, mpapi@csail.mit.edu, mahmood@notnoop.com
1 /*
2 * Copyright (c) 2005, 2012, Oracle and/or its affiliates. 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. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
26 package com.sun.source.util;
28 import java.lang.reflect.Method;
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.ErrorType;
38 import javax.lang.model.type.TypeMirror;
39 import javax.tools.Diagnostic;
40 import javax.tools.JavaCompiler.CompilationTask;
42 import com.sun.source.tree.CatchTree;
43 import com.sun.source.tree.ClassTree;
44 import com.sun.source.tree.CompilationUnitTree;
45 import com.sun.source.tree.MethodTree;
46 import com.sun.source.tree.Scope;
47 import com.sun.source.tree.Tree;
49 /**
50 * Bridges JSR 199, JSR 269, and the Tree API.
51 *
52 * @author Peter von der Ahé
53 */
54 public abstract class Trees {
55 /**
56 * Gets a Trees object for a given CompilationTask.
57 * @param task the compilation task for which to get the Trees object
58 * @throws IllegalArgumentException if the task does not support the Trees API.
59 */
60 public static Trees instance(CompilationTask task) {
61 String taskClassName = task.getClass().getName();
62 if (!taskClassName.equals("com.sun.tools.javac.api.JavacTaskImpl")
63 && !taskClassName.equals("com.sun.tools.javac.api.BasicJavacTask"))
64 throw new IllegalArgumentException();
65 return getJavacTrees(CompilationTask.class, task);
66 }
68 /**
69 * Gets a Trees object for a given ProcessingEnvironment.
70 * @param env the processing environment for which to get the Trees object
71 * @throws IllegalArgumentException if the env does not support the Trees API.
72 */
73 public static Trees instance(ProcessingEnvironment env) {
74 if (!env.getClass().getName().equals("com.sun.tools.javac.processing.JavacProcessingEnvironment"))
75 throw new IllegalArgumentException();
76 return getJavacTrees(ProcessingEnvironment.class, env);
77 }
79 static Trees getJavacTrees(Class<?> argType, Object arg) {
80 try {
81 ClassLoader cl = arg.getClass().getClassLoader();
82 Class<?> c = Class.forName("com.sun.tools.javac.api.JavacTrees", false, cl);
83 argType = Class.forName(argType.getName(), false, cl);
84 Method m = c.getMethod("instance", new Class<?>[] { argType });
85 return (Trees) m.invoke(null, new Object[] { arg });
86 } catch (Throwable e) {
87 throw new AssertionError(e);
88 }
89 }
91 /**
92 * Gets a utility object for obtaining source positions.
93 */
94 public abstract SourcePositions getSourcePositions();
96 /**
97 * Gets the Tree node for a given Element.
98 * Returns null if the node can not be found.
99 */
100 public abstract Tree getTree(Element element);
102 /**
103 * Gets the ClassTree node for a given TypeElement.
104 * Returns null if the node can not be found.
105 */
106 public abstract ClassTree getTree(TypeElement element);
108 /**
109 * Gets the MethodTree node for a given ExecutableElement.
110 * Returns null if the node can not be found.
111 */
112 public abstract MethodTree getTree(ExecutableElement method);
114 /**
115 * Gets the Tree node for an AnnotationMirror on a given Element.
116 * Returns null if the node can not be found.
117 */
118 public abstract Tree getTree(Element e, AnnotationMirror a);
120 /**
121 * Gets the Tree node for an AnnotationValue for an AnnotationMirror on a given Element.
122 * Returns null if the node can not be found.
123 */
124 public abstract Tree getTree(Element e, AnnotationMirror a, AnnotationValue v);
126 /**
127 * Gets the path to tree node within the specified compilation unit.
128 */
129 public abstract TreePath getPath(CompilationUnitTree unit, Tree node);
131 /**
132 * Gets the TreePath node for a given Element.
133 * Returns null if the node can not be found.
134 */
135 public abstract TreePath getPath(Element e);
137 /**
138 * Gets the TreePath node for an AnnotationMirror on a given Element.
139 * Returns null if the node can not be found.
140 */
141 public abstract TreePath getPath(Element e, AnnotationMirror a);
143 /**
144 * Gets the TreePath node for an AnnotationValue for an AnnotationMirror on a given Element.
145 * Returns null if the node can not be found.
146 */
147 public abstract TreePath getPath(Element e, AnnotationMirror a, AnnotationValue v);
149 /**
150 * Gets the Element for the Tree node identified by a given TreePath.
151 * Returns null if the element is not available.
152 * @throws IllegalArgumentException is the TreePath does not identify
153 * a Tree node that might have an associated Element.
154 */
155 public abstract Element getElement(TreePath path);
157 /**
158 * Gets the TypeMirror for the Tree node identified by a given TreePath.
159 * Returns null if the TypeMirror is not available.
160 * @throws IllegalArgumentException is the TreePath does not identify
161 * a Tree node that might have an associated TypeMirror.
162 */
163 public abstract TypeMirror getTypeMirror(TreePath path);
165 /**
166 * Gets the Scope for the Tree node identified by a given TreePath.
167 * Returns null if the Scope is not available.
168 */
169 public abstract Scope getScope(TreePath path);
171 /**
172 * Gets the doc comment, if any, for the Tree node identified by a given TreePath.
173 * Returns null if no doc comment was found.
174 * @see DocTrees#getDocCommentTree(TreePath)
175 */
176 public abstract String getDocComment(TreePath path);
178 /**
179 * Checks whether a given type is accessible in a given scope.
180 * @param scope the scope to be checked
181 * @param type the type to be checked
182 * @return true if {@code type} is accessible
183 */
184 public abstract boolean isAccessible(Scope scope, TypeElement type);
186 /**
187 * Checks whether the given element is accessible as a member of the given
188 * type in a given scope.
189 * @param scope the scope to be checked
190 * @param member the member to be checked
191 * @param type the type for which to check if the member is accessible
192 * @return true if {@code member} is accessible in {@code type}
193 */
194 public abstract boolean isAccessible(Scope scope, Element member, DeclaredType type);
196 /**
197 * Gets the original type from the ErrorType object.
198 * @param errorType The errorType for which we want to get the original type.
199 * @return javax.lang.model.type.TypeMirror corresponding to the original type, replaced by the ErrorType.
200 */
201 public abstract TypeMirror getOriginalType(ErrorType errorType);
203 /**
204 * Prints a message of the specified kind at the location of the
205 * tree within the provided compilation unit
206 *
207 * @param kind the kind of message
208 * @param msg the message, or an empty string if none
209 * @param t the tree to use as a position hint
210 * @param root the compilation unit that contains tree
211 */
212 public abstract void printMessage(Diagnostic.Kind kind, CharSequence msg,
213 com.sun.source.tree.Tree t,
214 com.sun.source.tree.CompilationUnitTree root);
216 /**
217 * Gets the lub of an exception parameter declared in a catch clause.
218 * @param tree the tree for the catch clause
219 * @return The lub of the exception parameter
220 */
221 public abstract TypeMirror getLub(CatchTree tree);
222 }