001 /*
002 * Copyright 2003-2008 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package com.sun.tools.javac.comp;
027
028 import java.util.*;
029 import java.util.Set;
030 import javax.tools.JavaFileObject;
031
032 import com.sun.tools.javac.code.*;
033 import com.sun.tools.javac.jvm.*;
034 import com.sun.tools.javac.tree.*;
035 import com.sun.tools.javac.util.*;
036 import com.sun.tools.javac.util.List;
037
038 import com.sun.tools.javac.code.Type.*;
039 import com.sun.tools.javac.code.Symbol.*;
040 import com.sun.tools.javac.tree.JCTree.*;
041
042 import static com.sun.tools.javac.code.Flags.*;
043 import static com.sun.tools.javac.code.Kinds.*;
044 import static com.sun.tools.javac.code.TypeTags.*;
045 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
046
047 /** This is the second phase of Enter, in which classes are completed
048 * by entering their members into the class scope using
049 * MemberEnter.complete(). See Enter for an overview.
050 *
051 * <p><b>This is NOT part of any API supported by Sun Microsystems. If
052 * you write code that depends on this, you do so at your own risk.
053 * This code and its internal interfaces are subject to change or
054 * deletion without notice.</b>
055 */
056 public class MemberEnter extends JCTree.Visitor implements Completer {
057 protected static final Context.Key<MemberEnter> memberEnterKey =
058 new Context.Key<MemberEnter>();
059
060 /** A switch to determine whether we check for package/class conflicts
061 */
062 final static boolean checkClash = true;
063
064 private final Names names;
065 private final Enter enter;
066 private final Log log;
067 private final Check chk;
068 private final Attr attr;
069 private final Symtab syms;
070 private final TreeMaker make;
071 private final ClassReader reader;
072 private final Todo todo;
073 private final Annotate annotate;
074 private final Types types;
075 private final JCDiagnostic.Factory diags;
076 private final Target target;
077
078 private final boolean skipAnnotations;
079
080 public static MemberEnter instance(Context context) {
081 MemberEnter instance = context.get(memberEnterKey);
082 if (instance == null)
083 instance = new MemberEnter(context);
084 return instance;
085 }
086
087 protected MemberEnter(Context context) {
088 context.put(memberEnterKey, this);
089 names = Names.instance(context);
090 enter = Enter.instance(context);
091 log = Log.instance(context);
092 chk = Check.instance(context);
093 attr = Attr.instance(context);
094 syms = Symtab.instance(context);
095 make = TreeMaker.instance(context);
096 reader = ClassReader.instance(context);
097 todo = Todo.instance(context);
098 annotate = Annotate.instance(context);
099 types = Types.instance(context);
100 diags = JCDiagnostic.Factory.instance(context);
101 target = Target.instance(context);
102 skipAnnotations =
103 Options.instance(context).get("skipAnnotations") != null;
104 }
105
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>>();
110
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;
115
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;
121
122 /* ---------- Processing import clauses ----------------
123 */
124
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 }
151
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;
165
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;
172
173 // also import inherited names
174 importFrom(types.supertype(tsym.type).tsym);
175 for (Type t : types.interfaces(tsym.type))
176 importFrom(t.tsym);
177
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);
190
191 // enter non-types before annotations that might use them
192 annotate.earlier(new Annotate.Annotator() {
193 Set<Symbol> processed = new HashSet<Symbol>();
194
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;
201
202 // also import inherited names
203 importFrom(types.supertype(tsym.type).tsym);
204 for (Type t : types.interfaces(tsym.type))
205 importFrom(t.tsym);
206
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 }
223
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 }
238
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 }
254
255 final Scope toScope = env.toplevel.namedImportScope;
256 final PackageSymbol packge = env.toplevel.packge;
257 final TypeSymbol origin = tsym;
258
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;
265
266 // also import inherited names
267 importFrom(types.supertype(tsym.type).tsym);
268 for (Type t : types.interfaces(tsym.type))
269 importFrom(t.tsym);
270
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);
284
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;
289
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;
296
297 // also import inherited names
298 importFrom(types.supertype(tsym.type).tsym);
299 for (Type t : types.interfaces(tsym.type))
300 importFrom(t.tsym);
301
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 }
344
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) {
358
359 // Enter and attribute type parameters.
360 List<Type> tvars = enter.classEnter(typarams, env);
361 attr.attribTypeVariables(typarams, env);
362
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 }
369
370 // Attribute result type, if one is given.
371 Type restype = res == null ? syms.voidType : attr.attribType(res, env);
372
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 }
387
388 /* ********************************************************************
389 * Visitor methods for member enter
390 *********************************************************************/
391
392 /** Visitor argument: the current environment
393 */
394 protected Env<AttrContext> env;
395
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 }
410
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 }
417
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 }
427
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));
433
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);
445
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);
459
460 // the remaining members are for bootstrapping only
461 if (!target.compilerBootstrap(tree.sym)) return;
462
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);
474
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);
486
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 }
498
499 public void visitTopLevel(JCCompilationUnit tree) {
500 if (tree.starImportScope.elems != null) {
501 // we must have already processed this toplevel
502 return;
503 }
504
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 }
519
520 // process package annotations
521 annotateLater(tree.packageAnnotations, env, tree.packge);
522
523 // Import-on-demand java.lang.
524 importAll(tree.pos, reader.enterPackage(names.java_lang), env);
525
526 // Process all import clauses.
527 memberEnter(tree.defs, env);
528 }
529
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;
535
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);
539
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 }
566
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);
573
574 // Compute the method type
575 m.type = signature(tree.typarams, tree.params,
576 tree.restype, tree.thrown,
577 localEnv);
578
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();
588
589 // mark the method varargs, if necessary
590 if (lastParam != null && (lastParam.mods.flags & Flags.VARARGS) != 0)
591 m.flags_field |= Flags.VARARGS;
592
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 }
601
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 }
614
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 }
643
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 }
663
664 /** Default member enter visitor method: do nothing
665 */
666 public void visitTree(JCTree tree) {
667 }
668
669
670 public void visitErroneous(JCErroneous tree) {
671 memberEnter(tree.errs, env);
672 }
673
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 }
683
684 public Env<AttrContext> getInitEnv(JCVariableDecl tree, Env<AttrContext> env) {
685 Env<AttrContext> iEnv = initEnv(tree, env);
686 return iEnv;
687 }
688
689 /* ********************************************************************
690 * Type completion
691 *********************************************************************/
692
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 }
704
705 /* ********************************************************************
706 * Annotation processing
707 *********************************************************************/
708
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 }
736
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 }
749
750
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 if (!annotated.add(a.type.tsym))
772 log.error(a.pos, "duplicate.annotation");
773 }
774 s.attributes_field = buf.toList();
775 }
776
777 /** Queue processing of an attribute default value. */
778 void annotateDefaultValueLater(final JCExpression defaultValue,
779 final Env<AttrContext> localEnv,
780 final MethodSymbol m) {
781 annotate.later(new Annotate.Annotator() {
782 public String toString() {
783 return "annotate " + m.owner + "." +
784 m + " default " + defaultValue;
785 }
786 public void enterAnnotation() {
787 JavaFileObject prev = log.useSource(localEnv.toplevel.sourcefile);
788 try {
789 enterDefaultValue(defaultValue, localEnv, m);
790 } finally {
791 log.useSource(prev);
792 }
793 }
794 });
795 }
796
797 /** Enter a default value for an attribute method. */
798 private void enterDefaultValue(final JCExpression defaultValue,
799 final Env<AttrContext> localEnv,
800 final MethodSymbol m) {
801 m.defaultValue = annotate.enterAttributeValue(m.type.getReturnType(),
802 defaultValue,
803 localEnv);
804 }
805
806 /* ********************************************************************
807 * Source completer
808 *********************************************************************/
809
810 /** Complete entering a class.
811 * @param sym The symbol of the class to be completed.
812 */
813 public void complete(Symbol sym) throws CompletionFailure {
814 // Suppress some (recursive) MemberEnter invocations
815 if (!completionEnabled) {
816 // Re-install same completer for next time around and return.
817 assert (sym.flags() & Flags.COMPOUND) == 0;
818 sym.completer = this;
819 return;
820 }
821
822 ClassSymbol c = (ClassSymbol)sym;
823 ClassType ct = (ClassType)c.type;
824 Env<AttrContext> env = enter.typeEnvs.get(c);
825 JCClassDecl tree = (JCClassDecl)env.tree;
826 boolean wasFirst = isFirst;
827 isFirst = false;
828
829 JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
830 try {
831 // Save class environment for later member enter (2) processing.
832 halfcompleted.append(env);
833
834 // Mark class as not yet attributed.
835 c.flags_field |= UNATTRIBUTED;
836
837 // If this is a toplevel-class, make sure any preceding import
838 // clauses have been seen.
839 if (c.owner.kind == PCK) {
840 memberEnter(env.toplevel, env.enclosing(JCTree.TOPLEVEL));
841 todo.append(env);
842 }
843
844 if (c.owner.kind == TYP)
845 c.owner.complete();
846
847 // create an environment for evaluating the base clauses
848 Env<AttrContext> baseEnv = baseEnv(tree, env);
849
850 // Determine supertype.
851 Type supertype =
852 (tree.extending != null)
853 ? attr.attribBase(tree.extending, baseEnv, true, false, true)
854 : ((tree.mods.flags & Flags.ENUM) != 0 && !target.compilerBootstrap(c))
855 ? attr.attribBase(enumBase(tree.pos, c), baseEnv,
856 true, false, false)
857 : (c.fullname == names.java_lang_Object)
858 ? Type.noType
859 : syms.objectType;
860 ct.supertype_field = supertype;
861
862 // Determine interfaces.
863 ListBuffer<Type> interfaces = new ListBuffer<Type>();
864 Set<Type> interfaceSet = new HashSet<Type>();
865 List<JCExpression> interfaceTrees = tree.implementing;
866 if ((tree.mods.flags & Flags.ENUM) != 0 && target.compilerBootstrap(c)) {
867 // add interface Comparable<T>
868 interfaceTrees =
869 interfaceTrees.prepend(make.Type(new ClassType(syms.comparableType.getEnclosingType(),
870 List.of(c.type),
871 syms.comparableType.tsym)));
872 // add interface Serializable
873 interfaceTrees =
874 interfaceTrees.prepend(make.Type(syms.serializableType));
875 }
876 for (JCExpression iface : interfaceTrees) {
877 Type i = attr.attribBase(iface, baseEnv, false, true, true);
878 if (i.tag == CLASS) {
879 interfaces.append(i);
880 chk.checkNotRepeated(iface.pos(), types.erasure(i), interfaceSet);
881 }
882 }
883 if ((c.flags_field & ANNOTATION) != 0)
884 ct.interfaces_field = List.of(syms.annotationType);
885 else
886 ct.interfaces_field = interfaces.toList();
887
888 if (c.fullname == names.java_lang_Object) {
889 if (tree.extending != null) {
890 chk.checkNonCyclic(tree.extending.pos(),
891 supertype);
892 ct.supertype_field = Type.noType;
893 }
894 else if (tree.implementing.nonEmpty()) {
895 chk.checkNonCyclic(tree.implementing.head.pos(),
896 ct.interfaces_field.head);
897 ct.interfaces_field = List.nil();
898 }
899 }
900
901 // Annotations.
902 // In general, we cannot fully process annotations yet, but we
903 // can attribute the annotation types and then check to see if the
904 // @Deprecated annotation is present.
905 attr.attribAnnotationTypes(tree.mods.annotations, baseEnv);
906 if (hasDeprecatedAnnotation(tree.mods.annotations))
907 c.flags_field |= DEPRECATED;
908 annotateLater(tree.mods.annotations, baseEnv, c);
909
910 chk.checkNonCyclic(tree.pos(), c.type);
911
912 attr.attribTypeVariables(tree.typarams, baseEnv);
913
914 // Add default constructor if needed.
915 if ((c.flags() & INTERFACE) == 0 &&
916 !TreeInfo.hasConstructors(tree.defs)) {
917 List<Type> argtypes = List.nil();
918 List<Type> typarams = List.nil();
919 List<Type> thrown = List.nil();
920 long ctorFlags = 0;
921 boolean based = false;
922 if (c.name.isEmpty()) {
923 JCNewClass nc = (JCNewClass)env.next.tree;
924 if (nc.constructor != null) {
925 Type superConstrType = types.memberType(c.type,
926 nc.constructor);
927 argtypes = superConstrType.getParameterTypes();
928 typarams = superConstrType.getTypeArguments();
929 ctorFlags = nc.constructor.flags() & VARARGS;
930 if (nc.encl != null) {
931 argtypes = argtypes.prepend(nc.encl.type);
932 based = true;
933 }
934 thrown = superConstrType.getThrownTypes();
935 }
936 }
937 JCTree constrDef = DefaultConstructor(make.at(tree.pos), c,
938 typarams, argtypes, thrown,
939 ctorFlags, based);
940 tree.defs = tree.defs.prepend(constrDef);
941 }
942
943 // If this is a class, enter symbols for this and super into
944 // current scope.
945 if ((c.flags_field & INTERFACE) == 0) {
946 VarSymbol thisSym =
947 new VarSymbol(FINAL | HASINIT, names._this, c.type, c);
948 thisSym.pos = Position.FIRSTPOS;
949 env.info.scope.enter(thisSym);
950 if (ct.supertype_field.tag == CLASS) {
951 VarSymbol superSym =
952 new VarSymbol(FINAL | HASINIT, names._super,
953 ct.supertype_field, c);
954 superSym.pos = Position.FIRSTPOS;
955 env.info.scope.enter(superSym);
956 }
957 }
958
959 // check that no package exists with same fully qualified name,
960 // but admit classes in the unnamed package which have the same
961 // name as a top-level package.
962 if (checkClash &&
963 c.owner.kind == PCK && c.owner != syms.unnamedPackage &&
964 reader.packageExists(c.fullname))
965 {
966 log.error(tree.pos, "clash.with.pkg.of.same.name", c);
967 }
968
969 } catch (CompletionFailure ex) {
970 chk.completionError(tree.pos(), ex);
971 } finally {
972 log.useSource(prev);
973 }
974
975 // Enter all member fields and methods of a set of half completed
976 // classes in a second phase.
977 if (wasFirst) {
978 try {
979 while (halfcompleted.nonEmpty()) {
980 finish(halfcompleted.next());
981 }
982 } finally {
983 isFirst = true;
984 }
985
986 // commit pending annotations
987 annotate.flush();
988 }
989 }
990
991 private Env<AttrContext> baseEnv(JCClassDecl tree, Env<AttrContext> env) {
992 Scope typaramScope = new Scope(tree.sym);
993 if (tree.typarams != null)
994 for (List<JCTypeParameter> typarams = tree.typarams;
995 typarams.nonEmpty();
996 typarams = typarams.tail)
997 typaramScope.enter(typarams.head.type.tsym);
998 Env<AttrContext> outer = env.outer; // the base clause can't see members of this class
999 Env<AttrContext> localEnv = outer.dup(tree, outer.info.dup(typaramScope));
1000 localEnv.baseClause = true;
1001 localEnv.outer = outer;
1002 localEnv.info.isSelfCall = false;
1003 return localEnv;
1004 }
1005
1006 /** Enter member fields and methods of a class
1007 * @param env the environment current for the class block.
1008 */
1009 private void finish(Env<AttrContext> env) {
1010 JavaFileObject prev = log.useSource(env.toplevel.sourcefile);
1011 try {
1012 JCClassDecl tree = (JCClassDecl)env.tree;
1013 finishClass(tree, env);
1014 } finally {
1015 log.useSource(prev);
1016 }
1017 }
1018
1019 /** Generate a base clause for an enum type.
1020 * @param pos The position for trees and diagnostics, if any
1021 * @param c The class symbol of the enum
1022 */
1023 private JCExpression enumBase(int pos, ClassSymbol c) {
1024 JCExpression result = make.at(pos).
1025 TypeApply(make.QualIdent(syms.enumSym),
1026 List.<JCExpression>of(make.Type(c.type)));
1027 return result;
1028 }
1029
1030 /* ***************************************************************************
1031 * tree building
1032 ****************************************************************************/
1033
1034 /** Generate default constructor for given class. For classes different
1035 * from java.lang.Object, this is:
1036 *
1037 * c(argtype_0 x_0, ..., argtype_n x_n) throws thrown {
1038 * super(x_0, ..., x_n)
1039 * }
1040 *
1041 * or, if based == true:
1042 *
1043 * c(argtype_0 x_0, ..., argtype_n x_n) throws thrown {
1044 * x_0.super(x_1, ..., x_n)
1045 * }
1046 *
1047 * @param make The tree factory.
1048 * @param c The class owning the default constructor.
1049 * @param argtypes The parameter types of the constructor.
1050 * @param thrown The thrown exceptions of the constructor.
1051 * @param based Is first parameter a this$n?
1052 */
1053 JCTree DefaultConstructor(TreeMaker make,
1054 ClassSymbol c,
1055 List<Type> typarams,
1056 List<Type> argtypes,
1057 List<Type> thrown,
1058 long flags,
1059 boolean based) {
1060 List<JCVariableDecl> params = make.Params(argtypes, syms.noSymbol);
1061 List<JCStatement> stats = List.nil();
1062 if (c.type != syms.objectType)
1063 stats = stats.prepend(SuperCall(make, typarams, params, based));
1064 if ((c.flags() & ENUM) != 0 &&
1065 (types.supertype(c.type).tsym == syms.enumSym ||
1066 target.compilerBootstrap(c))) {
1067 // constructors of true enums are private
1068 flags = (flags & ~AccessFlags) | PRIVATE | GENERATEDCONSTR;
1069 } else
1070 flags |= (c.flags() & AccessFlags) | GENERATEDCONSTR;
1071 if (c.name.isEmpty()) flags |= ANONCONSTR;
1072 JCTree result = make.MethodDef(
1073 make.Modifiers(flags),
1074 names.init,
1075 null,
1076 make.TypeParams(typarams),
1077 params,
1078 make.Types(thrown),
1079 make.Block(0, stats),
1080 null);
1081 return result;
1082 }
1083
1084 /** Generate call to superclass constructor. This is:
1085 *
1086 * super(id_0, ..., id_n)
1087 *
1088 * or, if based == true
1089 *
1090 * id_0.super(id_1,...,id_n)
1091 *
1092 * where id_0, ..., id_n are the names of the given parameters.
1093 *
1094 * @param make The tree factory
1095 * @param params The parameters that need to be passed to super
1096 * @param typarams The type parameters that need to be passed to super
1097 * @param based Is first parameter a this$n?
1098 */
1099 JCExpressionStatement SuperCall(TreeMaker make,
1100 List<Type> typarams,
1101 List<JCVariableDecl> params,
1102 boolean based) {
1103 JCExpression meth;
1104 if (based) {
1105 meth = make.Select(make.Ident(params.head), names._super);
1106 params = params.tail;
1107 } else {
1108 meth = make.Ident(names._super);
1109 }
1110 List<JCExpression> typeargs = typarams.nonEmpty() ? make.Types(typarams) : null;
1111 return make.Exec(make.Apply(typeargs, meth, make.Idents(params)));
1112 }
1113 }