Symbol.java revision 3905:dda71e3922d7
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 26package com.sun.tools.javac.code; 27 28import java.lang.annotation.Annotation; 29import java.lang.annotation.Inherited; 30import java.util.Collections; 31import java.util.EnumSet; 32import java.util.Map; 33import java.util.Set; 34import java.util.concurrent.Callable; 35 36import javax.lang.model.element.Element; 37import javax.lang.model.element.ElementKind; 38import javax.lang.model.element.ElementVisitor; 39import javax.lang.model.element.ExecutableElement; 40import javax.lang.model.element.Modifier; 41import javax.lang.model.element.ModuleElement; 42import javax.lang.model.element.NestingKind; 43import javax.lang.model.element.PackageElement; 44import javax.lang.model.element.TypeElement; 45import javax.lang.model.element.TypeParameterElement; 46import javax.lang.model.element.VariableElement; 47import javax.tools.JavaFileManager; 48import javax.tools.JavaFileObject; 49 50import com.sun.tools.javac.code.ClassFinder.BadEnclosingMethodAttr; 51import com.sun.tools.javac.code.Directive.RequiresFlag; 52import com.sun.tools.javac.code.Kinds.Kind; 53import com.sun.tools.javac.comp.Annotate.AnnotationTypeMetadata; 54import com.sun.tools.javac.code.Scope.WriteableScope; 55import com.sun.tools.javac.code.Type.*; 56import com.sun.tools.javac.comp.Attr; 57import com.sun.tools.javac.comp.AttrContext; 58import com.sun.tools.javac.comp.Env; 59import com.sun.tools.javac.jvm.*; 60import com.sun.tools.javac.tree.JCTree.JCFieldAccess; 61import com.sun.tools.javac.tree.JCTree.JCVariableDecl; 62import com.sun.tools.javac.tree.JCTree.Tag; 63import com.sun.tools.javac.util.*; 64import com.sun.tools.javac.util.DefinedBy.Api; 65import com.sun.tools.javac.util.Name; 66 67import static com.sun.tools.javac.code.Flags.*; 68import static com.sun.tools.javac.code.Kinds.*; 69import static com.sun.tools.javac.code.Kinds.Kind.*; 70import static com.sun.tools.javac.code.Scope.LookupKind.NON_RECURSIVE; 71import static com.sun.tools.javac.code.Symbol.OperatorSymbol.AccessCode.FIRSTASGOP; 72import static com.sun.tools.javac.code.TypeTag.CLASS; 73import static com.sun.tools.javac.code.TypeTag.FORALL; 74import static com.sun.tools.javac.code.TypeTag.TYPEVAR; 75import static com.sun.tools.javac.jvm.ByteCodes.iadd; 76import static com.sun.tools.javac.jvm.ByteCodes.ishll; 77import static com.sun.tools.javac.jvm.ByteCodes.lushrl; 78import static com.sun.tools.javac.jvm.ByteCodes.lxor; 79import 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 */ 91public 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 classLocation; 911 912 /** All directives, in natural order. */ 913 public List<com.sun.tools.javac.code.Directive> directives; 914 public List<com.sun.tools.javac.code.Directive.RequiresDirective> requires; 915 public List<com.sun.tools.javac.code.Directive.ExportsDirective> exports; 916 public List<com.sun.tools.javac.code.Directive.OpensDirective> opens; 917 public List<com.sun.tools.javac.code.Directive.ProvidesDirective> provides; 918 public List<com.sun.tools.javac.code.Directive.UsesDirective> uses; 919 920 public ClassSymbol module_info; 921 922 public PackageSymbol unnamedPackage; 923 public Map<Name, PackageSymbol> visiblePackages; 924 public Set<ModuleSymbol> readModules; 925 public List<Symbol> enclosedPackages = List.nil(); 926 927 public Completer usesProvidesCompleter = Completer.NULL_COMPLETER; 928 public final Set<ModuleFlags> flags = EnumSet.noneOf(ModuleFlags.class); 929 public final Set<ModuleResolutionFlags> resolutionFlags = EnumSet.noneOf(ModuleResolutionFlags.class); 930 931 /** 932 * Create a ModuleSymbol with an associated module-info ClassSymbol. 933 */ 934 public static ModuleSymbol create(Name name, Name module_info) { 935 ModuleSymbol msym = new ModuleSymbol(name, null); 936 ClassSymbol info = new ClassSymbol(Flags.MODULE, module_info, msym); 937 info.fullname = formFullName(module_info, msym); 938 info.flatname = info.fullname; 939 info.members_field = WriteableScope.create(info); 940 msym.module_info = info; 941 return msym; 942 } 943 944 public ModuleSymbol(Name name, Symbol owner) { 945 super(MDL, 0, name, null, owner); 946 Assert.checkNonNull(name); 947 this.type = new ModuleType(this); 948 } 949 950 @Override @DefinedBy(Api.LANGUAGE_MODEL) 951 public boolean isUnnamed() { 952 return name.isEmpty() && owner == null; 953 } 954 955 @Override 956 public boolean isDeprecated() { 957 return hasDeprecatedAnnotation(); 958 } 959 960 public boolean isNoModule() { 961 return false; 962 } 963 964 @Override @DefinedBy(Api.LANGUAGE_MODEL) 965 public ElementKind getKind() { 966 return ElementKind.MODULE; 967 } 968 969 @Override @DefinedBy(Api.LANGUAGE_MODEL) 970 public java.util.List<Directive> getDirectives() { 971 complete(); 972 completeUsesProvides(); 973 return Collections.unmodifiableList(directives); 974 } 975 976 public void completeUsesProvides() { 977 if (usesProvidesCompleter != Completer.NULL_COMPLETER) { 978 Completer c = usesProvidesCompleter; 979 usesProvidesCompleter = Completer.NULL_COMPLETER; 980 c.complete(this); 981 } 982 } 983 984 @Override 985 public ClassSymbol outermostClass() { 986 return null; 987 } 988 989 @Override 990 public String toString() { 991 // TODO: the following strings should be localized 992 // Do this with custom anon subtypes in Symtab 993 String n = (name == null) ? "<unknown>" 994 : (name.isEmpty()) ? "<unnamed>" 995 : String.valueOf(name); 996 return n; 997 } 998 999 @Override @DefinedBy(Api.LANGUAGE_MODEL) 1000 public <R, P> R accept(ElementVisitor<R, P> v, P p) { 1001 return v.visitModule(this, p); 1002 } 1003 1004 @Override @DefinedBy(Api.LANGUAGE_MODEL) 1005 public List<Symbol> getEnclosedElements() { 1006 List<Symbol> list = List.nil(); 1007 for (Symbol sym : enclosedPackages) { 1008 if (sym.members().anyMatch(m -> m.kind == TYP)) 1009 list = list.prepend(sym); 1010 } 1011 return list; 1012 } 1013 1014 public void reset() { 1015 this.directives = null; 1016 this.requires = null; 1017 this.exports = null; 1018 this.provides = null; 1019 this.uses = null; 1020 this.visiblePackages = null; 1021 } 1022 1023 } 1024 1025 public enum ModuleFlags { 1026 OPEN(0x0020), 1027 SYNTHETIC(0x1000), 1028 MANDATED(0x8000); 1029 1030 public static int value(Set<ModuleFlags> s) { 1031 int v = 0; 1032 for (ModuleFlags f: s) 1033 v |= f.value; 1034 return v; 1035 } 1036 1037 private ModuleFlags(int value) { 1038 this.value = value; 1039 } 1040 1041 public final int value; 1042 } 1043 1044 public enum ModuleResolutionFlags { 1045 DO_NOT_RESOLVE_BY_DEFAULT(0x0001), 1046 WARN_DEPRECATED(0x0002), 1047 WARN_DEPRECATED_REMOVAL(0x0004), 1048 WARN_INCUBATING(0x0008); 1049 1050 public static int value(Set<ModuleResolutionFlags> s) { 1051 int v = 0; 1052 for (ModuleResolutionFlags f: s) 1053 v |= f.value; 1054 return v; 1055 } 1056 1057 private ModuleResolutionFlags(int value) { 1058 this.value = value; 1059 } 1060 1061 public final int value; 1062 } 1063 1064 /** A class for package symbols 1065 */ 1066 public static class PackageSymbol extends TypeSymbol 1067 implements PackageElement { 1068 1069 public WriteableScope members_field; 1070 public Name fullname; 1071 public ClassSymbol package_info; // see bug 6443073 1072 public ModuleSymbol modle; 1073 // the file containing the documentation comments for the package 1074 public JavaFileObject sourcefile; 1075 1076 public PackageSymbol(Name name, Type type, Symbol owner) { 1077 super(PCK, 0, name, type, owner); 1078 this.members_field = null; 1079 this.fullname = formFullName(name, owner); 1080 } 1081 1082 public PackageSymbol(Name name, Symbol owner) { 1083 this(name, null, owner); 1084 this.type = new PackageType(this); 1085 } 1086 1087 public String toString() { 1088 return fullname.toString(); 1089 } 1090 1091 @DefinedBy(Api.LANGUAGE_MODEL) 1092 public Name getQualifiedName() { 1093 return fullname; 1094 } 1095 1096 @DefinedBy(Api.LANGUAGE_MODEL) 1097 public boolean isUnnamed() { 1098 return name.isEmpty() && owner != null; 1099 } 1100 1101 public WriteableScope members() { 1102 complete(); 1103 return members_field; 1104 } 1105 1106 public long flags() { 1107 complete(); 1108 return flags_field; 1109 } 1110 1111 @Override 1112 public List<Attribute.Compound> getRawAttributes() { 1113 complete(); 1114 if (package_info != null) { 1115 package_info.complete(); 1116 mergeAttributes(); 1117 } 1118 return super.getRawAttributes(); 1119 } 1120 1121 private void mergeAttributes() { 1122 if (metadata == null && 1123 package_info.metadata != null) { 1124 metadata = new SymbolMetadata(this); 1125 metadata.setAttributes(package_info.metadata); 1126 } 1127 } 1128 1129 /** A package "exists" if a type or package that exists has 1130 * been seen within it. 1131 */ 1132 public boolean exists() { 1133 return (flags_field & EXISTS) != 0; 1134 } 1135 1136 @DefinedBy(Api.LANGUAGE_MODEL) 1137 public ElementKind getKind() { 1138 return ElementKind.PACKAGE; 1139 } 1140 1141 @DefinedBy(Api.LANGUAGE_MODEL) 1142 public Symbol getEnclosingElement() { 1143 return modle != null && !modle.isNoModule() ? modle : null; 1144 } 1145 1146 @DefinedBy(Api.LANGUAGE_MODEL) 1147 public <R, P> R accept(ElementVisitor<R, P> v, P p) { 1148 return v.visitPackage(this, p); 1149 } 1150 1151 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) { 1152 return v.visitPackageSymbol(this, p); 1153 } 1154 1155 /**Resets the Symbol into the state good for next round of annotation processing.*/ 1156 public void reset() { 1157 metadata = null; 1158 } 1159 1160 } 1161 1162 /** A class for class symbols 1163 */ 1164 public static class ClassSymbol extends TypeSymbol implements TypeElement { 1165 1166 /** a scope for all class members; variables, methods and inner classes 1167 * type parameters are not part of this scope 1168 */ 1169 public WriteableScope members_field; 1170 1171 /** the fully qualified name of the class, i.e. pck.outer.inner. 1172 * null for anonymous classes 1173 */ 1174 public Name fullname; 1175 1176 /** the fully qualified name of the class after converting to flat 1177 * representation, i.e. pck.outer$inner, 1178 * set externally for local and anonymous classes 1179 */ 1180 public Name flatname; 1181 1182 /** the sourcefile where the class came from 1183 */ 1184 public JavaFileObject sourcefile; 1185 1186 /** the classfile from where to load this class 1187 * this will have extension .class or .java 1188 */ 1189 public JavaFileObject classfile; 1190 1191 /** the list of translated local classes (used for generating 1192 * InnerClasses attribute) 1193 */ 1194 public List<ClassSymbol> trans_local; 1195 1196 /** the constant pool of the class 1197 */ 1198 public Pool pool; 1199 1200 /** the annotation metadata attached to this class */ 1201 private AnnotationTypeMetadata annotationTypeMetadata; 1202 1203 public ClassSymbol(long flags, Name name, Type type, Symbol owner) { 1204 super(TYP, flags, name, type, owner); 1205 this.members_field = null; 1206 this.fullname = formFullName(name, owner); 1207 this.flatname = formFlatName(name, owner); 1208 this.sourcefile = null; 1209 this.classfile = null; 1210 this.pool = null; 1211 this.annotationTypeMetadata = AnnotationTypeMetadata.notAnAnnotationType(); 1212 } 1213 1214 public ClassSymbol(long flags, Name name, Symbol owner) { 1215 this( 1216 flags, 1217 name, 1218 new ClassType(Type.noType, null, null), 1219 owner); 1220 this.type.tsym = this; 1221 } 1222 1223 /** The Java source which this symbol represents. 1224 */ 1225 public String toString() { 1226 return className(); 1227 } 1228 1229 public long flags() { 1230 complete(); 1231 return flags_field; 1232 } 1233 1234 public WriteableScope members() { 1235 complete(); 1236 return members_field; 1237 } 1238 1239 @Override 1240 public List<Attribute.Compound> getRawAttributes() { 1241 complete(); 1242 return super.getRawAttributes(); 1243 } 1244 1245 @Override 1246 public List<Attribute.TypeCompound> getRawTypeAttributes() { 1247 complete(); 1248 return super.getRawTypeAttributes(); 1249 } 1250 1251 public Type erasure(Types types) { 1252 if (erasure_field == null) 1253 erasure_field = new ClassType(types.erasure(type.getEnclosingType()), 1254 List.nil(), this, 1255 type.getMetadata()); 1256 return erasure_field; 1257 } 1258 1259 public String className() { 1260 if (name.isEmpty()) 1261 return 1262 Log.getLocalizedString("anonymous.class", flatname); 1263 else 1264 return fullname.toString(); 1265 } 1266 1267 @DefinedBy(Api.LANGUAGE_MODEL) 1268 public Name getQualifiedName() { 1269 return fullname; 1270 } 1271 1272 public Name flatName() { 1273 return flatname; 1274 } 1275 1276 public boolean isSubClass(Symbol base, Types types) { 1277 if (this == base) { 1278 return true; 1279 } else if ((base.flags() & INTERFACE) != 0) { 1280 for (Type t = type; t.hasTag(CLASS); t = types.supertype(t)) 1281 for (List<Type> is = types.interfaces(t); 1282 is.nonEmpty(); 1283 is = is.tail) 1284 if (is.head.tsym.isSubClass(base, types)) return true; 1285 } else { 1286 for (Type t = type; t.hasTag(CLASS); t = types.supertype(t)) 1287 if (t.tsym == base) return true; 1288 } 1289 return false; 1290 } 1291 1292 /** Complete the elaboration of this symbol's definition. 1293 */ 1294 public void complete() throws CompletionFailure { 1295 try { 1296 super.complete(); 1297 } catch (CompletionFailure ex) { 1298 // quiet error recovery 1299 flags_field |= (PUBLIC|STATIC); 1300 this.type = new ErrorType(this, Type.noType); 1301 throw ex; 1302 } 1303 } 1304 1305 @DefinedBy(Api.LANGUAGE_MODEL) 1306 public List<Type> getInterfaces() { 1307 complete(); 1308 if (type instanceof ClassType) { 1309 ClassType t = (ClassType)type; 1310 if (t.interfaces_field == null) // FIXME: shouldn't be null 1311 t.interfaces_field = List.nil(); 1312 if (t.all_interfaces_field != null) 1313 return Type.getModelTypes(t.all_interfaces_field); 1314 return t.interfaces_field; 1315 } else { 1316 return List.nil(); 1317 } 1318 } 1319 1320 @DefinedBy(Api.LANGUAGE_MODEL) 1321 public Type getSuperclass() { 1322 complete(); 1323 if (type instanceof ClassType) { 1324 ClassType t = (ClassType)type; 1325 if (t.supertype_field == null) // FIXME: shouldn't be null 1326 t.supertype_field = Type.noType; 1327 // An interface has no superclass; its supertype is Object. 1328 return t.isInterface() 1329 ? Type.noType 1330 : t.supertype_field.getModelType(); 1331 } else { 1332 return Type.noType; 1333 } 1334 } 1335 1336 /** 1337 * Returns the next class to search for inherited annotations or {@code null} 1338 * if the next class can't be found. 1339 */ 1340 private ClassSymbol getSuperClassToSearchForAnnotations() { 1341 1342 Type sup = getSuperclass(); 1343 1344 if (!sup.hasTag(CLASS) || sup.isErroneous()) 1345 return null; 1346 1347 return (ClassSymbol) sup.tsym; 1348 } 1349 1350 1351 @Override 1352 protected <A extends Annotation> A[] getInheritedAnnotations(Class<A> annoType) { 1353 1354 ClassSymbol sup = getSuperClassToSearchForAnnotations(); 1355 1356 return sup == null ? super.getInheritedAnnotations(annoType) 1357 : sup.getAnnotationsByType(annoType); 1358 } 1359 1360 1361 @DefinedBy(Api.LANGUAGE_MODEL) 1362 public ElementKind getKind() { 1363 long flags = flags(); 1364 if ((flags & ANNOTATION) != 0) 1365 return ElementKind.ANNOTATION_TYPE; 1366 else if ((flags & INTERFACE) != 0) 1367 return ElementKind.INTERFACE; 1368 else if ((flags & ENUM) != 0) 1369 return ElementKind.ENUM; 1370 else 1371 return ElementKind.CLASS; 1372 } 1373 1374 @Override @DefinedBy(Api.LANGUAGE_MODEL) 1375 public Set<Modifier> getModifiers() { 1376 long flags = flags(); 1377 return Flags.asModifierSet(flags & ~DEFAULT); 1378 } 1379 1380 @DefinedBy(Api.LANGUAGE_MODEL) 1381 public NestingKind getNestingKind() { 1382 complete(); 1383 if (owner.kind == PCK) 1384 return NestingKind.TOP_LEVEL; 1385 else if (name.isEmpty()) 1386 return NestingKind.ANONYMOUS; 1387 else if (owner.kind == MTH) 1388 return NestingKind.LOCAL; 1389 else 1390 return NestingKind.MEMBER; 1391 } 1392 1393 1394 @Override 1395 protected <A extends Annotation> Attribute.Compound getAttribute(final Class<A> annoType) { 1396 1397 Attribute.Compound attrib = super.getAttribute(annoType); 1398 1399 boolean inherited = annoType.isAnnotationPresent(Inherited.class); 1400 if (attrib != null || !inherited) 1401 return attrib; 1402 1403 // Search supertypes 1404 ClassSymbol superType = getSuperClassToSearchForAnnotations(); 1405 return superType == null ? null 1406 : superType.getAttribute(annoType); 1407 } 1408 1409 1410 1411 1412 @DefinedBy(Api.LANGUAGE_MODEL) 1413 public <R, P> R accept(ElementVisitor<R, P> v, P p) { 1414 return v.visitType(this, p); 1415 } 1416 1417 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) { 1418 return v.visitClassSymbol(this, p); 1419 } 1420 1421 public void markAbstractIfNeeded(Types types) { 1422 if (types.enter.getEnv(this) != null && 1423 (flags() & ENUM) != 0 && types.supertype(type).tsym == types.syms.enumSym && 1424 (flags() & (FINAL | ABSTRACT)) == 0) { 1425 if (types.firstUnimplementedAbstract(this) != null) 1426 // add the ABSTRACT flag to an enum 1427 flags_field |= ABSTRACT; 1428 } 1429 } 1430 1431 /**Resets the Symbol into the state good for next round of annotation processing.*/ 1432 public void reset() { 1433 kind = TYP; 1434 erasure_field = null; 1435 members_field = null; 1436 flags_field = 0; 1437 if (type instanceof ClassType) { 1438 ClassType t = (ClassType)type; 1439 t.setEnclosingType(Type.noType); 1440 t.rank_field = -1; 1441 t.typarams_field = null; 1442 t.allparams_field = null; 1443 t.supertype_field = null; 1444 t.interfaces_field = null; 1445 t.all_interfaces_field = null; 1446 } 1447 clearAnnotationMetadata(); 1448 } 1449 1450 public void clearAnnotationMetadata() { 1451 metadata = null; 1452 annotationTypeMetadata = AnnotationTypeMetadata.notAnAnnotationType(); 1453 } 1454 1455 @Override 1456 public AnnotationTypeMetadata getAnnotationTypeMetadata() { 1457 return annotationTypeMetadata; 1458 } 1459 1460 @Override 1461 public boolean isAnnotationType() { 1462 return (flags_field & Flags.ANNOTATION) != 0; 1463 } 1464 1465 public void setAnnotationTypeMetadata(AnnotationTypeMetadata a) { 1466 Assert.checkNonNull(a); 1467 Assert.check(!annotationTypeMetadata.isMetadataForAnnotationType()); 1468 this.annotationTypeMetadata = a; 1469 } 1470 } 1471 1472 1473 /** A class for variable symbols 1474 */ 1475 public static class VarSymbol extends Symbol implements VariableElement { 1476 1477 /** The variable's declaration position. 1478 */ 1479 public int pos = Position.NOPOS; 1480 1481 /** The variable's address. Used for different purposes during 1482 * flow analysis, translation and code generation. 1483 * Flow analysis: 1484 * If this is a blank final or local variable, its sequence number. 1485 * Translation: 1486 * If this is a private field, its access number. 1487 * Code generation: 1488 * If this is a local variable, its logical slot number. 1489 */ 1490 public int adr = -1; 1491 1492 /** Construct a variable symbol, given its flags, name, type and owner. 1493 */ 1494 public VarSymbol(long flags, Name name, Type type, Symbol owner) { 1495 super(VAR, flags, name, type, owner); 1496 } 1497 1498 /** Clone this symbol with new owner. 1499 */ 1500 public VarSymbol clone(Symbol newOwner) { 1501 VarSymbol v = new VarSymbol(flags_field, name, type, newOwner) { 1502 @Override 1503 public Symbol baseSymbol() { 1504 return VarSymbol.this; 1505 } 1506 }; 1507 v.pos = pos; 1508 v.adr = adr; 1509 v.data = data; 1510// System.out.println("clone " + v + " in " + newOwner);//DEBUG 1511 return v; 1512 } 1513 1514 public String toString() { 1515 return name.toString(); 1516 } 1517 1518 public Symbol asMemberOf(Type site, Types types) { 1519 return new VarSymbol(flags_field, name, types.memberType(site, this), owner); 1520 } 1521 1522 @DefinedBy(Api.LANGUAGE_MODEL) 1523 public ElementKind getKind() { 1524 long flags = flags(); 1525 if ((flags & PARAMETER) != 0) { 1526 if (isExceptionParameter()) 1527 return ElementKind.EXCEPTION_PARAMETER; 1528 else 1529 return ElementKind.PARAMETER; 1530 } else if ((flags & ENUM) != 0) { 1531 return ElementKind.ENUM_CONSTANT; 1532 } else if (owner.kind == TYP || owner.kind == ERR) { 1533 return ElementKind.FIELD; 1534 } else if (isResourceVariable()) { 1535 return ElementKind.RESOURCE_VARIABLE; 1536 } else { 1537 return ElementKind.LOCAL_VARIABLE; 1538 } 1539 } 1540 1541 @DefinedBy(Api.LANGUAGE_MODEL) 1542 public <R, P> R accept(ElementVisitor<R, P> v, P p) { 1543 return v.visitVariable(this, p); 1544 } 1545 1546 @DefinedBy(Api.LANGUAGE_MODEL) 1547 public Object getConstantValue() { // Mirror API 1548 return Constants.decode(getConstValue(), type); 1549 } 1550 1551 public void setLazyConstValue(final Env<AttrContext> env, 1552 final Attr attr, 1553 final JCVariableDecl variable) 1554 { 1555 setData((Callable<Object>)() -> attr.attribLazyConstantValue(env, variable, type)); 1556 } 1557 1558 /** 1559 * The variable's constant value, if this is a constant. 1560 * Before the constant value is evaluated, it points to an 1561 * initializer environment. If this is not a constant, it can 1562 * be used for other stuff. 1563 */ 1564 private Object data; 1565 1566 public boolean isExceptionParameter() { 1567 return data == ElementKind.EXCEPTION_PARAMETER; 1568 } 1569 1570 public boolean isResourceVariable() { 1571 return data == ElementKind.RESOURCE_VARIABLE; 1572 } 1573 1574 public Object getConstValue() { 1575 // TODO: Consider if getConstValue and getConstantValue can be collapsed 1576 if (data == ElementKind.EXCEPTION_PARAMETER || 1577 data == ElementKind.RESOURCE_VARIABLE) { 1578 return null; 1579 } else if (data instanceof Callable<?>) { 1580 // In this case, this is a final variable, with an as 1581 // yet unevaluated initializer. 1582 Callable<?> eval = (Callable<?>)data; 1583 data = null; // to make sure we don't evaluate this twice. 1584 try { 1585 data = eval.call(); 1586 } catch (Exception ex) { 1587 throw new AssertionError(ex); 1588 } 1589 } 1590 return data; 1591 } 1592 1593 public void setData(Object data) { 1594 Assert.check(!(data instanceof Env<?>), this); 1595 this.data = data; 1596 } 1597 1598 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) { 1599 return v.visitVarSymbol(this, p); 1600 } 1601 } 1602 1603 /** A class for method symbols. 1604 */ 1605 public static class MethodSymbol extends Symbol implements ExecutableElement { 1606 1607 /** The code of the method. */ 1608 public Code code = null; 1609 1610 /** The extra (synthetic/mandated) parameters of the method. */ 1611 public List<VarSymbol> extraParams = List.nil(); 1612 1613 /** The captured local variables in an anonymous class */ 1614 public List<VarSymbol> capturedLocals = List.nil(); 1615 1616 /** The parameters of the method. */ 1617 public List<VarSymbol> params = null; 1618 1619 /** The names of the parameters */ 1620 public List<Name> savedParameterNames; 1621 1622 /** For an annotation type element, its default value if any. 1623 * The value is null if none appeared in the method 1624 * declaration. 1625 */ 1626 public Attribute defaultValue = null; 1627 1628 /** Construct a method symbol, given its flags, name, type and owner. 1629 */ 1630 public MethodSymbol(long flags, Name name, Type type, Symbol owner) { 1631 super(MTH, flags, name, type, owner); 1632 if (owner.type.hasTag(TYPEVAR)) Assert.error(owner + "." + name); 1633 } 1634 1635 /** Clone this symbol with new owner. 1636 */ 1637 public MethodSymbol clone(Symbol newOwner) { 1638 MethodSymbol m = new MethodSymbol(flags_field, name, type, newOwner) { 1639 @Override 1640 public Symbol baseSymbol() { 1641 return MethodSymbol.this; 1642 } 1643 }; 1644 m.code = code; 1645 return m; 1646 } 1647 1648 @Override @DefinedBy(Api.LANGUAGE_MODEL) 1649 public Set<Modifier> getModifiers() { 1650 long flags = flags(); 1651 return Flags.asModifierSet((flags & DEFAULT) != 0 ? flags & ~ABSTRACT : flags); 1652 } 1653 1654 /** The Java source which this symbol represents. 1655 */ 1656 public String toString() { 1657 if ((flags() & BLOCK) != 0) { 1658 return owner.name.toString(); 1659 } else { 1660 String s = (name == name.table.names.init) 1661 ? owner.name.toString() 1662 : name.toString(); 1663 if (type != null) { 1664 if (type.hasTag(FORALL)) 1665 s = "<" + ((ForAll)type).getTypeArguments() + ">" + s; 1666 s += "(" + type.argtypes((flags() & VARARGS) != 0) + ")"; 1667 } 1668 return s; 1669 } 1670 } 1671 1672 public boolean isDynamic() { 1673 return false; 1674 } 1675 1676 /** find a symbol that this (proxy method) symbol implements. 1677 * @param c The class whose members are searched for 1678 * implementations 1679 */ 1680 public Symbol implemented(TypeSymbol c, Types types) { 1681 Symbol impl = null; 1682 for (List<Type> is = types.interfaces(c.type); 1683 impl == null && is.nonEmpty(); 1684 is = is.tail) { 1685 TypeSymbol i = is.head.tsym; 1686 impl = implementedIn(i, types); 1687 if (impl == null) 1688 impl = implemented(i, types); 1689 } 1690 return impl; 1691 } 1692 1693 public Symbol implementedIn(TypeSymbol c, Types types) { 1694 Symbol impl = null; 1695 for (Symbol sym : c.members().getSymbolsByName(name)) { 1696 if (this.overrides(sym, (TypeSymbol)owner, types, true) && 1697 // FIXME: I suspect the following requires a 1698 // subst() for a parametric return type. 1699 types.isSameType(type.getReturnType(), 1700 types.memberType(owner.type, sym).getReturnType())) { 1701 impl = sym; 1702 } 1703 } 1704 return impl; 1705 } 1706 1707 /** Will the erasure of this method be considered by the VM to 1708 * override the erasure of the other when seen from class `origin'? 1709 */ 1710 public boolean binaryOverrides(Symbol _other, TypeSymbol origin, Types types) { 1711 if (isConstructor() || _other.kind != MTH) return false; 1712 1713 if (this == _other) return true; 1714 MethodSymbol other = (MethodSymbol)_other; 1715 1716 // check for a direct implementation 1717 if (other.isOverridableIn((TypeSymbol)owner) && 1718 types.asSuper(owner.type, other.owner) != null && 1719 types.isSameType(erasure(types), other.erasure(types))) 1720 return true; 1721 1722 // check for an inherited implementation 1723 return 1724 (flags() & ABSTRACT) == 0 && 1725 other.isOverridableIn(origin) && 1726 this.isMemberOf(origin, types) && 1727 types.isSameType(erasure(types), other.erasure(types)); 1728 } 1729 1730 /** The implementation of this (abstract) symbol in class origin, 1731 * from the VM's point of view, null if method does not have an 1732 * implementation in class. 1733 * @param origin The class of which the implementation is a member. 1734 */ 1735 public MethodSymbol binaryImplementation(ClassSymbol origin, Types types) { 1736 for (TypeSymbol c = origin; c != null; c = types.supertype(c.type).tsym) { 1737 for (Symbol sym : c.members().getSymbolsByName(name)) { 1738 if (sym.kind == MTH && 1739 ((MethodSymbol)sym).binaryOverrides(this, origin, types)) 1740 return (MethodSymbol)sym; 1741 } 1742 } 1743 return null; 1744 } 1745 1746 /** Does this symbol override `other' symbol, when both are seen as 1747 * members of class `origin'? It is assumed that _other is a member 1748 * of origin. 1749 * 1750 * It is assumed that both symbols have the same name. The static 1751 * modifier is ignored for this test. 1752 * 1753 * A quirk in the works is that if the receiver is a method symbol for 1754 * an inherited abstract method we answer false summarily all else being 1755 * immaterial. Abstract "own" methods (i.e `this' is a direct member of 1756 * origin) don't get rejected as summarily and are put to test against the 1757 * suitable criteria. 1758 * 1759 * See JLS 8.4.6.1 (without transitivity) and 8.4.6.4 1760 */ 1761 public boolean overrides(Symbol _other, TypeSymbol origin, Types types, boolean checkResult) { 1762 return overrides(_other, origin, types, checkResult, true); 1763 } 1764 1765 /** Does this symbol override `other' symbol, when both are seen as 1766 * members of class `origin'? It is assumed that _other is a member 1767 * of origin. 1768 * 1769 * Caveat: If `this' is an abstract inherited member of origin, it is 1770 * deemed to override `other' only when `requireConcreteIfInherited' 1771 * is false. 1772 * 1773 * It is assumed that both symbols have the same name. The static 1774 * modifier is ignored for this test. 1775 * 1776 * See JLS 8.4.6.1 (without transitivity) and 8.4.6.4 1777 */ 1778 public boolean overrides(Symbol _other, TypeSymbol origin, Types types, boolean checkResult, 1779 boolean requireConcreteIfInherited) { 1780 if (isConstructor() || _other.kind != MTH) return false; 1781 1782 if (this == _other) return true; 1783 MethodSymbol other = (MethodSymbol)_other; 1784 1785 // check for a direct implementation 1786 if (other.isOverridableIn((TypeSymbol)owner) && 1787 types.asSuper(owner.type, other.owner) != null) { 1788 Type mt = types.memberType(owner.type, this); 1789 Type ot = types.memberType(owner.type, other); 1790 if (types.isSubSignature(mt, ot)) { 1791 if (!checkResult) 1792 return true; 1793 if (types.returnTypeSubstitutable(mt, ot)) 1794 return true; 1795 } 1796 } 1797 1798 // check for an inherited implementation 1799 if (((flags() & ABSTRACT) != 0 && requireConcreteIfInherited) || 1800 ((other.flags() & ABSTRACT) == 0 && (other.flags() & DEFAULT) == 0) || 1801 !other.isOverridableIn(origin) || 1802 !this.isMemberOf(origin, types)) 1803 return false; 1804 1805 // assert types.asSuper(origin.type, other.owner) != null; 1806 Type mt = types.memberType(origin.type, this); 1807 Type ot = types.memberType(origin.type, other); 1808 return 1809 types.isSubSignature(mt, ot) && 1810 (!checkResult || types.resultSubtype(mt, ot, types.noWarnings)); 1811 } 1812 1813 private boolean isOverridableIn(TypeSymbol origin) { 1814 // JLS 8.4.6.1 1815 switch ((int)(flags_field & Flags.AccessFlags)) { 1816 case Flags.PRIVATE: 1817 return false; 1818 case Flags.PUBLIC: 1819 return !this.owner.isInterface() || 1820 (flags_field & STATIC) == 0; 1821 case Flags.PROTECTED: 1822 return (origin.flags() & INTERFACE) == 0; 1823 case 0: 1824 // for package private: can only override in the same 1825 // package 1826 return 1827 this.packge() == origin.packge() && 1828 (origin.flags() & INTERFACE) == 0; 1829 default: 1830 return false; 1831 } 1832 } 1833 1834 @Override 1835 public boolean isInheritedIn(Symbol clazz, Types types) { 1836 switch ((int)(flags_field & Flags.AccessFlags)) { 1837 case PUBLIC: 1838 return !this.owner.isInterface() || 1839 clazz == owner || 1840 (flags_field & STATIC) == 0; 1841 default: 1842 return super.isInheritedIn(clazz, types); 1843 } 1844 } 1845 1846 public boolean isLambdaMethod() { 1847 return (flags() & LAMBDA_METHOD) == LAMBDA_METHOD; 1848 } 1849 1850 /** The implementation of this (abstract) symbol in class origin; 1851 * null if none exists. Synthetic methods are not considered 1852 * as possible implementations. 1853 */ 1854 public MethodSymbol implementation(TypeSymbol origin, Types types, boolean checkResult) { 1855 return implementation(origin, types, checkResult, implementation_filter); 1856 } 1857 // where 1858 public static final Filter<Symbol> implementation_filter = s -> 1859 s.kind == MTH && (s.flags() & SYNTHETIC) == 0; 1860 1861 public MethodSymbol implementation(TypeSymbol origin, Types types, boolean checkResult, Filter<Symbol> implFilter) { 1862 MethodSymbol res = types.implementation(this, origin, checkResult, implFilter); 1863 if (res != null) 1864 return res; 1865 // if origin is derived from a raw type, we might have missed 1866 // an implementation because we do not know enough about instantiations. 1867 // in this case continue with the supertype as origin. 1868 if (types.isDerivedRaw(origin.type) && !origin.isInterface()) 1869 return implementation(types.supertype(origin.type).tsym, types, checkResult); 1870 else 1871 return null; 1872 } 1873 1874 public List<VarSymbol> params() { 1875 owner.complete(); 1876 if (params == null) { 1877 // If ClassReader.saveParameterNames has been set true, then 1878 // savedParameterNames will be set to a list of names that 1879 // matches the types in type.getParameterTypes(). If any names 1880 // were not found in the class file, those names in the list will 1881 // be set to the empty name. 1882 // If ClassReader.saveParameterNames has been set false, then 1883 // savedParameterNames will be null. 1884 List<Name> paramNames = savedParameterNames; 1885 savedParameterNames = null; 1886 // discard the provided names if the list of names is the wrong size. 1887 if (paramNames == null || paramNames.size() != type.getParameterTypes().size()) { 1888 paramNames = List.nil(); 1889 } 1890 ListBuffer<VarSymbol> buf = new ListBuffer<>(); 1891 List<Name> remaining = paramNames; 1892 // assert: remaining and paramNames are both empty or both 1893 // have same cardinality as type.getParameterTypes() 1894 int i = 0; 1895 for (Type t : type.getParameterTypes()) { 1896 Name paramName; 1897 if (remaining.isEmpty()) { 1898 // no names for any parameters available 1899 paramName = createArgName(i, paramNames); 1900 } else { 1901 paramName = remaining.head; 1902 remaining = remaining.tail; 1903 if (paramName.isEmpty()) { 1904 // no name for this specific parameter 1905 paramName = createArgName(i, paramNames); 1906 } 1907 } 1908 buf.append(new VarSymbol(PARAMETER, paramName, t, this)); 1909 i++; 1910 } 1911 params = buf.toList(); 1912 } 1913 return params; 1914 } 1915 1916 // Create a name for the argument at position 'index' that is not in 1917 // the exclude list. In normal use, either no names will have been 1918 // provided, in which case the exclude list is empty, or all the names 1919 // will have been provided, in which case this method will not be called. 1920 private Name createArgName(int index, List<Name> exclude) { 1921 String prefix = "arg"; 1922 while (true) { 1923 Name argName = name.table.fromString(prefix + index); 1924 if (!exclude.contains(argName)) 1925 return argName; 1926 prefix += "$"; 1927 } 1928 } 1929 1930 public Symbol asMemberOf(Type site, Types types) { 1931 return new MethodSymbol(flags_field, name, types.memberType(site, this), owner); 1932 } 1933 1934 @DefinedBy(Api.LANGUAGE_MODEL) 1935 public ElementKind getKind() { 1936 if (name == name.table.names.init) 1937 return ElementKind.CONSTRUCTOR; 1938 else if (name == name.table.names.clinit) 1939 return ElementKind.STATIC_INIT; 1940 else if ((flags() & BLOCK) != 0) 1941 return isStatic() ? ElementKind.STATIC_INIT : ElementKind.INSTANCE_INIT; 1942 else 1943 return ElementKind.METHOD; 1944 } 1945 1946 public boolean isStaticOrInstanceInit() { 1947 return getKind() == ElementKind.STATIC_INIT || 1948 getKind() == ElementKind.INSTANCE_INIT; 1949 } 1950 1951 @DefinedBy(Api.LANGUAGE_MODEL) 1952 public Attribute getDefaultValue() { 1953 return defaultValue; 1954 } 1955 1956 @DefinedBy(Api.LANGUAGE_MODEL) 1957 public List<VarSymbol> getParameters() { 1958 return params(); 1959 } 1960 1961 @DefinedBy(Api.LANGUAGE_MODEL) 1962 public boolean isVarArgs() { 1963 return (flags() & VARARGS) != 0; 1964 } 1965 1966 @DefinedBy(Api.LANGUAGE_MODEL) 1967 public boolean isDefault() { 1968 return (flags() & DEFAULT) != 0; 1969 } 1970 1971 @DefinedBy(Api.LANGUAGE_MODEL) 1972 public <R, P> R accept(ElementVisitor<R, P> v, P p) { 1973 return v.visitExecutable(this, p); 1974 } 1975 1976 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) { 1977 return v.visitMethodSymbol(this, p); 1978 } 1979 1980 @DefinedBy(Api.LANGUAGE_MODEL) 1981 public Type getReceiverType() { 1982 return asType().getReceiverType(); 1983 } 1984 1985 @DefinedBy(Api.LANGUAGE_MODEL) 1986 public Type getReturnType() { 1987 return asType().getReturnType(); 1988 } 1989 1990 @DefinedBy(Api.LANGUAGE_MODEL) 1991 public List<Type> getThrownTypes() { 1992 return asType().getThrownTypes(); 1993 } 1994 } 1995 1996 /** A class for invokedynamic method calls. 1997 */ 1998 public static class DynamicMethodSymbol extends MethodSymbol { 1999 2000 public Object[] staticArgs; 2001 public Symbol bsm; 2002 public int bsmKind; 2003 2004 public DynamicMethodSymbol(Name name, Symbol owner, int bsmKind, MethodSymbol bsm, Type type, Object[] staticArgs) { 2005 super(0, name, type, owner); 2006 this.bsm = bsm; 2007 this.bsmKind = bsmKind; 2008 this.staticArgs = staticArgs; 2009 } 2010 2011 @Override 2012 public boolean isDynamic() { 2013 return true; 2014 } 2015 } 2016 2017 /** A class for predefined operators. 2018 */ 2019 public static class OperatorSymbol extends MethodSymbol { 2020 2021 public int opcode; 2022 private int accessCode = Integer.MIN_VALUE; 2023 2024 public OperatorSymbol(Name name, Type type, int opcode, Symbol owner) { 2025 super(PUBLIC | STATIC, name, type, owner); 2026 this.opcode = opcode; 2027 } 2028 2029 @Override 2030 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) { 2031 return v.visitOperatorSymbol(this, p); 2032 } 2033 2034 public int getAccessCode(Tag tag) { 2035 if (accessCode != Integer.MIN_VALUE && !tag.isIncOrDecUnaryOp()) { 2036 return accessCode; 2037 } 2038 accessCode = AccessCode.from(tag, opcode); 2039 return accessCode; 2040 } 2041 2042 /** Access codes for dereferencing, assignment, 2043 * and pre/post increment/decrement. 2044 2045 * All access codes for accesses to the current class are even. 2046 * If a member of the superclass should be accessed instead (because 2047 * access was via a qualified super), add one to the corresponding code 2048 * for the current class, making the number odd. 2049 * This numbering scheme is used by the backend to decide whether 2050 * to issue an invokevirtual or invokespecial call. 2051 * 2052 * @see Gen#visitSelect(JCFieldAccess tree) 2053 */ 2054 public enum AccessCode { 2055 UNKNOWN(-1, Tag.NO_TAG), 2056 DEREF(0, Tag.NO_TAG), 2057 ASSIGN(2, Tag.ASSIGN), 2058 PREINC(4, Tag.PREINC), 2059 PREDEC(6, Tag.PREDEC), 2060 POSTINC(8, Tag.POSTINC), 2061 POSTDEC(10, Tag.POSTDEC), 2062 FIRSTASGOP(12, Tag.NO_TAG); 2063 2064 public final int code; 2065 public final Tag tag; 2066 public static final int numberOfAccessCodes = (lushrl - ishll + lxor + 2 - iadd) * 2 + FIRSTASGOP.code + 2; 2067 2068 AccessCode(int code, Tag tag) { 2069 this.code = code; 2070 this.tag = tag; 2071 } 2072 2073 static public AccessCode getFromCode(int code) { 2074 for (AccessCode aCodes : AccessCode.values()) { 2075 if (aCodes.code == code) { 2076 return aCodes; 2077 } 2078 } 2079 return UNKNOWN; 2080 } 2081 2082 static int from(Tag tag, int opcode) { 2083 /** Map bytecode of binary operation to access code of corresponding 2084 * assignment operation. This is always an even number. 2085 */ 2086 switch (tag) { 2087 case PREINC: 2088 return AccessCode.PREINC.code; 2089 case PREDEC: 2090 return AccessCode.PREDEC.code; 2091 case POSTINC: 2092 return AccessCode.POSTINC.code; 2093 case POSTDEC: 2094 return AccessCode.POSTDEC.code; 2095 } 2096 if (iadd <= opcode && opcode <= lxor) { 2097 return (opcode - iadd) * 2 + FIRSTASGOP.code; 2098 } else if (opcode == string_add) { 2099 return (lxor + 1 - iadd) * 2 + FIRSTASGOP.code; 2100 } else if (ishll <= opcode && opcode <= lushrl) { 2101 return (opcode - ishll + lxor + 2 - iadd) * 2 + FIRSTASGOP.code; 2102 } 2103 return -1; 2104 } 2105 } 2106 } 2107 2108 /** Symbol completer interface. 2109 */ 2110 public static interface Completer { 2111 2112 /** Dummy completer to be used when the symbol has been completed or 2113 * does not need completion. 2114 */ 2115 public final static Completer NULL_COMPLETER = new Completer() { 2116 public void complete(Symbol sym) { } 2117 public boolean isTerminal() { return true; } 2118 }; 2119 2120 void complete(Symbol sym) throws CompletionFailure; 2121 2122 /** Returns true if this completer is <em>terminal</em>. A terminal 2123 * completer is used as a place holder when the symbol is completed. 2124 * Calling complete on a terminal completer will not affect the symbol. 2125 * 2126 * The dummy NULL_COMPLETER and the GraphDependencies completer are 2127 * examples of terminal completers. 2128 * 2129 * @return true iff this completer is terminal 2130 */ 2131 default boolean isTerminal() { 2132 return false; 2133 } 2134 } 2135 2136 public static class CompletionFailure extends RuntimeException { 2137 private static final long serialVersionUID = 0; 2138 public Symbol sym; 2139 2140 /** A diagnostic object describing the failure 2141 */ 2142 public JCDiagnostic diag; 2143 2144 /** A localized string describing the failure. 2145 * @deprecated Use {@code getDetail()} or {@code getMessage()} 2146 */ 2147 @Deprecated 2148 public String errmsg; 2149 2150 public CompletionFailure(Symbol sym, String errmsg) { 2151 this.sym = sym; 2152 this.errmsg = errmsg; 2153// this.printStackTrace();//DEBUG 2154 } 2155 2156 public CompletionFailure(Symbol sym, JCDiagnostic diag) { 2157 this.sym = sym; 2158 this.diag = diag; 2159// this.printStackTrace();//DEBUG 2160 } 2161 2162 public JCDiagnostic getDiagnostic() { 2163 return diag; 2164 } 2165 2166 @Override 2167 public String getMessage() { 2168 if (diag != null) 2169 return diag.getMessage(null); 2170 else 2171 return errmsg; 2172 } 2173 2174 public Object getDetailValue() { 2175 return (diag != null ? diag : errmsg); 2176 } 2177 2178 @Override 2179 public CompletionFailure initCause(Throwable cause) { 2180 super.initCause(cause); 2181 return this; 2182 } 2183 2184 } 2185 2186 /** 2187 * A visitor for symbols. A visitor is used to implement operations 2188 * (or relations) on symbols. Most common operations on types are 2189 * binary relations and this interface is designed for binary 2190 * relations, that is, operations on the form 2191 * Symbol × P → R. 2192 * <!-- In plain text: Type x P -> R --> 2193 * 2194 * @param <R> the return type of the operation implemented by this 2195 * visitor; use Void if no return type is needed. 2196 * @param <P> the type of the second argument (the first being the 2197 * symbol itself) of the operation implemented by this visitor; use 2198 * Void if a second argument is not needed. 2199 */ 2200 public interface Visitor<R,P> { 2201 R visitClassSymbol(ClassSymbol s, P arg); 2202 R visitMethodSymbol(MethodSymbol s, P arg); 2203 R visitPackageSymbol(PackageSymbol s, P arg); 2204 R visitOperatorSymbol(OperatorSymbol s, P arg); 2205 R visitVarSymbol(VarSymbol s, P arg); 2206 R visitTypeSymbol(TypeSymbol s, P arg); 2207 R visitSymbol(Symbol s, P arg); 2208 } 2209} 2210