Fri, 29 Jan 2010 16:54:52 -0800
6499119: Created package-info class file modeled improperly
6920317: package-info.java file has to be specified on the javac cmdline, else it will not be avail.
Reviewed-by: darcy
1 /*
2 * Copyright 1999-2008 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
26 package com.sun.tools.javac.comp;
28 import java.util.*;
29 import javax.tools.JavaFileObject;
30 import javax.tools.JavaFileManager;
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.JCDiagnostic.DiagnosticPosition;
37 import com.sun.tools.javac.util.List;
39 import com.sun.tools.javac.code.Type.*;
40 import com.sun.tools.javac.code.Symbol.*;
41 import com.sun.tools.javac.tree.JCTree.*;
43 import static com.sun.tools.javac.code.Flags.*;
44 import static com.sun.tools.javac.code.Kinds.*;
46 /** This class enters symbols for all encountered definitions into
47 * the symbol table. The pass consists of two phases, organized as
48 * follows:
49 *
50 * <p>In the first phase, all class symbols are intered into their
51 * enclosing scope, descending recursively down the tree for classes
52 * which are members of other classes. The class symbols are given a
53 * MemberEnter object as completer.
54 *
55 * <p>In the second phase classes are completed using
56 * MemberEnter.complete(). Completion might occur on demand, but
57 * any classes that are not completed that way will be eventually
58 * completed by processing the `uncompleted' queue. Completion
59 * entails (1) determination of a class's parameters, supertype and
60 * interfaces, as well as (2) entering all symbols defined in the
61 * class into its scope, with the exception of class symbols which
62 * have been entered in phase 1. (2) depends on (1) having been
63 * completed for a class and all its superclasses and enclosing
64 * classes. That's why, after doing (1), we put classes in a
65 * `halfcompleted' queue. Only when we have performed (1) for a class
66 * and all it's superclasses and enclosing classes, we proceed to
67 * (2).
68 *
69 * <p>Whereas the first phase is organized as a sweep through all
70 * compiled syntax trees, the second phase is demand. Members of a
71 * class are entered when the contents of a class are first
72 * accessed. This is accomplished by installing completer objects in
73 * class symbols for compiled classes which invoke the member-enter
74 * phase for the corresponding class tree.
75 *
76 * <p>Classes migrate from one phase to the next via queues:
77 *
78 * <pre>
79 * class enter -> (Enter.uncompleted) --> member enter (1)
80 * -> (MemberEnter.halfcompleted) --> member enter (2)
81 * -> (Todo) --> attribute
82 * (only for toplevel classes)
83 * </pre>
84 *
85 * <p><b>This is NOT part of any API supported by Sun Microsystems. If
86 * you write code that depends on this, you do so at your own risk.
87 * This code and its internal interfaces are subject to change or
88 * deletion without notice.</b>
89 */
90 public class Enter extends JCTree.Visitor {
91 protected static final Context.Key<Enter> enterKey =
92 new Context.Key<Enter>();
94 Log log;
95 Symtab syms;
96 Check chk;
97 TreeMaker make;
98 ClassReader reader;
99 Annotate annotate;
100 MemberEnter memberEnter;
101 Types types;
102 Lint lint;
103 Names names;
104 JavaFileManager fileManager;
106 private final Todo todo;
108 public static Enter instance(Context context) {
109 Enter instance = context.get(enterKey);
110 if (instance == null)
111 instance = new Enter(context);
112 return instance;
113 }
115 protected Enter(Context context) {
116 context.put(enterKey, this);
118 log = Log.instance(context);
119 reader = ClassReader.instance(context);
120 make = TreeMaker.instance(context);
121 syms = Symtab.instance(context);
122 chk = Check.instance(context);
123 memberEnter = MemberEnter.instance(context);
124 types = Types.instance(context);
125 annotate = Annotate.instance(context);
126 lint = Lint.instance(context);
127 names = Names.instance(context);
129 predefClassDef = make.ClassDef(
130 make.Modifiers(PUBLIC),
131 syms.predefClass.name, null, null, null, null);
132 predefClassDef.sym = syms.predefClass;
133 todo = Todo.instance(context);
134 fileManager = context.get(JavaFileManager.class);
135 }
137 /** A hashtable mapping classes and packages to the environments current
138 * at the points of their definitions.
139 */
140 Map<TypeSymbol,Env<AttrContext>> typeEnvs =
141 new HashMap<TypeSymbol,Env<AttrContext>>();
143 /** Accessor for typeEnvs
144 */
145 public Env<AttrContext> getEnv(TypeSymbol sym) {
146 return typeEnvs.get(sym);
147 }
149 public Env<AttrContext> getClassEnv(TypeSymbol sym) {
150 Env<AttrContext> localEnv = getEnv(sym);
151 Env<AttrContext> lintEnv = localEnv;
152 while (lintEnv.info.lint == null)
153 lintEnv = lintEnv.next;
154 localEnv.info.lint = lintEnv.info.lint.augment(sym.attributes_field, sym.flags());
155 return localEnv;
156 }
158 /** The queue of all classes that might still need to be completed;
159 * saved and initialized by main().
160 */
161 ListBuffer<ClassSymbol> uncompleted;
163 /** A dummy class to serve as enclClass for toplevel environments.
164 */
165 private JCClassDecl predefClassDef;
167 /* ************************************************************************
168 * environment construction
169 *************************************************************************/
172 /** Create a fresh environment for class bodies.
173 * This will create a fresh scope for local symbols of a class, referred
174 * to by the environments info.scope field.
175 * This scope will contain
176 * - symbols for this and super
177 * - symbols for any type parameters
178 * In addition, it serves as an anchor for scopes of methods and initializers
179 * which are nested in this scope via Scope.dup().
180 * This scope should not be confused with the members scope of a class.
181 *
182 * @param tree The class definition.
183 * @param env The environment current outside of the class definition.
184 */
185 public Env<AttrContext> classEnv(JCClassDecl tree, Env<AttrContext> env) {
186 Env<AttrContext> localEnv =
187 env.dup(tree, env.info.dup(new Scope(tree.sym)));
188 localEnv.enclClass = tree;
189 localEnv.outer = env;
190 localEnv.info.isSelfCall = false;
191 localEnv.info.lint = null; // leave this to be filled in by Attr,
192 // when annotations have been processed
193 return localEnv;
194 }
196 /** Create a fresh environment for toplevels.
197 * @param tree The toplevel tree.
198 */
199 Env<AttrContext> topLevelEnv(JCCompilationUnit tree) {
200 Env<AttrContext> localEnv = new Env<AttrContext>(tree, new AttrContext());
201 localEnv.toplevel = tree;
202 localEnv.enclClass = predefClassDef;
203 tree.namedImportScope = new Scope.ImportScope(tree.packge);
204 tree.starImportScope = new Scope.ImportScope(tree.packge);
205 localEnv.info.scope = tree.namedImportScope;
206 localEnv.info.lint = lint;
207 return localEnv;
208 }
210 public Env<AttrContext> getTopLevelEnv(JCCompilationUnit tree) {
211 Env<AttrContext> localEnv = new Env<AttrContext>(tree, new AttrContext());
212 localEnv.toplevel = tree;
213 localEnv.enclClass = predefClassDef;
214 localEnv.info.scope = tree.namedImportScope;
215 localEnv.info.lint = lint;
216 return localEnv;
217 }
219 /** The scope in which a member definition in environment env is to be entered
220 * This is usually the environment's scope, except for class environments,
221 * where the local scope is for type variables, and the this and super symbol
222 * only, and members go into the class member scope.
223 */
224 Scope enterScope(Env<AttrContext> env) {
225 return (env.tree.getTag() == JCTree.CLASSDEF)
226 ? ((JCClassDecl) env.tree).sym.members_field
227 : env.info.scope;
228 }
230 /* ************************************************************************
231 * Visitor methods for phase 1: class enter
232 *************************************************************************/
234 /** Visitor argument: the current environment.
235 */
236 protected Env<AttrContext> env;
238 /** Visitor result: the computed type.
239 */
240 Type result;
242 /** Visitor method: enter all classes in given tree, catching any
243 * completion failure exceptions. Return the tree's type.
244 *
245 * @param tree The tree to be visited.
246 * @param env The environment visitor argument.
247 */
248 Type classEnter(JCTree tree, Env<AttrContext> env) {
249 Env<AttrContext> prevEnv = this.env;
250 try {
251 this.env = env;
252 tree.accept(this);
253 return result;
254 } catch (CompletionFailure ex) {
255 return chk.completionError(tree.pos(), ex);
256 } finally {
257 this.env = prevEnv;
258 }
259 }
261 /** Visitor method: enter classes of a list of trees, returning a list of types.
262 */
263 <T extends JCTree> List<Type> classEnter(List<T> trees, Env<AttrContext> env) {
264 ListBuffer<Type> ts = new ListBuffer<Type>();
265 for (List<T> l = trees; l.nonEmpty(); l = l.tail) {
266 Type t = classEnter(l.head, env);
267 if (t != null)
268 ts.append(t);
269 }
270 return ts.toList();
271 }
273 public void visitTopLevel(JCCompilationUnit tree) {
274 JavaFileObject prev = log.useSource(tree.sourcefile);
275 boolean addEnv = false;
276 boolean isPkgInfo = tree.sourcefile.isNameCompatible("package-info",
277 JavaFileObject.Kind.SOURCE);
278 if (tree.pid != null) {
279 tree.packge = reader.enterPackage(TreeInfo.fullName(tree.pid));
280 if (tree.packageAnnotations.nonEmpty()) {
281 if (isPkgInfo) {
282 addEnv = true;
283 } else {
284 log.error(tree.packageAnnotations.head.pos(),
285 "pkg.annotations.sb.in.package-info.java");
286 }
287 }
288 } else {
289 tree.packge = syms.unnamedPackage;
290 }
291 tree.packge.complete(); // Find all classes in package.
292 Env<AttrContext> env = topLevelEnv(tree);
294 // Save environment of package-info.java file.
295 if (isPkgInfo) {
296 Env<AttrContext> env0 = typeEnvs.get(tree.packge);
297 if (env0 == null) {
298 typeEnvs.put(tree.packge, env);
299 } else {
300 JCCompilationUnit tree0 = env0.toplevel;
301 if (!fileManager.isSameFile(tree.sourcefile, tree0.sourcefile)) {
302 log.warning(tree.pid != null ? tree.pid.pos()
303 : null,
304 "pkg-info.already.seen",
305 tree.packge);
306 if (addEnv || (tree0.packageAnnotations.isEmpty() &&
307 tree.docComments != null &&
308 tree.docComments.get(tree) != null)) {
309 typeEnvs.put(tree.packge, env);
310 }
311 }
312 }
314 for (Symbol q = tree.packge; q != null && q.kind == PCK; q = q.owner)
315 q.flags_field |= EXISTS;
317 Name name = names.package_info;
318 ClassSymbol c = reader.enterClass(name, tree.packge);
319 c.flatname = names.fromString(tree.packge + "." + name);
320 c.sourcefile = tree.sourcefile;
321 c.completer = null;
322 c.members_field = new Scope(c);
323 tree.packge.package_info = c;
324 }
325 classEnter(tree.defs, env);
326 if (addEnv) {
327 todo.append(env);
328 }
329 log.useSource(prev);
330 result = null;
331 }
333 public void visitClassDef(JCClassDecl tree) {
334 Symbol owner = env.info.scope.owner;
335 Scope enclScope = enterScope(env);
336 ClassSymbol c;
337 if (owner.kind == PCK) {
338 // We are seeing a toplevel class.
339 PackageSymbol packge = (PackageSymbol)owner;
340 for (Symbol q = packge; q != null && q.kind == PCK; q = q.owner)
341 q.flags_field |= EXISTS;
342 c = reader.enterClass(tree.name, packge);
343 packge.members().enterIfAbsent(c);
344 if ((tree.mods.flags & PUBLIC) != 0 && !classNameMatchesFileName(c, env)) {
345 log.error(tree.pos(),
346 "class.public.should.be.in.file", tree.name);
347 }
348 } else {
349 if (!tree.name.isEmpty() &&
350 !chk.checkUniqueClassName(tree.pos(), tree.name, enclScope)) {
351 result = null;
352 return;
353 }
354 if (owner.kind == TYP) {
355 // We are seeing a member class.
356 c = reader.enterClass(tree.name, (TypeSymbol)owner);
357 if ((owner.flags_field & INTERFACE) != 0) {
358 tree.mods.flags |= PUBLIC | STATIC;
359 }
360 } else {
361 // We are seeing a local class.
362 c = reader.defineClass(tree.name, owner);
363 c.flatname = chk.localClassName(c);
364 if (!c.name.isEmpty())
365 chk.checkTransparentClass(tree.pos(), c, env.info.scope);
366 }
367 }
368 tree.sym = c;
370 // Enter class into `compiled' table and enclosing scope.
371 if (chk.compiled.get(c.flatname) != null) {
372 duplicateClass(tree.pos(), c);
373 result = types.createErrorType(tree.name, (TypeSymbol)owner, Type.noType);
374 tree.sym = (ClassSymbol)result.tsym;
375 return;
376 }
377 chk.compiled.put(c.flatname, c);
378 enclScope.enter(c);
380 // Set up an environment for class block and store in `typeEnvs'
381 // table, to be retrieved later in memberEnter and attribution.
382 Env<AttrContext> localEnv = classEnv(tree, env);
383 typeEnvs.put(c, localEnv);
385 // Fill out class fields.
386 c.completer = memberEnter;
387 c.flags_field = chk.checkFlags(tree.pos(), tree.mods.flags, c, tree);
388 c.sourcefile = env.toplevel.sourcefile;
389 c.members_field = new Scope(c);
391 ClassType ct = (ClassType)c.type;
392 if (owner.kind != PCK && (c.flags_field & STATIC) == 0) {
393 // We are seeing a local or inner class.
394 // Set outer_field of this class to closest enclosing class
395 // which contains this class in a non-static context
396 // (its "enclosing instance class"), provided such a class exists.
397 Symbol owner1 = owner;
398 while ((owner1.kind & (VAR | MTH)) != 0 &&
399 (owner1.flags_field & STATIC) == 0) {
400 owner1 = owner1.owner;
401 }
402 if (owner1.kind == TYP) {
403 ct.setEnclosingType(owner1.type);
404 }
405 }
407 // Enter type parameters.
408 ct.typarams_field = classEnter(tree.typarams, localEnv);
410 // Add non-local class to uncompleted, to make sure it will be
411 // completed later.
412 if (!c.isLocal() && uncompleted != null) uncompleted.append(c);
413 // System.err.println("entering " + c.fullname + " in " + c.owner);//DEBUG
415 // Recursively enter all member classes.
416 classEnter(tree.defs, localEnv);
418 result = c.type;
419 }
420 //where
421 /** Does class have the same name as the file it appears in?
422 */
423 private static boolean classNameMatchesFileName(ClassSymbol c,
424 Env<AttrContext> env) {
425 return env.toplevel.sourcefile.isNameCompatible(c.name.toString(),
426 JavaFileObject.Kind.SOURCE);
427 }
429 /** Complain about a duplicate class. */
430 protected void duplicateClass(DiagnosticPosition pos, ClassSymbol c) {
431 log.error(pos, "duplicate.class", c.fullname);
432 }
434 /** Class enter visitor method for type parameters.
435 * Enter a symbol for type parameter in local scope, after checking that it
436 * is unique.
437 */
438 public void visitTypeParameter(JCTypeParameter tree) {
439 TypeVar a = (tree.type != null)
440 ? (TypeVar)tree.type
441 : new TypeVar(tree.name, env.info.scope.owner, syms.botType);
442 tree.type = a;
443 if (chk.checkUnique(tree.pos(), a.tsym, env.info.scope)) {
444 env.info.scope.enter(a.tsym);
445 }
446 result = a;
447 }
449 /** Default class enter visitor method: do nothing.
450 */
451 public void visitTree(JCTree tree) {
452 result = null;
453 }
455 /** Main method: enter all classes in a list of toplevel trees.
456 * @param trees The list of trees to be processed.
457 */
458 public void main(List<JCCompilationUnit> trees) {
459 complete(trees, null);
460 }
462 /** Main method: enter one class from a list of toplevel trees and
463 * place the rest on uncompleted for later processing.
464 * @param trees The list of trees to be processed.
465 * @param c The class symbol to be processed.
466 */
467 public void complete(List<JCCompilationUnit> trees, ClassSymbol c) {
468 annotate.enterStart();
469 ListBuffer<ClassSymbol> prevUncompleted = uncompleted;
470 if (memberEnter.completionEnabled) uncompleted = new ListBuffer<ClassSymbol>();
472 try {
473 // enter all classes, and construct uncompleted list
474 classEnter(trees, null);
476 // complete all uncompleted classes in memberEnter
477 if (memberEnter.completionEnabled) {
478 while (uncompleted.nonEmpty()) {
479 ClassSymbol clazz = uncompleted.next();
480 if (c == null || c == clazz || prevUncompleted == null)
481 clazz.complete();
482 else
483 // defer
484 prevUncompleted.append(clazz);
485 }
487 // if there remain any unimported toplevels (these must have
488 // no classes at all), process their import statements as well.
489 for (JCCompilationUnit tree : trees) {
490 if (tree.starImportScope.elems == null) {
491 JavaFileObject prev = log.useSource(tree.sourcefile);
492 Env<AttrContext> env = typeEnvs.get(tree);
493 if (env == null)
494 env = topLevelEnv(tree);
495 memberEnter.memberEnter(tree, env);
496 log.useSource(prev);
497 }
498 }
499 }
500 } finally {
501 uncompleted = prevUncompleted;
502 annotate.enterDone();
503 }
504 }
505 }