src/share/classes/com/sun/tools/javac/code/Symbol.java

Thu, 09 Dec 2010 15:50:34 +0000

author
mcimadamore
date
Thu, 09 Dec 2010 15:50:34 +0000
changeset 780
1d625fbe6c22
parent 697
28b021bb889f
child 815
d17f37522154
permissions
-rw-r--r--

6476118: compiler bug causes runtime ClassCastException for generics overloading
Summary: compiler allows bridge methods to override unrelated method
Reviewed-by: jjg

duke@1 1 /*
sundar@697 2 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.tools.javac.code;
duke@1 27
duke@1 28 import java.util.Set;
duke@1 29 import java.util.concurrent.Callable;
duke@1 30 import javax.lang.model.element.*;
duke@1 31 import javax.tools.JavaFileObject;
duke@1 32
duke@1 33 import com.sun.tools.javac.util.*;
duke@1 34 import com.sun.tools.javac.util.Name;
duke@1 35 import com.sun.tools.javac.code.Type.*;
duke@1 36 import com.sun.tools.javac.comp.Attr;
duke@1 37 import com.sun.tools.javac.comp.AttrContext;
duke@1 38 import com.sun.tools.javac.comp.Env;
duke@1 39 import com.sun.tools.javac.jvm.*;
duke@1 40 import com.sun.tools.javac.model.*;
duke@1 41 import com.sun.tools.javac.tree.JCTree;
duke@1 42
duke@1 43 import static com.sun.tools.javac.code.Flags.*;
duke@1 44 import static com.sun.tools.javac.code.Kinds.*;
duke@1 45 import static com.sun.tools.javac.code.TypeTags.*;
duke@1 46
duke@1 47 /** Root class for Java symbols. It contains subclasses
duke@1 48 * for specific sorts of symbols, such as variables, methods and operators,
duke@1 49 * types, packages. Each subclass is represented as a static inner class
duke@1 50 * inside Symbol.
duke@1 51 *
jjg@581 52 * <p><b>This is NOT part of any supported API.
jjg@581 53 * If you write code that depends on this, you do so at your own risk.
duke@1 54 * This code and its internal interfaces are subject to change or
duke@1 55 * deletion without notice.</b>
duke@1 56 */
duke@1 57 public abstract class Symbol implements Element {
duke@1 58 // public Throwable debug = new Throwable();
duke@1 59
duke@1 60 /** The kind of this symbol.
duke@1 61 * @see Kinds
duke@1 62 */
duke@1 63 public int kind;
duke@1 64
duke@1 65 /** The flags of this symbol.
duke@1 66 */
duke@1 67 public long flags_field;
duke@1 68
duke@1 69 /** An accessor method for the flags of this symbol.
duke@1 70 * Flags of class symbols should be accessed through the accessor
duke@1 71 * method to make sure that the class symbol is loaded.
duke@1 72 */
duke@1 73 public long flags() { return flags_field; }
duke@1 74
duke@1 75 /** The attributes of this symbol.
duke@1 76 */
duke@1 77 public List<Attribute.Compound> attributes_field;
duke@1 78
duke@1 79 /** An accessor method for the attributes of this symbol.
duke@1 80 * Attributes of class symbols should be accessed through the accessor
duke@1 81 * method to make sure that the class symbol is loaded.
duke@1 82 */
duke@1 83 public List<Attribute.Compound> getAnnotationMirrors() {
duke@1 84 assert attributes_field != null;
duke@1 85 return attributes_field;
duke@1 86 }
duke@1 87
duke@1 88 /** Fetch a particular annotation from a symbol. */
duke@1 89 public Attribute.Compound attribute(Symbol anno) {
duke@1 90 for (Attribute.Compound a : getAnnotationMirrors())
duke@1 91 if (a.type.tsym == anno) return a;
duke@1 92 return null;
duke@1 93 }
duke@1 94
duke@1 95 /** The name of this symbol in Utf8 representation.
duke@1 96 */
duke@1 97 public Name name;
duke@1 98
duke@1 99 /** The type of this symbol.
duke@1 100 */
duke@1 101 public Type type;
duke@1 102
jjg@308 103 /** The type annotations targeted to a tree directly owned by this symbol
jjg@308 104 */
jjg@308 105 // type annotations are stored here for two purposes:
jjg@308 106 // - convenient location to store annotations for generation after erasure
jjg@308 107 // - a private interface for accessing type annotations parsed from
jjg@308 108 // classfiles
jjg@308 109 // the field is populated for the following declaration only
jjg@308 110 // class, field, variable and type parameters
jjg@308 111 //
jjg@308 112 public List<Attribute.TypeCompound> typeAnnotations;
jjg@308 113
duke@1 114 /** The owner of this symbol.
duke@1 115 */
duke@1 116 public Symbol owner;
duke@1 117
duke@1 118 /** The completer of this symbol.
duke@1 119 */
duke@1 120 public Completer completer;
duke@1 121
duke@1 122 /** A cache for the type erasure of this symbol.
duke@1 123 */
duke@1 124 public Type erasure_field;
duke@1 125
duke@1 126 /** Construct a symbol with given kind, flags, name, type and owner.
duke@1 127 */
duke@1 128 public Symbol(int kind, long flags, Name name, Type type, Symbol owner) {
duke@1 129 this.kind = kind;
duke@1 130 this.flags_field = flags;
duke@1 131 this.type = type;
duke@1 132 this.owner = owner;
duke@1 133 this.completer = null;
duke@1 134 this.erasure_field = null;
duke@1 135 this.attributes_field = List.nil();
jjg@308 136 this.typeAnnotations = List.nil();
duke@1 137 this.name = name;
duke@1 138 }
duke@1 139
duke@1 140 /** Clone this symbol with new owner.
duke@1 141 * Legal only for fields and methods.
duke@1 142 */
duke@1 143 public Symbol clone(Symbol newOwner) {
duke@1 144 throw new AssertionError();
duke@1 145 }
duke@1 146
mcimadamore@121 147 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
mcimadamore@121 148 return v.visitSymbol(this, p);
mcimadamore@121 149 }
mcimadamore@121 150
duke@1 151 /** The Java source which this symbol represents.
duke@1 152 * A description of this symbol; overrides Object.
duke@1 153 */
duke@1 154 public String toString() {
duke@1 155 return name.toString();
duke@1 156 }
duke@1 157
duke@1 158 /** A Java source description of the location of this symbol; used for
mcimadamore@80 159 * error reporting.
mcimadamore@80 160 *
mcimadamore@80 161 * @return null if the symbol is a package or a toplevel class defined in
mcimadamore@80 162 * the default package; otherwise, the owner symbol is returned
duke@1 163 */
mcimadamore@80 164 public Symbol location() {
jjg@509 165 if (owner.name == null || (owner.name.isEmpty() && owner.kind != PCK && owner.kind != TYP)) {
mcimadamore@80 166 return null;
duke@1 167 }
mcimadamore@80 168 return owner;
duke@1 169 }
duke@1 170
mcimadamore@80 171 public Symbol location(Type site, Types types) {
jjg@113 172 if (owner.name == null || owner.name.isEmpty()) {
duke@1 173 return location();
duke@1 174 }
duke@1 175 if (owner.type.tag == CLASS) {
duke@1 176 Type ownertype = types.asOuterSuper(site, owner);
mcimadamore@80 177 if (ownertype != null) return ownertype.tsym;
duke@1 178 }
mcimadamore@80 179 return owner;
duke@1 180 }
duke@1 181
duke@1 182 /** The symbol's erased type.
duke@1 183 */
duke@1 184 public Type erasure(Types types) {
duke@1 185 if (erasure_field == null)
duke@1 186 erasure_field = types.erasure(type);
duke@1 187 return erasure_field;
duke@1 188 }
duke@1 189
duke@1 190 /** The external type of a symbol. This is the symbol's erased type
duke@1 191 * except for constructors of inner classes which get the enclosing
duke@1 192 * instance class added as first argument.
duke@1 193 */
duke@1 194 public Type externalType(Types types) {
duke@1 195 Type t = erasure(types);
jjg@113 196 if (name == name.table.names.init && owner.hasOuterInstance()) {
duke@1 197 Type outerThisType = types.erasure(owner.type.getEnclosingType());
duke@1 198 return new MethodType(t.getParameterTypes().prepend(outerThisType),
duke@1 199 t.getReturnType(),
duke@1 200 t.getThrownTypes(),
duke@1 201 t.tsym);
duke@1 202 } else {
duke@1 203 return t;
duke@1 204 }
duke@1 205 }
duke@1 206
duke@1 207 public boolean isStatic() {
duke@1 208 return
duke@1 209 (flags() & STATIC) != 0 ||
duke@1 210 (owner.flags() & INTERFACE) != 0 && kind != MTH;
duke@1 211 }
duke@1 212
duke@1 213 public boolean isInterface() {
duke@1 214 return (flags() & INTERFACE) != 0;
duke@1 215 }
duke@1 216
mcimadamore@674 217 /** Recognize if this symbol was marked @PolymorphicSignature in the source. */
mcimadamore@674 218 public boolean isPolymorphicSignatureGeneric() {
mcimadamore@674 219 return (flags() & (POLYMORPHIC_SIGNATURE | HYPOTHETICAL)) == POLYMORPHIC_SIGNATURE;
mcimadamore@674 220 }
mcimadamore@674 221
mcimadamore@674 222 /** Recognize if this symbol was split from a @PolymorphicSignature symbol in the source. */
mcimadamore@674 223 public boolean isPolymorphicSignatureInstance() {
mcimadamore@674 224 return (flags() & (POLYMORPHIC_SIGNATURE | HYPOTHETICAL)) == (POLYMORPHIC_SIGNATURE | HYPOTHETICAL);
mcimadamore@674 225 }
mcimadamore@674 226
duke@1 227 /** Is this symbol declared (directly or indirectly) local
duke@1 228 * to a method or variable initializer?
duke@1 229 * Also includes fields of inner classes which are in
duke@1 230 * turn local to a method or variable initializer.
duke@1 231 */
duke@1 232 public boolean isLocal() {
duke@1 233 return
duke@1 234 (owner.kind & (VAR | MTH)) != 0 ||
duke@1 235 (owner.kind == TYP && owner.isLocal());
duke@1 236 }
duke@1 237
mcimadamore@537 238 /** Has this symbol an empty name? This includes anonymous
mcimadamore@537 239 * inner classses.
mcimadamore@537 240 */
mcimadamore@537 241 public boolean isAnonymous() {
mcimadamore@537 242 return name.isEmpty();
mcimadamore@537 243 }
mcimadamore@537 244
duke@1 245 /** Is this symbol a constructor?
duke@1 246 */
duke@1 247 public boolean isConstructor() {
jjg@113 248 return name == name.table.names.init;
duke@1 249 }
duke@1 250
duke@1 251 /** The fully qualified name of this symbol.
duke@1 252 * This is the same as the symbol's name except for class symbols,
duke@1 253 * which are handled separately.
duke@1 254 */
duke@1 255 public Name getQualifiedName() {
duke@1 256 return name;
duke@1 257 }
duke@1 258
duke@1 259 /** The fully qualified name of this symbol after converting to flat
duke@1 260 * representation. This is the same as the symbol's name except for
duke@1 261 * class symbols, which are handled separately.
duke@1 262 */
duke@1 263 public Name flatName() {
duke@1 264 return getQualifiedName();
duke@1 265 }
duke@1 266
duke@1 267 /** If this is a class or package, its members, otherwise null.
duke@1 268 */
duke@1 269 public Scope members() {
duke@1 270 return null;
duke@1 271 }
duke@1 272
duke@1 273 /** A class is an inner class if it it has an enclosing instance class.
duke@1 274 */
duke@1 275 public boolean isInner() {
duke@1 276 return type.getEnclosingType().tag == CLASS;
duke@1 277 }
duke@1 278
duke@1 279 /** An inner class has an outer instance if it is not an interface
duke@1 280 * it has an enclosing instance class which might be referenced from the class.
duke@1 281 * Nested classes can see instance members of their enclosing class.
duke@1 282 * Their constructors carry an additional this$n parameter, inserted
duke@1 283 * implicitly by the compiler.
duke@1 284 *
duke@1 285 * @see #isInner
duke@1 286 */
duke@1 287 public boolean hasOuterInstance() {
duke@1 288 return
duke@1 289 type.getEnclosingType().tag == CLASS && (flags() & (INTERFACE | NOOUTERTHIS)) == 0;
duke@1 290 }
duke@1 291
duke@1 292 /** The closest enclosing class of this symbol's declaration.
duke@1 293 */
duke@1 294 public ClassSymbol enclClass() {
duke@1 295 Symbol c = this;
duke@1 296 while (c != null &&
duke@1 297 ((c.kind & TYP) == 0 || c.type.tag != CLASS)) {
duke@1 298 c = c.owner;
duke@1 299 }
duke@1 300 return (ClassSymbol)c;
duke@1 301 }
duke@1 302
duke@1 303 /** The outermost class which indirectly owns this symbol.
duke@1 304 */
duke@1 305 public ClassSymbol outermostClass() {
duke@1 306 Symbol sym = this;
duke@1 307 Symbol prev = null;
duke@1 308 while (sym.kind != PCK) {
duke@1 309 prev = sym;
duke@1 310 sym = sym.owner;
duke@1 311 }
duke@1 312 return (ClassSymbol) prev;
duke@1 313 }
duke@1 314
duke@1 315 /** The package which indirectly owns this symbol.
duke@1 316 */
duke@1 317 public PackageSymbol packge() {
duke@1 318 Symbol sym = this;
duke@1 319 while (sym.kind != PCK) {
duke@1 320 sym = sym.owner;
duke@1 321 }
duke@1 322 return (PackageSymbol) sym;
duke@1 323 }
duke@1 324
duke@1 325 /** Is this symbol a subclass of `base'? Only defined for ClassSymbols.
duke@1 326 */
duke@1 327 public boolean isSubClass(Symbol base, Types types) {
duke@1 328 throw new AssertionError("isSubClass " + this);
duke@1 329 }
duke@1 330
duke@1 331 /** Fully check membership: hierarchy, protection, and hiding.
duke@1 332 * Does not exclude methods not inherited due to overriding.
duke@1 333 */
duke@1 334 public boolean isMemberOf(TypeSymbol clazz, Types types) {
duke@1 335 return
duke@1 336 owner == clazz ||
duke@1 337 clazz.isSubClass(owner, types) &&
duke@1 338 isInheritedIn(clazz, types) &&
duke@1 339 !hiddenIn((ClassSymbol)clazz, types);
duke@1 340 }
duke@1 341
duke@1 342 /** Is this symbol the same as or enclosed by the given class? */
duke@1 343 public boolean isEnclosedBy(ClassSymbol clazz) {
duke@1 344 for (Symbol sym = this; sym.kind != PCK; sym = sym.owner)
duke@1 345 if (sym == clazz) return true;
duke@1 346 return false;
duke@1 347 }
duke@1 348
duke@1 349 /** Check for hiding. Note that this doesn't handle multiple
duke@1 350 * (interface) inheritance. */
duke@1 351 private boolean hiddenIn(ClassSymbol clazz, Types types) {
duke@1 352 if (kind == MTH && (flags() & STATIC) == 0) return false;
duke@1 353 while (true) {
duke@1 354 if (owner == clazz) return false;
duke@1 355 Scope.Entry e = clazz.members().lookup(name);
duke@1 356 while (e.scope != null) {
duke@1 357 if (e.sym == this) return false;
duke@1 358 if (e.sym.kind == kind &&
duke@1 359 (kind != MTH ||
duke@1 360 (e.sym.flags() & STATIC) != 0 &&
duke@1 361 types.isSubSignature(e.sym.type, type)))
duke@1 362 return true;
duke@1 363 e = e.next();
duke@1 364 }
duke@1 365 Type superType = types.supertype(clazz.type);
duke@1 366 if (superType.tag != TypeTags.CLASS) return false;
duke@1 367 clazz = (ClassSymbol)superType.tsym;
duke@1 368 }
duke@1 369 }
duke@1 370
duke@1 371 /** Is this symbol inherited into a given class?
duke@1 372 * PRE: If symbol's owner is a interface,
duke@1 373 * it is already assumed that the interface is a superinterface
duke@1 374 * of given class.
duke@1 375 * @param clazz The class for which we want to establish membership.
duke@1 376 * This must be a subclass of the member's owner.
duke@1 377 */
duke@1 378 public boolean isInheritedIn(Symbol clazz, Types types) {
duke@1 379 switch ((int)(flags_field & Flags.AccessFlags)) {
duke@1 380 default: // error recovery
duke@1 381 case PUBLIC:
duke@1 382 return true;
duke@1 383 case PRIVATE:
duke@1 384 return this.owner == clazz;
duke@1 385 case PROTECTED:
duke@1 386 // we model interfaces as extending Object
duke@1 387 return (clazz.flags() & INTERFACE) == 0;
duke@1 388 case 0:
duke@1 389 PackageSymbol thisPackage = this.packge();
duke@1 390 for (Symbol sup = clazz;
duke@1 391 sup != null && sup != this.owner;
duke@1 392 sup = types.supertype(sup.type).tsym) {
mcimadamore@155 393 while (sup.type.tag == TYPEVAR)
mcimadamore@155 394 sup = sup.type.getUpperBound().tsym;
duke@1 395 if (sup.type.isErroneous())
duke@1 396 return true; // error recovery
duke@1 397 if ((sup.flags() & COMPOUND) != 0)
duke@1 398 continue;
duke@1 399 if (sup.packge() != thisPackage)
duke@1 400 return false;
duke@1 401 }
duke@1 402 return (clazz.flags() & INTERFACE) == 0;
duke@1 403 }
duke@1 404 }
duke@1 405
duke@1 406 /** The (variable or method) symbol seen as a member of given
duke@1 407 * class type`site' (this might change the symbol's type).
duke@1 408 * This is used exclusively for producing diagnostics.
duke@1 409 */
duke@1 410 public Symbol asMemberOf(Type site, Types types) {
duke@1 411 throw new AssertionError();
duke@1 412 }
duke@1 413
duke@1 414 /** Does this method symbol override `other' symbol, when both are seen as
duke@1 415 * members of class `origin'? It is assumed that _other is a member
duke@1 416 * of origin.
duke@1 417 *
duke@1 418 * It is assumed that both symbols have the same name. The static
duke@1 419 * modifier is ignored for this test.
duke@1 420 *
duke@1 421 * See JLS 8.4.6.1 (without transitivity) and 8.4.6.4
duke@1 422 */
duke@1 423 public boolean overrides(Symbol _other, TypeSymbol origin, Types types, boolean checkResult) {
duke@1 424 return false;
duke@1 425 }
duke@1 426
duke@1 427 /** Complete the elaboration of this symbol's definition.
duke@1 428 */
duke@1 429 public void complete() throws CompletionFailure {
duke@1 430 if (completer != null) {
duke@1 431 Completer c = completer;
duke@1 432 completer = null;
duke@1 433 c.complete(this);
duke@1 434 }
duke@1 435 }
duke@1 436
duke@1 437 /** True if the symbol represents an entity that exists.
duke@1 438 */
duke@1 439 public boolean exists() {
duke@1 440 return true;
duke@1 441 }
duke@1 442
duke@1 443 public Type asType() {
duke@1 444 return type;
duke@1 445 }
duke@1 446
duke@1 447 public Symbol getEnclosingElement() {
duke@1 448 return owner;
duke@1 449 }
duke@1 450
duke@1 451 public ElementKind getKind() {
duke@1 452 return ElementKind.OTHER; // most unkind
duke@1 453 }
duke@1 454
duke@1 455 public Set<Modifier> getModifiers() {
duke@1 456 return Flags.asModifierSet(flags());
duke@1 457 }
duke@1 458
duke@1 459 public Name getSimpleName() {
duke@1 460 return name;
duke@1 461 }
duke@1 462
duke@1 463 /**
duke@1 464 * @deprecated this method should never be used by javac internally.
duke@1 465 */
duke@1 466 @Deprecated
duke@1 467 public <A extends java.lang.annotation.Annotation> A getAnnotation(Class<A> annoType) {
duke@1 468 return JavacElements.getAnnotation(this, annoType);
duke@1 469 }
duke@1 470
duke@1 471 // TODO: getEnclosedElements should return a javac List, fix in FilteredMemberList
duke@1 472 public java.util.List<Symbol> getEnclosedElements() {
duke@1 473 return List.nil();
duke@1 474 }
duke@1 475
duke@1 476 public List<TypeSymbol> getTypeParameters() {
duke@1 477 ListBuffer<TypeSymbol> l = ListBuffer.lb();
duke@1 478 for (Type t : type.getTypeArguments()) {
duke@1 479 l.append(t.tsym);
duke@1 480 }
duke@1 481 return l.toList();
duke@1 482 }
duke@1 483
duke@1 484 public static class DelegatedSymbol extends Symbol {
duke@1 485 protected Symbol other;
duke@1 486 public DelegatedSymbol(Symbol other) {
duke@1 487 super(other.kind, other.flags_field, other.name, other.type, other.owner);
duke@1 488 this.other = other;
duke@1 489 }
duke@1 490 public String toString() { return other.toString(); }
mcimadamore@80 491 public Symbol location() { return other.location(); }
mcimadamore@80 492 public Symbol location(Type site, Types types) { return other.location(site, types); }
duke@1 493 public Type erasure(Types types) { return other.erasure(types); }
duke@1 494 public Type externalType(Types types) { return other.externalType(types); }
duke@1 495 public boolean isLocal() { return other.isLocal(); }
duke@1 496 public boolean isConstructor() { return other.isConstructor(); }
duke@1 497 public Name getQualifiedName() { return other.getQualifiedName(); }
duke@1 498 public Name flatName() { return other.flatName(); }
duke@1 499 public Scope members() { return other.members(); }
duke@1 500 public boolean isInner() { return other.isInner(); }
duke@1 501 public boolean hasOuterInstance() { return other.hasOuterInstance(); }
duke@1 502 public ClassSymbol enclClass() { return other.enclClass(); }
duke@1 503 public ClassSymbol outermostClass() { return other.outermostClass(); }
duke@1 504 public PackageSymbol packge() { return other.packge(); }
duke@1 505 public boolean isSubClass(Symbol base, Types types) { return other.isSubClass(base, types); }
duke@1 506 public boolean isMemberOf(TypeSymbol clazz, Types types) { return other.isMemberOf(clazz, types); }
duke@1 507 public boolean isEnclosedBy(ClassSymbol clazz) { return other.isEnclosedBy(clazz); }
duke@1 508 public boolean isInheritedIn(Symbol clazz, Types types) { return other.isInheritedIn(clazz, types); }
duke@1 509 public Symbol asMemberOf(Type site, Types types) { return other.asMemberOf(site, types); }
duke@1 510 public void complete() throws CompletionFailure { other.complete(); }
duke@1 511
duke@1 512 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
duke@1 513 return other.accept(v, p);
duke@1 514 }
mcimadamore@121 515
mcimadamore@121 516 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
mcimadamore@121 517 return v.visitSymbol(other, p);
mcimadamore@121 518 }
duke@1 519 }
duke@1 520
duke@1 521 /** A class for type symbols. Type variables are represented by instances
duke@1 522 * of this class, classes and packages by instances of subclasses.
duke@1 523 */
duke@1 524 public static class TypeSymbol
duke@1 525 extends Symbol implements TypeParameterElement {
duke@1 526 // Implements TypeParameterElement because type parameters don't
duke@1 527 // have their own TypeSymbol subclass.
duke@1 528 // TODO: type parameters should have their own TypeSymbol subclass
duke@1 529
duke@1 530 public TypeSymbol(long flags, Name name, Type type, Symbol owner) {
duke@1 531 super(TYP, flags, name, type, owner);
duke@1 532 }
duke@1 533
duke@1 534 /** form a fully qualified name from a name and an owner
duke@1 535 */
duke@1 536 static public Name formFullName(Name name, Symbol owner) {
duke@1 537 if (owner == null) return name;
duke@1 538 if (((owner.kind != ERR)) &&
duke@1 539 ((owner.kind & (VAR | MTH)) != 0
duke@1 540 || (owner.kind == TYP && owner.type.tag == TYPEVAR)
duke@1 541 )) return name;
duke@1 542 Name prefix = owner.getQualifiedName();
jjg@113 543 if (prefix == null || prefix == prefix.table.names.empty)
duke@1 544 return name;
duke@1 545 else return prefix.append('.', name);
duke@1 546 }
duke@1 547
duke@1 548 /** form a fully qualified name from a name and an owner, after
duke@1 549 * converting to flat representation
duke@1 550 */
duke@1 551 static public Name formFlatName(Name name, Symbol owner) {
duke@1 552 if (owner == null ||
duke@1 553 (owner.kind & (VAR | MTH)) != 0
duke@1 554 || (owner.kind == TYP && owner.type.tag == TYPEVAR)
duke@1 555 ) return name;
duke@1 556 char sep = owner.kind == TYP ? '$' : '.';
duke@1 557 Name prefix = owner.flatName();
jjg@113 558 if (prefix == null || prefix == prefix.table.names.empty)
duke@1 559 return name;
duke@1 560 else return prefix.append(sep, name);
duke@1 561 }
duke@1 562
duke@1 563 /**
duke@1 564 * A total ordering between type symbols that refines the
duke@1 565 * class inheritance graph.
duke@1 566 *
duke@1 567 * Typevariables always precede other kinds of symbols.
duke@1 568 */
duke@1 569 public final boolean precedes(TypeSymbol that, Types types) {
duke@1 570 if (this == that)
duke@1 571 return false;
duke@1 572 if (this.type.tag == that.type.tag) {
duke@1 573 if (this.type.tag == CLASS) {
duke@1 574 return
duke@1 575 types.rank(that.type) < types.rank(this.type) ||
duke@1 576 types.rank(that.type) == types.rank(this.type) &&
duke@1 577 that.getQualifiedName().compareTo(this.getQualifiedName()) < 0;
duke@1 578 } else if (this.type.tag == TYPEVAR) {
duke@1 579 return types.isSubtype(this.type, that.type);
duke@1 580 }
duke@1 581 }
duke@1 582 return this.type.tag == TYPEVAR;
duke@1 583 }
duke@1 584
duke@1 585 // For type params; overridden in subclasses.
duke@1 586 public ElementKind getKind() {
duke@1 587 return ElementKind.TYPE_PARAMETER;
duke@1 588 }
duke@1 589
duke@1 590 public java.util.List<Symbol> getEnclosedElements() {
duke@1 591 List<Symbol> list = List.nil();
sundar@666 592 if (kind == TYP && type.tag == TYPEVAR) {
sundar@666 593 return list;
sundar@666 594 }
duke@1 595 for (Scope.Entry e = members().elems; e != null; e = e.sibling) {
duke@1 596 if (e.sym != null && (e.sym.flags() & SYNTHETIC) == 0 && e.sym.owner == this)
duke@1 597 list = list.prepend(e.sym);
duke@1 598 }
duke@1 599 return list;
duke@1 600 }
duke@1 601
duke@1 602 // For type params.
duke@1 603 // Perhaps not needed if getEnclosingElement can be spec'ed
duke@1 604 // to do the same thing.
duke@1 605 // TODO: getGenericElement() might not be needed
duke@1 606 public Symbol getGenericElement() {
duke@1 607 return owner;
duke@1 608 }
duke@1 609
duke@1 610 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
duke@1 611 assert type.tag == TYPEVAR; // else override will be invoked
duke@1 612 return v.visitTypeParameter(this, p);
duke@1 613 }
duke@1 614
mcimadamore@121 615 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
mcimadamore@121 616 return v.visitTypeSymbol(this, p);
mcimadamore@121 617 }
mcimadamore@121 618
duke@1 619 public List<Type> getBounds() {
duke@1 620 TypeVar t = (TypeVar)type;
duke@1 621 Type bound = t.getUpperBound();
duke@1 622 if (!bound.isCompound())
duke@1 623 return List.of(bound);
duke@1 624 ClassType ct = (ClassType)bound;
duke@1 625 if (!ct.tsym.erasure_field.isInterface()) {
duke@1 626 return ct.interfaces_field.prepend(ct.supertype_field);
duke@1 627 } else {
duke@1 628 // No superclass was given in bounds.
duke@1 629 // In this case, supertype is Object, erasure is first interface.
duke@1 630 return ct.interfaces_field;
duke@1 631 }
duke@1 632 }
duke@1 633 }
duke@1 634
duke@1 635 /** A class for package symbols
duke@1 636 */
duke@1 637 public static class PackageSymbol extends TypeSymbol
duke@1 638 implements PackageElement {
duke@1 639
duke@1 640 public Scope members_field;
duke@1 641 public Name fullname;
duke@1 642 public ClassSymbol package_info; // see bug 6443073
duke@1 643
duke@1 644 public PackageSymbol(Name name, Type type, Symbol owner) {
duke@1 645 super(0, name, type, owner);
duke@1 646 this.kind = PCK;
duke@1 647 this.members_field = null;
duke@1 648 this.fullname = formFullName(name, owner);
duke@1 649 }
duke@1 650
duke@1 651 public PackageSymbol(Name name, Symbol owner) {
duke@1 652 this(name, null, owner);
duke@1 653 this.type = new PackageType(this);
duke@1 654 }
duke@1 655
duke@1 656 public String toString() {
duke@1 657 return fullname.toString();
duke@1 658 }
duke@1 659
duke@1 660 public Name getQualifiedName() {
duke@1 661 return fullname;
duke@1 662 }
duke@1 663
duke@1 664 public boolean isUnnamed() {
duke@1 665 return name.isEmpty() && owner != null;
duke@1 666 }
duke@1 667
duke@1 668 public Scope members() {
duke@1 669 if (completer != null) complete();
duke@1 670 return members_field;
duke@1 671 }
duke@1 672
duke@1 673 public long flags() {
duke@1 674 if (completer != null) complete();
duke@1 675 return flags_field;
duke@1 676 }
duke@1 677
duke@1 678 public List<Attribute.Compound> getAnnotationMirrors() {
duke@1 679 if (completer != null) complete();
jjg@483 680 if (package_info != null && package_info.completer != null) {
jjg@483 681 package_info.complete();
jjg@483 682 if (attributes_field.isEmpty())
jjg@483 683 attributes_field = package_info.attributes_field;
jjg@483 684 }
duke@1 685 assert attributes_field != null;
duke@1 686 return attributes_field;
duke@1 687 }
duke@1 688
duke@1 689 /** A package "exists" if a type or package that exists has
duke@1 690 * been seen within it.
duke@1 691 */
duke@1 692 public boolean exists() {
duke@1 693 return (flags_field & EXISTS) != 0;
duke@1 694 }
duke@1 695
duke@1 696 public ElementKind getKind() {
duke@1 697 return ElementKind.PACKAGE;
duke@1 698 }
duke@1 699
duke@1 700 public Symbol getEnclosingElement() {
duke@1 701 return null;
duke@1 702 }
duke@1 703
duke@1 704 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
duke@1 705 return v.visitPackage(this, p);
duke@1 706 }
mcimadamore@121 707
mcimadamore@121 708 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
mcimadamore@121 709 return v.visitPackageSymbol(this, p);
mcimadamore@121 710 }
duke@1 711 }
duke@1 712
duke@1 713 /** A class for class symbols
duke@1 714 */
duke@1 715 public static class ClassSymbol extends TypeSymbol implements TypeElement {
duke@1 716
duke@1 717 /** a scope for all class members; variables, methods and inner classes
duke@1 718 * type parameters are not part of this scope
duke@1 719 */
duke@1 720 public Scope members_field;
duke@1 721
duke@1 722 /** the fully qualified name of the class, i.e. pck.outer.inner.
duke@1 723 * null for anonymous classes
duke@1 724 */
duke@1 725 public Name fullname;
duke@1 726
duke@1 727 /** the fully qualified name of the class after converting to flat
duke@1 728 * representation, i.e. pck.outer$inner,
duke@1 729 * set externally for local and anonymous classes
duke@1 730 */
duke@1 731 public Name flatname;
duke@1 732
duke@1 733 /** the sourcefile where the class came from
duke@1 734 */
duke@1 735 public JavaFileObject sourcefile;
duke@1 736
duke@1 737 /** the classfile from where to load this class
duke@1 738 * this will have extension .class or .java
duke@1 739 */
duke@1 740 public JavaFileObject classfile;
duke@1 741
duke@1 742 /** the constant pool of the class
duke@1 743 */
duke@1 744 public Pool pool;
duke@1 745
duke@1 746 public ClassSymbol(long flags, Name name, Type type, Symbol owner) {
duke@1 747 super(flags, name, type, owner);
duke@1 748 this.members_field = null;
duke@1 749 this.fullname = formFullName(name, owner);
duke@1 750 this.flatname = formFlatName(name, owner);
duke@1 751 this.sourcefile = null;
duke@1 752 this.classfile = null;
duke@1 753 this.pool = null;
duke@1 754 }
duke@1 755
duke@1 756 public ClassSymbol(long flags, Name name, Symbol owner) {
duke@1 757 this(
duke@1 758 flags,
duke@1 759 name,
duke@1 760 new ClassType(Type.noType, null, null),
duke@1 761 owner);
duke@1 762 this.type.tsym = this;
duke@1 763 }
duke@1 764
duke@1 765 /** The Java source which this symbol represents.
duke@1 766 */
duke@1 767 public String toString() {
duke@1 768 return className();
duke@1 769 }
duke@1 770
duke@1 771 public long flags() {
duke@1 772 if (completer != null) complete();
duke@1 773 return flags_field;
duke@1 774 }
duke@1 775
duke@1 776 public Scope members() {
duke@1 777 if (completer != null) complete();
duke@1 778 return members_field;
duke@1 779 }
duke@1 780
duke@1 781 public List<Attribute.Compound> getAnnotationMirrors() {
duke@1 782 if (completer != null) complete();
duke@1 783 assert attributes_field != null;
duke@1 784 return attributes_field;
duke@1 785 }
duke@1 786
duke@1 787 public Type erasure(Types types) {
duke@1 788 if (erasure_field == null)
duke@1 789 erasure_field = new ClassType(types.erasure(type.getEnclosingType()),
duke@1 790 List.<Type>nil(), this);
duke@1 791 return erasure_field;
duke@1 792 }
duke@1 793
duke@1 794 public String className() {
jjg@113 795 if (name.isEmpty())
duke@1 796 return
duke@1 797 Log.getLocalizedString("anonymous.class", flatname);
duke@1 798 else
duke@1 799 return fullname.toString();
duke@1 800 }
duke@1 801
duke@1 802 public Name getQualifiedName() {
duke@1 803 return fullname;
duke@1 804 }
duke@1 805
duke@1 806 public Name flatName() {
duke@1 807 return flatname;
duke@1 808 }
duke@1 809
duke@1 810 public boolean isSubClass(Symbol base, Types types) {
duke@1 811 if (this == base) {
duke@1 812 return true;
duke@1 813 } else if ((base.flags() & INTERFACE) != 0) {
duke@1 814 for (Type t = type; t.tag == CLASS; t = types.supertype(t))
duke@1 815 for (List<Type> is = types.interfaces(t);
duke@1 816 is.nonEmpty();
duke@1 817 is = is.tail)
duke@1 818 if (is.head.tsym.isSubClass(base, types)) return true;
duke@1 819 } else {
duke@1 820 for (Type t = type; t.tag == CLASS; t = types.supertype(t))
duke@1 821 if (t.tsym == base) return true;
duke@1 822 }
duke@1 823 return false;
duke@1 824 }
duke@1 825
duke@1 826 /** Complete the elaboration of this symbol's definition.
duke@1 827 */
duke@1 828 public void complete() throws CompletionFailure {
duke@1 829 try {
duke@1 830 super.complete();
duke@1 831 } catch (CompletionFailure ex) {
duke@1 832 // quiet error recovery
duke@1 833 flags_field |= (PUBLIC|STATIC);
jjg@110 834 this.type = new ErrorType(this, Type.noType);
duke@1 835 throw ex;
duke@1 836 }
duke@1 837 }
duke@1 838
duke@1 839 public List<Type> getInterfaces() {
duke@1 840 complete();
duke@1 841 if (type instanceof ClassType) {
duke@1 842 ClassType t = (ClassType)type;
duke@1 843 if (t.interfaces_field == null) // FIXME: shouldn't be null
duke@1 844 t.interfaces_field = List.nil();
duke@1 845 return t.interfaces_field;
duke@1 846 } else {
duke@1 847 return List.nil();
duke@1 848 }
duke@1 849 }
duke@1 850
duke@1 851 public Type getSuperclass() {
duke@1 852 complete();
duke@1 853 if (type instanceof ClassType) {
duke@1 854 ClassType t = (ClassType)type;
duke@1 855 if (t.supertype_field == null) // FIXME: shouldn't be null
duke@1 856 t.supertype_field = Type.noType;
duke@1 857 // An interface has no superclass; its supertype is Object.
duke@1 858 return t.isInterface()
duke@1 859 ? Type.noType
duke@1 860 : t.supertype_field;
duke@1 861 } else {
duke@1 862 return Type.noType;
duke@1 863 }
duke@1 864 }
duke@1 865
duke@1 866 public ElementKind getKind() {
duke@1 867 long flags = flags();
duke@1 868 if ((flags & ANNOTATION) != 0)
duke@1 869 return ElementKind.ANNOTATION_TYPE;
duke@1 870 else if ((flags & INTERFACE) != 0)
duke@1 871 return ElementKind.INTERFACE;
duke@1 872 else if ((flags & ENUM) != 0)
duke@1 873 return ElementKind.ENUM;
duke@1 874 else
duke@1 875 return ElementKind.CLASS;
duke@1 876 }
duke@1 877
duke@1 878 public NestingKind getNestingKind() {
duke@1 879 complete();
duke@1 880 if (owner.kind == PCK)
duke@1 881 return NestingKind.TOP_LEVEL;
duke@1 882 else if (name.isEmpty())
duke@1 883 return NestingKind.ANONYMOUS;
duke@1 884 else if (owner.kind == MTH)
duke@1 885 return NestingKind.LOCAL;
duke@1 886 else
duke@1 887 return NestingKind.MEMBER;
duke@1 888 }
duke@1 889
duke@1 890 /**
duke@1 891 * @deprecated this method should never be used by javac internally.
duke@1 892 */
duke@1 893 @Override @Deprecated
duke@1 894 public <A extends java.lang.annotation.Annotation> A getAnnotation(Class<A> annoType) {
duke@1 895 return JavacElements.getAnnotation(this, annoType);
duke@1 896 }
duke@1 897
duke@1 898 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
duke@1 899 return v.visitType(this, p);
duke@1 900 }
mcimadamore@121 901
mcimadamore@121 902 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
mcimadamore@121 903 return v.visitClassSymbol(this, p);
mcimadamore@121 904 }
duke@1 905 }
duke@1 906
duke@1 907
duke@1 908 /** A class for variable symbols
duke@1 909 */
duke@1 910 public static class VarSymbol extends Symbol implements VariableElement {
duke@1 911
duke@1 912 /** The variable's declaration position.
duke@1 913 */
duke@1 914 public int pos = Position.NOPOS;
duke@1 915
duke@1 916 /** The variable's address. Used for different purposes during
duke@1 917 * flow analysis, translation and code generation.
duke@1 918 * Flow analysis:
duke@1 919 * If this is a blank final or local variable, its sequence number.
duke@1 920 * Translation:
duke@1 921 * If this is a private field, its access number.
duke@1 922 * Code generation:
duke@1 923 * If this is a local variable, its logical slot number.
duke@1 924 */
duke@1 925 public int adr = -1;
duke@1 926
duke@1 927 /** Construct a variable symbol, given its flags, name, type and owner.
duke@1 928 */
duke@1 929 public VarSymbol(long flags, Name name, Type type, Symbol owner) {
duke@1 930 super(VAR, flags, name, type, owner);
duke@1 931 }
duke@1 932
duke@1 933 /** Clone this symbol with new owner.
duke@1 934 */
duke@1 935 public VarSymbol clone(Symbol newOwner) {
duke@1 936 VarSymbol v = new VarSymbol(flags_field, name, type, newOwner);
duke@1 937 v.pos = pos;
duke@1 938 v.adr = adr;
duke@1 939 v.data = data;
duke@1 940 // System.out.println("clone " + v + " in " + newOwner);//DEBUG
duke@1 941 return v;
duke@1 942 }
duke@1 943
duke@1 944 public String toString() {
duke@1 945 return name.toString();
duke@1 946 }
duke@1 947
duke@1 948 public Symbol asMemberOf(Type site, Types types) {
duke@1 949 return new VarSymbol(flags_field, name, types.memberType(site, this), owner);
duke@1 950 }
duke@1 951
duke@1 952 public ElementKind getKind() {
duke@1 953 long flags = flags();
duke@1 954 if ((flags & PARAMETER) != 0) {
duke@1 955 if (isExceptionParameter())
duke@1 956 return ElementKind.EXCEPTION_PARAMETER;
duke@1 957 else
duke@1 958 return ElementKind.PARAMETER;
duke@1 959 } else if ((flags & ENUM) != 0) {
duke@1 960 return ElementKind.ENUM_CONSTANT;
duke@1 961 } else if (owner.kind == TYP || owner.kind == ERR) {
duke@1 962 return ElementKind.FIELD;
sundar@697 963 } else if (isResourceVariable()) {
sundar@697 964 return ElementKind.RESOURCE_VARIABLE;
duke@1 965 } else {
duke@1 966 return ElementKind.LOCAL_VARIABLE;
duke@1 967 }
duke@1 968 }
duke@1 969
duke@1 970 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
duke@1 971 return v.visitVariable(this, p);
duke@1 972 }
duke@1 973
duke@1 974 public Object getConstantValue() { // Mirror API
duke@1 975 return Constants.decode(getConstValue(), type);
duke@1 976 }
duke@1 977
duke@1 978 public void setLazyConstValue(final Env<AttrContext> env,
duke@1 979 final Log log,
duke@1 980 final Attr attr,
duke@1 981 final JCTree.JCExpression initializer)
duke@1 982 {
duke@1 983 setData(new Callable<Object>() {
duke@1 984 public Object call() {
duke@1 985 JavaFileObject source = log.useSource(env.toplevel.sourcefile);
duke@1 986 try {
duke@1 987 Type itype = attr.attribExpr(initializer, env, type);
duke@1 988 if (itype.constValue() != null)
duke@1 989 return attr.coerce(itype, type).constValue();
duke@1 990 else
duke@1 991 return null;
duke@1 992 } finally {
duke@1 993 log.useSource(source);
duke@1 994 }
duke@1 995 }
duke@1 996 });
duke@1 997 }
duke@1 998
duke@1 999 /**
duke@1 1000 * The variable's constant value, if this is a constant.
duke@1 1001 * Before the constant value is evaluated, it points to an
duke@1 1002 * initalizer environment. If this is not a constant, it can
duke@1 1003 * be used for other stuff.
duke@1 1004 */
duke@1 1005 private Object data;
duke@1 1006
duke@1 1007 public boolean isExceptionParameter() {
duke@1 1008 return data == ElementKind.EXCEPTION_PARAMETER;
duke@1 1009 }
duke@1 1010
darcy@609 1011 public boolean isResourceVariable() {
darcy@609 1012 return data == ElementKind.RESOURCE_VARIABLE;
darcy@609 1013 }
darcy@609 1014
duke@1 1015 public Object getConstValue() {
duke@1 1016 // TODO: Consider if getConstValue and getConstantValue can be collapsed
darcy@609 1017 if (data == ElementKind.EXCEPTION_PARAMETER ||
darcy@609 1018 data == ElementKind.RESOURCE_VARIABLE) {
duke@1 1019 return null;
duke@1 1020 } else if (data instanceof Callable<?>) {
darcy@609 1021 // In this case, this is a final variable, with an as
duke@1 1022 // yet unevaluated initializer.
duke@1 1023 Callable<?> eval = (Callable<?>)data;
duke@1 1024 data = null; // to make sure we don't evaluate this twice.
duke@1 1025 try {
duke@1 1026 data = eval.call();
duke@1 1027 } catch (Exception ex) {
duke@1 1028 throw new AssertionError(ex);
duke@1 1029 }
duke@1 1030 }
duke@1 1031 return data;
duke@1 1032 }
duke@1 1033
duke@1 1034 public void setData(Object data) {
duke@1 1035 assert !(data instanceof Env<?>) : this;
duke@1 1036 this.data = data;
duke@1 1037 }
mcimadamore@121 1038
mcimadamore@121 1039 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
mcimadamore@121 1040 return v.visitVarSymbol(this, p);
mcimadamore@121 1041 }
duke@1 1042 }
duke@1 1043
duke@1 1044 /** A class for method symbols.
duke@1 1045 */
duke@1 1046 public static class MethodSymbol extends Symbol implements ExecutableElement {
duke@1 1047
duke@1 1048 /** The code of the method. */
duke@1 1049 public Code code = null;
duke@1 1050
duke@1 1051 /** The parameters of the method. */
duke@1 1052 public List<VarSymbol> params = null;
duke@1 1053
duke@1 1054 /** The names of the parameters */
duke@1 1055 public List<Name> savedParameterNames;
duke@1 1056
duke@1 1057 /** For an attribute field accessor, its default value if any.
duke@1 1058 * The value is null if none appeared in the method
duke@1 1059 * declaration.
duke@1 1060 */
duke@1 1061 public Attribute defaultValue = null;
duke@1 1062
duke@1 1063 /** Construct a method symbol, given its flags, name, type and owner.
duke@1 1064 */
duke@1 1065 public MethodSymbol(long flags, Name name, Type type, Symbol owner) {
duke@1 1066 super(MTH, flags, name, type, owner);
duke@1 1067 assert owner.type.tag != TYPEVAR : owner + "." + name;
duke@1 1068 }
duke@1 1069
duke@1 1070 /** Clone this symbol with new owner.
duke@1 1071 */
duke@1 1072 public MethodSymbol clone(Symbol newOwner) {
duke@1 1073 MethodSymbol m = new MethodSymbol(flags_field, name, type, newOwner);
duke@1 1074 m.code = code;
duke@1 1075 return m;
duke@1 1076 }
duke@1 1077
duke@1 1078 /** The Java source which this symbol represents.
duke@1 1079 */
duke@1 1080 public String toString() {
duke@1 1081 if ((flags() & BLOCK) != 0) {
duke@1 1082 return owner.name.toString();
duke@1 1083 } else {
jjg@113 1084 String s = (name == name.table.names.init)
duke@1 1085 ? owner.name.toString()
duke@1 1086 : name.toString();
duke@1 1087 if (type != null) {
duke@1 1088 if (type.tag == FORALL)
duke@1 1089 s = "<" + ((ForAll)type).getTypeArguments() + ">" + s;
duke@1 1090 s += "(" + type.argtypes((flags() & VARARGS) != 0) + ")";
duke@1 1091 }
duke@1 1092 return s;
duke@1 1093 }
duke@1 1094 }
duke@1 1095
duke@1 1096 /** find a symbol that this (proxy method) symbol implements.
duke@1 1097 * @param c The class whose members are searched for
duke@1 1098 * implementations
duke@1 1099 */
duke@1 1100 public Symbol implemented(TypeSymbol c, Types types) {
duke@1 1101 Symbol impl = null;
duke@1 1102 for (List<Type> is = types.interfaces(c.type);
duke@1 1103 impl == null && is.nonEmpty();
duke@1 1104 is = is.tail) {
duke@1 1105 TypeSymbol i = is.head.tsym;
mcimadamore@780 1106 impl = implementedIn(i, types);
mcimadamore@780 1107 if (impl == null)
mcimadamore@780 1108 impl = implemented(i, types);
mcimadamore@780 1109 }
mcimadamore@780 1110 return impl;
mcimadamore@780 1111 }
mcimadamore@780 1112
mcimadamore@780 1113 public Symbol implementedIn(TypeSymbol c, Types types) {
mcimadamore@780 1114 Symbol impl = null;
mcimadamore@780 1115 for (Scope.Entry e = c.members().lookup(name);
mcimadamore@780 1116 impl == null && e.scope != null;
mcimadamore@780 1117 e = e.next()) {
mcimadamore@780 1118 if (this.overrides(e.sym, (TypeSymbol)owner, types, true) &&
mcimadamore@780 1119 // FIXME: I suspect the following requires a
mcimadamore@780 1120 // subst() for a parametric return type.
mcimadamore@780 1121 types.isSameType(type.getReturnType(),
mcimadamore@780 1122 types.memberType(owner.type, e.sym).getReturnType())) {
mcimadamore@780 1123 impl = e.sym;
duke@1 1124 }
duke@1 1125 }
duke@1 1126 return impl;
duke@1 1127 }
duke@1 1128
duke@1 1129 /** Will the erasure of this method be considered by the VM to
duke@1 1130 * override the erasure of the other when seen from class `origin'?
duke@1 1131 */
duke@1 1132 public boolean binaryOverrides(Symbol _other, TypeSymbol origin, Types types) {
duke@1 1133 if (isConstructor() || _other.kind != MTH) return false;
duke@1 1134
duke@1 1135 if (this == _other) return true;
duke@1 1136 MethodSymbol other = (MethodSymbol)_other;
duke@1 1137
duke@1 1138 // check for a direct implementation
duke@1 1139 if (other.isOverridableIn((TypeSymbol)owner) &&
duke@1 1140 types.asSuper(owner.type, other.owner) != null &&
duke@1 1141 types.isSameType(erasure(types), other.erasure(types)))
duke@1 1142 return true;
duke@1 1143
duke@1 1144 // check for an inherited implementation
duke@1 1145 return
duke@1 1146 (flags() & ABSTRACT) == 0 &&
duke@1 1147 other.isOverridableIn(origin) &&
duke@1 1148 this.isMemberOf(origin, types) &&
duke@1 1149 types.isSameType(erasure(types), other.erasure(types));
duke@1 1150 }
duke@1 1151
duke@1 1152 /** The implementation of this (abstract) symbol in class origin,
duke@1 1153 * from the VM's point of view, null if method does not have an
duke@1 1154 * implementation in class.
duke@1 1155 * @param origin The class of which the implementation is a member.
duke@1 1156 */
duke@1 1157 public MethodSymbol binaryImplementation(ClassSymbol origin, Types types) {
duke@1 1158 for (TypeSymbol c = origin; c != null; c = types.supertype(c.type).tsym) {
duke@1 1159 for (Scope.Entry e = c.members().lookup(name);
duke@1 1160 e.scope != null;
duke@1 1161 e = e.next()) {
duke@1 1162 if (e.sym.kind == MTH &&
duke@1 1163 ((MethodSymbol)e.sym).binaryOverrides(this, origin, types))
duke@1 1164 return (MethodSymbol)e.sym;
duke@1 1165 }
duke@1 1166 }
duke@1 1167 return null;
duke@1 1168 }
duke@1 1169
duke@1 1170 /** Does this symbol override `other' symbol, when both are seen as
duke@1 1171 * members of class `origin'? It is assumed that _other is a member
duke@1 1172 * of origin.
duke@1 1173 *
duke@1 1174 * It is assumed that both symbols have the same name. The static
duke@1 1175 * modifier is ignored for this test.
duke@1 1176 *
duke@1 1177 * See JLS 8.4.6.1 (without transitivity) and 8.4.6.4
duke@1 1178 */
duke@1 1179 public boolean overrides(Symbol _other, TypeSymbol origin, Types types, boolean checkResult) {
duke@1 1180 if (isConstructor() || _other.kind != MTH) return false;
duke@1 1181
duke@1 1182 if (this == _other) return true;
duke@1 1183 MethodSymbol other = (MethodSymbol)_other;
duke@1 1184
duke@1 1185 // check for a direct implementation
duke@1 1186 if (other.isOverridableIn((TypeSymbol)owner) &&
duke@1 1187 types.asSuper(owner.type, other.owner) != null) {
duke@1 1188 Type mt = types.memberType(owner.type, this);
duke@1 1189 Type ot = types.memberType(owner.type, other);
duke@1 1190 if (types.isSubSignature(mt, ot)) {
duke@1 1191 if (!checkResult)
duke@1 1192 return true;
duke@1 1193 if (types.returnTypeSubstitutable(mt, ot))
duke@1 1194 return true;
duke@1 1195 }
duke@1 1196 }
duke@1 1197
duke@1 1198 // check for an inherited implementation
duke@1 1199 if ((flags() & ABSTRACT) != 0 ||
duke@1 1200 (other.flags() & ABSTRACT) == 0 ||
duke@1 1201 !other.isOverridableIn(origin) ||
duke@1 1202 !this.isMemberOf(origin, types))
duke@1 1203 return false;
duke@1 1204
duke@1 1205 // assert types.asSuper(origin.type, other.owner) != null;
duke@1 1206 Type mt = types.memberType(origin.type, this);
duke@1 1207 Type ot = types.memberType(origin.type, other);
duke@1 1208 return
duke@1 1209 types.isSubSignature(mt, ot) &&
duke@1 1210 (!checkResult || types.resultSubtype(mt, ot, Warner.noWarnings));
duke@1 1211 }
duke@1 1212
duke@1 1213 private boolean isOverridableIn(TypeSymbol origin) {
duke@1 1214 // JLS3 8.4.6.1
duke@1 1215 switch ((int)(flags_field & Flags.AccessFlags)) {
duke@1 1216 case Flags.PRIVATE:
duke@1 1217 return false;
duke@1 1218 case Flags.PUBLIC:
duke@1 1219 return true;
duke@1 1220 case Flags.PROTECTED:
duke@1 1221 return (origin.flags() & INTERFACE) == 0;
duke@1 1222 case 0:
duke@1 1223 // for package private: can only override in the same
duke@1 1224 // package
duke@1 1225 return
duke@1 1226 this.packge() == origin.packge() &&
duke@1 1227 (origin.flags() & INTERFACE) == 0;
duke@1 1228 default:
duke@1 1229 return false;
duke@1 1230 }
duke@1 1231 }
duke@1 1232
duke@1 1233 /** The implementation of this (abstract) symbol in class origin;
duke@1 1234 * null if none exists. Synthetic methods are not considered
duke@1 1235 * as possible implementations.
duke@1 1236 */
duke@1 1237 public MethodSymbol implementation(TypeSymbol origin, Types types, boolean checkResult) {
mcimadamore@673 1238 return implementation(origin, types, checkResult, implementation_filter);
mcimadamore@673 1239 }
mcimadamore@673 1240 // where
mcimadamore@673 1241 private static final Filter<Symbol> implementation_filter = new Filter<Symbol>() {
mcimadamore@673 1242 public boolean accepts(Symbol s) {
mcimadamore@673 1243 return s.kind == Kinds.MTH &&
mcimadamore@673 1244 (s.flags() & SYNTHETIC) == 0;
mcimadamore@673 1245 }
mcimadamore@673 1246 };
mcimadamore@673 1247
mcimadamore@673 1248 public MethodSymbol implementation(TypeSymbol origin, Types types, boolean checkResult, Filter<Symbol> implFilter) {
mcimadamore@673 1249 MethodSymbol res = types.implementation(this, origin, types, checkResult, implFilter);
mcimadamore@341 1250 if (res != null)
mcimadamore@341 1251 return res;
duke@1 1252 // if origin is derived from a raw type, we might have missed
duke@1 1253 // an implementation because we do not know enough about instantiations.
duke@1 1254 // in this case continue with the supertype as origin.
duke@1 1255 if (types.isDerivedRaw(origin.type))
duke@1 1256 return implementation(types.supertype(origin.type).tsym, types, checkResult);
duke@1 1257 else
duke@1 1258 return null;
duke@1 1259 }
duke@1 1260
duke@1 1261 public List<VarSymbol> params() {
duke@1 1262 owner.complete();
duke@1 1263 if (params == null) {
jjg@428 1264 // If ClassReader.saveParameterNames has been set true, then
jjg@428 1265 // savedParameterNames will be set to a list of names that
jjg@428 1266 // matches the types in type.getParameterTypes(). If any names
jjg@428 1267 // were not found in the class file, those names in the list will
jjg@428 1268 // be set to the empty name.
jjg@428 1269 // If ClassReader.saveParameterNames has been set false, then
jjg@428 1270 // savedParameterNames will be null.
jjg@428 1271 List<Name> paramNames = savedParameterNames;
duke@1 1272 savedParameterNames = null;
jjg@428 1273 // discard the provided names if the list of names is the wrong size.
jjg@428 1274 if (paramNames == null || paramNames.size() != type.getParameterTypes().size())
jjg@428 1275 paramNames = List.nil();
duke@1 1276 ListBuffer<VarSymbol> buf = new ListBuffer<VarSymbol>();
jjg@428 1277 List<Name> remaining = paramNames;
jjg@428 1278 // assert: remaining and paramNames are both empty or both
jjg@428 1279 // have same cardinality as type.getParameterTypes()
jjg@428 1280 int i = 0;
duke@1 1281 for (Type t : type.getParameterTypes()) {
jjg@428 1282 Name paramName;
jjg@428 1283 if (remaining.isEmpty()) {
jjg@428 1284 // no names for any parameters available
jjg@428 1285 paramName = createArgName(i, paramNames);
jjg@428 1286 } else {
jjg@428 1287 paramName = remaining.head;
jjg@428 1288 remaining = remaining.tail;
jjg@428 1289 if (paramName.isEmpty()) {
jjg@428 1290 // no name for this specific parameter
jjg@428 1291 paramName = createArgName(i, paramNames);
jjg@428 1292 }
jjg@428 1293 }
jjg@428 1294 buf.append(new VarSymbol(PARAMETER, paramName, t, this));
jjg@428 1295 i++;
duke@1 1296 }
duke@1 1297 params = buf.toList();
duke@1 1298 }
duke@1 1299 return params;
duke@1 1300 }
duke@1 1301
jjg@428 1302 // Create a name for the argument at position 'index' that is not in
jjg@428 1303 // the exclude list. In normal use, either no names will have been
jjg@428 1304 // provided, in which case the exclude list is empty, or all the names
jjg@428 1305 // will have been provided, in which case this method will not be called.
jjg@428 1306 private Name createArgName(int index, List<Name> exclude) {
jjg@428 1307 String prefix = "arg";
jjg@428 1308 while (true) {
jjg@428 1309 Name argName = name.table.fromString(prefix + index);
jjg@428 1310 if (!exclude.contains(argName))
jjg@428 1311 return argName;
jjg@428 1312 prefix += "$";
jjg@428 1313 }
jjg@428 1314 }
jjg@428 1315
duke@1 1316 public Symbol asMemberOf(Type site, Types types) {
duke@1 1317 return new MethodSymbol(flags_field, name, types.memberType(site, this), owner);
duke@1 1318 }
duke@1 1319
duke@1 1320 public ElementKind getKind() {
jjg@113 1321 if (name == name.table.names.init)
duke@1 1322 return ElementKind.CONSTRUCTOR;
jjg@113 1323 else if (name == name.table.names.clinit)
duke@1 1324 return ElementKind.STATIC_INIT;
duke@1 1325 else
duke@1 1326 return ElementKind.METHOD;
duke@1 1327 }
duke@1 1328
duke@1 1329 public Attribute getDefaultValue() {
duke@1 1330 return defaultValue;
duke@1 1331 }
duke@1 1332
duke@1 1333 public List<VarSymbol> getParameters() {
duke@1 1334 return params();
duke@1 1335 }
duke@1 1336
duke@1 1337 public boolean isVarArgs() {
duke@1 1338 return (flags() & VARARGS) != 0;
duke@1 1339 }
duke@1 1340
duke@1 1341 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
duke@1 1342 return v.visitExecutable(this, p);
duke@1 1343 }
duke@1 1344
mcimadamore@121 1345 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
mcimadamore@121 1346 return v.visitMethodSymbol(this, p);
mcimadamore@121 1347 }
mcimadamore@121 1348
duke@1 1349 public Type getReturnType() {
duke@1 1350 return asType().getReturnType();
duke@1 1351 }
duke@1 1352
duke@1 1353 public List<Type> getThrownTypes() {
duke@1 1354 return asType().getThrownTypes();
duke@1 1355 }
duke@1 1356 }
duke@1 1357
duke@1 1358 /** A class for predefined operators.
duke@1 1359 */
duke@1 1360 public static class OperatorSymbol extends MethodSymbol {
duke@1 1361
duke@1 1362 public int opcode;
duke@1 1363
duke@1 1364 public OperatorSymbol(Name name, Type type, int opcode, Symbol owner) {
duke@1 1365 super(PUBLIC | STATIC, name, type, owner);
duke@1 1366 this.opcode = opcode;
duke@1 1367 }
mcimadamore@121 1368
mcimadamore@121 1369 public <R, P> R accept(Symbol.Visitor<R, P> v, P p) {
mcimadamore@121 1370 return v.visitOperatorSymbol(this, p);
mcimadamore@121 1371 }
duke@1 1372 }
duke@1 1373
duke@1 1374 /** Symbol completer interface.
duke@1 1375 */
duke@1 1376 public static interface Completer {
duke@1 1377 void complete(Symbol sym) throws CompletionFailure;
duke@1 1378 }
duke@1 1379
duke@1 1380 public static class CompletionFailure extends RuntimeException {
duke@1 1381 private static final long serialVersionUID = 0;
duke@1 1382 public Symbol sym;
duke@1 1383
jjg@12 1384 /** A diagnostic object describing the failure
jjg@12 1385 */
jjg@12 1386 public JCDiagnostic diag;
jjg@12 1387
duke@1 1388 /** A localized string describing the failure.
jjg@12 1389 * @deprecated Use {@code getDetail()} or {@code getMessage()}
duke@1 1390 */
jjg@12 1391 @Deprecated
duke@1 1392 public String errmsg;
duke@1 1393
duke@1 1394 public CompletionFailure(Symbol sym, String errmsg) {
duke@1 1395 this.sym = sym;
duke@1 1396 this.errmsg = errmsg;
duke@1 1397 // this.printStackTrace();//DEBUG
duke@1 1398 }
duke@1 1399
jjg@12 1400 public CompletionFailure(Symbol sym, JCDiagnostic diag) {
jjg@12 1401 this.sym = sym;
jjg@12 1402 this.diag = diag;
jjg@12 1403 // this.printStackTrace();//DEBUG
jjg@12 1404 }
jjg@12 1405
jjg@12 1406 public JCDiagnostic getDiagnostic() {
jjg@12 1407 return diag;
jjg@12 1408 }
jjg@12 1409
jjg@12 1410 @Override
duke@1 1411 public String getMessage() {
jjg@12 1412 if (diag != null)
jjg@12 1413 return diag.getMessage(null);
jjg@12 1414 else
jjg@12 1415 return errmsg;
jjg@12 1416 }
jjg@12 1417
jjg@12 1418 public Object getDetailValue() {
jjg@12 1419 return (diag != null ? diag : errmsg);
duke@1 1420 }
duke@1 1421
duke@1 1422 @Override
duke@1 1423 public CompletionFailure initCause(Throwable cause) {
duke@1 1424 super.initCause(cause);
duke@1 1425 return this;
duke@1 1426 }
duke@1 1427
duke@1 1428 }
mcimadamore@121 1429
mcimadamore@121 1430 /**
mcimadamore@121 1431 * A visitor for symbols. A visitor is used to implement operations
mcimadamore@121 1432 * (or relations) on symbols. Most common operations on types are
mcimadamore@121 1433 * binary relations and this interface is designed for binary
mcimadamore@121 1434 * relations, that is, operations on the form
mcimadamore@121 1435 * Symbol&nbsp;&times;&nbsp;P&nbsp;&rarr;&nbsp;R.
mcimadamore@121 1436 * <!-- In plain text: Type x P -> R -->
mcimadamore@121 1437 *
mcimadamore@121 1438 * @param <R> the return type of the operation implemented by this
mcimadamore@121 1439 * visitor; use Void if no return type is needed.
mcimadamore@121 1440 * @param <P> the type of the second argument (the first being the
mcimadamore@121 1441 * symbol itself) of the operation implemented by this visitor; use
mcimadamore@121 1442 * Void if a second argument is not needed.
mcimadamore@121 1443 */
mcimadamore@121 1444 public interface Visitor<R,P> {
mcimadamore@121 1445 R visitClassSymbol(ClassSymbol s, P arg);
mcimadamore@121 1446 R visitMethodSymbol(MethodSymbol s, P arg);
mcimadamore@121 1447 R visitPackageSymbol(PackageSymbol s, P arg);
mcimadamore@121 1448 R visitOperatorSymbol(OperatorSymbol s, P arg);
mcimadamore@121 1449 R visitVarSymbol(VarSymbol s, P arg);
mcimadamore@121 1450 R visitTypeSymbol(TypeSymbol s, P arg);
mcimadamore@121 1451 R visitSymbol(Symbol s, P arg);
mcimadamore@121 1452 }
duke@1 1453 }

mercurial