src/share/classes/com/sun/tools/javac/comp/MemberEnter.java

Fri, 18 Jun 2010 15:12:04 -0700

author
jrose
date
Fri, 18 Jun 2010 15:12:04 -0700
changeset 573
005bec70ca27
parent 554
9d9f26857129
parent 571
f0e3ec1f9d9f
child 591
d1d7595fa824
permissions
-rw-r--r--

Merge

     1 /*
     2  * Copyright (c) 2003, 2008, 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  */
    26 package com.sun.tools.javac.comp;
    28 import java.util.*;
    29 import java.util.Set;
    30 import javax.tools.JavaFileObject;
    32 import com.sun.tools.javac.code.*;
    33 import com.sun.tools.javac.jvm.*;
    34 import com.sun.tools.javac.tree.*;
    35 import com.sun.tools.javac.util.*;
    36 import com.sun.tools.javac.util.List;
    38 import com.sun.tools.javac.code.Type.*;
    39 import com.sun.tools.javac.code.Symbol.*;
    40 import com.sun.tools.javac.tree.JCTree.*;
    42 import static com.sun.tools.javac.code.Flags.*;
    43 import static com.sun.tools.javac.code.Kinds.*;
    44 import static com.sun.tools.javac.code.TypeTags.*;
    45 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
    47 /** This is the second phase of Enter, in which classes are completed
    48  *  by entering their members into the class scope using
    49  *  MemberEnter.complete().  See Enter for an overview.
    50  *
    51  *  <p><b>This is NOT part of any API supported by Sun Microsystems.  If
    52  *  you write code that depends on this, you do so at your own risk.
    53  *  This code and its internal interfaces are subject to change or
    54  *  deletion without notice.</b>
    55  */
    56 public class MemberEnter extends JCTree.Visitor implements Completer {
    57     protected static final Context.Key<MemberEnter> memberEnterKey =
    58         new Context.Key<MemberEnter>();
    60     /** A switch to determine whether we check for package/class conflicts
    61      */
    62     final static boolean checkClash = true;
    64     private final Names names;
    65     private final Enter enter;
    66     private final Log log;
    67     private final Check chk;
    68     private final Attr attr;
    69     private final Symtab syms;
    70     private final TreeMaker make;
    71     private final ClassReader reader;
    72     private final Todo todo;
    73     private final Annotate annotate;
    74     private final Types types;
    75     private final JCDiagnostic.Factory diags;
    76     private final Target target;
    78     private final boolean skipAnnotations;
    80     public static MemberEnter instance(Context context) {
    81         MemberEnter instance = context.get(memberEnterKey);
    82         if (instance == null)
    83             instance = new MemberEnter(context);
    84         return instance;
    85     }
    87     protected MemberEnter(Context context) {
    88         context.put(memberEnterKey, this);
    89         names = Names.instance(context);
    90         enter = Enter.instance(context);
    91         log = Log.instance(context);
    92         chk = Check.instance(context);
    93         attr = Attr.instance(context);
    94         syms = Symtab.instance(context);
    95         make = TreeMaker.instance(context);
    96         reader = ClassReader.instance(context);
    97         todo = Todo.instance(context);
    98         annotate = Annotate.instance(context);
    99         types = Types.instance(context);
   100         diags = JCDiagnostic.Factory.instance(context);
   101         target = Target.instance(context);
   102         Options options = Options.instance(context);
   103         skipAnnotations = options.get("skipAnnotations") != null;
   104     }
   106     /** A queue for classes whose members still need to be entered into the
   107      *  symbol table.
   108      */
   109     ListBuffer<Env<AttrContext>> halfcompleted = new ListBuffer<Env<AttrContext>>();
   111     /** Set to true only when the first of a set of classes is
   112      *  processed from the halfcompleted queue.
   113      */
   114     boolean isFirst = true;
   116     /** A flag to disable completion from time to time during member
   117      *  enter, as we only need to look up types.  This avoids
   118      *  unnecessarily deep recursion.
   119      */
   120     boolean completionEnabled = true;
   122     /* ---------- Processing import clauses ----------------
   123      */
   125     /** Import all classes of a class or package on demand.
   126      *  @param pos           Position to be used for error reporting.
   127      *  @param tsym          The class or package the members of which are imported.
   128      *  @param toScope   The (import) scope in which imported classes
   129      *               are entered.
   130      */
   131     private void importAll(int pos,
   132                            final TypeSymbol tsym,
   133                            Env<AttrContext> env) {
   134         // Check that packages imported from exist (JLS ???).
   135         if (tsym.kind == PCK && tsym.members().elems == null && !tsym.exists()) {
   136             // If we can't find java.lang, exit immediately.
   137             if (((PackageSymbol)tsym).fullname.equals(names.java_lang)) {
   138                 JCDiagnostic msg = diags.fragment("fatal.err.no.java.lang");
   139                 throw new FatalError(msg);
   140             } else {
   141                 log.error(pos, "doesnt.exist", tsym);
   142             }
   143         }
   144         final Scope fromScope = tsym.members();
   145         final Scope toScope = env.toplevel.starImportScope;
   146         for (Scope.Entry e = fromScope.elems; e != null; e = e.sibling) {
   147             if (e.sym.kind == TYP && !toScope.includes(e.sym))
   148                 toScope.enter(e.sym, fromScope);
   149         }
   150     }
   152     /** Import all static members of a class or package on demand.
   153      *  @param pos           Position to be used for error reporting.
   154      *  @param tsym          The class or package the members of which are imported.
   155      *  @param toScope   The (import) scope in which imported classes
   156      *               are entered.
   157      */
   158     private void importStaticAll(int pos,
   159                                  final TypeSymbol tsym,
   160                                  Env<AttrContext> env) {
   161         final JavaFileObject sourcefile = env.toplevel.sourcefile;
   162         final Scope toScope = env.toplevel.starImportScope;
   163         final PackageSymbol packge = env.toplevel.packge;
   164         final TypeSymbol origin = tsym;
   166         // enter imported types immediately
   167         new Object() {
   168             Set<Symbol> processed = new HashSet<Symbol>();
   169             void importFrom(TypeSymbol tsym) {
   170                 if (tsym == null || !processed.add(tsym))
   171                     return;
   173                 // also import inherited names
   174                 importFrom(types.supertype(tsym.type).tsym);
   175                 for (Type t : types.interfaces(tsym.type))
   176                     importFrom(t.tsym);
   178                 final Scope fromScope = tsym.members();
   179                 for (Scope.Entry e = fromScope.elems; e != null; e = e.sibling) {
   180                     Symbol sym = e.sym;
   181                     if (sym.kind == TYP &&
   182                         (sym.flags() & STATIC) != 0 &&
   183                         staticImportAccessible(sym, packge) &&
   184                         sym.isMemberOf(origin, types) &&
   185                         !toScope.includes(sym))
   186                         toScope.enter(sym, fromScope, origin.members());
   187                 }
   188             }
   189         }.importFrom(tsym);
   191         // enter non-types before annotations that might use them
   192         annotate.earlier(new Annotate.Annotator() {
   193             Set<Symbol> processed = new HashSet<Symbol>();
   195             public String toString() {
   196                 return "import static " + tsym + ".*" + " in " + sourcefile;
   197             }
   198             void importFrom(TypeSymbol tsym) {
   199                 if (tsym == null || !processed.add(tsym))
   200                     return;
   202                 // also import inherited names
   203                 importFrom(types.supertype(tsym.type).tsym);
   204                 for (Type t : types.interfaces(tsym.type))
   205                     importFrom(t.tsym);
   207                 final Scope fromScope = tsym.members();
   208                 for (Scope.Entry e = fromScope.elems; e != null; e = e.sibling) {
   209                     Symbol sym = e.sym;
   210                     if (sym.isStatic() && sym.kind != TYP &&
   211                         staticImportAccessible(sym, packge) &&
   212                         !toScope.includes(sym) &&
   213                         sym.isMemberOf(origin, types)) {
   214                         toScope.enter(sym, fromScope, origin.members());
   215                     }
   216                 }
   217             }
   218             public void enterAnnotation() {
   219                 importFrom(tsym);
   220             }
   221         });
   222     }
   224     // is the sym accessible everywhere in packge?
   225     boolean staticImportAccessible(Symbol sym, PackageSymbol packge) {
   226         int flags = (int)(sym.flags() & AccessFlags);
   227         switch (flags) {
   228         default:
   229         case PUBLIC:
   230             return true;
   231         case PRIVATE:
   232             return false;
   233         case 0:
   234         case PROTECTED:
   235             return sym.packge() == packge;
   236         }
   237     }
   239     /** Import statics types of a given name.  Non-types are handled in Attr.
   240      *  @param pos           Position to be used for error reporting.
   241      *  @param tsym          The class from which the name is imported.
   242      *  @param name          The (simple) name being imported.
   243      *  @param env           The environment containing the named import
   244      *                  scope to add to.
   245      */
   246     private void importNamedStatic(final DiagnosticPosition pos,
   247                                    final TypeSymbol tsym,
   248                                    final Name name,
   249                                    final Env<AttrContext> env) {
   250         if (tsym.kind != TYP) {
   251             log.error(pos, "static.imp.only.classes.and.interfaces");
   252             return;
   253         }
   255         final Scope toScope = env.toplevel.namedImportScope;
   256         final PackageSymbol packge = env.toplevel.packge;
   257         final TypeSymbol origin = tsym;
   259         // enter imported types immediately
   260         new Object() {
   261             Set<Symbol> processed = new HashSet<Symbol>();
   262             void importFrom(TypeSymbol tsym) {
   263                 if (tsym == null || !processed.add(tsym))
   264                     return;
   266                 // also import inherited names
   267                 importFrom(types.supertype(tsym.type).tsym);
   268                 for (Type t : types.interfaces(tsym.type))
   269                     importFrom(t.tsym);
   271                 for (Scope.Entry e = tsym.members().lookup(name);
   272                      e.scope != null;
   273                      e = e.next()) {
   274                     Symbol sym = e.sym;
   275                     if (sym.isStatic() &&
   276                         sym.kind == TYP &&
   277                         staticImportAccessible(sym, packge) &&
   278                         sym.isMemberOf(origin, types) &&
   279                         chk.checkUniqueStaticImport(pos, sym, toScope))
   280                         toScope.enter(sym, sym.owner.members(), origin.members());
   281                 }
   282             }
   283         }.importFrom(tsym);
   285         // enter non-types before annotations that might use them
   286         annotate.earlier(new Annotate.Annotator() {
   287             Set<Symbol> processed = new HashSet<Symbol>();
   288             boolean found = false;
   290             public String toString() {
   291                 return "import static " + tsym + "." + name;
   292             }
   293             void importFrom(TypeSymbol tsym) {
   294                 if (tsym == null || !processed.add(tsym))
   295                     return;
   297                 // also import inherited names
   298                 importFrom(types.supertype(tsym.type).tsym);
   299                 for (Type t : types.interfaces(tsym.type))
   300                     importFrom(t.tsym);
   302                 for (Scope.Entry e = tsym.members().lookup(name);
   303                      e.scope != null;
   304                      e = e.next()) {
   305                     Symbol sym = e.sym;
   306                     if (sym.isStatic() &&
   307                         staticImportAccessible(sym, packge) &&
   308                         sym.isMemberOf(origin, types)) {
   309                         found = true;
   310                         if (sym.kind == MTH ||
   311                             sym.kind != TYP && chk.checkUniqueStaticImport(pos, sym, toScope))
   312                             toScope.enter(sym, sym.owner.members(), origin.members());
   313                     }
   314                 }
   315             }
   316             public void enterAnnotation() {
   317                 JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
   318                 try {
   319                     importFrom(tsym);
   320                     if (!found) {
   321                         log.error(pos, "cant.resolve.location",
   322                                   KindName.STATIC,
   323                                   name, List.<Type>nil(), List.<Type>nil(),
   324                                   Kinds.typeKindName(tsym.type),
   325                                   tsym.type);
   326                     }
   327                 } finally {
   328                     log.useSource(prev);
   329                 }
   330             }
   331         });
   332     }
   333     /** Import given class.
   334      *  @param pos           Position to be used for error reporting.
   335      *  @param tsym          The class to be imported.
   336      *  @param env           The environment containing the named import
   337      *                  scope to add to.
   338      */
   339     private void importNamed(DiagnosticPosition pos, Symbol tsym, Env<AttrContext> env) {
   340         if (tsym.kind == TYP &&
   341             chk.checkUniqueImport(pos, tsym, env.toplevel.namedImportScope))
   342             env.toplevel.namedImportScope.enter(tsym, tsym.owner.members());
   343     }
   345     /** Construct method type from method signature.
   346      *  @param typarams    The method's type parameters.
   347      *  @param params      The method's value parameters.
   348      *  @param res             The method's result type,
   349      *                 null if it is a constructor.
   350      *  @param thrown      The method's thrown exceptions.
   351      *  @param env             The method's (local) environment.
   352      */
   353     Type signature(List<JCTypeParameter> typarams,
   354                    List<JCVariableDecl> params,
   355                    JCTree res,
   356                    List<JCExpression> thrown,
   357                    Env<AttrContext> env) {
   359         // Enter and attribute type parameters.
   360         List<Type> tvars = enter.classEnter(typarams, env);
   361         attr.attribTypeVariables(typarams, env);
   363         // Enter and attribute value parameters.
   364         ListBuffer<Type> argbuf = new ListBuffer<Type>();
   365         for (List<JCVariableDecl> l = params; l.nonEmpty(); l = l.tail) {
   366             memberEnter(l.head, env);
   367             argbuf.append(l.head.vartype.type);
   368         }
   370         // Attribute result type, if one is given.
   371         Type restype = res == null ? syms.voidType : attr.attribType(res, env);
   373         // Attribute thrown exceptions.
   374         ListBuffer<Type> thrownbuf = new ListBuffer<Type>();
   375         for (List<JCExpression> l = thrown; l.nonEmpty(); l = l.tail) {
   376             Type exc = attr.attribType(l.head, env);
   377             if (exc.tag != TYPEVAR)
   378                 exc = chk.checkClassType(l.head.pos(), exc);
   379             thrownbuf.append(exc);
   380         }
   381         Type mtype = new MethodType(argbuf.toList(),
   382                                     restype,
   383                                     thrownbuf.toList(),
   384                                     syms.methodClass);
   385         return tvars.isEmpty() ? mtype : new ForAll(tvars, mtype);
   386     }
   388 /* ********************************************************************
   389  * Visitor methods for member enter
   390  *********************************************************************/
   392     /** Visitor argument: the current environment
   393      */
   394     protected Env<AttrContext> env;
   396     /** Enter field and method definitions and process import
   397      *  clauses, catching any completion failure exceptions.
   398      */
   399     protected void memberEnter(JCTree tree, Env<AttrContext> env) {
   400         Env<AttrContext> prevEnv = this.env;
   401         try {
   402             this.env = env;
   403             tree.accept(this);
   404         }  catch (CompletionFailure ex) {
   405             chk.completionError(tree.pos(), ex);
   406         } finally {
   407             this.env = prevEnv;
   408         }
   409     }
   411     /** Enter members from a list of trees.
   412      */
   413     void memberEnter(List<? extends JCTree> trees, Env<AttrContext> env) {
   414         for (List<? extends JCTree> l = trees; l.nonEmpty(); l = l.tail)
   415             memberEnter(l.head, env);
   416     }
   418     /** Enter members for a class.
   419      */
   420     void finishClass(JCClassDecl tree, Env<AttrContext> env) {
   421         if ((tree.mods.flags & Flags.ENUM) != 0 &&
   422             (types.supertype(tree.sym.type).tsym.flags() & Flags.ENUM) == 0) {
   423             addEnumMembers(tree, env);
   424         }
   425         memberEnter(tree.defs, env);
   426     }
   428     /** Add the implicit members for an enum type
   429      *  to the symbol table.
   430      */
   431     private void addEnumMembers(JCClassDecl tree, Env<AttrContext> env) {
   432         JCExpression valuesType = make.Type(new ArrayType(tree.sym.type, syms.arrayClass));
   434         // public static T[] values() { return ???; }
   435         JCMethodDecl values = make.
   436             MethodDef(make.Modifiers(Flags.PUBLIC|Flags.STATIC),
   437                       names.values,
   438                       valuesType,
   439                       List.<JCTypeParameter>nil(),
   440                       List.<JCVariableDecl>nil(),
   441                       List.<JCExpression>nil(), // thrown
   442                       null, //make.Block(0, Tree.emptyList.prepend(make.Return(make.Ident(names._null)))),
   443                       null);
   444         memberEnter(values, env);
   446         // public static T valueOf(String name) { return ???; }
   447         JCMethodDecl valueOf = make.
   448             MethodDef(make.Modifiers(Flags.PUBLIC|Flags.STATIC),
   449                       names.valueOf,
   450                       make.Type(tree.sym.type),
   451                       List.<JCTypeParameter>nil(),
   452                       List.of(make.VarDef(make.Modifiers(Flags.PARAMETER),
   453                                             names.fromString("name"),
   454                                             make.Type(syms.stringType), null)),
   455                       List.<JCExpression>nil(), // thrown
   456                       null, //make.Block(0, Tree.emptyList.prepend(make.Return(make.Ident(names._null)))),
   457                       null);
   458         memberEnter(valueOf, env);
   460         // the remaining members are for bootstrapping only
   461         if (!target.compilerBootstrap(tree.sym)) return;
   463         // public final int ordinal() { return ???; }
   464         JCMethodDecl ordinal = make.at(tree.pos).
   465             MethodDef(make.Modifiers(Flags.PUBLIC|Flags.FINAL),
   466                       names.ordinal,
   467                       make.Type(syms.intType),
   468                       List.<JCTypeParameter>nil(),
   469                       List.<JCVariableDecl>nil(),
   470                       List.<JCExpression>nil(),
   471                       null,
   472                       null);
   473         memberEnter(ordinal, env);
   475         // public final String name() { return ???; }
   476         JCMethodDecl name = make.
   477             MethodDef(make.Modifiers(Flags.PUBLIC|Flags.FINAL),
   478                       names._name,
   479                       make.Type(syms.stringType),
   480                       List.<JCTypeParameter>nil(),
   481                       List.<JCVariableDecl>nil(),
   482                       List.<JCExpression>nil(),
   483                       null,
   484                       null);
   485         memberEnter(name, env);
   487         // public int compareTo(E other) { return ???; }
   488         MethodSymbol compareTo = new
   489             MethodSymbol(Flags.PUBLIC,
   490                          names.compareTo,
   491                          new MethodType(List.of(tree.sym.type),
   492                                         syms.intType,
   493                                         List.<Type>nil(),
   494                                         syms.methodClass),
   495                          tree.sym);
   496         memberEnter(make.MethodDef(compareTo, null), env);
   497     }
   499     public void visitTopLevel(JCCompilationUnit tree) {
   500         if (tree.starImportScope.elems != null) {
   501             // we must have already processed this toplevel
   502             return;
   503         }
   505         // check that no class exists with same fully qualified name as
   506         // toplevel package
   507         if (checkClash && tree.pid != null) {
   508             Symbol p = tree.packge;
   509             while (p.owner != syms.rootPackage) {
   510                 p.owner.complete(); // enter all class members of p
   511                 if (syms.classes.get(p.getQualifiedName()) != null) {
   512                     log.error(tree.pos,
   513                               "pkg.clashes.with.class.of.same.name",
   514                               p);
   515                 }
   516                 p = p.owner;
   517             }
   518         }
   520         // process package annotations
   521         annotateLater(tree.packageAnnotations, env, tree.packge);
   523         // Import-on-demand java.lang.
   524         importAll(tree.pos, reader.enterPackage(names.java_lang), env);
   526         // Process all import clauses.
   527         memberEnter(tree.defs, env);
   528     }
   530     // process the non-static imports and the static imports of types.
   531     public void visitImport(JCImport tree) {
   532         JCTree imp = tree.qualid;
   533         Name name = TreeInfo.name(imp);
   534         TypeSymbol p;
   536         // Create a local environment pointing to this tree to disable
   537         // effects of other imports in Resolve.findGlobalType
   538         Env<AttrContext> localEnv = env.dup(tree);
   540         // Attribute qualifying package or class.
   541         JCFieldAccess s = (JCFieldAccess) imp;
   542         p = attr.
   543             attribTree(s.selected,
   544                        localEnv,
   545                        tree.staticImport ? TYP : (TYP | PCK),
   546                        Type.noType).tsym;
   547         if (name == names.asterisk) {
   548             // Import on demand.
   549             chk.checkCanonical(s.selected);
   550             if (tree.staticImport)
   551                 importStaticAll(tree.pos, p, env);
   552             else
   553                 importAll(tree.pos, p, env);
   554         } else {
   555             // Named type import.
   556             if (tree.staticImport) {
   557                 importNamedStatic(tree.pos(), p, name, localEnv);
   558                 chk.checkCanonical(s.selected);
   559             } else {
   560                 TypeSymbol c = attribImportType(imp, localEnv).tsym;
   561                 chk.checkCanonical(imp);
   562                 importNamed(tree.pos(), c, env);
   563             }
   564         }
   565     }
   567     public void visitMethodDef(JCMethodDecl tree) {
   568         Scope enclScope = enter.enterScope(env);
   569         MethodSymbol m = new MethodSymbol(0, tree.name, null, enclScope.owner);
   570         m.flags_field = chk.checkFlags(tree.pos(), tree.mods.flags, m, tree);
   571         tree.sym = m;
   572         Env<AttrContext> localEnv = methodEnv(tree, env);
   574         // Compute the method type
   575         m.type = signature(tree.typarams, tree.params,
   576                            tree.restype, tree.thrown,
   577                            localEnv);
   579         // Set m.params
   580         ListBuffer<VarSymbol> params = new ListBuffer<VarSymbol>();
   581         JCVariableDecl lastParam = null;
   582         for (List<JCVariableDecl> l = tree.params; l.nonEmpty(); l = l.tail) {
   583             JCVariableDecl param = lastParam = l.head;
   584             assert param.sym != null;
   585             params.append(param.sym);
   586         }
   587         m.params = params.toList();
   589         // mark the method varargs, if necessary
   590         if (lastParam != null && (lastParam.mods.flags & Flags.VARARGS) != 0)
   591             m.flags_field |= Flags.VARARGS;
   593         localEnv.info.scope.leave();
   594         if (chk.checkUnique(tree.pos(), m, enclScope)) {
   595             enclScope.enter(m);
   596         }
   597         annotateLater(tree.mods.annotations, localEnv, m);
   598         if (tree.defaultValue != null)
   599             annotateDefaultValueLater(tree.defaultValue, localEnv, m);
   600     }
   602     /** Create a fresh environment for method bodies.
   603      *  @param tree     The method definition.
   604      *  @param env      The environment current outside of the method definition.
   605      */
   606     Env<AttrContext> methodEnv(JCMethodDecl tree, Env<AttrContext> env) {
   607         Env<AttrContext> localEnv =
   608             env.dup(tree, env.info.dup(env.info.scope.dupUnshared()));
   609         localEnv.enclMethod = tree;
   610         localEnv.info.scope.owner = tree.sym;
   611         if ((tree.mods.flags & STATIC) != 0) localEnv.info.staticLevel++;
   612         return localEnv;
   613     }
   615     public void visitVarDef(JCVariableDecl tree) {
   616         Env<AttrContext> localEnv = env;
   617         if ((tree.mods.flags & STATIC) != 0 ||
   618             (env.info.scope.owner.flags() & INTERFACE) != 0) {
   619             localEnv = env.dup(tree, env.info.dup());
   620             localEnv.info.staticLevel++;
   621         }
   622         attr.attribType(tree.vartype, localEnv);
   623         Scope enclScope = enter.enterScope(env);
   624         VarSymbol v =
   625             new VarSymbol(0, tree.name, tree.vartype.type, enclScope.owner);
   626         v.flags_field = chk.checkFlags(tree.pos(), tree.mods.flags, v, tree);
   627         tree.sym = v;
   628         if (tree.init != null) {
   629             v.flags_field |= HASINIT;
   630             if ((v.flags_field & FINAL) != 0 && tree.init.getTag() != JCTree.NEWCLASS) {
   631                 Env<AttrContext> initEnv = getInitEnv(tree, env);
   632                 initEnv.info.enclVar = v;
   633                 v.setLazyConstValue(initEnv(tree, initEnv), log, attr, tree.init);
   634             }
   635         }
   636         if (chk.checkUnique(tree.pos(), v, enclScope)) {
   637             chk.checkTransparentVar(tree.pos(), v, enclScope);
   638             enclScope.enter(v);
   639         }
   640         annotateLater(tree.mods.annotations, localEnv, v);
   641         v.pos = tree.pos;
   642     }
   644     /** Create a fresh environment for a variable's initializer.
   645      *  If the variable is a field, the owner of the environment's scope
   646      *  is be the variable itself, otherwise the owner is the method
   647      *  enclosing the variable definition.
   648      *
   649      *  @param tree     The variable definition.
   650      *  @param env      The environment current outside of the variable definition.
   651      */
   652     Env<AttrContext> initEnv(JCVariableDecl tree, Env<AttrContext> env) {
   653         Env<AttrContext> localEnv = env.dupto(new AttrContextEnv(tree, env.info.dup()));
   654         if (tree.sym.owner.kind == TYP) {
   655             localEnv.info.scope = new Scope.DelegatedScope(env.info.scope);
   656             localEnv.info.scope.owner = tree.sym;
   657         }
   658         if ((tree.mods.flags & STATIC) != 0 ||
   659             (env.enclClass.sym.flags() & INTERFACE) != 0)
   660             localEnv.info.staticLevel++;
   661         return localEnv;
   662     }
   664     /** Default member enter visitor method: do nothing
   665      */
   666     public void visitTree(JCTree tree) {
   667     }
   670     public void visitErroneous(JCErroneous tree) {
   671         memberEnter(tree.errs, env);
   672     }
   674     public Env<AttrContext> getMethodEnv(JCMethodDecl tree, Env<AttrContext> env) {
   675         Env<AttrContext> mEnv = methodEnv(tree, env);
   676         mEnv.info.lint = mEnv.info.lint.augment(tree.sym.attributes_field, tree.sym.flags());
   677         for (List<JCTypeParameter> l = tree.typarams; l.nonEmpty(); l = l.tail)
   678             mEnv.info.scope.enterIfAbsent(l.head.type.tsym);
   679         for (List<JCVariableDecl> l = tree.params; l.nonEmpty(); l = l.tail)
   680             mEnv.info.scope.enterIfAbsent(l.head.sym);
   681         return mEnv;
   682     }
   684     public Env<AttrContext> getInitEnv(JCVariableDecl tree, Env<AttrContext> env) {
   685         Env<AttrContext> iEnv = initEnv(tree, env);
   686         return iEnv;
   687     }
   689 /* ********************************************************************
   690  * Type completion
   691  *********************************************************************/
   693     Type attribImportType(JCTree tree, Env<AttrContext> env) {
   694         assert completionEnabled;
   695         try {
   696             // To prevent deep recursion, suppress completion of some
   697             // types.
   698             completionEnabled = false;
   699             return attr.attribType(tree, env);
   700         } finally {
   701             completionEnabled = true;
   702         }
   703     }
   705 /* ********************************************************************
   706  * Annotation processing
   707  *********************************************************************/
   709     /** Queue annotations for later processing. */
   710     void annotateLater(final List<JCAnnotation> annotations,
   711                        final Env<AttrContext> localEnv,
   712                        final Symbol s) {
   713         if (annotations.isEmpty()) return;
   714         if (s.kind != PCK) s.attributes_field = null; // mark it incomplete for now
   715         annotate.later(new Annotate.Annotator() {
   716                 public String toString() {
   717                     return "annotate " + annotations + " onto " + s + " in " + s.owner;
   718                 }
   719                 public void enterAnnotation() {
   720                     assert s.kind == PCK || s.attributes_field == null;
   721                     JavaFileObject prev = log.useSource(localEnv.toplevel.sourcefile);
   722                     try {
   723                         if (s.attributes_field != null &&
   724                             s.attributes_field.nonEmpty() &&
   725                             annotations.nonEmpty())
   726                             log.error(annotations.head.pos,
   727                                       "already.annotated",
   728                                       kindName(s), s);
   729                         enterAnnotations(annotations, localEnv, s);
   730                     } finally {
   731                         log.useSource(prev);
   732                     }
   733                 }
   734             });
   735     }
   737     /**
   738      * Check if a list of annotations contains a reference to
   739      * java.lang.Deprecated.
   740      **/
   741     private boolean hasDeprecatedAnnotation(List<JCAnnotation> annotations) {
   742         for (List<JCAnnotation> al = annotations; al.nonEmpty(); al = al.tail) {
   743             JCAnnotation a = al.head;
   744             if (a.annotationType.type == syms.deprecatedType && a.args.isEmpty())
   745                 return true;
   746         }
   747         return false;
   748     }
   751     /** Enter a set of annotations. */
   752     private void enterAnnotations(List<JCAnnotation> annotations,
   753                           Env<AttrContext> env,
   754                           Symbol s) {
   755         ListBuffer<Attribute.Compound> buf =
   756             new ListBuffer<Attribute.Compound>();
   757         Set<TypeSymbol> annotated = new HashSet<TypeSymbol>();
   758         if (!skipAnnotations)
   759         for (List<JCAnnotation> al = annotations; al.nonEmpty(); al = al.tail) {
   760             JCAnnotation a = al.head;
   761             Attribute.Compound c = annotate.enterAnnotation(a,
   762                                                             syms.annotationType,
   763                                                             env);
   764             if (c == null) continue;
   765             buf.append(c);
   766             // Note: @Deprecated has no effect on local variables and parameters
   767             if (!c.type.isErroneous()
   768                 && s.owner.kind != MTH
   769                 && types.isSameType(c.type, syms.deprecatedType))
   770                 s.flags_field |= Flags.DEPRECATED;
   771             // Internally to java.dyn, a @PolymorphicSignature annotation
   772             // translates to a classfile attribute.
   773             if (!c.type.isErroneous()
   774                 && types.isSameType(c.type, syms.polymorphicSignatureType)) {
   775                 s.flags_field |= Flags.POLYMORPHIC_SIGNATURE;
   776             }
   777             if (!annotated.add(a.type.tsym))
   778                 log.error(a.pos, "duplicate.annotation");
   779         }
   780         s.attributes_field = buf.toList();
   781     }
   783     /** Queue processing of an attribute default value. */
   784     void annotateDefaultValueLater(final JCExpression defaultValue,
   785                                    final Env<AttrContext> localEnv,
   786                                    final MethodSymbol m) {
   787         annotate.later(new Annotate.Annotator() {
   788                 public String toString() {
   789                     return "annotate " + m.owner + "." +
   790                         m + " default " + defaultValue;
   791                 }
   792                 public void enterAnnotation() {
   793                     JavaFileObject prev = log.useSource(localEnv.toplevel.sourcefile);
   794                     try {
   795                         enterDefaultValue(defaultValue, localEnv, m);
   796                     } finally {
   797                         log.useSource(prev);
   798                     }
   799                 }
   800             });
   801     }
   803     /** Enter a default value for an attribute method. */
   804     private void enterDefaultValue(final JCExpression defaultValue,
   805                                    final Env<AttrContext> localEnv,
   806                                    final MethodSymbol m) {
   807         m.defaultValue = annotate.enterAttributeValue(m.type.getReturnType(),
   808                                                       defaultValue,
   809                                                       localEnv);
   810     }
   812 /* ********************************************************************
   813  * Source completer
   814  *********************************************************************/
   816     /** Complete entering a class.
   817      *  @param sym         The symbol of the class to be completed.
   818      */
   819     public void complete(Symbol sym) throws CompletionFailure {
   820         // Suppress some (recursive) MemberEnter invocations
   821         if (!completionEnabled) {
   822             // Re-install same completer for next time around and return.
   823             assert (sym.flags() & Flags.COMPOUND) == 0;
   824             sym.completer = this;
   825             return;
   826         }
   828         ClassSymbol c = (ClassSymbol)sym;
   829         ClassType ct = (ClassType)c.type;
   830         Env<AttrContext> env = enter.typeEnvs.get(c);
   831         JCClassDecl tree = (JCClassDecl)env.tree;
   832         boolean wasFirst = isFirst;
   833         isFirst = false;
   835         JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
   836         try {
   837             // Save class environment for later member enter (2) processing.
   838             halfcompleted.append(env);
   840             // Mark class as not yet attributed.
   841             c.flags_field |= UNATTRIBUTED;
   843             // If this is a toplevel-class, make sure any preceding import
   844             // clauses have been seen.
   845             if (c.owner.kind == PCK) {
   846                 memberEnter(env.toplevel, env.enclosing(JCTree.TOPLEVEL));
   847                 todo.append(env);
   848             }
   850             if (c.owner.kind == TYP)
   851                 c.owner.complete();
   853             // create an environment for evaluating the base clauses
   854             Env<AttrContext> baseEnv = baseEnv(tree, env);
   856             // Determine supertype.
   857             Type supertype =
   858                 (tree.extending != null)
   859                 ? attr.attribBase(tree.extending, baseEnv, true, false, true)
   860                 : ((tree.mods.flags & Flags.ENUM) != 0 && !target.compilerBootstrap(c))
   861                 ? attr.attribBase(enumBase(tree.pos, c), baseEnv,
   862                                   true, false, false)
   863                 : (c.fullname == names.java_lang_Object)
   864                 ? Type.noType
   865                 : syms.objectType;
   866             ct.supertype_field = supertype;
   868             // Determine interfaces.
   869             ListBuffer<Type> interfaces = new ListBuffer<Type>();
   870             Set<Type> interfaceSet = new HashSet<Type>();
   871             List<JCExpression> interfaceTrees = tree.implementing;
   872             if ((tree.mods.flags & Flags.ENUM) != 0 && target.compilerBootstrap(c)) {
   873                 // add interface Comparable<T>
   874                 interfaceTrees =
   875                     interfaceTrees.prepend(make.Type(new ClassType(syms.comparableType.getEnclosingType(),
   876                                                                    List.of(c.type),
   877                                                                    syms.comparableType.tsym)));
   878                 // add interface Serializable
   879                 interfaceTrees =
   880                     interfaceTrees.prepend(make.Type(syms.serializableType));
   881             }
   882             for (JCExpression iface : interfaceTrees) {
   883                 Type i = attr.attribBase(iface, baseEnv, false, true, true);
   884                 if (i.tag == CLASS) {
   885                     interfaces.append(i);
   886                     chk.checkNotRepeated(iface.pos(), types.erasure(i), interfaceSet);
   887                 }
   888             }
   889             if ((c.flags_field & ANNOTATION) != 0)
   890                 ct.interfaces_field = List.of(syms.annotationType);
   891             else
   892                 ct.interfaces_field = interfaces.toList();
   894             if (c.fullname == names.java_lang_Object) {
   895                 if (tree.extending != null) {
   896                     chk.checkNonCyclic(tree.extending.pos(),
   897                                        supertype);
   898                     ct.supertype_field = Type.noType;
   899                 }
   900                 else if (tree.implementing.nonEmpty()) {
   901                     chk.checkNonCyclic(tree.implementing.head.pos(),
   902                                        ct.interfaces_field.head);
   903                     ct.interfaces_field = List.nil();
   904                 }
   905             }
   907             // Annotations.
   908             // In general, we cannot fully process annotations yet,  but we
   909             // can attribute the annotation types and then check to see if the
   910             // @Deprecated annotation is present.
   911             attr.attribAnnotationTypes(tree.mods.annotations, baseEnv);
   912             if (hasDeprecatedAnnotation(tree.mods.annotations))
   913                 c.flags_field |= DEPRECATED;
   914             annotateLater(tree.mods.annotations, baseEnv, c);
   915             // class type parameters use baseEnv but everything uses env
   916             for (JCTypeParameter tp : tree.typarams)
   917                 tp.accept(new TypeAnnotate(baseEnv));
   918             tree.accept(new TypeAnnotate(env));
   920             chk.checkNonCyclic(tree.pos(), c.type);
   922             attr.attribTypeVariables(tree.typarams, baseEnv);
   924             // Add default constructor if needed.
   925             if ((c.flags() & INTERFACE) == 0 &&
   926                 !TreeInfo.hasConstructors(tree.defs)) {
   927                 List<Type> argtypes = List.nil();
   928                 List<Type> typarams = List.nil();
   929                 List<Type> thrown = List.nil();
   930                 long ctorFlags = 0;
   931                 boolean based = false;
   932                 if (c.name.isEmpty()) {
   933                     JCNewClass nc = (JCNewClass)env.next.tree;
   934                     if (nc.constructor != null) {
   935                         Type superConstrType = types.memberType(c.type,
   936                                                                 nc.constructor);
   937                         argtypes = superConstrType.getParameterTypes();
   938                         typarams = superConstrType.getTypeArguments();
   939                         ctorFlags = nc.constructor.flags() & VARARGS;
   940                         if (nc.encl != null) {
   941                             argtypes = argtypes.prepend(nc.encl.type);
   942                             based = true;
   943                         }
   944                         thrown = superConstrType.getThrownTypes();
   945                     }
   946                 }
   947                 JCTree constrDef = DefaultConstructor(make.at(tree.pos), c,
   948                                                     typarams, argtypes, thrown,
   949                                                     ctorFlags, based);
   950                 tree.defs = tree.defs.prepend(constrDef);
   951             }
   953             // If this is a class, enter symbols for this and super into
   954             // current scope.
   955             if ((c.flags_field & INTERFACE) == 0) {
   956                 VarSymbol thisSym =
   957                     new VarSymbol(FINAL | HASINIT, names._this, c.type, c);
   958                 thisSym.pos = Position.FIRSTPOS;
   959                 env.info.scope.enter(thisSym);
   960                 if (ct.supertype_field.tag == CLASS) {
   961                     VarSymbol superSym =
   962                         new VarSymbol(FINAL | HASINIT, names._super,
   963                                       ct.supertype_field, c);
   964                     superSym.pos = Position.FIRSTPOS;
   965                     env.info.scope.enter(superSym);
   966                 }
   967             }
   969             // check that no package exists with same fully qualified name,
   970             // but admit classes in the unnamed package which have the same
   971             // name as a top-level package.
   972             if (checkClash &&
   973                 c.owner.kind == PCK && c.owner != syms.unnamedPackage &&
   974                 reader.packageExists(c.fullname))
   975                 {
   976                     log.error(tree.pos, "clash.with.pkg.of.same.name", c);
   977                 }
   979         } catch (CompletionFailure ex) {
   980             chk.completionError(tree.pos(), ex);
   981         } finally {
   982             log.useSource(prev);
   983         }
   985         // Enter all member fields and methods of a set of half completed
   986         // classes in a second phase.
   987         if (wasFirst) {
   988             try {
   989                 while (halfcompleted.nonEmpty()) {
   990                     finish(halfcompleted.next());
   991                 }
   992             } finally {
   993                 isFirst = true;
   994             }
   996             // commit pending annotations
   997             annotate.flush();
   998         }
   999     }
  1001     // A sub-phase that "compiles" annotations in annotated types.
  1002     private class TypeAnnotate extends TreeScanner {
  1003         private Env<AttrContext> env;
  1004         public TypeAnnotate(Env<AttrContext> env) { this.env = env; }
  1006         private void enterTypeAnnotations(List<JCTypeAnnotation> annotations) {
  1007             Set<TypeSymbol> annotated = new HashSet<TypeSymbol>();
  1008             if (!skipAnnotations)
  1009                 for (List<JCTypeAnnotation> al = annotations; al.nonEmpty(); al = al.tail) {
  1010                     JCTypeAnnotation a = al.head;
  1011                     Attribute.Compound c = annotate.enterAnnotation(a,
  1012                             syms.annotationType,
  1013                             env);
  1014                     if (c == null) continue;
  1015                     Attribute.TypeCompound tc = new Attribute.TypeCompound(c.type, c.values, a.annotation_position);
  1016                     a.attribute_field = tc;
  1017                     // Note: @Deprecated has no effect on local variables and parameters
  1018                     if (!annotated.add(a.type.tsym))
  1019                         log.error(a.pos, "duplicate.annotation");
  1023         // each class (including enclosed inner classes) should be visited
  1024         // separately through MemberEnter.complete(Symbol)
  1025         // this flag is used to prevent from visiting inner classes.
  1026         private boolean isEnclosingClass = false;
  1027         @Override
  1028         public void visitClassDef(final JCClassDecl tree) {
  1029             if (isEnclosingClass)
  1030                 return;
  1031             isEnclosingClass = true;
  1032             scan(tree.mods);
  1033             // type parameter need to be visited with a separate env
  1034             // scan(tree.typarams);
  1035             scan(tree.extending);
  1036             scan(tree.implementing);
  1037             scan(tree.defs);
  1040         private void annotate(final JCTree tree, final List<JCTypeAnnotation> annotations) {
  1041             annotate.later(new Annotate.Annotator() {
  1042                 public String toString() {
  1043                     return "annotate " + annotations + " onto " + tree;
  1045                 public void enterAnnotation() {
  1046                     JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
  1047                     try {
  1048                         enterTypeAnnotations(annotations);
  1049                     } finally {
  1050                         log.useSource(prev);
  1053             });
  1056         @Override
  1057         public void visitAnnotatedType(final JCAnnotatedType tree) {
  1058             annotate(tree, tree.annotations);
  1059             super.visitAnnotatedType(tree);
  1061         @Override
  1062         public void visitTypeParameter(final JCTypeParameter tree) {
  1063             annotate(tree, tree.annotations);
  1064             super.visitTypeParameter(tree);
  1066         @Override
  1067         public void visitNewArray(final JCNewArray tree) {
  1068             annotate(tree, tree.annotations);
  1069             for (List<JCTypeAnnotation> dimAnnos : tree.dimAnnotations)
  1070                 annotate(tree, dimAnnos);
  1071             super.visitNewArray(tree);
  1073         @Override
  1074         public void visitMethodDef(JCMethodDecl tree) {
  1075             annotate(tree, tree.receiverAnnotations);
  1076             super.visitMethodDef(tree);
  1081     private Env<AttrContext> baseEnv(JCClassDecl tree, Env<AttrContext> env) {
  1082         Scope typaramScope = new Scope(tree.sym);
  1083         if (tree.typarams != null)
  1084             for (List<JCTypeParameter> typarams = tree.typarams;
  1085                  typarams.nonEmpty();
  1086                  typarams = typarams.tail)
  1087                 typaramScope.enter(typarams.head.type.tsym);
  1088         Env<AttrContext> outer = env.outer; // the base clause can't see members of this class
  1089         Env<AttrContext> localEnv = outer.dup(tree, outer.info.dup(typaramScope));
  1090         localEnv.baseClause = true;
  1091         localEnv.outer = outer;
  1092         localEnv.info.isSelfCall = false;
  1093         return localEnv;
  1096     /** Enter member fields and methods of a class
  1097      *  @param env        the environment current for the class block.
  1098      */
  1099     private void finish(Env<AttrContext> env) {
  1100         JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
  1101         try {
  1102             JCClassDecl tree = (JCClassDecl)env.tree;
  1103             finishClass(tree, env);
  1104         } finally {
  1105             log.useSource(prev);
  1109     /** Generate a base clause for an enum type.
  1110      *  @param pos              The position for trees and diagnostics, if any
  1111      *  @param c                The class symbol of the enum
  1112      */
  1113     private JCExpression enumBase(int pos, ClassSymbol c) {
  1114         JCExpression result = make.at(pos).
  1115             TypeApply(make.QualIdent(syms.enumSym),
  1116                       List.<JCExpression>of(make.Type(c.type)));
  1117         return result;
  1120 /* ***************************************************************************
  1121  * tree building
  1122  ****************************************************************************/
  1124     /** Generate default constructor for given class. For classes different
  1125      *  from java.lang.Object, this is:
  1127      *    c(argtype_0 x_0, ..., argtype_n x_n) throws thrown {
  1128      *      super(x_0, ..., x_n)
  1129      *    }
  1131      *  or, if based == true:
  1133      *    c(argtype_0 x_0, ..., argtype_n x_n) throws thrown {
  1134      *      x_0.super(x_1, ..., x_n)
  1135      *    }
  1137      *  @param make     The tree factory.
  1138      *  @param c        The class owning the default constructor.
  1139      *  @param argtypes The parameter types of the constructor.
  1140      *  @param thrown   The thrown exceptions of the constructor.
  1141      *  @param based    Is first parameter a this$n?
  1142      */
  1143     JCTree DefaultConstructor(TreeMaker make,
  1144                             ClassSymbol c,
  1145                             List<Type> typarams,
  1146                             List<Type> argtypes,
  1147                             List<Type> thrown,
  1148                             long flags,
  1149                             boolean based) {
  1150         List<JCVariableDecl> params = make.Params(argtypes, syms.noSymbol);
  1151         List<JCStatement> stats = List.nil();
  1152         if (c.type != syms.objectType)
  1153             stats = stats.prepend(SuperCall(make, typarams, params, based));
  1154         if ((c.flags() & ENUM) != 0 &&
  1155             (types.supertype(c.type).tsym == syms.enumSym ||
  1156              target.compilerBootstrap(c))) {
  1157             // constructors of true enums are private
  1158             flags = (flags & ~AccessFlags) | PRIVATE | GENERATEDCONSTR;
  1159         } else
  1160             flags |= (c.flags() & AccessFlags) | GENERATEDCONSTR;
  1161         if (c.name.isEmpty()) flags |= ANONCONSTR;
  1162         JCTree result = make.MethodDef(
  1163             make.Modifiers(flags),
  1164             names.init,
  1165             null,
  1166             make.TypeParams(typarams),
  1167             params,
  1168             make.Types(thrown),
  1169             make.Block(0, stats),
  1170             null);
  1171         return result;
  1174     /** Generate call to superclass constructor. This is:
  1176      *    super(id_0, ..., id_n)
  1178      * or, if based == true
  1180      *    id_0.super(id_1,...,id_n)
  1182      *  where id_0, ..., id_n are the names of the given parameters.
  1184      *  @param make    The tree factory
  1185      *  @param params  The parameters that need to be passed to super
  1186      *  @param typarams  The type parameters that need to be passed to super
  1187      *  @param based   Is first parameter a this$n?
  1188      */
  1189     JCExpressionStatement SuperCall(TreeMaker make,
  1190                    List<Type> typarams,
  1191                    List<JCVariableDecl> params,
  1192                    boolean based) {
  1193         JCExpression meth;
  1194         if (based) {
  1195             meth = make.Select(make.Ident(params.head), names._super);
  1196             params = params.tail;
  1197         } else {
  1198             meth = make.Ident(names._super);
  1200         List<JCExpression> typeargs = typarams.nonEmpty() ? make.Types(typarams) : null;
  1201         return make.Exec(make.Apply(typeargs, meth, make.Idents(params)));

mercurial