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