1 /*
2 * Copyright (c) 2003, 2025, 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.tools.javac.comp;
27
28 import com.sun.tools.javac.code.*;
29 import com.sun.tools.javac.code.Attribute.Compound;
30 import com.sun.tools.javac.code.Attribute.TypeCompound;
31 import com.sun.tools.javac.code.Kinds.KindSelector;
32 import com.sun.tools.javac.code.Scope.WriteableScope;
33 import com.sun.tools.javac.code.Source.Feature;
34 import com.sun.tools.javac.code.Symbol.*;
35 import com.sun.tools.javac.code.TypeMetadata.Annotations;
36 import com.sun.tools.javac.comp.Check.CheckContext;
37 import com.sun.tools.javac.resources.CompilerProperties.Errors;
38 import com.sun.tools.javac.resources.CompilerProperties.Fragments;
39 import com.sun.tools.javac.tree.JCTree;
40 import com.sun.tools.javac.tree.JCTree.*;
41 import com.sun.tools.javac.tree.TreeInfo;
42 import com.sun.tools.javac.tree.TreeMaker;
43 import com.sun.tools.javac.tree.TreeScanner;
44 import com.sun.tools.javac.util.*;
45 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
46 import com.sun.tools.javac.util.List;
47
48 import javax.tools.JavaFileObject;
49
50 import java.util.*;
51
52 import static com.sun.tools.javac.code.Flags.SYNTHETIC;
53 import static com.sun.tools.javac.code.Kinds.Kind.MDL;
54 import static com.sun.tools.javac.code.Kinds.Kind.MTH;
55 import static com.sun.tools.javac.code.Kinds.Kind.PCK;
56 import static com.sun.tools.javac.code.Kinds.Kind.TYP;
57 import static com.sun.tools.javac.code.Kinds.Kind.VAR;
58 import static com.sun.tools.javac.code.Scope.LookupKind.NON_RECURSIVE;
59 import static com.sun.tools.javac.code.TypeTag.ARRAY;
60 import static com.sun.tools.javac.code.TypeTag.CLASS;
61 import static com.sun.tools.javac.tree.JCTree.Tag.ANNOTATION;
62 import static com.sun.tools.javac.tree.JCTree.Tag.ASSIGN;
63 import static com.sun.tools.javac.tree.JCTree.Tag.IDENT;
64 import static com.sun.tools.javac.tree.JCTree.Tag.NEWARRAY;
65
66 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticFlag;
67
68
69 /** Enter annotations onto symbols and types (and trees).
70 *
71 * This is also a pseudo stage in the compiler taking care of scheduling when annotations are
72 * entered.
73 *
74 * <p><b>This is NOT part of any supported API.
75 * If you write code that depends on this, you do so at your own risk.
76 * This code and its internal interfaces are subject to change or
77 * deletion without notice.</b>
78 */
79 public class Annotate {
80 protected static final Context.Key<Annotate> annotateKey = new Context.Key<>();
81
82 public static Annotate instance(Context context) {
83 Annotate instance = context.get(annotateKey);
84 if (instance == null)
85 instance = new Annotate(context);
86 return instance;
87 }
88
89 private final Attr attr;
90 private final Check chk;
91 private final ConstFold cfolder;
92 private final DeferredLintHandler deferredLintHandler;
93 private final Enter enter;
94 private final Lint lint;
95 private final Log log;
96 private final Names names;
97 private final Resolve resolve;
98 private final TreeMaker make;
99 private final Symtab syms;
100 private final TypeEnvs typeEnvs;
101 private final Types types;
102
103 private final Attribute theUnfinishedDefaultValue;
104 private final String sourceName;
105
106 @SuppressWarnings("this-escape")
107 protected Annotate(Context context) {
108 context.put(annotateKey, this);
109
110 attr = Attr.instance(context);
111 chk = Check.instance(context);
112 cfolder = ConstFold.instance(context);
113 deferredLintHandler = DeferredLintHandler.instance(context);
114 enter = Enter.instance(context);
115 log = Log.instance(context);
116 lint = Lint.instance(context);
117 make = TreeMaker.instance(context);
118 names = Names.instance(context);
119 resolve = Resolve.instance(context);
120 syms = Symtab.instance(context);
121 typeEnvs = TypeEnvs.instance(context);
122 types = Types.instance(context);
123
124 theUnfinishedDefaultValue = new Attribute.Error(syms.errType);
125
126 Source source = Source.instance(context);
127 sourceName = source.name;
128
129 blockCount = 1;
130 }
131
132 /** Semaphore to delay annotation processing */
133 private int blockCount = 0;
134
135 /** Called when annotations processing needs to be postponed. */
136 public void blockAnnotations() {
137 blockCount++;
138 }
139
140 /** Called when annotation processing can be resumed. */
141 public void unblockAnnotations() {
142 blockCount--;
143 if (blockCount == 0)
144 flush();
145 }
146
147 /** Variant which allows for a delayed flush of annotations.
148 * Needed by ClassReader */
149 public void unblockAnnotationsNoFlush() {
150 blockCount--;
151 }
152
153 /** are we blocking annotation processing? */
154 public boolean annotationsBlocked() {return blockCount > 0; }
155
156 public void enterDone() {
157 unblockAnnotations();
158 }
159
160 public List<TypeCompound> fromAnnotations(List<JCAnnotation> annotations) {
161 if (annotations.isEmpty()) {
162 return List.nil();
163 }
164
165 ListBuffer<TypeCompound> buf = new ListBuffer<>();
166 for (JCAnnotation anno : annotations) {
167 Assert.checkNonNull(anno.attribute);
168 buf.append((TypeCompound) anno.attribute);
169 }
170 return buf.toList();
171 }
172
173 /** Annotate (used for everything else) */
174 public void normal(Runnable r) {
175 q.append(r);
176 }
177
178 /** Validate, triggers after 'normal' */
179 public void validate(Runnable a) {
180 validateQ.append(a);
181 }
182
183 /** Flush all annotation queues */
184 public void flush() {
185 if (annotationsBlocked()) return;
186 if (isFlushing()) return;
187
188 startFlushing();
189 try {
190 while (q.nonEmpty() ||
191 typesQ.nonEmpty() ||
192 afterTypesQ.nonEmpty() ||
193 validateQ.nonEmpty()) {
194 while (q.nonEmpty()) {
195 q.next().run();
196 }
197 while (typesQ.nonEmpty()) {
198 typesQ.next().run();
199 }
200 while (afterTypesQ.nonEmpty()) {
201 afterTypesQ.next().run();
202 }
203 while (validateQ.nonEmpty()) {
204 validateQ.next().run();
205 }
206 }
207 } finally {
208 doneFlushing();
209 }
210 }
211
212 private ListBuffer<Runnable> q = new ListBuffer<>();
213 private ListBuffer<Runnable> validateQ = new ListBuffer<>();
214
215 private int flushCount = 0;
216 private boolean isFlushing() { return flushCount > 0; }
217 private void startFlushing() { flushCount++; }
218 private void doneFlushing() { flushCount--; }
219
220 ListBuffer<Runnable> typesQ = new ListBuffer<>();
221 ListBuffer<Runnable> afterTypesQ = new ListBuffer<>();
222
223
224 public void typeAnnotation(Runnable a) {
225 typesQ.append(a);
226 }
227
228 public void afterTypes(Runnable a) {
229 afterTypesQ.append(a);
230 }
231
232 /**
233 * Queue annotations for later attribution and entering. This is probably the method you are looking for.
234 *
235 * @param annotations the list of JCAnnotations to attribute and enter
236 * @param localEnv the enclosing env
237 * @param s the Symbol on which to enter the annotations
238 * @param deferDecl enclosing declaration for DeferredLintHandler, or null for no deferral
239 */
240 public void annotateLater(List<JCAnnotation> annotations, Env<AttrContext> localEnv,
241 Symbol s, JCTree deferDecl)
242 {
243 if (annotations.isEmpty()) {
244 return;
245 }
246
247 s.resetAnnotations(); // mark Annotations as incomplete for now
248
249 normal(() -> {
250 // Packages are unusual, in that they are the only type of declaration that can legally appear
251 // more than once in a compilation, and in all cases refer to the same underlying symbol.
252 // This means they are the only kind of declaration that syntactically may have multiple sets
253 // of annotations, each on a different package declaration, even though that is ultimately
254 // forbidden by JLS 8 section 7.4.
255 // The corollary here is that all of the annotations on a package symbol may have already
256 // been handled, meaning that the set of annotations pending completion is now empty.
257 Assert.check(s.kind == PCK || s.annotationsPendingCompletion());
258 JavaFileObject prev = log.useSource(localEnv.toplevel.sourcefile);
259 Assert.check(deferDecl != null);
260 deferredLintHandler.push(deferDecl);
261 try {
262 if (s.hasAnnotations() && annotations.nonEmpty())
263 log.error(annotations.head.pos, Errors.AlreadyAnnotated(Kinds.kindName(s), s));
264
265 Assert.checkNonNull(s, "Symbol argument to actualEnterAnnotations is null");
266
267 // false is passed as fifth parameter since annotateLater is
268 // never called for a type parameter
269 annotateNow(s, annotations, localEnv, false, false);
270 } finally {
271 deferredLintHandler.pop();
272 log.useSource(prev);
273 }
274 });
275
276 validate(() -> { //validate annotations
277 JavaFileObject prev = log.useSource(localEnv.toplevel.sourcefile);
278 try {
279 chk.validateAnnotations(annotations, TreeInfo.declarationFor(s, localEnv.tree), s);
280 } finally {
281 log.useSource(prev);
282 }
283 });
284 }
285
286
287 /** Queue processing of an attribute default value. */
288 public void annotateDefaultValueLater(JCExpression defaultValue, Env<AttrContext> localEnv,
289 MethodSymbol m, JCTree deferDecl)
290 {
291 normal(() -> {
292 JavaFileObject prev = log.useSource(localEnv.toplevel.sourcefile);
293 deferredLintHandler.push(deferDecl);
294 try {
295 enterDefaultValue(defaultValue, localEnv, m);
296 } finally {
297 deferredLintHandler.pop();
298 log.useSource(prev);
299 }
300 });
301
302 validate(() -> { //validate annotations
303 JavaFileObject prev = log.useSource(localEnv.toplevel.sourcefile);
304 try {
305 // if default value is an annotation, check it is a well-formed
306 // annotation value (e.g. no duplicate values, no missing values, etc.)
307 chk.validateAnnotationTree(defaultValue);
308 } finally {
309 log.useSource(prev);
310 }
311 });
312 }
313
314 /** Enter a default value for an annotation element. */
315 private void enterDefaultValue(JCExpression defaultValue,
316 Env<AttrContext> localEnv, MethodSymbol m) {
317 m.defaultValue = attributeAnnotationValue(m.type.getReturnType(), defaultValue, localEnv);
318 }
319
320 /**
321 * Gather up annotations into a map from type symbols to lists of Compound attributes,
322 * then continue on with repeating annotations processing.
323 */
324 private <T extends Attribute.Compound> void annotateNow(Symbol toAnnotate,
325 List<JCAnnotation> withAnnotations, Env<AttrContext> env, boolean typeAnnotations,
326 boolean isTypeParam)
327 {
328 Map<TypeSymbol, ListBuffer<T>> annotated = new LinkedHashMap<>();
329 Map<T, DiagnosticPosition> pos = new HashMap<>();
330
331 for (List<JCAnnotation> al = withAnnotations; !al.isEmpty(); al = al.tail) {
332 JCAnnotation a = al.head;
333
334 T c;
335 if (typeAnnotations) {
336 @SuppressWarnings("unchecked")
337 T tmp = (T)attributeTypeAnnotation(a, syms.annotationType, env);
338 c = tmp;
339 } else {
340 @SuppressWarnings("unchecked")
341 T tmp = (T)attributeAnnotation(a, syms.annotationType, env);
342 c = tmp;
343 }
344
345 Assert.checkNonNull(c, "Failed to create annotation");
346
347 if (a.type.isErroneous() || a.type.tsym.isAnnotationType()) {
348 if (annotated.containsKey(a.type.tsym)) {
349 ListBuffer<T> l = annotated.get(a.type.tsym);
350 l = l.append(c);
351 annotated.put(a.type.tsym, l);
352 pos.put(c, a.pos());
353 } else {
354 annotated.put(a.type.tsym, ListBuffer.of(c));
355 pos.put(c, a.pos());
356 }
357 }
358
359 // Note: @Deprecated has no effect on local variables and parameters
360 if (!c.type.isErroneous()
361 && (toAnnotate.kind == MDL || toAnnotate.owner.kind != MTH)
362 && types.isSameType(c.type, syms.deprecatedType)) {
363 toAnnotate.flags_field |= (Flags.DEPRECATED | Flags.DEPRECATED_ANNOTATION);
364 if (isAttributeTrue(c.member(names.forRemoval))) {
365 toAnnotate.flags_field |= Flags.DEPRECATED_REMOVAL;
366 }
367 }
368
369 if (!c.type.isErroneous()
370 && types.isSameType(c.type, syms.previewFeatureType)) {
371 toAnnotate.flags_field |= Flags.PREVIEW_API;
372 if (isAttributeTrue(c.member(names.reflective))) {
373 toAnnotate.flags_field |= Flags.PREVIEW_REFLECTIVE;
374 }
375 }
376
377 if (!c.type.isErroneous()
378 && toAnnotate.kind == TYP
379 && types.isSameType(c.type, syms.valueBasedType)) {
380 toAnnotate.flags_field |= Flags.VALUE_BASED;
381 }
382
383 if (!c.type.isErroneous()
384 && types.isSameType(c.type, syms.restrictedType)) {
385 toAnnotate.flags_field |= Flags.RESTRICTED;
386 }
387 }
388
389 List<T> buf = List.nil();
390 for (ListBuffer<T> lb : annotated.values()) {
391 if (lb.size() == 1) {
392 buf = buf.prepend(lb.first());
393 } else {
394 AnnotationContext<T> ctx = new AnnotationContext<>(env, annotated, pos, typeAnnotations);
395 T res = makeContainerAnnotation(lb.toList(), ctx, toAnnotate, isTypeParam);
396 if (res != null)
397 buf = buf.prepend(res);
398 }
399 }
400
401 if (typeAnnotations) {
402 @SuppressWarnings("unchecked")
403 List<TypeCompound> attrs = (List<TypeCompound>)buf.reverse();
404 toAnnotate.appendUniqueTypeAttributes(attrs);
405 } else {
406 @SuppressWarnings("unchecked")
407 List<Attribute.Compound> attrs = (List<Attribute.Compound>)buf.reverse();
408 toAnnotate.resetAnnotations();
409 toAnnotate.setDeclarationAttributes(attrs);
410 }
411 }
412 //where:
413 private boolean isAttributeTrue(Attribute attr) {
414 return (attr instanceof Attribute.Constant constant)
415 && constant.type == syms.booleanType
416 && ((Integer) constant.value) != 0;
417 }
418
419 /**
420 * Attribute and store a semantic representation of the annotation tree {@code tree} into the
421 * tree.attribute field.
422 *
423 * @param tree the tree representing an annotation
424 * @param expectedAnnotationType the expected (super)type of the annotation
425 * @param env the current env in where the annotation instance is found
426 */
427 public Attribute.Compound attributeAnnotation(JCAnnotation tree, Type expectedAnnotationType,
428 Env<AttrContext> env)
429 {
430 // The attribute might have been entered if it is Target or Repeatable
431 // Because TreeCopier does not copy type, redo this if type is null
432 if (tree.attribute != null && tree.type != null)
433 return tree.attribute;
434
435 List<Pair<MethodSymbol, Attribute>> elems = attributeAnnotationValues(tree, expectedAnnotationType, env);
436 Attribute.Compound ac = new Attribute.Compound(tree.type, elems);
437
438 return tree.attribute = ac;
439 }
440
441 /** Attribute and store a semantic representation of the type annotation tree {@code tree} into
442 * the tree.attribute field.
443 *
444 * @param a the tree representing an annotation
445 * @param expectedAnnotationType the expected (super)type of the annotation
446 * @param env the current env in where the annotation instance is found
447 */
448 public Attribute.TypeCompound attributeTypeAnnotation(JCAnnotation a, Type expectedAnnotationType,
449 Env<AttrContext> env)
450 {
451 // The attribute might have been entered if it is Target or Repeatable
452 // Because TreeCopier does not copy type, redo this if type is null
453 if (a.attribute == null || a.type == null || !(a.attribute instanceof Attribute.TypeCompound typeCompound)) {
454 // Create a new TypeCompound
455 List<Pair<MethodSymbol,Attribute>> elems =
456 attributeAnnotationValues(a, expectedAnnotationType, env);
457
458 Attribute.TypeCompound tc =
459 new Attribute.TypeCompound(a.type, elems, TypeAnnotationPosition.unknown);
460 a.attribute = tc;
461 return tc;
462 } else {
463 // Use an existing TypeCompound
464 return typeCompound;
465 }
466 }
467
468 /**
469 * Attribute annotation elements creating a list of pairs of the Symbol representing that
470 * element and the value of that element as an Attribute. */
471 private List<Pair<MethodSymbol, Attribute>> attributeAnnotationValues(JCAnnotation a,
472 Type expected, Env<AttrContext> env)
473 {
474 // The annotation might have had its type attributed (but not
475 // checked) by attr.attribAnnotationTypes during MemberEnter,
476 // in which case we do not need to do it again.
477 Type at = (a.annotationType.type != null ?
478 a.annotationType.type : attr.attribType(a.annotationType, env));
479 a.type = chk.checkType(a.annotationType.pos(), at, expected);
480
481 boolean isError = a.type.isErroneous();
482 if (!a.type.tsym.isAnnotationType() && !isError) {
483 log.error(a.annotationType.pos(), Errors.NotAnnotationType(a.type));
484 isError = true;
485 }
486
487 // List of name=value pairs (or implicit "value=" if size 1)
488 List<JCExpression> args = a.args;
489
490 boolean elidedValue = false;
491 // special case: elided "value=" assumed
492 if (args.length() == 1 && !args.head.hasTag(ASSIGN)) {
493 args.head = make.at(args.head.pos).
494 Assign(make.Ident(names.value), args.head);
495 elidedValue = true;
496 }
497
498 ListBuffer<Pair<MethodSymbol,Attribute>> buf = new ListBuffer<>();
499 for (List<JCExpression> tl = args; tl.nonEmpty(); tl = tl.tail) {
500 Pair<MethodSymbol, Attribute> p = attributeAnnotationNameValuePair(tl.head, a.type, isError, env, elidedValue);
501 if (p != null && !p.fst.type.isErroneous())
502 buf.append(p);
503 }
504 return buf.toList();
505 }
506
507 // where
508 private Pair<MethodSymbol, Attribute> attributeAnnotationNameValuePair(JCExpression nameValuePair,
509 Type thisAnnotationType, boolean badAnnotation, Env<AttrContext> env, boolean elidedValue)
510 {
511 if (!nameValuePair.hasTag(ASSIGN)) {
512 log.error(nameValuePair.pos(), Errors.AnnotationValueMustBeNameValue);
513 attributeAnnotationValue(nameValuePair.type = syms.errType, nameValuePair, env);
514 return null;
515 }
516 JCAssign assign = (JCAssign)nameValuePair;
517 if (!assign.lhs.hasTag(IDENT)) {
518 log.error(nameValuePair.pos(), Errors.AnnotationValueMustBeNameValue);
519 attributeAnnotationValue(nameValuePair.type = syms.errType, nameValuePair, env);
520 return null;
521 }
522
523 // Resolve element to MethodSym
524 JCIdent left = (JCIdent)assign.lhs;
525 Symbol method = resolve.resolveQualifiedMethod(elidedValue ? assign.rhs.pos() : left.pos(),
526 env, thisAnnotationType,
527 left.name, List.nil(), null);
528 left.sym = method;
529 left.type = method.type;
530 chk.checkDeprecated(left, env.info.scope.owner, method);
531 if (method.owner != thisAnnotationType.tsym && !badAnnotation)
532 log.error(left.pos(), Errors.NoAnnotationMember(left.name, thisAnnotationType));
533 Type resultType = method.type.getReturnType();
534
535 // Compute value part
536 Attribute value = attributeAnnotationValue(resultType, assign.rhs, env);
537 nameValuePair.type = resultType;
538
539 return method.type.isErroneous() ? null : new Pair<>((MethodSymbol)method, value);
540
541 }
542
543 /** Attribute an annotation element value */
544 private Attribute attributeAnnotationValue(Type expectedElementType, JCExpression tree,
545 Env<AttrContext> env)
546 {
547 //first, try completing the symbol for the annotation value - if a completion
548 //error is thrown, we should recover gracefully, and display an
549 //ordinary resolution diagnostic.
550 try {
551 expectedElementType.tsym.complete();
552 } catch(CompletionFailure e) {
553 log.error(tree.pos(), Errors.CantResolve(Kinds.kindName(e.sym), e.sym.getQualifiedName(), null, null));
554 expectedElementType = syms.errType;
555 }
556
557 if (expectedElementType.hasTag(ARRAY)) {
558 return getAnnotationArrayValue(expectedElementType, tree, env);
559 }
560
561 //error recovery
562 if (tree.hasTag(NEWARRAY)) {
563 if (!expectedElementType.isErroneous())
564 log.error(tree.pos(), Errors.AnnotationValueNotAllowableType);
565 JCNewArray na = (JCNewArray)tree;
566 if (na.elemtype != null) {
567 log.error(na.elemtype.pos(), Errors.NewNotAllowedInAnnotation);
568 }
569 for (List<JCExpression> l = na.elems; l.nonEmpty(); l=l.tail) {
570 attributeAnnotationValue(syms.errType,
571 l.head,
572 env);
573 }
574 return new Attribute.Error(syms.errType);
575 }
576
577 if (expectedElementType.tsym.isAnnotationType()) {
578 if (tree.hasTag(ANNOTATION)) {
579 return attributeAnnotation((JCAnnotation)tree, expectedElementType, env);
580 } else {
581 log.error(tree.pos(), Errors.AnnotationValueMustBeAnnotation);
582 expectedElementType = syms.errType;
583 }
584 }
585
586 //error recovery
587 if (tree.hasTag(ANNOTATION)) {
588 if (!expectedElementType.isErroneous())
589 log.error(tree.pos(), Errors.AnnotationNotValidForType(expectedElementType));
590 attributeAnnotation((JCAnnotation)tree, syms.errType, env);
591 return new Attribute.Error(((JCAnnotation)tree).annotationType.type);
592 }
593
594 MemberEnter.InitTreeVisitor initTreeVisitor = new MemberEnter.InitTreeVisitor() {
595 // the methods below are added to allow class literals on top of constant expressions
596 @Override
597 public void visitTypeIdent(JCPrimitiveTypeTree that) {}
598
599 @Override
600 public void visitTypeArray(JCArrayTypeTree that) {}
601 };
602 tree.accept(initTreeVisitor);
603 if (!initTreeVisitor.result) {
604 log.error(tree.pos(), Errors.ExpressionNotAllowableAsAnnotationValue);
605 return new Attribute.Error(syms.errType);
606 }
607
608 if (expectedElementType.isPrimitive() ||
609 (types.isSameType(expectedElementType, syms.stringType) && !expectedElementType.hasTag(TypeTag.ERROR))) {
610 return getAnnotationPrimitiveValue(expectedElementType, tree, env);
611 }
612
613 if (expectedElementType.tsym == syms.classType.tsym) {
614 return getAnnotationClassValue(expectedElementType, tree, env);
615 }
616
617 if (expectedElementType.hasTag(CLASS) &&
618 (expectedElementType.tsym.flags() & Flags.ENUM) != 0) {
619 return getAnnotationEnumValue(expectedElementType, tree, env);
620 }
621
622 //error recovery:
623 if (!expectedElementType.isErroneous())
624 log.error(tree.pos(), Errors.AnnotationValueNotAllowableType);
625 return new Attribute.Error(attr.attribExpr(tree, env, expectedElementType));
626 }
627
628 private Attribute getAnnotationEnumValue(Type expectedElementType, JCExpression tree, Env<AttrContext> env) {
629 Type result = attr.attribTree(tree, env, annotationValueInfo(expectedElementType));
630 Symbol sym = TreeInfo.symbol(tree);
631 if (sym == null ||
632 TreeInfo.nonstaticSelect(tree) ||
633 sym.kind != VAR ||
634 (sym.flags() & Flags.ENUM) == 0) {
635 log.error(tree.pos(), Errors.EnumAnnotationMustBeEnumConstant);
636 return new Attribute.Error(result.getOriginalType());
637 }
638 VarSymbol enumerator = (VarSymbol) sym;
639 return new Attribute.Enum(expectedElementType, enumerator);
640 }
641
642 private Attribute getAnnotationClassValue(Type expectedElementType, JCExpression tree, Env<AttrContext> env) {
643 Type result = attr.attribTree(tree, env, annotationValueInfo(expectedElementType));
644 if (result.isErroneous()) {
645 // Does it look like an unresolved class literal?
646 if (TreeInfo.name(tree) == names._class &&
647 ((JCFieldAccess) tree).selected.type.isErroneous()) {
648 Name n = (((JCFieldAccess) tree).selected).type.tsym.flatName();
649 return new Attribute.UnresolvedClass(expectedElementType,
650 types.createErrorType(n,
651 syms.unknownSymbol, syms.classType));
652 } else {
653 return new Attribute.Error(result.getOriginalType());
654 }
655 }
656
657 // Class literals look like field accesses of a field named class
658 // at the tree level
659 if (TreeInfo.name(tree) != names._class) {
660 log.error(tree.pos(), Errors.AnnotationValueMustBeClassLiteral);
661 return new Attribute.Error(syms.errType);
662 }
663
664 return new Attribute.Class(types,
665 (((JCFieldAccess) tree).selected).type);
666 }
667
668 private Attribute getAnnotationPrimitiveValue(Type expectedElementType, JCExpression tree, Env<AttrContext> env) {
669 Type result = attr.attribTree(tree, env, annotationValueInfo(expectedElementType));
670 if (result.isErroneous())
671 return new Attribute.Error(result.getOriginalType());
672 if (result.constValue() == null) {
673 log.error(tree.pos(), Errors.AttributeValueMustBeConstant);
674 return new Attribute.Error(expectedElementType);
675 }
676
677 // Scan the annotation element value and then attribute nested annotations if present
678 if (tree.type != null && tree.type.tsym != null) {
679 queueScanTreeAndTypeAnnotate(tree, env, tree.type.tsym, null);
680 }
681
682 result = cfolder.coerce(result, expectedElementType);
683 return new Attribute.Constant(expectedElementType, result.constValue());
684 }
685
686 private Attr.ResultInfo annotationValueInfo(Type pt) {
687 return attr.unknownExprInfo.dup(pt, new AnnotationValueContext(attr.unknownExprInfo.checkContext));
688 }
689
690 class AnnotationValueContext extends Check.NestedCheckContext {
691 AnnotationValueContext(CheckContext enclosingContext) {
692 super(enclosingContext);
693 }
694
695 @Override
696 public boolean compatible(Type found, Type req, Warner warn) {
697 //handle non-final implicitly-typed vars (will be rejected later on)
698 return found.hasTag(TypeTag.NONE) || super.compatible(found, req, warn);
699 }
700 }
701
702 private Attribute getAnnotationArrayValue(Type expectedElementType, JCExpression tree, Env<AttrContext> env) {
703 // Special case, implicit array
704 if (!tree.hasTag(NEWARRAY)) {
705 tree = make.at(tree.pos).
706 NewArray(null, List.nil(), List.of(tree));
707 }
708
709 JCNewArray na = (JCNewArray)tree;
710 List<JCExpression> elems = na.elems;
711 if (na.elemtype != null) {
712 log.error(na.elemtype.pos(), Errors.NewNotAllowedInAnnotation);
713 if (elems == null) {
714 elems = List.nil();
715 }
716 }
717 ListBuffer<Attribute> buf = new ListBuffer<>();
718 for (List<JCExpression> l = elems; l.nonEmpty(); l = l.tail) {
719 buf.append(attributeAnnotationValue(types.elemtype(expectedElementType),
720 l.head,
721 env));
722 }
723 na.type = expectedElementType;
724 return new Attribute.
725 Array(expectedElementType, buf.toArray(new Attribute[buf.length()]));
726 }
727
728 /* *********************************
729 * Support for repeating annotations
730 ***********************************/
731
732 /**
733 * This context contains all the information needed to synthesize new
734 * annotations trees for repeating annotations.
735 */
736 private class AnnotationContext<T extends Attribute.Compound> {
737 public final Env<AttrContext> env;
738 public final Map<Symbol.TypeSymbol, ListBuffer<T>> annotated;
739 public final Map<T, JCDiagnostic.DiagnosticPosition> pos;
740 public final boolean isTypeCompound;
741
742 public AnnotationContext(Env<AttrContext> env,
743 Map<Symbol.TypeSymbol, ListBuffer<T>> annotated,
744 Map<T, JCDiagnostic.DiagnosticPosition> pos,
745 boolean isTypeCompound) {
746 Assert.checkNonNull(env);
747 Assert.checkNonNull(annotated);
748 Assert.checkNonNull(pos);
749
750 this.env = env;
751 this.annotated = annotated;
752 this.pos = pos;
753 this.isTypeCompound = isTypeCompound;
754 }
755 }
756
757 /* Process repeated annotations. This method returns the
758 * synthesized container annotation or null IFF all repeating
759 * annotation are invalid. This method reports errors/warnings.
760 */
761 private <T extends Attribute.Compound> T processRepeatedAnnotations(List<T> annotations,
762 AnnotationContext<T> ctx, Symbol on, boolean isTypeParam)
763 {
764 T firstOccurrence = annotations.head;
765 List<Attribute> repeated = List.nil();
766 Type origAnnoType = null;
767 Type arrayOfOrigAnnoType = null;
768 Type targetContainerType = null;
769 MethodSymbol containerValueSymbol = null;
770
771 Assert.check(!annotations.isEmpty() && !annotations.tail.isEmpty()); // i.e. size() > 1
772
773 int count = 0;
774 for (List<T> al = annotations; !al.isEmpty(); al = al.tail) {
775 count++;
776
777 // There must be more than a single anno in the annotation list
778 Assert.check(count > 1 || !al.tail.isEmpty());
779
780 T currentAnno = al.head;
781
782 origAnnoType = currentAnno.type;
783 if (arrayOfOrigAnnoType == null) {
784 arrayOfOrigAnnoType = types.makeArrayType(origAnnoType);
785 }
786
787 // Only report errors if this isn't the first occurrence I.E. count > 1
788 boolean reportError = count > 1;
789 Type currentContainerType = getContainingType(currentAnno, ctx.pos.get(currentAnno), reportError);
790 if (currentContainerType == null) {
791 continue;
792 }
793 // Assert that the target Container is == for all repeated
794 // annos of the same annotation type, the types should
795 // come from the same Symbol, i.e. be '=='
796 Assert.check(targetContainerType == null || currentContainerType == targetContainerType);
797 targetContainerType = currentContainerType;
798
799 containerValueSymbol = validateContainer(targetContainerType, origAnnoType, ctx.pos.get(currentAnno));
800
801 if (containerValueSymbol == null) { // Check of CA type failed
802 // errors are already reported
803 continue;
804 }
805
806 repeated = repeated.prepend(currentAnno);
807 }
808
809 if (!repeated.isEmpty() && targetContainerType == null) {
810 log.error(ctx.pos.get(annotations.head), Errors.DuplicateAnnotationInvalidRepeated(origAnnoType));
811 return null;
812 }
813
814 if (!repeated.isEmpty()) {
815 repeated = repeated.reverse();
816 DiagnosticPosition pos = ctx.pos.get(firstOccurrence);
817 TreeMaker m = make.at(pos);
818 Pair<MethodSymbol, Attribute> p =
819 new Pair<MethodSymbol, Attribute>(containerValueSymbol,
820 new Attribute.Array(arrayOfOrigAnnoType, repeated));
821 if (ctx.isTypeCompound) {
822 /* TODO: the following code would be cleaner:
823 Attribute.TypeCompound at = new Attribute.TypeCompound(targetContainerType, List.of(p),
824 ((Attribute.TypeCompound)annotations.head).position);
825 JCTypeAnnotation annoTree = m.TypeAnnotation(at);
826 at = attributeTypeAnnotation(annoTree, targetContainerType, ctx.env);
827 */
828 // However, we directly construct the TypeCompound to keep the
829 // direct relation to the contained TypeCompounds.
830 Attribute.TypeCompound at = new Attribute.TypeCompound(targetContainerType, List.of(p),
831 ((Attribute.TypeCompound)annotations.head).position);
832
833 JCAnnotation annoTree = m.TypeAnnotation(at);
834 if (!chk.validateAnnotationDeferErrors(annoTree))
835 log.error(annoTree.pos(), Errors.DuplicateAnnotationInvalidRepeated(origAnnoType));
836
837 if (!chk.isTypeAnnotation(annoTree, isTypeParam)) {
838 log.error(pos, isTypeParam ? Errors.InvalidRepeatableAnnotationNotApplicable(targetContainerType, on)
839 : Errors.InvalidRepeatableAnnotationNotApplicableInContext(targetContainerType));
840 }
841
842 at.setSynthesized(true);
843
844 @SuppressWarnings("unchecked")
845 T x = (T) at;
846 return x;
847 } else {
848 Attribute.Compound c = new Attribute.Compound(targetContainerType, List.of(p));
849 JCAnnotation annoTree = m.Annotation(c);
850
851 boolean isRecordMember = (on.flags_field & Flags.RECORD) != 0 || on.enclClass() != null && on.enclClass().isRecord();
852 /* if it is a record member we will not issue the error now and wait until annotations on records are
853 * checked at Check::validateAnnotation, which will issue it
854 */
855 if (!chk.annotationApplicable(annoTree, on) && (!isRecordMember || isRecordMember && (on.flags_field & Flags.GENERATED_MEMBER) == 0)) {
856 log.error(annoTree.pos(),
857 Errors.InvalidRepeatableAnnotationNotApplicable(targetContainerType, on));
858 }
859
860 if (!chk.validateAnnotationDeferErrors(annoTree))
861 log.error(annoTree.pos(), Errors.DuplicateAnnotationInvalidRepeated(origAnnoType));
862
863 c = attributeAnnotation(annoTree, targetContainerType, ctx.env);
864 c.setSynthesized(true);
865
866 @SuppressWarnings("unchecked")
867 T x = (T) c;
868 return x;
869 }
870 } else {
871 return null; // errors should have been reported elsewhere
872 }
873 }
874
875 /**
876 * Fetches the actual Type that should be the containing annotation.
877 */
878 private Type getContainingType(Attribute.Compound currentAnno,
879 DiagnosticPosition pos,
880 boolean reportError)
881 {
882 Type origAnnoType = currentAnno.type;
883 TypeSymbol origAnnoDecl = origAnnoType.tsym;
884
885 // Fetch the Repeatable annotation from the current
886 // annotation's declaration, or null if it has none
887 Attribute.Compound ca = origAnnoDecl.getAnnotationTypeMetadata().getRepeatable();
888 if (ca == null) { // has no Repeatable annotation
889 if (reportError)
890 log.error(pos, Errors.DuplicateAnnotationMissingContainer(origAnnoType));
891 return null;
892 }
893
894 return filterSame(extractContainingType(ca, pos, origAnnoDecl),
895 origAnnoType);
896 }
897
898 // returns null if t is same as 's', returns 't' otherwise
899 private Type filterSame(Type t, Type s) {
900 if (t == null || s == null) {
901 return t;
902 }
903
904 return types.isSameType(t, s) ? null : t;
905 }
906
907 /** Extract the actual Type to be used for a containing annotation. */
908 private Type extractContainingType(Attribute.Compound ca,
909 DiagnosticPosition pos,
910 TypeSymbol annoDecl)
911 {
912 // The next three checks check that the Repeatable annotation
913 // on the declaration of the annotation type that is repeating is
914 // valid.
915
916 // Repeatable must have at least one element
917 if (ca.values.isEmpty()) {
918 log.error(pos, Errors.InvalidRepeatableAnnotation(annoDecl));
919 return null;
920 }
921 Pair<MethodSymbol,Attribute> p = ca.values.head;
922 Name name = p.fst.name;
923 if (name != names.value) { // should contain only one element, named "value"
924 log.error(pos, Errors.InvalidRepeatableAnnotation(annoDecl));
925 return null;
926 }
927 if (!(p.snd instanceof Attribute.Class attributeClass)) { // check that the value of "value" is an Attribute.Class
928 log.error(pos, Errors.InvalidRepeatableAnnotation(annoDecl));
929 return null;
930 }
931
932 return attributeClass.getValue();
933 }
934
935 /* Validate that the suggested targetContainerType Type is a valid
936 * container type for repeated instances of originalAnnoType
937 * annotations. Return null and report errors if this is not the
938 * case, return the MethodSymbol of the value element in
939 * targetContainerType if it is suitable (this is needed to
940 * synthesize the container). */
941 private MethodSymbol validateContainer(Type targetContainerType,
942 Type originalAnnoType,
943 DiagnosticPosition pos) {
944 MethodSymbol containerValueSymbol = null;
945 boolean fatalError = false;
946
947 // Validate that there is a (and only 1) value method
948 Scope scope = null;
949 try {
950 scope = targetContainerType.tsym.members();
951 } catch (CompletionFailure ex) {
952 chk.completionError(pos, ex);
953 return null;
954 }
955 int nr_value_elems = 0;
956 boolean error = false;
957 for(Symbol elm : scope.getSymbolsByName(names.value)) {
958 nr_value_elems++;
959
960 if (nr_value_elems == 1 &&
961 elm.kind == MTH) {
962 containerValueSymbol = (MethodSymbol)elm;
963 } else {
964 error = true;
965 }
966 }
967 if (error) {
968 log.error(pos,
969 Errors.InvalidRepeatableAnnotationMultipleValues(targetContainerType,
970 nr_value_elems));
971 return null;
972 } else if (nr_value_elems == 0) {
973 log.error(pos,
974 Errors.InvalidRepeatableAnnotationNoValue(targetContainerType));
975 return null;
976 }
977
978 // validate that the 'value' element is a method
979 // probably "impossible" to fail this
980 if (containerValueSymbol.kind != MTH) {
981 log.error(pos,
982 Errors.InvalidRepeatableAnnotationInvalidValue(targetContainerType));
983 fatalError = true;
984 }
985
986 // validate that the 'value' element has the correct return type
987 // i.e. array of original anno
988 Type valueRetType = containerValueSymbol.type.getReturnType();
989 Type expectedType = types.makeArrayType(originalAnnoType);
990 if (!(types.isArray(valueRetType) &&
991 types.isSameType(expectedType, valueRetType))) {
992 log.error(pos,
993 Errors.InvalidRepeatableAnnotationValueReturn(targetContainerType,
994 valueRetType,
995 expectedType));
996 fatalError = true;
997 }
998
999 return fatalError ? null : containerValueSymbol;
1000 }
1001
1002 private <T extends Attribute.Compound> T makeContainerAnnotation(List<T> toBeReplaced,
1003 AnnotationContext<T> ctx, Symbol sym, boolean isTypeParam)
1004 {
1005 // Process repeated annotations
1006 T validRepeated =
1007 processRepeatedAnnotations(toBeReplaced, ctx, sym, isTypeParam);
1008
1009 if (validRepeated != null) {
1010 // Check that the container isn't manually
1011 // present along with repeated instances of
1012 // its contained annotation.
1013 ListBuffer<T> manualContainer = ctx.annotated.get(validRepeated.type.tsym);
1014 if (manualContainer != null) {
1015 log.error(ctx.pos.get(manualContainer.first()),
1016 Errors.InvalidRepeatableAnnotationRepeatedAndContainerPresent(manualContainer.first().type.tsym));
1017 }
1018 }
1019
1020 // A null return will delete the Placeholder
1021 return validRepeated;
1022 }
1023
1024 /* ******************
1025 * Type annotations *
1026 ********************/
1027
1028 /**
1029 * Attribute the list of annotations and enter them onto s.
1030 */
1031 public void enterTypeAnnotations(List<JCAnnotation> annotations, Env<AttrContext> env,
1032 Symbol s, JCTree deferDecl, boolean isTypeParam)
1033 {
1034 Assert.checkNonNull(s, "Symbol argument to actualEnterTypeAnnotations is nul/");
1035 JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
1036
1037 if (deferDecl != null) {
1038 deferredLintHandler.push(deferDecl);
1039 }
1040 try {
1041 annotateNow(s, annotations, env, true, isTypeParam);
1042 } finally {
1043 if (deferDecl != null)
1044 deferredLintHandler.pop();
1045 log.useSource(prev);
1046 }
1047 }
1048
1049 /**
1050 * Enqueue tree for scanning of type annotations, attaching to the Symbol sym.
1051 */
1052 public void queueScanTreeAndTypeAnnotate(JCTree tree, Env<AttrContext> env, Symbol sym, JCTree deferDecl)
1053 {
1054 Assert.checkNonNull(sym);
1055 normal(() -> tree.accept(new TypeAnnotate(env, sym, deferDecl)));
1056 }
1057
1058 /**
1059 * Apply the annotations to the particular type.
1060 */
1061 public void annotateTypeSecondStage(JCTree tree, List<JCAnnotation> annotations, Type storeAt) {
1062 typeAnnotation(() -> {
1063 List<Attribute.TypeCompound> compounds = fromAnnotations(annotations);
1064 Assert.check(annotations.size() == compounds.size());
1065 // the type already has annotation metadata, but it's empty
1066 Annotations metadata = storeAt.getMetadata(Annotations.class);
1067 Assert.checkNonNull(metadata);
1068 Assert.check(metadata.annotationBuffer().isEmpty());
1069 metadata.annotationBuffer().appendList(compounds);
1070 });
1071 }
1072
1073 /**
1074 * Apply the annotations to the particular type.
1075 */
1076 public void annotateTypeParameterSecondStage(JCTree tree, List<JCAnnotation> annotations) {
1077 typeAnnotation(() -> {
1078 List<Attribute.TypeCompound> compounds = fromAnnotations(annotations);
1079 Assert.check(annotations.size() == compounds.size());
1080 });
1081 }
1082
1083 /**
1084 * We need to use a TreeScanner, because it is not enough to visit the top-level
1085 * annotations. We also need to visit type arguments, etc.
1086 */
1087 private class TypeAnnotate extends TreeScanner {
1088 private final Env<AttrContext> env;
1089 private final Symbol sym;
1090 private JCTree deferDecl;
1091
1092 public TypeAnnotate(Env<AttrContext> env, Symbol sym, JCTree deferDecl) {
1093
1094 this.env = env;
1095 this.sym = sym;
1096 this.deferDecl = deferDecl;
1097 }
1098
1099 @Override
1100 public void visitAnnotatedType(JCAnnotatedType tree) {
1101 enterTypeAnnotations(tree.annotations, env, sym, deferDecl, false);
1102 scan(tree.underlyingType);
1103 }
1104
1105 @Override
1106 public void visitTypeParameter(JCTypeParameter tree) {
1107 enterTypeAnnotations(tree.annotations, env, sym, deferDecl, true);
1108 scan(tree.bounds);
1109 }
1110
1111 @Override
1112 public void visitNewArray(JCNewArray tree) {
1113 enterTypeAnnotations(tree.annotations, env, sym, deferDecl, false);
1114 for (List<JCAnnotation> dimAnnos : tree.dimAnnotations)
1115 enterTypeAnnotations(dimAnnos, env, sym, deferDecl, false);
1116 scan(tree.elemtype);
1117 scan(tree.elems);
1118 }
1119
1120 @Override
1121 public void visitMethodDef(JCMethodDecl tree) {
1122 scan(tree.mods);
1123 scan(tree.restype);
1124 scan(tree.typarams);
1125 scan(tree.recvparam);
1126 scan(tree.params);
1127 scan(tree.thrown);
1128 scan(tree.defaultValue);
1129 // Do not annotate the body, just the signature.
1130 }
1131
1132 @Override
1133 public void visitVarDef(JCVariableDecl tree) {
1134 JCTree prevDecl = deferDecl;
1135 deferDecl = tree;
1136 try {
1137 if (sym != null && sym.kind == VAR) {
1138 // Don't visit a parameter once when the sym is the method
1139 // and once when the sym is the parameter.
1140 scan(tree.mods);
1141 scan(tree.vartype);
1142 }
1143 scan(tree.init);
1144 } finally {
1145 deferDecl = prevDecl;
1146 }
1147 }
1148
1149 @Override
1150 public void visitBindingPattern(JCTree.JCBindingPattern tree) {
1151 //type binding pattern's type will be annotated separately, avoid
1152 //adding its annotations into the owning method here (would clash
1153 //with repeatable annotations).
1154 }
1155
1156 @Override
1157 public void visitClassDef(JCClassDecl tree) {
1158 // We can only hit a classdef if it is declared within
1159 // a method. Ignore it - the class will be visited
1160 // separately later.
1161 }
1162
1163 @Override
1164 public void visitNewClass(JCNewClass tree) {
1165 scan(tree.encl);
1166 scan(tree.typeargs);
1167 if (tree.def == null) {
1168 scan(tree.clazz);
1169 }
1170 scan(tree.args);
1171 // the anonymous class instantiation if any will be visited separately.
1172 }
1173
1174 @Override
1175 public void visitErroneous(JCErroneous tree) {
1176 if (tree.errs != null) {
1177 for (JCTree err : tree.errs) {
1178 scan(err);
1179 }
1180 }
1181 }
1182 }
1183
1184 /* *******************
1185 * Completer support *
1186 *********************/
1187
1188 private AnnotationTypeCompleter theSourceCompleter = new AnnotationTypeCompleter() {
1189 @Override
1190 public void complete(ClassSymbol sym) throws CompletionFailure {
1191 Env<AttrContext> context = typeEnvs.get(sym);
1192 Annotate.this.attributeAnnotationType(context);
1193 }
1194 };
1195
1196 /* Last stage completer to enter just enough annotations to have a prototype annotation type.
1197 * This currently means entering @Target and @Repeatable.
1198 */
1199 public AnnotationTypeCompleter annotationTypeSourceCompleter() {
1200 return theSourceCompleter;
1201 }
1202
1203 private void attributeAnnotationType(Env<AttrContext> env) {
1204 Assert.check(((JCClassDecl)env.tree).sym.isAnnotationType(),
1205 "Trying to annotation type complete a non-annotation type");
1206
1207 JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
1208 try {
1209 JCClassDecl tree = (JCClassDecl)env.tree;
1210 AnnotationTypeVisitor v = new AnnotationTypeVisitor(attr, chk, syms, typeEnvs);
1211 v.scanAnnotationType(tree);
1212 tree.sym.getAnnotationTypeMetadata().setRepeatable(v.repeatable);
1213 tree.sym.getAnnotationTypeMetadata().setTarget(v.target);
1214 } finally {
1215 log.useSource(prev);
1216 }
1217 }
1218
1219 public Attribute unfinishedDefaultValue() {
1220 return theUnfinishedDefaultValue;
1221 }
1222
1223 public static interface AnnotationTypeCompleter {
1224 void complete(ClassSymbol sym) throws CompletionFailure;
1225 }
1226
1227 /** Visitor to determine a prototype annotation type for a class declaring an annotation type.
1228 *
1229 * <p><b>This is NOT part of any supported API.
1230 * If you write code that depends on this, you do so at your own risk.
1231 * This code and its internal interfaces are subject to change or
1232 * deletion without notice.</b>
1233 */
1234 public class AnnotationTypeVisitor extends TreeScanner {
1235 private Env<AttrContext> env;
1236
1237 private final Attr attr;
1238 private final Check check;
1239 private final Symtab tab;
1240 private final TypeEnvs typeEnvs;
1241
1242 private Compound target;
1243 private Compound repeatable;
1244
1245 public AnnotationTypeVisitor(Attr attr, Check check, Symtab tab, TypeEnvs typeEnvs) {
1246 this.attr = attr;
1247 this.check = check;
1248 this.tab = tab;
1249 this.typeEnvs = typeEnvs;
1250 }
1251
1252 public Compound getRepeatable() {
1253 return repeatable;
1254 }
1255
1256 public Compound getTarget() {
1257 return target;
1258 }
1259
1260 public void scanAnnotationType(JCClassDecl decl) {
1261 visitClassDef(decl);
1262 }
1263
1264 @Override
1265 public void visitClassDef(JCClassDecl tree) {
1266 Env<AttrContext> prevEnv = env;
1267 env = typeEnvs.get(tree.sym);
1268 try {
1269 scan(tree.mods); // look for repeatable and target
1270 // don't descend into body
1271 } finally {
1272 env = prevEnv;
1273 }
1274 }
1275
1276 @Override
1277 public void visitAnnotation(JCAnnotation tree) {
1278 Type t = tree.annotationType.type;
1279 if (t == null) {
1280 t = attr.attribType(tree.annotationType, env);
1281 tree.annotationType.type = t = check.checkType(tree.annotationType.pos(), t, tab.annotationType);
1282 }
1283
1284 if (t == tab.annotationTargetType) {
1285 target = Annotate.this.attributeAnnotation(tree, tab.annotationTargetType, env);
1286 } else if (t == tab.repeatableType) {
1287 repeatable = Annotate.this.attributeAnnotation(tree, tab.repeatableType, env);
1288 }
1289 }
1290 }
1291
1292 /** Represents the semantics of an Annotation Type.
1293 *
1294 * <p><b>This is NOT part of any supported API.
1295 * If you write code that depends on this, you do so at your own risk.
1296 * This code and its internal interfaces are subject to change or
1297 * deletion without notice.</b>
1298 */
1299 public static class AnnotationTypeMetadata {
1300 final ClassSymbol metaDataFor;
1301 private Compound target;
1302 private Compound repeatable;
1303 private AnnotationTypeCompleter annotationTypeCompleter;
1304
1305 public AnnotationTypeMetadata(ClassSymbol metaDataFor, AnnotationTypeCompleter annotationTypeCompleter) {
1306 this.metaDataFor = metaDataFor;
1307 this.annotationTypeCompleter = annotationTypeCompleter;
1308 }
1309
1310 private void init() {
1311 // Make sure metaDataFor is member entered
1312 while (!metaDataFor.isCompleted())
1313 metaDataFor.complete();
1314
1315 if (annotationTypeCompleter != null) {
1316 AnnotationTypeCompleter c = annotationTypeCompleter;
1317 annotationTypeCompleter = null;
1318 c.complete(metaDataFor);
1319 }
1320 }
1321
1322 public void complete() {
1323 init();
1324 }
1325
1326 public Compound getRepeatable() {
1327 init();
1328 return repeatable;
1329 }
1330
1331 public void setRepeatable(Compound repeatable) {
1332 Assert.checkNull(this.repeatable);
1333 this.repeatable = repeatable;
1334 }
1335
1336 public Compound getTarget() {
1337 init();
1338 return target;
1339 }
1340
1341 public void setTarget(Compound target) {
1342 Assert.checkNull(this.target);
1343 this.target = target;
1344 }
1345
1346 public Set<MethodSymbol> getAnnotationElements() {
1347 init();
1348 Set<MethodSymbol> members = new LinkedHashSet<>();
1349 WriteableScope s = metaDataFor.members();
1350 Iterable<Symbol> ss = s.getSymbols(NON_RECURSIVE);
1351 for (Symbol sym : ss)
1352 if (sym.kind == MTH &&
1353 sym.name != sym.name.table.names.clinit &&
1354 (sym.flags() & SYNTHETIC) == 0)
1355 members.add((MethodSymbol)sym);
1356 return members;
1357 }
1358
1359 public Set<MethodSymbol> getAnnotationElementsWithDefault() {
1360 init();
1361 Set<MethodSymbol> members = getAnnotationElements();
1362 Set<MethodSymbol> res = new LinkedHashSet<>();
1363 for (MethodSymbol m : members)
1364 if (m.defaultValue != null)
1365 res.add(m);
1366 return res;
1367 }
1368
1369 @Override
1370 public String toString() {
1371 return "Annotation type for: " + metaDataFor;
1372 }
1373
1374 public boolean isMetadataForAnnotationType() { return true; }
1375
1376 public static AnnotationTypeMetadata notAnAnnotationType() {
1377 return NOT_AN_ANNOTATION_TYPE;
1378 }
1379
1380 private static final AnnotationTypeMetadata NOT_AN_ANNOTATION_TYPE =
1381 new AnnotationTypeMetadata(null, null) {
1382 @Override
1383 public void complete() {
1384 } // do nothing
1385
1386 @Override
1387 public String toString() {
1388 return "Not an annotation type";
1389 }
1390
1391 @Override
1392 public Set<MethodSymbol> getAnnotationElements() {
1393 return new LinkedHashSet<>(0);
1394 }
1395
1396 @Override
1397 public Set<MethodSymbol> getAnnotationElementsWithDefault() {
1398 return new LinkedHashSet<>(0);
1399 }
1400
1401 @Override
1402 public boolean isMetadataForAnnotationType() {
1403 return false;
1404 }
1405
1406 @Override
1407 public Compound getTarget() {
1408 return null;
1409 }
1410
1411 @Override
1412 public Compound getRepeatable() {
1413 return null;
1414 }
1415 };
1416 }
1417
1418 public void newRound() {
1419 blockCount = 1;
1420 }
1421
1422 public Queues setQueues(Queues nue) {
1423 Queues stored = new Queues(q, validateQ, typesQ, afterTypesQ);
1424 this.q = nue.q;
1425 this.typesQ = nue.typesQ;
1426 this.afterTypesQ = nue.afterTypesQ;
1427 this.validateQ = nue.validateQ;
1428 return stored;
1429 }
1430
1431 static class Queues {
1432 private final ListBuffer<Runnable> q;
1433 private final ListBuffer<Runnable> validateQ;
1434 private final ListBuffer<Runnable> typesQ;
1435 private final ListBuffer<Runnable> afterTypesQ;
1436
1437 public Queues() {
1438 this(new ListBuffer<Runnable>(), new ListBuffer<Runnable>(), new ListBuffer<Runnable>(), new ListBuffer<Runnable>());
1439 }
1440
1441 public Queues(ListBuffer<Runnable> q, ListBuffer<Runnable> validateQ, ListBuffer<Runnable> typesQ, ListBuffer<Runnable> afterTypesQ) {
1442 this.q = q;
1443 this.validateQ = validateQ;
1444 this.typesQ = typesQ;
1445 this.afterTypesQ = afterTypesQ;
1446 }
1447 }
1448 }