Sat, 24 Jan 2009 11:07:32 -0800
6797463: 6557199 breaks the jax-ws workspace
Reviewed-by: jjg
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 JavaFileManager fileManager;
105 private final Todo todo;
107 public static Enter instance(Context context) {
108 Enter instance = context.get(enterKey);
109 if (instance == null)
110 instance = new Enter(context);
111 return instance;
112 }
114 protected Enter(Context context) {
115 context.put(enterKey, this);
117 log = Log.instance(context);
118 reader = ClassReader.instance(context);
119 make = TreeMaker.instance(context);
120 syms = Symtab.instance(context);
121 chk = Check.instance(context);
122 memberEnter = MemberEnter.instance(context);
123 types = Types.instance(context);
124 annotate = Annotate.instance(context);
125 lint = Lint.instance(context);
127 predefClassDef = make.ClassDef(
128 make.Modifiers(PUBLIC),
129 syms.predefClass.name, null, null, null, null);
130 predefClassDef.sym = syms.predefClass;
131 todo = Todo.instance(context);
132 fileManager = context.get(JavaFileManager.class);
133 }
135 /** A hashtable mapping classes and packages to the environments current
136 * at the points of their definitions.
137 */
138 Map<TypeSymbol,Env<AttrContext>> typeEnvs =
139 new HashMap<TypeSymbol,Env<AttrContext>>();
141 /** Accessor for typeEnvs
142 */
143 public Env<AttrContext> getEnv(TypeSymbol sym) {
144 return typeEnvs.get(sym);
145 }
147 public Env<AttrContext> getClassEnv(TypeSymbol sym) {
148 Env<AttrContext> localEnv = getEnv(sym);
149 Env<AttrContext> lintEnv = localEnv;
150 while (lintEnv.info.lint == null)
151 lintEnv = lintEnv.next;
152 localEnv.info.lint = lintEnv.info.lint.augment(sym.attributes_field, sym.flags());
153 return localEnv;
154 }
156 /** The queue of all classes that might still need to be completed;
157 * saved and initialized by main().
158 */
159 ListBuffer<ClassSymbol> uncompleted;
161 /** A dummy class to serve as enclClass for toplevel environments.
162 */
163 private JCClassDecl predefClassDef;
165 /* ************************************************************************
166 * environment construction
167 *************************************************************************/
170 /** Create a fresh environment for class bodies.
171 * This will create a fresh scope for local symbols of a class, referred
172 * to by the environments info.scope field.
173 * This scope will contain
174 * - symbols for this and super
175 * - symbols for any type parameters
176 * In addition, it serves as an anchor for scopes of methods and initializers
177 * which are nested in this scope via Scope.dup().
178 * This scope should not be confused with the members scope of a class.
179 *
180 * @param tree The class definition.
181 * @param env The environment current outside of the class definition.
182 */
183 public Env<AttrContext> classEnv(JCClassDecl tree, Env<AttrContext> env) {
184 Env<AttrContext> localEnv =
185 env.dup(tree, env.info.dup(new Scope(tree.sym)));
186 localEnv.enclClass = tree;
187 localEnv.outer = env;
188 localEnv.info.isSelfCall = false;
189 localEnv.info.lint = null; // leave this to be filled in by Attr,
190 // when annotations have been processed
191 return localEnv;
192 }
194 /** Create a fresh environment for toplevels.
195 * @param tree The toplevel tree.
196 */
197 Env<AttrContext> topLevelEnv(JCCompilationUnit tree) {
198 Env<AttrContext> localEnv = new Env<AttrContext>(tree, new AttrContext());
199 localEnv.toplevel = tree;
200 localEnv.enclClass = predefClassDef;
201 tree.namedImportScope = new Scope.ImportScope(tree.packge);
202 tree.starImportScope = new Scope.ImportScope(tree.packge);
203 localEnv.info.scope = tree.namedImportScope;
204 localEnv.info.lint = lint;
205 return localEnv;
206 }
208 public Env<AttrContext> getTopLevelEnv(JCCompilationUnit tree) {
209 Env<AttrContext> localEnv = new Env<AttrContext>(tree, new AttrContext());
210 localEnv.toplevel = tree;
211 localEnv.enclClass = predefClassDef;
212 localEnv.info.scope = tree.namedImportScope;
213 localEnv.info.lint = lint;
214 return localEnv;
215 }
217 /** The scope in which a member definition in environment env is to be entered
218 * This is usually the environment's scope, except for class environments,
219 * where the local scope is for type variables, and the this and super symbol
220 * only, and members go into the class member scope.
221 */
222 Scope enterScope(Env<AttrContext> env) {
223 return (env.tree.getTag() == JCTree.CLASSDEF)
224 ? ((JCClassDecl) env.tree).sym.members_field
225 : env.info.scope;
226 }
228 /* ************************************************************************
229 * Visitor methods for phase 1: class enter
230 *************************************************************************/
232 /** Visitor argument: the current environment.
233 */
234 protected Env<AttrContext> env;
236 /** Visitor result: the computed type.
237 */
238 Type result;
240 /** Visitor method: enter all classes in given tree, catching any
241 * completion failure exceptions. Return the tree's type.
242 *
243 * @param tree The tree to be visited.
244 * @param env The environment visitor argument.
245 */
246 Type classEnter(JCTree tree, Env<AttrContext> env) {
247 Env<AttrContext> prevEnv = this.env;
248 try {
249 this.env = env;
250 tree.accept(this);
251 return result;
252 } catch (CompletionFailure ex) {
253 return chk.completionError(tree.pos(), ex);
254 } finally {
255 this.env = prevEnv;
256 }
257 }
259 /** Visitor method: enter classes of a list of trees, returning a list of types.
260 */
261 <T extends JCTree> List<Type> classEnter(List<T> trees, Env<AttrContext> env) {
262 ListBuffer<Type> ts = new ListBuffer<Type>();
263 for (List<T> l = trees; l.nonEmpty(); l = l.tail) {
264 Type t = classEnter(l.head, env);
265 if (t != null)
266 ts.append(t);
267 }
268 return ts.toList();
269 }
271 public void visitTopLevel(JCCompilationUnit tree) {
272 JavaFileObject prev = log.useSource(tree.sourcefile);
273 boolean addEnv = false;
274 boolean isPkgInfo = tree.sourcefile.isNameCompatible("package-info",
275 JavaFileObject.Kind.SOURCE);
276 if (tree.pid != null) {
277 tree.packge = reader.enterPackage(TreeInfo.fullName(tree.pid));
278 if (tree.packageAnnotations.nonEmpty()) {
279 if (isPkgInfo) {
280 addEnv = true;
281 } else {
282 log.error(tree.packageAnnotations.head.pos(),
283 "pkg.annotations.sb.in.package-info.java");
284 }
285 }
286 } else {
287 tree.packge = syms.unnamedPackage;
288 }
289 tree.packge.complete(); // Find all classes in package.
290 Env<AttrContext> env = topLevelEnv(tree);
292 // Save environment of package-info.java file.
293 if (isPkgInfo) {
294 Env<AttrContext> env0 = typeEnvs.get(tree.packge);
295 if (env0 == null) {
296 typeEnvs.put(tree.packge, env);
297 } else {
298 JCCompilationUnit tree0 = env0.toplevel;
299 if (!fileManager.isSameFile(tree.sourcefile, tree0.sourcefile)) {
300 log.warning(tree.pid != null ? tree.pid.pos()
301 : null,
302 "pkg-info.already.seen",
303 tree.packge);
304 if (addEnv || (tree0.packageAnnotations.isEmpty() &&
305 tree.docComments != null &&
306 tree.docComments.get(tree) != null)) {
307 typeEnvs.put(tree.packge, env);
308 }
309 }
310 }
311 }
312 classEnter(tree.defs, env);
313 if (addEnv) {
314 todo.append(env);
315 }
316 log.useSource(prev);
317 result = null;
318 }
320 public void visitClassDef(JCClassDecl tree) {
321 Symbol owner = env.info.scope.owner;
322 Scope enclScope = enterScope(env);
323 ClassSymbol c;
324 if (owner.kind == PCK) {
325 // We are seeing a toplevel class.
326 PackageSymbol packge = (PackageSymbol)owner;
327 for (Symbol q = packge; q != null && q.kind == PCK; q = q.owner)
328 q.flags_field |= EXISTS;
329 c = reader.enterClass(tree.name, packge);
330 packge.members().enterIfAbsent(c);
331 if ((tree.mods.flags & PUBLIC) != 0 && !classNameMatchesFileName(c, env)) {
332 log.error(tree.pos(),
333 "class.public.should.be.in.file", tree.name);
334 }
335 } else {
336 if (!tree.name.isEmpty() &&
337 !chk.checkUniqueClassName(tree.pos(), tree.name, enclScope)) {
338 result = null;
339 return;
340 }
341 if (owner.kind == TYP) {
342 // We are seeing a member class.
343 c = reader.enterClass(tree.name, (TypeSymbol)owner);
344 if ((owner.flags_field & INTERFACE) != 0) {
345 tree.mods.flags |= PUBLIC | STATIC;
346 }
347 } else {
348 // We are seeing a local class.
349 c = reader.defineClass(tree.name, owner);
350 c.flatname = chk.localClassName(c);
351 if (!c.name.isEmpty())
352 chk.checkTransparentClass(tree.pos(), c, env.info.scope);
353 }
354 }
355 tree.sym = c;
357 // Enter class into `compiled' table and enclosing scope.
358 if (chk.compiled.get(c.flatname) != null) {
359 duplicateClass(tree.pos(), c);
360 result = types.createErrorType(tree.name, (TypeSymbol)owner, Type.noType);
361 tree.sym = (ClassSymbol)result.tsym;
362 return;
363 }
364 chk.compiled.put(c.flatname, c);
365 enclScope.enter(c);
367 // Set up an environment for class block and store in `typeEnvs'
368 // table, to be retrieved later in memberEnter and attribution.
369 Env<AttrContext> localEnv = classEnv(tree, env);
370 typeEnvs.put(c, localEnv);
372 // Fill out class fields.
373 c.completer = memberEnter;
374 c.flags_field = chk.checkFlags(tree.pos(), tree.mods.flags, c, tree);
375 c.sourcefile = env.toplevel.sourcefile;
376 c.members_field = new Scope(c);
378 ClassType ct = (ClassType)c.type;
379 if (owner.kind != PCK && (c.flags_field & STATIC) == 0) {
380 // We are seeing a local or inner class.
381 // Set outer_field of this class to closest enclosing class
382 // which contains this class in a non-static context
383 // (its "enclosing instance class"), provided such a class exists.
384 Symbol owner1 = owner;
385 while ((owner1.kind & (VAR | MTH)) != 0 &&
386 (owner1.flags_field & STATIC) == 0) {
387 owner1 = owner1.owner;
388 }
389 if (owner1.kind == TYP) {
390 ct.setEnclosingType(owner1.type);
391 }
392 }
394 // Enter type parameters.
395 ct.typarams_field = classEnter(tree.typarams, localEnv);
397 // Add non-local class to uncompleted, to make sure it will be
398 // completed later.
399 if (!c.isLocal() && uncompleted != null) uncompleted.append(c);
400 // System.err.println("entering " + c.fullname + " in " + c.owner);//DEBUG
402 // Recursively enter all member classes.
403 classEnter(tree.defs, localEnv);
405 result = c.type;
406 }
407 //where
408 /** Does class have the same name as the file it appears in?
409 */
410 private static boolean classNameMatchesFileName(ClassSymbol c,
411 Env<AttrContext> env) {
412 return env.toplevel.sourcefile.isNameCompatible(c.name.toString(),
413 JavaFileObject.Kind.SOURCE);
414 }
416 /** Complain about a duplicate class. */
417 protected void duplicateClass(DiagnosticPosition pos, ClassSymbol c) {
418 log.error(pos, "duplicate.class", c.fullname);
419 }
421 /** Class enter visitor method for type parameters.
422 * Enter a symbol for type parameter in local scope, after checking that it
423 * is unique.
424 */
425 public void visitTypeParameter(JCTypeParameter tree) {
426 TypeVar a = (tree.type != null)
427 ? (TypeVar)tree.type
428 : new TypeVar(tree.name, env.info.scope.owner, syms.botType);
429 tree.type = a;
430 if (chk.checkUnique(tree.pos(), a.tsym, env.info.scope)) {
431 env.info.scope.enter(a.tsym);
432 }
433 result = a;
434 }
436 /** Default class enter visitor method: do nothing.
437 */
438 public void visitTree(JCTree tree) {
439 result = null;
440 }
442 /** Main method: enter all classes in a list of toplevel trees.
443 * @param trees The list of trees to be processed.
444 */
445 public void main(List<JCCompilationUnit> trees) {
446 complete(trees, null);
447 }
449 /** Main method: enter one class from a list of toplevel trees and
450 * place the rest on uncompleted for later processing.
451 * @param trees The list of trees to be processed.
452 * @param c The class symbol to be processed.
453 */
454 public void complete(List<JCCompilationUnit> trees, ClassSymbol c) {
455 annotate.enterStart();
456 ListBuffer<ClassSymbol> prevUncompleted = uncompleted;
457 if (memberEnter.completionEnabled) uncompleted = new ListBuffer<ClassSymbol>();
459 try {
460 // enter all classes, and construct uncompleted list
461 classEnter(trees, null);
463 // complete all uncompleted classes in memberEnter
464 if (memberEnter.completionEnabled) {
465 while (uncompleted.nonEmpty()) {
466 ClassSymbol clazz = uncompleted.next();
467 if (c == null || c == clazz || prevUncompleted == null)
468 clazz.complete();
469 else
470 // defer
471 prevUncompleted.append(clazz);
472 }
474 // if there remain any unimported toplevels (these must have
475 // no classes at all), process their import statements as well.
476 for (JCCompilationUnit tree : trees) {
477 if (tree.starImportScope.elems == null) {
478 JavaFileObject prev = log.useSource(tree.sourcefile);
479 Env<AttrContext> env = typeEnvs.get(tree);
480 if (env == null)
481 env = topLevelEnv(tree);
482 memberEnter.memberEnter(tree, env);
483 log.useSource(prev);
484 }
485 }
486 }
487 } finally {
488 uncompleted = prevUncompleted;
489 annotate.enterDone();
490 }
491 }
492 }