1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
/*******************************************************************************
* Copyright (c) 2005, 2017 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
* IBM Corporation - Fix for bug 328575
* het@google.com - Bug 415274 - Annotation processing throws a NPE in getElementsAnnotatedWith()
*******************************************************************************/
package org.eclipse.jdt.internal.compiler.apt.dispatch;
import java.lang.annotation.Annotation;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.Element;
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.TypeElement;
import javax.lang.model.util.ElementFilter;
import org.eclipse.jdt.internal.compiler.apt.model.Factory;
import org.eclipse.jdt.internal.compiler.apt.model.TypeElementImpl;
import org.eclipse.jdt.internal.compiler.apt.util.ManyToMany;
import org.eclipse.jdt.internal.compiler.ast.CompilationUnitDeclaration;
import org.eclipse.jdt.internal.compiler.lookup.AnnotationBinding;
import org.eclipse.jdt.internal.compiler.lookup.Binding;
import org.eclipse.jdt.internal.compiler.lookup.FieldBinding;
import org.eclipse.jdt.internal.compiler.lookup.MethodBinding;
import org.eclipse.jdt.internal.compiler.lookup.ParameterizedTypeBinding;
import org.eclipse.jdt.internal.compiler.lookup.ReferenceBinding;
import org.eclipse.jdt.internal.compiler.lookup.SourceTypeBinding;
import org.eclipse.jdt.internal.compiler.lookup.TagBits;
public class RoundEnvImpl implements RoundEnvironment
{
private final BaseProcessingEnvImpl _processingEnv;
private final boolean _isLastRound;
private final CompilationUnitDeclaration[] _units;
private final ManyToMany<TypeElement, Element> _annoToUnit;
private final ReferenceBinding[] _binaryTypes;
private final Factory _factory;
private Set<Element> _rootElements = null;
public RoundEnvImpl(CompilationUnitDeclaration[] units, ReferenceBinding[] binaryTypeBindings, boolean isLastRound, BaseProcessingEnvImpl env) {
_processingEnv = env;
_isLastRound = isLastRound;
_units = units;
_factory = _processingEnv.getFactory();
// Discover the annotations that will be passed to Processor.process()
AnnotationDiscoveryVisitor visitor = new AnnotationDiscoveryVisitor(_processingEnv);
if (_units != null) {
for (CompilationUnitDeclaration unit : _units) {
unit.scope.suppressImportErrors = true;
unit.traverse(visitor, unit.scope);
unit.scope.suppressImportErrors = false;
}
}
_annoToUnit = visitor._annoToElement;
if (binaryTypeBindings != null) collectAnnotations(binaryTypeBindings);
_binaryTypes = binaryTypeBindings;
}
private void collectAnnotations(ReferenceBinding[] referenceBindings) {
for (ReferenceBinding referenceBinding : referenceBindings) {
// collect all annotations from the binary types
if (referenceBinding instanceof ParameterizedTypeBinding) {
referenceBinding = ((ParameterizedTypeBinding) referenceBinding).genericType();
}
AnnotationBinding[] annotationBindings = Factory.getPackedAnnotationBindings(referenceBinding.getAnnotations());
for (AnnotationBinding annotationBinding : annotationBindings) {
TypeElement anno = (TypeElement)_factory.newElement(annotationBinding.getAnnotationType());
Element element = _factory.newElement(referenceBinding);
_annoToUnit.put(anno, element);
}
FieldBinding[] fieldBindings = referenceBinding.fields();
for (FieldBinding fieldBinding : fieldBindings) {
annotationBindings = Factory.getPackedAnnotationBindings(fieldBinding.getAnnotations());
for (AnnotationBinding annotationBinding : annotationBindings) {
TypeElement anno = (TypeElement)_factory.newElement(annotationBinding.getAnnotationType());
Element element = _factory.newElement(fieldBinding);
_annoToUnit.put(anno, element);
}
}
MethodBinding[] methodBindings = referenceBinding.methods();
for (MethodBinding methodBinding : methodBindings) {
annotationBindings = Factory.getPackedAnnotationBindings(methodBinding.getAnnotations());
for (AnnotationBinding annotationBinding : annotationBindings) {
TypeElement anno = (TypeElement)_factory.newElement(annotationBinding.getAnnotationType());
Element element = _factory.newElement(methodBinding);
_annoToUnit.put(anno, element);
}
}
ReferenceBinding[] memberTypes = referenceBinding.memberTypes();
collectAnnotations(memberTypes);
}
}
/**
* Return the set of annotation types that were discovered on the root elements.
* This does not include inherited annotations, only those directly on the root
* elements.
* @return a set of annotation types, possibly empty.
*/
public Set<TypeElement> getRootAnnotations()
{
return Collections.unmodifiableSet(_annoToUnit.getKeySet());
}
@Override
public boolean errorRaised()
{
return _processingEnv.errorRaised();
}
/**
* From the set of root elements and their enclosed elements, return the subset that are annotated
* with {@code a}. If {@code a} is annotated with the {@link java.lang.annotation.Inherited}
* annotation, include those elements that inherit the annotation from their superclasses.
* Note that {@link java.lang.annotation.Inherited} only applies to classes (i.e. TypeElements).
*/
@Override
public Set<? extends Element> getElementsAnnotatedWith(TypeElement a)
{
if (a.getKind() != ElementKind.ANNOTATION_TYPE) {
throw new IllegalArgumentException("Argument must represent an annotation type"); //$NON-NLS-1$
}
Binding annoBinding = ((TypeElementImpl)a)._binding;
if (0 != (annoBinding.getAnnotationTagBits() & TagBits.AnnotationInherited)) {
Set<Element> annotatedElements = new HashSet<>(_annoToUnit.getValues(a));
// For all other root elements that are TypeElements, and for their recursively enclosed
// types, add each element if it has a superclass are annotated with 'a'
ReferenceBinding annoTypeBinding = (ReferenceBinding) annoBinding;
for (TypeElement element : ElementFilter.typesIn(getRootElements())) {
ReferenceBinding typeBinding = (ReferenceBinding)((TypeElementImpl)element)._binding;
addAnnotatedElements(annoTypeBinding, typeBinding, annotatedElements);
}
return Collections.unmodifiableSet(annotatedElements);
}
return Collections.unmodifiableSet(_annoToUnit.getValues(a));
}
/**
* For every type in types that is a class and that is annotated with anno, either directly or by inheritance,
* add that type to result. Recursively descend on each types's child classes as well.
* @param anno the compiler binding for an annotation type
* @param type a type, not necessarily a class
* @param result must be a modifiable Set; will accumulate annotated classes
*/
private void addAnnotatedElements(ReferenceBinding anno, ReferenceBinding type, Set<Element> result) {
if (type.isClass()) {
if (inheritsAnno(type, anno)) {
result.add(_factory.newElement(type));
}
}
for (ReferenceBinding element : type.memberTypes()) {
addAnnotatedElements(anno, element, result);
}
}
/**
* Check whether an element has a superclass that is annotated with an @Inherited annotation.
* @param element must be a class (not an interface, enum, etc.).
* @param anno must be an annotation type, and must be @Inherited
* @return true if element has a superclass that is annotated with anno
*/
private boolean inheritsAnno(ReferenceBinding element, ReferenceBinding anno) {
ReferenceBinding searchedElement = element;
do {
if (searchedElement instanceof ParameterizedTypeBinding) {
searchedElement = ((ParameterizedTypeBinding) searchedElement).genericType();
}
AnnotationBinding[] annos = Factory.getPackedAnnotationBindings(searchedElement.getAnnotations());
for (AnnotationBinding annoBinding : annos) {
if (annoBinding.getAnnotationType() == anno) { //$IDENTITY-COMPARISON$
// element is annotated with anno
return true;
}
}
} while (null != (searchedElement = searchedElement.superclass()));
return false;
}
@Override
public Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a)
{
String canonicalName = a.getCanonicalName();
if (canonicalName == null) {
// null for anonymous and local classes or an array of those
throw new IllegalArgumentException("Argument must represent an annotation type"); //$NON-NLS-1$
}
TypeElement annoType = _processingEnv.getElementUtils().getTypeElement(canonicalName);
if (annoType == null) {
return Collections.emptySet();
}
return getElementsAnnotatedWith(annoType);
}
@Override
public Set<? extends Element> getRootElements()
{
if (_units == null) {
return Collections.emptySet();
}
if (_rootElements == null) {
Set<Element> elements = new HashSet<>(_units.length);
for (CompilationUnitDeclaration unit : _units) {
if (unit.moduleDeclaration != null && unit.moduleDeclaration.binding != null) {
Element m = _factory.newElement(unit.moduleDeclaration.binding);
elements.add(m);
continue;
}
if (null == unit.scope || null == unit.scope.topLevelTypes)
continue;
for (SourceTypeBinding binding : unit.scope.topLevelTypes) {
Element element = _factory.newElement(binding);
if (null == element) {
throw new IllegalArgumentException("Top-level type binding could not be converted to element: " + binding); //$NON-NLS-1$
}
elements.add(element);
}
}
if (this._binaryTypes != null) {
for (ReferenceBinding typeBinding : _binaryTypes) {
Element element = _factory.newElement(typeBinding);
if (null == element) {
throw new IllegalArgumentException("Top-level type binding could not be converted to element: " + typeBinding); //$NON-NLS-1$
}
elements.add(element);
}
}
_rootElements = elements;
}
return _rootElements;
}
@Override
public boolean processingOver()
{
return _isLastRound;
}
}
|
