1 /*
2 * Copyright (c) 1999, 2017, 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.code;
27
28 import java.lang.annotation.Annotation;
29 import java.lang.annotation.Inherited;
30 import java.util.Collections;
31 import java.util.EnumSet;
32 import java.util.Map;
33 import java.util.Set;
34 import java.util.concurrent.Callable;
35
36 import javax.lang.model.element.Element;
37 import javax.lang.model.element.ElementKind;
38 import javax.lang.model.element.ElementVisitor;
39 import javax.lang.model.element.ExecutableElement;
40 import javax.lang.model.element.Modifier;
41 import javax.lang.model.element.ModuleElement;
42 import javax.lang.model.element.NestingKind;
43 import javax.lang.model.element.PackageElement;
44 import javax.lang.model.element.TypeElement;
45 import javax.lang.model.element.TypeParameterElement;
46 import javax.lang.model.element.VariableElement;
47 import javax.tools.JavaFileManager;
48 import javax.tools.JavaFileObject;
49
50 import com.sun.tools.javac.code.ClassFinder.BadEnclosingMethodAttr;
51 import com.sun.tools.javac.code.Directive.RequiresFlag;
52 import com.sun.tools.javac.code.Kinds.Kind;
53 import com.sun.tools.javac.comp.Annotate.AnnotationTypeMetadata;
54 import com.sun.tools.javac.code.Scope.WriteableScope;
55 import com.sun.tools.javac.code.Type.*;
56 import com.sun.tools.javac.comp.Attr;
57 import com.sun.tools.javac.comp.AttrContext;
58 import com.sun.tools.javac.comp.Env;
59 import com.sun.tools.javac.jvm.*;
60 import com.sun.tools.javac.tree.JCTree.JCFieldAccess;
61 import com.sun.tools.javac.tree.JCTree.JCVariableDecl;
62 import com.sun.tools.javac.tree.JCTree.Tag;
63 import com.sun.tools.javac.util.*;
64 import com.sun.tools.javac.util.DefinedBy.Api;
65 import com.sun.tools.javac.util.Name;
66
67 import static com.sun.tools.javac.code.Flags.*;
68 import static com.sun.tools.javac.code.Kinds.*;
69 import static com.sun.tools.javac.code.Kinds.Kind.*;
70 import static com.sun.tools.javac.code.Scope.LookupKind.NON_RECURSIVE;
71 import static com.sun.tools.javac.code.Symbol.OperatorSymbol.AccessCode.FIRSTASGOP;
72 import static com.sun.tools.javac.code.TypeTag.CLASS;
73 import static com.sun.tools.javac.code.TypeTag.FORALL;
74 import static com.sun.tools.javac.code.TypeTag.TYPEVAR;
75 import static com.sun.tools.javac.jvm.ByteCodes.iadd;
76 import static com.sun.tools.javac.jvm.ByteCodes.ishll;
77 import static com.sun.tools.javac.jvm.ByteCodes.lushrl;
78 import static com.sun.tools.javac.jvm.ByteCodes.lxor;
79 import static com.sun.tools.javac.jvm.ByteCodes.string_add;
80
81 /** Root class for Java symbols. It contains subclasses
82 * for specific sorts of symbols, such as variables, methods and operators,
83 * types, packages. Each subclass is represented as a static inner class
84 * inside Symbol.
85 *
86 * <p><b>This is NOT part of any supported API.
87 * If you write code that depends on this, you do so at your own risk.
88 * This code and its internal interfaces are subject to change or
89 * deletion without notice.</b>
90 */
91 public abstract class Symbol extends AnnoConstruct implements Element {
92
93 /** The kind of this symbol.
94 * @see Kinds
95 */
96 public Kind kind;
97
98 /** The flags of this symbol.
99 */
100 public long flags_field;
101
102 /** An accessor method for the flags of this symbol.
103 * Flags of class symbols should be accessed through the accessor
104 * method to make sure that the class symbol is loaded.
105 */
106 public long flags() { return flags_field; }
107
108 /** The name of this symbol in Utf8 representation.
109 */
110 public Name name;
111
112 /** The type of this symbol.
113 */
114 public Type type;
115
116 /** The owner of this symbol.
117 */
118 public Symbol owner;
119
120 /** The completer of this symbol.
121 * This should never equal null (NULL_COMPLETER should be used instead).
122 */
123 public Completer completer;
124
125 /** A cache for the type erasure of this symbol.
126 */
127 public Type erasure_field;
128
129 // <editor-fold defaultstate="collapsed" desc="annotations">
130
131 /** The attributes of this symbol are contained in this
132 * SymbolMetadata. The SymbolMetadata instance is NOT immutable.
133 */
134 protected SymbolMetadata metadata;
135
136
137 /** An accessor method for the attributes of this symbol.
138 * Attributes of class symbols should be accessed through the accessor
139 * method to make sure that the class symbol is loaded.
140 */
141 public List<Attribute.Compound> getRawAttributes() {
142 return (metadata == null)
143 ? List.nil()
144 : metadata.getDeclarationAttributes();
145 }
146
147 /** An accessor method for the type attributes of this symbol.
148 * Attributes of class symbols should be accessed through the accessor
149 * method to make sure that the class symbol is loaded.
150 */
151 public List<Attribute.TypeCompound> getRawTypeAttributes() {
152 return (metadata == null)
153 ? List.nil()
154 : metadata.getTypeAttributes();
155 }
156
157 /** Fetch a particular annotation from a symbol. */
158 public Attribute.Compound attribute(Symbol anno) {
159 for (Attribute.Compound a : getRawAttributes()) {
160 if (a.type.tsym == anno) return a;
161 }
162 return null;
163 }
164
165 public boolean annotationsPendingCompletion() {
166 return metadata == null ? false : metadata.pendingCompletion();
167 }
168
169 public void appendAttributes(List<Attribute.Compound> l) {
170 if (l.nonEmpty()) {
171 initedMetadata().append(l);
172 }
173 }
174
175 public void appendClassInitTypeAttributes(List<Attribute.TypeCompound> l) {
176 if (l.nonEmpty()) {
177 initedMetadata().appendClassInitTypeAttributes(l);
178 }
179 }
180
181 public void appendInitTypeAttributes(List<Attribute.TypeCompound> l) {
182 if (l.nonEmpty()) {
183 initedMetadata().appendInitTypeAttributes(l);
184 }
185 }
186
187 public void appendUniqueTypeAttributes(List<Attribute.TypeCompound> l) {
188 if (l.nonEmpty()) {
189 initedMetadata().appendUniqueTypes(l);
190 }
191 }
192
193 public List<Attribute.TypeCompound> getClassInitTypeAttributes() {
194 return (metadata == null)
195 ? List.nil()
196 : metadata.getClassInitTypeAttributes();
197 }
198
199 public List<Attribute.TypeCompound> getInitTypeAttributes() {
200 return (metadata == null)
201 ? List.nil()
202 : metadata.getInitTypeAttributes();
203 }
204
205 public void setInitTypeAttributes(List<Attribute.TypeCompound> l) {
206 initedMetadata().setInitTypeAttributes(l);
207 }
208
209 public void setClassInitTypeAttributes(List<Attribute.TypeCompound> l) {
210 initedMetadata().setClassInitTypeAttributes(l);
211 }
212
213 public List<Attribute.Compound> getDeclarationAttributes() {
214 return (metadata == null)
215 ? List.nil()
216 : metadata.getDeclarationAttributes();
217 }
218
219 public boolean hasAnnotations() {
220 return (metadata != null && !metadata.isEmpty());
221 }
222
223 public boolean hasTypeAnnotations() {
224 return (metadata != null && !metadata.isTypesEmpty());
225 }
226
227 public boolean isCompleted() {
228 return completer.isTerminal();
229 }
230
231 public void prependAttributes(List<Attribute.Compound> l) {
232 if (l.nonEmpty()) {
233 initedMetadata().prepend(l);
234 }
235 }
236
237 public void resetAnnotations() {
238 initedMetadata().reset();
239 }
240
241 public void setAttributes(Symbol other) {
242 if (metadata != null || other.metadata != null) {
243 initedMetadata().setAttributes(other.metadata);
244 }
245 }
246
247 public void setDeclarationAttributes(List<Attribute.Compound> a) {
248 if (metadata != null || a.nonEmpty()) {
249 initedMetadata().setDeclarationAttributes(a);
250 }
251 }
252
253 public void setTypeAttributes(List<Attribute.TypeCompound> a) {
254 if (metadata != null || a.nonEmpty()) {
255 if (metadata == null)
256 metadata = new SymbolMetadata(this);
257 metadata.setTypeAttributes(a);
258 }
259 }
260
261 private SymbolMetadata initedMetadata() {
262 if (metadata == null)
263 metadata = new SymbolMetadata(this);
264 return metadata;
265 }
266
267 /** This method is intended for debugging only. */
268 public SymbolMetadata getMetadata() {
269 return metadata;
270 }
271
272 // </editor-fold>
273
274 /** Construct a symbol with given kind, flags, name, type and owner.
275 */
276 public Symbol(Kind kind, long flags, Name name, Type type, Symbol owner) {
277 this.kind = kind;
278 this.flags_field = flags;
279 this.type = type;
280 this.owner = owner;
281 this.completer = Completer.NULL_COMPLETER;
282 this.erasure_field = null;
283 this.name = name;
284 }
285
286 /** Clone this symbol with new owner.
287 * Legal only for fields and methods.
288 */
289 public Symbol clone(Symbol newOwner) {
290 throw new AssertionError();
291 }
292
293 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
294 return v.visitSymbol(this, p);
295 }
296
297 /** The Java source which this symbol represents.
298 * A description of this symbol; overrides Object.
299 */
300 public String toString() {
301 return name.toString();
302 }
303
304 /** A Java source description of the location of this symbol; used for
305 * error reporting.
306 *
307 * @return null if the symbol is a package or a toplevel class defined in
308 * the default package; otherwise, the owner symbol is returned
309 */
310 public Symbol location() {
311 if (owner.name == null || (owner.name.isEmpty() &&
312 (owner.flags() & BLOCK) == 0 &&
313 owner.kind != PCK &&
314 owner.kind != TYP)) {
315 return null;
316 }
317 return owner;
318 }
319
320 public Symbol location(Type site, Types types) {
321 if (owner.name == null || owner.name.isEmpty()) {
322 return location();
323 }
324 if (owner.type.hasTag(CLASS)) {
325 Type ownertype = types.asOuterSuper(site, owner);
326 if (ownertype != null) return ownertype.tsym;
327 }
328 return owner;
329 }
330
331 public Symbol baseSymbol() {
332 return this;
333 }
334
335 /** The symbol's erased type.
336 */
337 public Type erasure(Types types) {
338 if (erasure_field == null)
339 erasure_field = types.erasure(type);
340 return erasure_field;
341 }
342
343 /** The external type of a symbol. This is the symbol's erased type
344 * except for constructors of inner classes which get the enclosing
345 * instance class added as first argument.
346 */
347 public Type externalType(Types types) {
348 Type t = erasure(types);
349 if (name == name.table.names.init && owner.hasOuterInstance()) {
350 Type outerThisType = types.erasure(owner.type.getEnclosingType());
351 return new MethodType(t.getParameterTypes().prepend(outerThisType),
352 t.getReturnType(),
353 t.getThrownTypes(),
354 t.tsym);
355 } else {
356 return t;
357 }
358 }
359
360 public boolean isDeprecated() {
361 return (flags_field & DEPRECATED) != 0;
362 }
363
364 public boolean hasDeprecatedAnnotation() {
365 return (flags_field & DEPRECATED_ANNOTATION) != 0;
366 }
367
368 public boolean isDeprecatedForRemoval() {
369 return (flags_field & DEPRECATED_REMOVAL) != 0;
370 }
371
372 public boolean isDeprecatableViaAnnotation() {
373 switch (getKind()) {
374 case LOCAL_VARIABLE:
375 case PACKAGE:
376 case PARAMETER:
377 case RESOURCE_VARIABLE:
378 case EXCEPTION_PARAMETER:
379 return false;
380 default:
381 return true;
382 }
383 }
384
385 public boolean isStatic() {
386 return
387 (flags() & STATIC) != 0 ||
388 (owner.flags() & INTERFACE) != 0 && kind != MTH &&
389 name != name.table.names._this;
390 }
391
392 public boolean isInterface() {
393 return (flags() & INTERFACE) != 0;
394 }
395
396 public boolean isPrivate() {
397 return (flags_field & Flags.AccessFlags) == PRIVATE;
398 }
399
400 public boolean isEnum() {
401 return (flags() & ENUM) != 0;
402 }
403
404 /** Is this symbol declared (directly or indirectly) local
405 * to a method or variable initializer?
406 * Also includes fields of inner classes which are in
407 * turn local to a method or variable initializer.
408 */
409 public boolean isLocal() {
410 return
411 (owner.kind.matches(KindSelector.VAL_MTH) ||
412 (owner.kind == TYP && owner.isLocal()));
413 }
414
415 /** Has this symbol an empty name? This includes anonymous
416 * inner classes.
417 */
418 public boolean isAnonymous() {
419 return name.isEmpty();
420 }
421
422 /** Is this symbol a constructor?
423 */
424 public boolean isConstructor() {
425 return name == name.table.names.init;
426 }
427
428 /** The fully qualified name of this symbol.
429 * This is the same as the symbol's name except for class symbols,
430 * which are handled separately.
431 */
432 public Name getQualifiedName() {
433 return name;
434 }
435
436 /** The fully qualified name of this symbol after converting to flat
437 * representation. This is the same as the symbol's name except for
438 * class symbols, which are handled separately.
439 */
440 public Name flatName() {
441 return getQualifiedName();
442 }
443
444 /** If this is a class or package, its members, otherwise null.
445 */
446 public WriteableScope members() {
447 return null;
448 }
449
450 /** A class is an inner class if it it has an enclosing instance class.
451 */
452 public boolean isInner() {
453 return kind == TYP && type.getEnclosingType().hasTag(CLASS);
454 }
455
456 /** An inner class has an outer instance if it is not an interface
457 * it has an enclosing instance class which might be referenced from the class.
458 * Nested classes can see instance members of their enclosing class.
459 * Their constructors carry an additional this$n parameter, inserted
460 * implicitly by the compiler.
461 *
462 * @see #isInner
463 */
464 public boolean hasOuterInstance() {
465 return
466 type.getEnclosingType().hasTag(CLASS) && (flags() & (INTERFACE | NOOUTERTHIS)) == 0;
467 }
468
469 /** The closest enclosing class of this symbol's declaration.
470 * Warning: this (misnamed) method returns the receiver itself
471 * when the receiver is a class (as opposed to its enclosing
472 * class as one may be misled to believe.)
473 */
474 public ClassSymbol enclClass() {
475 Symbol c = this;
476 while (c != null &&
477 (!c.kind.matches(KindSelector.TYP) || !c.type.hasTag(CLASS))) {
478 c = c.owner;
479 }
480 return (ClassSymbol)c;
481 }
482
483 /** The outermost class which indirectly owns this symbol.
484 */
485 public ClassSymbol outermostClass() {
486 Symbol sym = this;
487 Symbol prev = null;
488 while (sym.kind != PCK) {
489 prev = sym;
490 sym = sym.owner;
491 }
492 return (ClassSymbol) prev;
493 }
494
495 /** The package which indirectly owns this symbol.
496 */
497 public PackageSymbol packge() {
498 Symbol sym = this;
499 while (sym.kind != PCK) {
500 sym = sym.owner;
501 }
502 return (PackageSymbol) sym;
503 }
504
505 /** Is this symbol a subclass of `base'? Only defined for ClassSymbols.
506 */
507 public boolean isSubClass(Symbol base, Types types) {
508 throw new AssertionError("isSubClass " + this);
509 }
510
511 /** Fully check membership: hierarchy, protection, and hiding.
512 * Does not exclude methods not inherited due to overriding.
513 */
514 public boolean isMemberOf(TypeSymbol clazz, Types types) {
515 return
516 owner == clazz ||
517 clazz.isSubClass(owner, types) &&
518 isInheritedIn(clazz, types) &&
519 !hiddenIn((ClassSymbol)clazz, types);
520 }
521
522 /** Is this symbol the same as or enclosed by the given class? */
523 public boolean isEnclosedBy(ClassSymbol clazz) {
524 for (Symbol sym = this; sym.kind != PCK; sym = sym.owner)
525 if (sym == clazz) return true;
526 return false;
527 }
528
529 private boolean hiddenIn(ClassSymbol clazz, Types types) {
530 Symbol sym = hiddenInInternal(clazz, types);
531 Assert.check(sym != null, "the result of hiddenInInternal() can't be null");
532 /* If we find the current symbol then there is no symbol hiding it
533 */
534 return sym != this;
535 }
536
537 /** This method looks in the supertypes graph that has the current class as the
538 * initial node, till it finds the current symbol or another symbol that hides it.
539 * If the current class has more than one supertype (extends one class and
540 * implements one or more interfaces) then null can be returned, meaning that
541 * a wrong path in the supertypes graph was selected. Null can only be returned
542 * as a temporary value, as a result of the recursive call.
543 */
544 private Symbol hiddenInInternal(ClassSymbol currentClass, Types types) {
545 if (currentClass == owner) {
546 return this;
547 }
548 for (Symbol sym : currentClass.members().getSymbolsByName(name)) {
549 if (sym.kind == kind &&
550 (kind != MTH ||
551 (sym.flags() & STATIC) != 0 &&
552 types.isSubSignature(sym.type, type))) {
553 return sym;
554 }
555 }
556 Symbol hiddenSym = null;
557 for (Type st : types.interfaces(currentClass.type)
558 .prepend(types.supertype(currentClass.type))) {
559 if (st != null && (st.hasTag(CLASS))) {
560 Symbol sym = hiddenInInternal((ClassSymbol)st.tsym, types);
561 if (sym == this) {
562 return this;
563 } else if (sym != null) {
564 hiddenSym = sym;
565 }
566 }
567 }
568 return hiddenSym;
569 }
570
571 /** Is this symbol inherited into a given class?
572 * PRE: If symbol's owner is a interface,
573 * it is already assumed that the interface is a superinterface
574 * of given class.
575 * @param clazz The class for which we want to establish membership.
576 * This must be a subclass of the member's owner.
577 */
578 public boolean isInheritedIn(Symbol clazz, Types types) {
579 switch ((int)(flags_field & Flags.AccessFlags)) {
580 default: // error recovery
581 case PUBLIC:
582 return true;
583 case PRIVATE:
584 return this.owner == clazz;
585 case PROTECTED:
586 // we model interfaces as extending Object
587 return (clazz.flags() & INTERFACE) == 0;
588 case 0:
589 PackageSymbol thisPackage = this.packge();
590 for (Symbol sup = clazz;
591 sup != null && sup != this.owner;
592 sup = types.supertype(sup.type).tsym) {
593 while (sup.type.hasTag(TYPEVAR))
594 sup = sup.type.getUpperBound().tsym;
595 if (sup.type.isErroneous())
596 return true; // error recovery
597 if ((sup.flags() & COMPOUND) != 0)
598 continue;
599 if (sup.packge() != thisPackage)
600 return false;
601 }
602 return (clazz.flags() & INTERFACE) == 0;
603 }
604 }
605
606 /** The (variable or method) symbol seen as a member of given
607 * class type`site' (this might change the symbol's type).
608 * This is used exclusively for producing diagnostics.
609 */
610 public Symbol asMemberOf(Type site, Types types) {
611 throw new AssertionError();
612 }
613
614 /** Does this method symbol override `other' symbol, when both are seen as
615 * members of class `origin'? It is assumed that _other is a member
616 * of origin.
617 *
618 * It is assumed that both symbols have the same name. The static
619 * modifier is ignored for this test.
620 *
621 * See JLS 8.4.6.1 (without transitivity) and 8.4.6.4
622 */
623 public boolean overrides(Symbol _other, TypeSymbol origin, Types types, boolean checkResult) {
624 return false;
625 }
626
627 /** Complete the elaboration of this symbol's definition.
628 */
629 public void complete() throws CompletionFailure {
630 if (completer != Completer.NULL_COMPLETER) {
631 Completer c = completer;
632 completer = Completer.NULL_COMPLETER;
633 c.complete(this);
634 }
635 }
636
637 /** True if the symbol represents an entity that exists.
638 */
639 public boolean exists() {
640 return true;
641 }
642
643 @DefinedBy(Api.LANGUAGE_MODEL)
644 public Type asType() {
645 return type;
646 }
647
648 @DefinedBy(Api.LANGUAGE_MODEL)
649 public Symbol getEnclosingElement() {
650 return owner;
651 }
652
653 @DefinedBy(Api.LANGUAGE_MODEL)
654 public ElementKind getKind() {
655 return ElementKind.OTHER; // most unkind
656 }
657
658 @DefinedBy(Api.LANGUAGE_MODEL)
659 public Set<Modifier> getModifiers() {
660 return Flags.asModifierSet(flags());
661 }
662
663 @DefinedBy(Api.LANGUAGE_MODEL)
664 public Name getSimpleName() {
665 return name;
666 }
667
668 /**
669 * This is the implementation for {@code
670 * javax.lang.model.element.Element.getAnnotationMirrors()}.
671 */
672 @Override @DefinedBy(Api.LANGUAGE_MODEL)
673 public List<Attribute.Compound> getAnnotationMirrors() {
674 return getRawAttributes();
675 }
676
677
678 // TODO: getEnclosedElements should return a javac List, fix in FilteredMemberList
679 @DefinedBy(Api.LANGUAGE_MODEL)
680 public java.util.List<Symbol> getEnclosedElements() {
681 return List.nil();
682 }
683
684 public List<TypeVariableSymbol> getTypeParameters() {
685 ListBuffer<TypeVariableSymbol> l = new ListBuffer<>();
686 for (Type t : type.getTypeArguments()) {
687 Assert.check(t.tsym.getKind() == ElementKind.TYPE_PARAMETER);
688 l.append((TypeVariableSymbol)t.tsym);
689 }
690 return l.toList();
691 }
692
693 public static class DelegatedSymbol<T extends Symbol> extends Symbol {
694 protected T other;
695 public DelegatedSymbol(T other) {
696 super(other.kind, other.flags_field, other.name, other.type, other.owner);
697 this.other = other;
698 }
699 public String toString() { return other.toString(); }
700 public Symbol location() { return other.location(); }
701 public Symbol location(Type site, Types types) { return other.location(site, types); }
702 public Symbol baseSymbol() { return other; }
703 public Type erasure(Types types) { return other.erasure(types); }
704 public Type externalType(Types types) { return other.externalType(types); }
705 public boolean isLocal() { return other.isLocal(); }
706 public boolean isConstructor() { return other.isConstructor(); }
707 public Name getQualifiedName() { return other.getQualifiedName(); }
708 public Name flatName() { return other.flatName(); }
709 public WriteableScope members() { return other.members(); }
710 public boolean isInner() { return other.isInner(); }
711 public boolean hasOuterInstance() { return other.hasOuterInstance(); }
712 public ClassSymbol enclClass() { return other.enclClass(); }
713 public ClassSymbol outermostClass() { return other.outermostClass(); }
714 public PackageSymbol packge() { return other.packge(); }
715 public boolean isSubClass(Symbol base, Types types) { return other.isSubClass(base, types); }
716 public boolean isMemberOf(TypeSymbol clazz, Types types) { return other.isMemberOf(clazz, types); }
717 public boolean isEnclosedBy(ClassSymbol clazz) { return other.isEnclosedBy(clazz); }
718 public boolean isInheritedIn(Symbol clazz, Types types) { return other.isInheritedIn(clazz, types); }
719 public Symbol asMemberOf(Type site, Types types) { return other.asMemberOf(site, types); }
720 public void complete() throws CompletionFailure { other.complete(); }
721
722 @DefinedBy(Api.LANGUAGE_MODEL)
723 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
724 return other.accept(v, p);
725 }
726
727 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
728 return v.visitSymbol(other, p);
729 }
730
731 public T getUnderlyingSymbol() {
732 return other;
733 }
734 }
735
736 /** A base class for Symbols representing types.
737 */
738 public static abstract class TypeSymbol extends Symbol {
739 public TypeSymbol(Kind kind, long flags, Name name, Type type, Symbol owner) {
740 super(kind, flags, name, type, owner);
741 }
742 /** form a fully qualified name from a name and an owner
743 */
744 static public Name formFullName(Name name, Symbol owner) {
745 if (owner == null) return name;
746 if ((owner.kind != ERR) &&
747 (owner.kind.matches(KindSelector.VAL_MTH) ||
748 (owner.kind == TYP && owner.type.hasTag(TYPEVAR))
749 )) return name;
750 Name prefix = owner.getQualifiedName();
751 if (prefix == null || prefix == prefix.table.names.empty)
752 return name;
753 else return prefix.append('.', name);
754 }
755
756 /** form a fully qualified name from a name and an owner, after
757 * converting to flat representation
758 */
759 static public Name formFlatName(Name name, Symbol owner) {
760 if (owner == null || owner.kind.matches(KindSelector.VAL_MTH) ||
761 (owner.kind == TYP && owner.type.hasTag(TYPEVAR))
762 ) return name;
763 char sep = owner.kind == TYP ? '$' : '.';
764 Name prefix = owner.flatName();
765 if (prefix == null || prefix == prefix.table.names.empty)
766 return name;
767 else return prefix.append(sep, name);
768 }
769
770 /**
771 * A partial ordering between type symbols that refines the
772 * class inheritance graph.
773 *
774 * Type variables always precede other kinds of symbols.
775 */
776 public final boolean precedes(TypeSymbol that, Types types) {
777 if (this == that)
778 return false;
779 if (type.hasTag(that.type.getTag())) {
780 if (type.hasTag(CLASS)) {
781 return
782 types.rank(that.type) < types.rank(this.type) ||
783 types.rank(that.type) == types.rank(this.type) &&
784 that.getQualifiedName().compareTo(this.getQualifiedName()) < 0;
785 } else if (type.hasTag(TYPEVAR)) {
786 return types.isSubtype(this.type, that.type);
787 }
788 }
789 return type.hasTag(TYPEVAR);
790 }
791
792 @Override @DefinedBy(Api.LANGUAGE_MODEL)
793 public java.util.List<Symbol> getEnclosedElements() {
794 List<Symbol> list = List.nil();
795 if (kind == TYP && type.hasTag(TYPEVAR)) {
796 return list;
797 }
798 for (Symbol sym : members().getSymbols(NON_RECURSIVE)) {
799 try {
800 if (sym != null && (sym.flags() & SYNTHETIC) == 0 && sym.owner == this) {
801 list = list.prepend(sym);
802 }
803 } catch (BadEnclosingMethodAttr badEnclosingMethod) {
804 // ignore the exception
805 }
806 }
807 return list;
808 }
809
810 public AnnotationTypeMetadata getAnnotationTypeMetadata() {
811 Assert.error("Only on ClassSymbol");
812 return null; //unreachable
813 }
814
815 public boolean isAnnotationType() { return false; }
816
817 @Override
818 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
819 return v.visitTypeSymbol(this, p);
820 }
821 }
822
823 /**
824 * Type variables are represented by instances of this class.
825 */
826 public static class TypeVariableSymbol
827 extends TypeSymbol implements TypeParameterElement {
828
829 public TypeVariableSymbol(long flags, Name name, Type type, Symbol owner) {
830 super(TYP, flags, name, type, owner);
831 }
832
833 @DefinedBy(Api.LANGUAGE_MODEL)
834 public ElementKind getKind() {
835 return ElementKind.TYPE_PARAMETER;
836 }
837
838 @Override @DefinedBy(Api.LANGUAGE_MODEL)
839 public Symbol getGenericElement() {
840 return owner;
841 }
842
843 @DefinedBy(Api.LANGUAGE_MODEL)
844 public List<Type> getBounds() {
845 TypeVar t = (TypeVar)type;
846 Type bound = t.getUpperBound();
847 if (!bound.isCompound())
848 return List.of(bound);
849 ClassType ct = (ClassType)bound;
850 if (!ct.tsym.erasure_field.isInterface()) {
851 return ct.interfaces_field.prepend(ct.supertype_field);
852 } else {
853 // No superclass was given in bounds.
854 // In this case, supertype is Object, erasure is first interface.
855 return ct.interfaces_field;
856 }
857 }
858
859 @Override @DefinedBy(Api.LANGUAGE_MODEL)
860 public List<Attribute.Compound> getAnnotationMirrors() {
861 // Declaration annotations on type variables are stored in type attributes
862 // on the owner of the TypeVariableSymbol
863 List<Attribute.TypeCompound> candidates = owner.getRawTypeAttributes();
864 int index = owner.getTypeParameters().indexOf(this);
865 List<Attribute.Compound> res = List.nil();
866 for (Attribute.TypeCompound a : candidates) {
867 if (isCurrentSymbolsAnnotation(a, index))
868 res = res.prepend(a);
869 }
870
871 return res.reverse();
872 }
873
874 // Helper to getAnnotation[s]
875 @Override
876 public <A extends Annotation> Attribute.Compound getAttribute(Class<A> annoType) {
877 String name = annoType.getName();
878
879 // Declaration annotations on type variables are stored in type attributes
880 // on the owner of the TypeVariableSymbol
881 List<Attribute.TypeCompound> candidates = owner.getRawTypeAttributes();
882 int index = owner.getTypeParameters().indexOf(this);
883 for (Attribute.TypeCompound anno : candidates)
884 if (isCurrentSymbolsAnnotation(anno, index) &&
885 name.contentEquals(anno.type.tsym.flatName()))
886 return anno;
887
888 return null;
889 }
890 //where:
891 boolean isCurrentSymbolsAnnotation(Attribute.TypeCompound anno, int index) {
892 return (anno.position.type == TargetType.CLASS_TYPE_PARAMETER ||
893 anno.position.type == TargetType.METHOD_TYPE_PARAMETER) &&
894 anno.position.parameter_index == index;
895 }
896
897
898 @Override @DefinedBy(Api.LANGUAGE_MODEL)
899 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
900 return v.visitTypeParameter(this, p);
901 }
902 }
903 /** A class for module symbols.
904 */
905 public static class ModuleSymbol extends TypeSymbol
906 implements ModuleElement {
907
908 public Name version;
909 public JavaFileManager.Location sourceLocation;
910 public JavaFileManager.Location patchLocation;
911 public JavaFileManager.Location classLocation;
912
913 /** All directives, in natural order. */
914 public List<com.sun.tools.javac.code.Directive> directives;
915 public List<com.sun.tools.javac.code.Directive.RequiresDirective> requires;
916 public List<com.sun.tools.javac.code.Directive.ExportsDirective> exports;
917 public List<com.sun.tools.javac.code.Directive.OpensDirective> opens;
918 public List<com.sun.tools.javac.code.Directive.ProvidesDirective> provides;
919 public List<com.sun.tools.javac.code.Directive.UsesDirective> uses;
920
921 public ClassSymbol module_info;
922
923 public PackageSymbol unnamedPackage;
924 public Map<Name, PackageSymbol> visiblePackages;
925 public Set<ModuleSymbol> readModules;
926 public List<Symbol> enclosedPackages = List.nil();
927
928 public Completer usesProvidesCompleter = Completer.NULL_COMPLETER;
929 public final Set<ModuleFlags> flags = EnumSet.noneOf(ModuleFlags.class);
930 public final Set<ModuleResolutionFlags> resolutionFlags = EnumSet.noneOf(ModuleResolutionFlags.class);
931
932 /**
933 * Create a ModuleSymbol with an associated module-info ClassSymbol.
934 */
935 public static ModuleSymbol create(Name name, Name module_info) {
936 ModuleSymbol msym = new ModuleSymbol(name, null);
937 ClassSymbol info = new ClassSymbol(Flags.MODULE, module_info, msym);
938 info.fullname = formFullName(module_info, msym);
939 info.flatname = info.fullname;
940 info.members_field = WriteableScope.create(info);
941 msym.module_info = info;
942 return msym;
943 }
944
945 public ModuleSymbol(Name name, Symbol owner) {
946 super(MDL, 0, name, null, owner);
947 Assert.checkNonNull(name);
948 this.type = new ModuleType(this);
949 }
950
951 @Override @DefinedBy(Api.LANGUAGE_MODEL)
952 public boolean isOpen() {
953 return flags.contains(ModuleFlags.OPEN);
954 }
955
956 @Override @DefinedBy(Api.LANGUAGE_MODEL)
957 public boolean isUnnamed() {
958 return name.isEmpty() && owner == null;
959 }
960
961 @Override
962 public boolean isDeprecated() {
963 return hasDeprecatedAnnotation();
964 }
965
966 public boolean isNoModule() {
967 return false;
968 }
969
970 @Override @DefinedBy(Api.LANGUAGE_MODEL)
971 public ElementKind getKind() {
972 return ElementKind.MODULE;
973 }
974
975 @Override @DefinedBy(Api.LANGUAGE_MODEL)
976 public java.util.List<Directive> getDirectives() {
977 complete();
978 completeUsesProvides();
979 return Collections.unmodifiableList(directives);
980 }
981
982 public void completeUsesProvides() {
983 if (usesProvidesCompleter != Completer.NULL_COMPLETER) {
984 Completer c = usesProvidesCompleter;
985 usesProvidesCompleter = Completer.NULL_COMPLETER;
986 c.complete(this);
987 }
988 }
989
990 @Override
991 public ClassSymbol outermostClass() {
992 return null;
993 }
994
995 @Override
996 public String toString() {
997 // TODO: the following strings should be localized
998 // Do this with custom anon subtypes in Symtab
999 String n = (name == null) ? "<unknown>"
1000 : (name.isEmpty()) ? "<unnamed>"
1001 : String.valueOf(name);
1002 return n;
1003 }
1004
1005 @Override @DefinedBy(Api.LANGUAGE_MODEL)
1006 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
1007 return v.visitModule(this, p);
1008 }
1009
1010 @Override @DefinedBy(Api.LANGUAGE_MODEL)
1011 public List<Symbol> getEnclosedElements() {
1012 List<Symbol> list = List.nil();
1013 for (Symbol sym : enclosedPackages) {
1014 if (sym.members().anyMatch(m -> m.kind == TYP))
1015 list = list.prepend(sym);
1016 }
1017 return list;
1018 }
1019
1020 public void reset() {
1021 this.directives = null;
1022 this.requires = null;
1023 this.exports = null;
1024 this.provides = null;
1025 this.uses = null;
1026 this.visiblePackages = null;
1027 }
1028
1029 }
1030
1031 public enum ModuleFlags {
1032 OPEN(0x0020),
1033 SYNTHETIC(0x1000),
1034 MANDATED(0x8000);
1035
1036 public static int value(Set<ModuleFlags> s) {
1037 int v = 0;
1038 for (ModuleFlags f: s)
1039 v |= f.value;
1040 return v;
1041 }
1042
1043 private ModuleFlags(int value) {
1044 this.value = value;
1045 }
1046
1047 public final int value;
1048 }
1049
1050 public enum ModuleResolutionFlags {
1051 DO_NOT_RESOLVE_BY_DEFAULT(0x0001),
1052 WARN_DEPRECATED(0x0002),
1053 WARN_DEPRECATED_REMOVAL(0x0004),
1054 WARN_INCUBATING(0x0008);
1055
1056 public static int value(Set<ModuleResolutionFlags> s) {
1057 int v = 0;
1058 for (ModuleResolutionFlags f: s)
1059 v |= f.value;
1060 return v;
1061 }
1062
1063 private ModuleResolutionFlags(int value) {
1064 this.value = value;
1065 }
1066
1067 public final int value;
1068 }
1069
1070 /** A class for package symbols
1071 */
1072 public static class PackageSymbol extends TypeSymbol
1073 implements PackageElement {
1074
1075 public WriteableScope members_field;
1076 public Name fullname;
1077 public ClassSymbol package_info; // see bug 6443073
1078 public ModuleSymbol modle;
1079 // the file containing the documentation comments for the package
1080 public JavaFileObject sourcefile;
1081
1082 public PackageSymbol(Name name, Type type, Symbol owner) {
1083 super(PCK, 0, name, type, owner);
1084 this.members_field = null;
1085 this.fullname = formFullName(name, owner);
1086 }
1087
1088 public PackageSymbol(Name name, Symbol owner) {
1089 this(name, null, owner);
1090 this.type = new PackageType(this);
1091 }
1092
1093 public String toString() {
1094 return fullname.toString();
1095 }
1096
1097 @DefinedBy(Api.LANGUAGE_MODEL)
1098 public Name getQualifiedName() {
1099 return fullname;
1100 }
1101
1102 @DefinedBy(Api.LANGUAGE_MODEL)
1103 public boolean isUnnamed() {
1104 return name.isEmpty() && owner != null;
1105 }
1106
1107 public WriteableScope members() {
1108 complete();
1109 return members_field;
1110 }
1111
1112 public long flags() {
1113 complete();
1114 return flags_field;
1115 }
1116
1117 @Override
1118 public List<Attribute.Compound> getRawAttributes() {
1119 complete();
1120 if (package_info != null) {
1121 package_info.complete();
1122 mergeAttributes();
1123 }
1124 return super.getRawAttributes();
1125 }
1126
1127 private void mergeAttributes() {
1128 if (metadata == null &&
1129 package_info.metadata != null) {
1130 metadata = new SymbolMetadata(this);
1131 metadata.setAttributes(package_info.metadata);
1132 }
1133 }
1134
1135 /** A package "exists" if a type or package that exists has
1136 * been seen within it.
1137 */
1138 public boolean exists() {
1139 return (flags_field & EXISTS) != 0;
1140 }
1141
1142 @DefinedBy(Api.LANGUAGE_MODEL)
1143 public ElementKind getKind() {
1144 return ElementKind.PACKAGE;
1145 }
1146
1147 @DefinedBy(Api.LANGUAGE_MODEL)
1148 public Symbol getEnclosingElement() {
1149 return modle != null && !modle.isNoModule() ? modle : null;
1150 }
1151
1152 @DefinedBy(Api.LANGUAGE_MODEL)
1153 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
1154 return v.visitPackage(this, p);
1155 }
1156
1157 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
1158 return v.visitPackageSymbol(this, p);
1159 }
1160
1161 /**Resets the Symbol into the state good for next round of annotation processing.*/
1162 public void reset() {
1163 metadata = null;
1164 }
1165
1166 }
1167
1168 /** A class for class symbols
1169 */
1170 public static class ClassSymbol extends TypeSymbol implements TypeElement {
1171
1172 /** a scope for all class members; variables, methods and inner classes
1173 * type parameters are not part of this scope
1174 */
1175 public WriteableScope members_field;
1176
1177 /** the fully qualified name of the class, i.e. pck.outer.inner.
1178 * null for anonymous classes
1179 */
1180 public Name fullname;
1181
1182 /** the fully qualified name of the class after converting to flat
1183 * representation, i.e. pck.outer$inner,
1184 * set externally for local and anonymous classes
1185 */
1186 public Name flatname;
1187
1188 /** the sourcefile where the class came from
1189 */
1190 public JavaFileObject sourcefile;
1191
1192 /** the classfile from where to load this class
1193 * this will have extension .class or .java
1194 */
1195 public JavaFileObject classfile;
1196
1197 /** the list of translated local classes (used for generating
1198 * InnerClasses attribute)
1199 */
1200 public List<ClassSymbol> trans_local;
1201
1202 /** the constant pool of the class
1203 */
1204 public Pool pool;
1205
1206 /** the annotation metadata attached to this class */
1207 private AnnotationTypeMetadata annotationTypeMetadata;
1208
1209 public ClassSymbol(long flags, Name name, Type type, Symbol owner) {
1210 super(TYP, flags, name, type, owner);
1211 this.members_field = null;
1212 this.fullname = formFullName(name, owner);
1213 this.flatname = formFlatName(name, owner);
1214 this.sourcefile = null;
1215 this.classfile = null;
1216 this.pool = null;
1217 this.annotationTypeMetadata = AnnotationTypeMetadata.notAnAnnotationType();
1218 }
1219
1220 public ClassSymbol(long flags, Name name, Symbol owner) {
1221 this(
1222 flags,
1223 name,
1224 new ClassType(Type.noType, null, null),
1225 owner);
1226 this.type.tsym = this;
1227 }
1228
1229 /** The Java source which this symbol represents.
1230 */
1231 public String toString() {
1232 return className();
1233 }
1234
1235 public long flags() {
1236 complete();
1237 return flags_field;
1238 }
1239
1240 public WriteableScope members() {
1241 complete();
1242 return members_field;
1243 }
1244
1245 @Override
1246 public List<Attribute.Compound> getRawAttributes() {
1247 complete();
1248 return super.getRawAttributes();
1249 }
1250
1251 @Override
1252 public List<Attribute.TypeCompound> getRawTypeAttributes() {
1253 complete();
1254 return super.getRawTypeAttributes();
1255 }
1256
1257 public Type erasure(Types types) {
1258 if (erasure_field == null)
1259 erasure_field = new ClassType(types.erasure(type.getEnclosingType()),
1260 List.nil(), this,
1261 type.getMetadata());
1262 return erasure_field;
1263 }
1264
1265 public String className() {
1266 if (name.isEmpty())
1267 return
1268 Log.getLocalizedString("anonymous.class", flatname);
1269 else
1270 return fullname.toString();
1271 }
1272
1273 @DefinedBy(Api.LANGUAGE_MODEL)
1274 public Name getQualifiedName() {
1275 return fullname;
1276 }
1277
1278 public Name flatName() {
1279 return flatname;
1280 }
1281
1282 public boolean isSubClass(Symbol base, Types types) {
1283 if (this == base) {
1284 return true;
1285 } else if ((base.flags() & INTERFACE) != 0) {
1286 for (Type t = type; t.hasTag(CLASS); t = types.supertype(t))
1287 for (List<Type> is = types.interfaces(t);
1288 is.nonEmpty();
1289 is = is.tail)
1290 if (is.head.tsym.isSubClass(base, types)) return true;
1291 } else {
1292 for (Type t = type; t.hasTag(CLASS); t = types.supertype(t))
1293 if (t.tsym == base) return true;
1294 }
1295 return false;
1296 }
1297
1298 /** Complete the elaboration of this symbol's definition.
1299 */
1300 public void complete() throws CompletionFailure {
1301 try {
1302 super.complete();
1303 } catch (CompletionFailure ex) {
1304 // quiet error recovery
1305 flags_field |= (PUBLIC|STATIC);
1306 this.type = new ErrorType(this, Type.noType);
1307 throw ex;
1308 }
1309 }
1310
1311 @DefinedBy(Api.LANGUAGE_MODEL)
1312 public List<Type> getInterfaces() {
1313 complete();
1314 if (type instanceof ClassType) {
1315 ClassType t = (ClassType)type;
1316 if (t.interfaces_field == null) // FIXME: shouldn't be null
1317 t.interfaces_field = List.nil();
1318 if (t.all_interfaces_field != null)
1319 return Type.getModelTypes(t.all_interfaces_field);
1320 return t.interfaces_field;
1321 } else {
1322 return List.nil();
1323 }
1324 }
1325
1326 @DefinedBy(Api.LANGUAGE_MODEL)
1327 public Type getSuperclass() {
1328 complete();
1329 if (type instanceof ClassType) {
1330 ClassType t = (ClassType)type;
1331 if (t.supertype_field == null) // FIXME: shouldn't be null
1332 t.supertype_field = Type.noType;
1333 // An interface has no superclass; its supertype is Object.
1334 return t.isInterface()
1335 ? Type.noType
1336 : t.supertype_field.getModelType();
1337 } else {
1338 return Type.noType;
1339 }
1340 }
1341
1342 /**
1343 * Returns the next class to search for inherited annotations or {@code null}
1344 * if the next class can't be found.
1345 */
1346 private ClassSymbol getSuperClassToSearchForAnnotations() {
1347
1348 Type sup = getSuperclass();
1349
1350 if (!sup.hasTag(CLASS) || sup.isErroneous())
1351 return null;
1352
1353 return (ClassSymbol) sup.tsym;
1354 }
1355
1356
1357 @Override
1358 protected <A extends Annotation> A[] getInheritedAnnotations(Class<A> annoType) {
1359
1360 ClassSymbol sup = getSuperClassToSearchForAnnotations();
1361
1362 return sup == null ? super.getInheritedAnnotations(annoType)
1363 : sup.getAnnotationsByType(annoType);
1364 }
1365
1366
1367 @DefinedBy(Api.LANGUAGE_MODEL)
1368 public ElementKind getKind() {
1369 long flags = flags();
1370 if ((flags & ANNOTATION) != 0)
1371 return ElementKind.ANNOTATION_TYPE;
1372 else if ((flags & INTERFACE) != 0)
1373 return ElementKind.INTERFACE;
1374 else if ((flags & ENUM) != 0)
1375 return ElementKind.ENUM;
1376 else
1377 return ElementKind.CLASS;
1378 }
1379
1380 @Override @DefinedBy(Api.LANGUAGE_MODEL)
1381 public Set<Modifier> getModifiers() {
1382 long flags = flags();
1383 return Flags.asModifierSet(flags & ~DEFAULT);
1384 }
1385
1386 @DefinedBy(Api.LANGUAGE_MODEL)
1387 public NestingKind getNestingKind() {
1388 complete();
1389 if (owner.kind == PCK)
1390 return NestingKind.TOP_LEVEL;
1391 else if (name.isEmpty())
1392 return NestingKind.ANONYMOUS;
1393 else if (owner.kind == MTH)
1394 return NestingKind.LOCAL;
1395 else
1396 return NestingKind.MEMBER;
1397 }
1398
1399
1400 @Override
1401 protected <A extends Annotation> Attribute.Compound getAttribute(final Class<A> annoType) {
1402
1403 Attribute.Compound attrib = super.getAttribute(annoType);
1404
1405 boolean inherited = annoType.isAnnotationPresent(Inherited.class);
1406 if (attrib != null || !inherited)
1407 return attrib;
1408
1409 // Search supertypes
1410 ClassSymbol superType = getSuperClassToSearchForAnnotations();
1411 return superType == null ? null
1412 : superType.getAttribute(annoType);
1413 }
1414
1415
1416
1417
1418 @DefinedBy(Api.LANGUAGE_MODEL)
1419 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
1420 return v.visitType(this, p);
1421 }
1422
1423 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
1424 return v.visitClassSymbol(this, p);
1425 }
1426
1427 public void markAbstractIfNeeded(Types types) {
1428 if (types.enter.getEnv(this) != null &&
1429 (flags() & ENUM) != 0 && types.supertype(type).tsym == types.syms.enumSym &&
1430 (flags() & (FINAL | ABSTRACT)) == 0) {
1431 if (types.firstUnimplementedAbstract(this) != null)
1432 // add the ABSTRACT flag to an enum
1433 flags_field |= ABSTRACT;
1434 }
1435 }
1436
1437 /**Resets the Symbol into the state good for next round of annotation processing.*/
1438 public void reset() {
1439 kind = TYP;
1440 erasure_field = null;
1441 members_field = null;
1442 flags_field = 0;
1443 if (type instanceof ClassType) {
1444 ClassType t = (ClassType)type;
1445 t.setEnclosingType(Type.noType);
1446 t.rank_field = -1;
1447 t.typarams_field = null;
1448 t.allparams_field = null;
1449 t.supertype_field = null;
1450 t.interfaces_field = null;
1451 t.all_interfaces_field = null;
1452 }
1453 clearAnnotationMetadata();
1454 }
1455
1456 public void clearAnnotationMetadata() {
1457 metadata = null;
1458 annotationTypeMetadata = AnnotationTypeMetadata.notAnAnnotationType();
1459 }
1460
1461 @Override
1462 public AnnotationTypeMetadata getAnnotationTypeMetadata() {
1463 return annotationTypeMetadata;
1464 }
1465
1466 @Override
1467 public boolean isAnnotationType() {
1468 return (flags_field & Flags.ANNOTATION) != 0;
1469 }
1470
1471 public void setAnnotationTypeMetadata(AnnotationTypeMetadata a) {
1472 Assert.checkNonNull(a);
1473 Assert.check(!annotationTypeMetadata.isMetadataForAnnotationType());
1474 this.annotationTypeMetadata = a;
1475 }
1476 }
1477
1478
1479 /** A class for variable symbols
1480 */
1481 public static class VarSymbol extends Symbol implements VariableElement {
1482
1483 /** The variable's declaration position.
1484 */
1485 public int pos = Position.NOPOS;
1486
1487 /** The variable's address. Used for different purposes during
1488 * flow analysis, translation and code generation.
1489 * Flow analysis:
1490 * If this is a blank final or local variable, its sequence number.
1491 * Translation:
1492 * If this is a private field, its access number.
1493 * Code generation:
1494 * If this is a local variable, its logical slot number.
1495 */
1496 public int adr = -1;
1497
1498 /** Construct a variable symbol, given its flags, name, type and owner.
1499 */
1500 public VarSymbol(long flags, Name name, Type type, Symbol owner) {
1501 super(VAR, flags, name, type, owner);
1502 }
1503
1504 /** Clone this symbol with new owner.
1505 */
1506 public VarSymbol clone(Symbol newOwner) {
1507 VarSymbol v = new VarSymbol(flags_field, name, type, newOwner) {
1508 @Override
1509 public Symbol baseSymbol() {
1510 return VarSymbol.this;
1511 }
1512 };
1513 v.pos = pos;
1514 v.adr = adr;
1515 v.data = data;
1516 // System.out.println("clone " + v + " in " + newOwner);//DEBUG
1517 return v;
1518 }
1519
1520 public String toString() {
1521 return name.toString();
1522 }
1523
1524 public Symbol asMemberOf(Type site, Types types) {
1525 return new VarSymbol(flags_field, name, types.memberType(site, this), owner);
1526 }
1527
1528 @DefinedBy(Api.LANGUAGE_MODEL)
1529 public ElementKind getKind() {
1530 long flags = flags();
1531 if ((flags & PARAMETER) != 0) {
1532 if (isExceptionParameter())
1533 return ElementKind.EXCEPTION_PARAMETER;
1534 else
1535 return ElementKind.PARAMETER;
1536 } else if ((flags & ENUM) != 0) {
1537 return ElementKind.ENUM_CONSTANT;
1538 } else if (owner.kind == TYP || owner.kind == ERR) {
1539 return ElementKind.FIELD;
1540 } else if (isResourceVariable()) {
1541 return ElementKind.RESOURCE_VARIABLE;
1542 } else {
1543 return ElementKind.LOCAL_VARIABLE;
1544 }
1545 }
1546
1547 @DefinedBy(Api.LANGUAGE_MODEL)
1548 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
1549 return v.visitVariable(this, p);
1550 }
1551
1552 @DefinedBy(Api.LANGUAGE_MODEL)
1553 public Object getConstantValue() { // Mirror API
1554 return Constants.decode(getConstValue(), type);
1555 }
1556
1557 public void setLazyConstValue(final Env<AttrContext> env,
1558 final Attr attr,
1559 final JCVariableDecl variable)
1560 {
1561 setData((Callable<Object>)() -> attr.attribLazyConstantValue(env, variable, type));
1562 }
1563
1564 /**
1565 * The variable's constant value, if this is a constant.
1566 * Before the constant value is evaluated, it points to an
1567 * initializer environment. If this is not a constant, it can
1568 * be used for other stuff.
1569 */
1570 private Object data;
1571
1572 public boolean isExceptionParameter() {
1573 return data == ElementKind.EXCEPTION_PARAMETER;
1574 }
1575
1576 public boolean isResourceVariable() {
1577 return data == ElementKind.RESOURCE_VARIABLE;
1578 }
1579
1580 public Object getConstValue() {
1581 // TODO: Consider if getConstValue and getConstantValue can be collapsed
1582 if (data == ElementKind.EXCEPTION_PARAMETER ||
1583 data == ElementKind.RESOURCE_VARIABLE) {
1584 return null;
1585 } else if (data instanceof Callable<?>) {
1586 // In this case, this is a final variable, with an as
1587 // yet unevaluated initializer.
1588 Callable<?> eval = (Callable<?>)data;
1589 data = null; // to make sure we don't evaluate this twice.
1590 try {
1591 data = eval.call();
1592 } catch (Exception ex) {
1593 throw new AssertionError(ex);
1594 }
1595 }
1596 return data;
1597 }
1598
1599 public void setData(Object data) {
1600 Assert.check(!(data instanceof Env<?>), this);
1601 this.data = data;
1602 }
1603
1604 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
1605 return v.visitVarSymbol(this, p);
1606 }
1607 }
1608
1609 /** A class for method symbols.
1610 */
1611 public static class MethodSymbol extends Symbol implements ExecutableElement {
1612
1613 /** The code of the method. */
1614 public Code code = null;
1615
1616 /** The extra (synthetic/mandated) parameters of the method. */
1617 public List<VarSymbol> extraParams = List.nil();
1618
1619 /** The captured local variables in an anonymous class */
1620 public List<VarSymbol> capturedLocals = List.nil();
1621
1622 /** The parameters of the method. */
1623 public List<VarSymbol> params = null;
1624
1625 /** The names of the parameters */
1626 public List<Name> savedParameterNames;
1627
1628 /** For an annotation type element, its default value if any.
1629 * The value is null if none appeared in the method
1630 * declaration.
1631 */
1632 public Attribute defaultValue = null;
1633
1634 /** Construct a method symbol, given its flags, name, type and owner.
1635 */
1636 public MethodSymbol(long flags, Name name, Type type, Symbol owner) {
1637 super(MTH, flags, name, type, owner);
1638 if (owner.type.hasTag(TYPEVAR)) Assert.error(owner + "." + name);
1639 }
1640
1641 /** Clone this symbol with new owner.
1642 */
1643 public MethodSymbol clone(Symbol newOwner) {
1644 MethodSymbol m = new MethodSymbol(flags_field, name, type, newOwner) {
1645 @Override
1646 public Symbol baseSymbol() {
1647 return MethodSymbol.this;
1648 }
1649 };
1650 m.code = code;
1651 return m;
1652 }
1653
1654 @Override @DefinedBy(Api.LANGUAGE_MODEL)
1655 public Set<Modifier> getModifiers() {
1656 long flags = flags();
1657 return Flags.asModifierSet((flags & DEFAULT) != 0 ? flags & ~ABSTRACT : flags);
1658 }
1659
1660 /** The Java source which this symbol represents.
1661 */
1662 public String toString() {
1663 if ((flags() & BLOCK) != 0) {
1664 return owner.name.toString();
1665 } else {
1666 String s = (name == name.table.names.init)
1667 ? owner.name.toString()
1668 : name.toString();
1669 if (type != null) {
1670 if (type.hasTag(FORALL))
1671 s = "<" + ((ForAll)type).getTypeArguments() + ">" + s;
1672 s += "(" + type.argtypes((flags() & VARARGS) != 0) + ")";
1673 }
1674 return s;
1675 }
1676 }
1677
1678 public boolean isDynamic() {
1679 return false;
1680 }
1681
1682 /** find a symbol that this (proxy method) symbol implements.
1683 * @param c The class whose members are searched for
1684 * implementations
1685 */
1686 public Symbol implemented(TypeSymbol c, Types types) {
1687 Symbol impl = null;
1688 for (List<Type> is = types.interfaces(c.type);
1689 impl == null && is.nonEmpty();
1690 is = is.tail) {
1691 TypeSymbol i = is.head.tsym;
1692 impl = implementedIn(i, types);
1693 if (impl == null)
1694 impl = implemented(i, types);
1695 }
1696 return impl;
1697 }
1698
1699 public Symbol implementedIn(TypeSymbol c, Types types) {
1700 Symbol impl = null;
1701 for (Symbol sym : c.members().getSymbolsByName(name)) {
1702 if (this.overrides(sym, (TypeSymbol)owner, types, true) &&
1703 // FIXME: I suspect the following requires a
1704 // subst() for a parametric return type.
1705 types.isSameType(type.getReturnType(),
1706 types.memberType(owner.type, sym).getReturnType())) {
1707 impl = sym;
1708 }
1709 }
1710 return impl;
1711 }
1712
1713 /** Will the erasure of this method be considered by the VM to
1714 * override the erasure of the other when seen from class `origin'?
1715 */
1716 public boolean binaryOverrides(Symbol _other, TypeSymbol origin, Types types) {
1717 if (isConstructor() || _other.kind != MTH) return false;
1718
1719 if (this == _other) return true;
1720 MethodSymbol other = (MethodSymbol)_other;
1721
1722 // check for a direct implementation
1723 if (other.isOverridableIn((TypeSymbol)owner) &&
1724 types.asSuper(owner.type, other.owner) != null &&
1725 types.isSameType(erasure(types), other.erasure(types)))
1726 return true;
1727
1728 // check for an inherited implementation
1729 return
1730 (flags() & ABSTRACT) == 0 &&
1731 other.isOverridableIn(origin) &&
1732 this.isMemberOf(origin, types) &&
1733 types.isSameType(erasure(types), other.erasure(types));
1734 }
1735
1736 /** The implementation of this (abstract) symbol in class origin,
1737 * from the VM's point of view, null if method does not have an
1738 * implementation in class.
1739 * @param origin The class of which the implementation is a member.
1740 */
1741 public MethodSymbol binaryImplementation(ClassSymbol origin, Types types) {
1742 for (TypeSymbol c = origin; c != null; c = types.supertype(c.type).tsym) {
1743 for (Symbol sym : c.members().getSymbolsByName(name)) {
1744 if (sym.kind == MTH &&
1745 ((MethodSymbol)sym).binaryOverrides(this, origin, types))
1746 return (MethodSymbol)sym;
1747 }
1748 }
1749 return null;
1750 }
1751
1752 /** Does this symbol override `other' symbol, when both are seen as
1753 * members of class `origin'? It is assumed that _other is a member
1754 * of origin.
1755 *
1756 * It is assumed that both symbols have the same name. The static
1757 * modifier is ignored for this test.
1758 *
1759 * A quirk in the works is that if the receiver is a method symbol for
1760 * an inherited abstract method we answer false summarily all else being
1761 * immaterial. Abstract "own" methods (i.e `this' is a direct member of
1762 * origin) don't get rejected as summarily and are put to test against the
1763 * suitable criteria.
1764 *
1765 * See JLS 8.4.6.1 (without transitivity) and 8.4.6.4
1766 */
1767 public boolean overrides(Symbol _other, TypeSymbol origin, Types types, boolean checkResult) {
1768 return overrides(_other, origin, types, checkResult, true);
1769 }
1770
1771 /** Does this symbol override `other' symbol, when both are seen as
1772 * members of class `origin'? It is assumed that _other is a member
1773 * of origin.
1774 *
1775 * Caveat: If `this' is an abstract inherited member of origin, it is
1776 * deemed to override `other' only when `requireConcreteIfInherited'
1777 * is false.
1778 *
1779 * It is assumed that both symbols have the same name. The static
1780 * modifier is ignored for this test.
1781 *
1782 * See JLS 8.4.6.1 (without transitivity) and 8.4.6.4
1783 */
1784 public boolean overrides(Symbol _other, TypeSymbol origin, Types types, boolean checkResult,
1785 boolean requireConcreteIfInherited) {
1786 if (isConstructor() || _other.kind != MTH) return false;
1787
1788 if (this == _other) return true;
1789 MethodSymbol other = (MethodSymbol)_other;
1790
1791 // check for a direct implementation
1792 if (other.isOverridableIn((TypeSymbol)owner) &&
1793 types.asSuper(owner.type, other.owner) != null) {
1794 Type mt = types.memberType(owner.type, this);
1795 Type ot = types.memberType(owner.type, other);
1796 if (types.isSubSignature(mt, ot)) {
1797 if (!checkResult)
1798 return true;
1799 if (types.returnTypeSubstitutable(mt, ot))
1800 return true;
1801 }
1802 }
1803
1804 // check for an inherited implementation
1805 if (((flags() & ABSTRACT) != 0 && requireConcreteIfInherited) ||
1806 ((other.flags() & ABSTRACT) == 0 && (other.flags() & DEFAULT) == 0) ||
1807 !other.isOverridableIn(origin) ||
1808 !this.isMemberOf(origin, types))
1809 return false;
1810
1811 // assert types.asSuper(origin.type, other.owner) != null;
1812 Type mt = types.memberType(origin.type, this);
1813 Type ot = types.memberType(origin.type, other);
1814 return
1815 types.isSubSignature(mt, ot) &&
1816 (!checkResult || types.resultSubtype(mt, ot, types.noWarnings));
1817 }
1818
1819 private boolean isOverridableIn(TypeSymbol origin) {
1820 // JLS 8.4.6.1
1821 switch ((int)(flags_field & Flags.AccessFlags)) {
1822 case Flags.PRIVATE:
1823 return false;
1824 case Flags.PUBLIC:
1825 return !this.owner.isInterface() ||
1826 (flags_field & STATIC) == 0;
1827 case Flags.PROTECTED:
1828 return (origin.flags() & INTERFACE) == 0;
1829 case 0:
1830 // for package private: can only override in the same
1831 // package
1832 return
1833 this.packge() == origin.packge() &&
1834 (origin.flags() & INTERFACE) == 0;
1835 default:
1836 return false;
1837 }
1838 }
1839
1840 @Override
1841 public boolean isInheritedIn(Symbol clazz, Types types) {
1842 switch ((int)(flags_field & Flags.AccessFlags)) {
1843 case PUBLIC:
1844 return !this.owner.isInterface() ||
1845 clazz == owner ||
1846 (flags_field & STATIC) == 0;
1847 default:
1848 return super.isInheritedIn(clazz, types);
1849 }
1850 }
1851
1852 public boolean isLambdaMethod() {
1853 return (flags() & LAMBDA_METHOD) == LAMBDA_METHOD;
1854 }
1855
1856 /** The implementation of this (abstract) symbol in class origin;
1857 * null if none exists. Synthetic methods are not considered
1858 * as possible implementations.
1859 */
1860 public MethodSymbol implementation(TypeSymbol origin, Types types, boolean checkResult) {
1861 return implementation(origin, types, checkResult, implementation_filter);
1862 }
1863 // where
1864 public static final Filter<Symbol> implementation_filter = s ->
1865 s.kind == MTH && (s.flags() & SYNTHETIC) == 0;
1866
1867 public MethodSymbol implementation(TypeSymbol origin, Types types, boolean checkResult, Filter<Symbol> implFilter) {
1868 MethodSymbol res = types.implementation(this, origin, checkResult, implFilter);
1869 if (res != null)
1870 return res;
1871 // if origin is derived from a raw type, we might have missed
1872 // an implementation because we do not know enough about instantiations.
1873 // in this case continue with the supertype as origin.
1874 if (types.isDerivedRaw(origin.type) && !origin.isInterface())
1875 return implementation(types.supertype(origin.type).tsym, types, checkResult);
1876 else
1877 return null;
1878 }
1879
1880 public List<VarSymbol> params() {
1881 owner.complete();
1882 if (params == null) {
1883 // If ClassReader.saveParameterNames has been set true, then
1884 // savedParameterNames will be set to a list of names that
1885 // matches the types in type.getParameterTypes(). If any names
1886 // were not found in the class file, those names in the list will
1887 // be set to the empty name.
1888 // If ClassReader.saveParameterNames has been set false, then
1889 // savedParameterNames will be null.
1890 List<Name> paramNames = savedParameterNames;
1891 savedParameterNames = null;
1892 // discard the provided names if the list of names is the wrong size.
1893 if (paramNames == null || paramNames.size() != type.getParameterTypes().size()) {
1894 paramNames = List.nil();
1895 }
1896 ListBuffer<VarSymbol> buf = new ListBuffer<>();
1897 List<Name> remaining = paramNames;
1898 // assert: remaining and paramNames are both empty or both
1899 // have same cardinality as type.getParameterTypes()
1900 int i = 0;
1901 for (Type t : type.getParameterTypes()) {
1902 Name paramName;
1903 if (remaining.isEmpty()) {
1904 // no names for any parameters available
1905 paramName = createArgName(i, paramNames);
1906 } else {
1907 paramName = remaining.head;
1908 remaining = remaining.tail;
1909 if (paramName.isEmpty()) {
1910 // no name for this specific parameter
1911 paramName = createArgName(i, paramNames);
1912 }
1913 }
1914 buf.append(new VarSymbol(PARAMETER, paramName, t, this));
1915 i++;
1916 }
1917 params = buf.toList();
1918 }
1919 return params;
1920 }
1921
1922 // Create a name for the argument at position 'index' that is not in
1923 // the exclude list. In normal use, either no names will have been
1924 // provided, in which case the exclude list is empty, or all the names
1925 // will have been provided, in which case this method will not be called.
1926 private Name createArgName(int index, List<Name> exclude) {
1927 String prefix = "arg";
1928 while (true) {
1929 Name argName = name.table.fromString(prefix + index);
1930 if (!exclude.contains(argName))
1931 return argName;
1932 prefix += "$";
1933 }
1934 }
1935
1936 public Symbol asMemberOf(Type site, Types types) {
1937 return new MethodSymbol(flags_field, name, types.memberType(site, this), owner);
1938 }
1939
1940 @DefinedBy(Api.LANGUAGE_MODEL)
1941 public ElementKind getKind() {
1942 if (name == name.table.names.init)
1943 return ElementKind.CONSTRUCTOR;
1944 else if (name == name.table.names.clinit)
1945 return ElementKind.STATIC_INIT;
1946 else if ((flags() & BLOCK) != 0)
1947 return isStatic() ? ElementKind.STATIC_INIT : ElementKind.INSTANCE_INIT;
1948 else
1949 return ElementKind.METHOD;
1950 }
1951
1952 public boolean isStaticOrInstanceInit() {
1953 return getKind() == ElementKind.STATIC_INIT ||
1954 getKind() == ElementKind.INSTANCE_INIT;
1955 }
1956
1957 @DefinedBy(Api.LANGUAGE_MODEL)
1958 public Attribute getDefaultValue() {
1959 return defaultValue;
1960 }
1961
1962 @DefinedBy(Api.LANGUAGE_MODEL)
1963 public List<VarSymbol> getParameters() {
1964 return params();
1965 }
1966
1967 @DefinedBy(Api.LANGUAGE_MODEL)
1968 public boolean isVarArgs() {
1969 return (flags() & VARARGS) != 0;
1970 }
1971
1972 @DefinedBy(Api.LANGUAGE_MODEL)
1973 public boolean isDefault() {
1974 return (flags() & DEFAULT) != 0;
1975 }
1976
1977 @DefinedBy(Api.LANGUAGE_MODEL)
1978 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
1979 return v.visitExecutable(this, p);
1980 }
1981
1982 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
1983 return v.visitMethodSymbol(this, p);
1984 }
1985
1986 @DefinedBy(Api.LANGUAGE_MODEL)
1987 public Type getReceiverType() {
1988 return asType().getReceiverType();
1989 }
1990
1991 @DefinedBy(Api.LANGUAGE_MODEL)
1992 public Type getReturnType() {
1993 return asType().getReturnType();
1994 }
1995
1996 @DefinedBy(Api.LANGUAGE_MODEL)
1997 public List<Type> getThrownTypes() {
1998 return asType().getThrownTypes();
1999 }
2000 }
2001
2002 /** A class for invokedynamic method calls.
2003 */
2004 public static class DynamicMethodSymbol extends MethodSymbol {
2005
2006 public Object[] staticArgs;
2007 public Symbol bsm;
2008 public int bsmKind;
2009
2010 public DynamicMethodSymbol(Name name, Symbol owner, int bsmKind, MethodSymbol bsm, Type type, Object[] staticArgs) {
2011 super(0, name, type, owner);
2012 this.bsm = bsm;
2013 this.bsmKind = bsmKind;
2014 this.staticArgs = staticArgs;
2015 }
2016
2017 @Override
2018 public boolean isDynamic() {
2019 return true;
2020 }
2021 }
2022
2023 /** A class for predefined operators.
2024 */
2025 public static class OperatorSymbol extends MethodSymbol {
2026
2027 public int opcode;
2028 private int accessCode = Integer.MIN_VALUE;
2029
2030 public OperatorSymbol(Name name, Type type, int opcode, Symbol owner) {
2031 super(PUBLIC | STATIC, name, type, owner);
2032 this.opcode = opcode;
2033 }
2034
2035 @Override
2036 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
2037 return v.visitOperatorSymbol(this, p);
2038 }
2039
2040 public int getAccessCode(Tag tag) {
2041 if (accessCode != Integer.MIN_VALUE && !tag.isIncOrDecUnaryOp()) {
2042 return accessCode;
2043 }
2044 accessCode = AccessCode.from(tag, opcode);
2045 return accessCode;
2046 }
2047
2048 /** Access codes for dereferencing, assignment,
2049 * and pre/post increment/decrement.
2050
2051 * All access codes for accesses to the current class are even.
2052 * If a member of the superclass should be accessed instead (because
2053 * access was via a qualified super), add one to the corresponding code
2054 * for the current class, making the number odd.
2055 * This numbering scheme is used by the backend to decide whether
2056 * to issue an invokevirtual or invokespecial call.
2057 *
2058 * @see Gen#visitSelect(JCFieldAccess tree)
2059 */
2060 public enum AccessCode {
2061 UNKNOWN(-1, Tag.NO_TAG),
2062 DEREF(0, Tag.NO_TAG),
2063 ASSIGN(2, Tag.ASSIGN),
2064 PREINC(4, Tag.PREINC),
2065 PREDEC(6, Tag.PREDEC),
2066 POSTINC(8, Tag.POSTINC),
2067 POSTDEC(10, Tag.POSTDEC),
2068 FIRSTASGOP(12, Tag.NO_TAG);
2069
2070 public final int code;
2071 public final Tag tag;
2072 public static final int numberOfAccessCodes = (lushrl - ishll + lxor + 2 - iadd) * 2 + FIRSTASGOP.code + 2;
2073
2074 AccessCode(int code, Tag tag) {
2075 this.code = code;
2076 this.tag = tag;
2077 }
2078
2079 static public AccessCode getFromCode(int code) {
2080 for (AccessCode aCodes : AccessCode.values()) {
2081 if (aCodes.code == code) {
2082 return aCodes;
2083 }
2084 }
2085 return UNKNOWN;
2086 }
2087
2088 static int from(Tag tag, int opcode) {
2089 /** Map bytecode of binary operation to access code of corresponding
2090 * assignment operation. This is always an even number.
2091 */
2092 switch (tag) {
2093 case PREINC:
2094 return AccessCode.PREINC.code;
2095 case PREDEC:
2096 return AccessCode.PREDEC.code;
2097 case POSTINC:
2098 return AccessCode.POSTINC.code;
2099 case POSTDEC:
2100 return AccessCode.POSTDEC.code;
2101 }
2102 if (iadd <= opcode && opcode <= lxor) {
2103 return (opcode - iadd) * 2 + FIRSTASGOP.code;
2104 } else if (opcode == string_add) {
2105 return (lxor + 1 - iadd) * 2 + FIRSTASGOP.code;
2106 } else if (ishll <= opcode && opcode <= lushrl) {
2107 return (opcode - ishll + lxor + 2 - iadd) * 2 + FIRSTASGOP.code;
2108 }
2109 return -1;
2110 }
2111 }
2112 }
2113
2114 /** Symbol completer interface.
2115 */
2116 public static interface Completer {
2117
2118 /** Dummy completer to be used when the symbol has been completed or
2119 * does not need completion.
2120 */
2121 public final static Completer NULL_COMPLETER = new Completer() {
2122 public void complete(Symbol sym) { }
2123 public boolean isTerminal() { return true; }
2124 };
2125
2126 void complete(Symbol sym) throws CompletionFailure;
2127
2128 /** Returns true if this completer is <em>terminal</em>. A terminal
2129 * completer is used as a place holder when the symbol is completed.
2130 * Calling complete on a terminal completer will not affect the symbol.
2131 *
2132 * The dummy NULL_COMPLETER and the GraphDependencies completer are
2133 * examples of terminal completers.
2134 *
2135 * @return true iff this completer is terminal
2136 */
2137 default boolean isTerminal() {
2138 return false;
2139 }
2140 }
2141
2142 public static class CompletionFailure extends RuntimeException {
2143 private static final long serialVersionUID = 0;
2144 public Symbol sym;
2145
2146 /** A diagnostic object describing the failure
2147 */
2148 public JCDiagnostic diag;
2149
2150 /** A localized string describing the failure.
2151 * @deprecated Use {@code getDetail()} or {@code getMessage()}
2152 */
2153 @Deprecated
2154 public String errmsg;
2155
2156 public CompletionFailure(Symbol sym, String errmsg) {
2157 this.sym = sym;
2158 this.errmsg = errmsg;
2159 // this.printStackTrace();//DEBUG
2160 }
2161
2162 public CompletionFailure(Symbol sym, JCDiagnostic diag) {
2163 this.sym = sym;
2164 this.diag = diag;
2165 // this.printStackTrace();//DEBUG
2166 }
2167
2168 public JCDiagnostic getDiagnostic() {
2169 return diag;
2170 }
2171
2172 @Override
2173 public String getMessage() {
2174 if (diag != null)
2175 return diag.getMessage(null);
2176 else
2177 return errmsg;
2178 }
2179
2180 public Object getDetailValue() {
2181 return (diag != null ? diag : errmsg);
2182 }
2183
2184 @Override
2185 public CompletionFailure initCause(Throwable cause) {
2186 super.initCause(cause);
2187 return this;
2188 }
2189
2190 }
2191
2192 /**
2193 * A visitor for symbols. A visitor is used to implement operations
2194 * (or relations) on symbols. Most common operations on types are
2195 * binary relations and this interface is designed for binary
2196 * relations, that is, operations on the form
2197 * Symbol × P → R.
2198 * <!-- In plain text: Type x P -> R -->
2199 *
2200 * @param <R> the return type of the operation implemented by this
2201 * visitor; use Void if no return type is needed.
2202 * @param <P> the type of the second argument (the first being the
2203 * symbol itself) of the operation implemented by this visitor; use
2204 * Void if a second argument is not needed.
2205 */
2206 public interface Visitor<R,P> {
2207 R visitClassSymbol(ClassSymbol s, P arg);
2208 R visitMethodSymbol(MethodSymbol s, P arg);
2209 R visitPackageSymbol(PackageSymbol s, P arg);
2210 R visitOperatorSymbol(OperatorSymbol s, P arg);
2211 R visitVarSymbol(VarSymbol s, P arg);
2212 R visitTypeSymbol(TypeSymbol s, P arg);
2213 R visitSymbol(Symbol s, P arg);
2214 }
2215 }