1 /*
2 * Copyright (c) 1999, 2024, 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 */
25
26 package com.sun.tools.javac.code;
27
28 import java.util.Collection;
29 import java.util.Collections;
30 import java.util.EnumSet;
31 import java.util.HashMap;
32 import java.util.LinkedHashMap;
33 import java.util.Map;
34
35 import javax.lang.model.element.ElementVisitor;
36
37 import com.sun.tools.javac.code.Scope.WriteableScope;
38 import com.sun.tools.javac.code.Source.Feature;
39 import com.sun.tools.javac.code.Symbol.ClassSymbol;
40 import com.sun.tools.javac.code.Symbol.Completer;
41 import com.sun.tools.javac.code.Symbol.CompletionFailure;
42 import com.sun.tools.javac.code.Symbol.MethodSymbol;
43 import com.sun.tools.javac.code.Symbol.ModuleSymbol;
44 import com.sun.tools.javac.code.Symbol.PackageSymbol;
45 import com.sun.tools.javac.code.Symbol.RootPackageSymbol;
46 import com.sun.tools.javac.code.Symbol.TypeSymbol;
47 import com.sun.tools.javac.code.Symbol.VarSymbol;
48 import com.sun.tools.javac.code.Type.BottomType;
49 import com.sun.tools.javac.code.Type.ClassType;
50 import com.sun.tools.javac.code.Type.ErrorType;
51 import com.sun.tools.javac.code.Type.JCPrimitiveType;
52 import com.sun.tools.javac.code.Type.JCVoidType;
53 import com.sun.tools.javac.code.Type.MethodType;
54 import com.sun.tools.javac.code.Type.UnknownType;
55 import com.sun.tools.javac.code.Types.UniqueType;
56 import com.sun.tools.javac.comp.Modules;
57 import com.sun.tools.javac.jvm.Target;
58 import com.sun.tools.javac.util.Assert;
59 import com.sun.tools.javac.util.Context;
60 import com.sun.tools.javac.util.Convert;
61 import com.sun.tools.javac.util.DefinedBy;
62 import com.sun.tools.javac.util.DefinedBy.Api;
63 import com.sun.tools.javac.util.Iterators;
64 import com.sun.tools.javac.util.JavacMessages;
65 import com.sun.tools.javac.util.List;
66 import com.sun.tools.javac.util.Name;
67 import com.sun.tools.javac.util.Names;
68
69 import static com.sun.tools.javac.code.Flags.*;
70 import static com.sun.tools.javac.code.Kinds.Kind.*;
71 import static com.sun.tools.javac.code.TypeTag.*;
72
73 /** A class that defines all predefined constants and operators
74 * as well as special classes such as java.lang.Object, which need
75 * to be known to the compiler. All symbols are held in instance
76 * fields. This makes it possible to work in multiple concurrent
77 * projects, which might use different class files for library classes.
78 *
79 * <p><b>This is NOT part of any supported API.
80 * If you write code that depends on this, you do so at your own risk.
81 * This code and its internal interfaces are subject to change or
82 * deletion without notice.</b>
83 */
84 public class Symtab {
85 /** The context key for the symbol table. */
86 protected static final Context.Key<Symtab> symtabKey = new Context.Key<>();
87
88 /** Get the symbol table instance. */
89 public static Symtab instance(Context context) {
90 Symtab instance = context.get(symtabKey);
91 if (instance == null)
92 instance = new Symtab(context);
93 return instance;
94 }
95
96 /** Builtin types.
97 */
98 public final JCPrimitiveType byteType = new JCPrimitiveType(BYTE, null);
99 public final JCPrimitiveType charType = new JCPrimitiveType(CHAR, null);
100 public final JCPrimitiveType shortType = new JCPrimitiveType(SHORT, null);
101 public final JCPrimitiveType intType = new JCPrimitiveType(INT, null);
102 public final JCPrimitiveType longType = new JCPrimitiveType(LONG, null);
103 public final JCPrimitiveType floatType = new JCPrimitiveType(FLOAT, null);
104 public final JCPrimitiveType doubleType = new JCPrimitiveType(DOUBLE, null);
105 public final JCPrimitiveType booleanType = new JCPrimitiveType(BOOLEAN, null);
106 public final Type botType = new BottomType();
107 public final JCVoidType voidType = new JCVoidType();
108
109 private final Names names;
110 private final JavacMessages messages;
111 private final Completer initialCompleter;
112 private final Completer moduleCompleter;
113
114 /** A symbol for the unnamed module.
115 */
116 public final ModuleSymbol unnamedModule;
117
118 /** The error module.
119 */
120 public final ModuleSymbol errModule;
121
122 /** A symbol for no module, for use with -source 8 or less
123 */
124 public final ModuleSymbol noModule;
125
126 /** A symbol for the root package.
127 */
128 public final PackageSymbol rootPackage;
129
130 /** A symbol that stands for a missing symbol.
131 */
132 public final TypeSymbol noSymbol;
133
134 /** The error symbol.
135 */
136 public final ClassSymbol errSymbol;
137
138 /** The unknown symbol.
139 */
140 public final ClassSymbol unknownSymbol;
141
142 /** A value for the errType, with a originalType of noType */
143 public final Type errType;
144
145 /** A value for the unknown type. */
146 public final Type unknownType;
147
148 /** The builtin type of all arrays. */
149 public final ClassSymbol arrayClass;
150 public final MethodSymbol arrayCloneMethod;
151
152 /** VGJ: The (singleton) type of all bound types. */
153 public final ClassSymbol boundClass;
154
155 /** The builtin type of all methods. */
156 public final ClassSymbol methodClass;
157
158 /** A symbol for the java.base module.
159 */
160 public final ModuleSymbol java_base;
161
162 /** Predefined types.
163 */
164 public final Type objectType;
165 public final Type objectMethodsType;
166 public final Type exactConversionsSupportType;
167 public final Type objectsType;
168 public final Type classType;
169 public final Type classLoaderType;
170 public final Type stringType;
171 public final Type stringBufferType;
172 public final Type stringBuilderType;
173 public final Type cloneableType;
174 public final Type serializableType;
175 public final Type serializedLambdaType;
176 public final Type varHandleType;
177 public final Type methodHandleType;
178 public final Type methodHandlesType;
179 public final Type methodHandleLookupType;
180 public final Type methodTypeType;
181 public final Type nativeHeaderType;
182 public final Type throwableType;
183 public final Type errorType;
184 public final Type interruptedExceptionType;
185 public final Type illegalArgumentExceptionType;
186 public final Type exceptionType;
187 public final Type runtimeExceptionType;
188 public final Type classNotFoundExceptionType;
189 public final Type noClassDefFoundErrorType;
190 public final Type noSuchFieldErrorType;
191 public final Type assertionErrorType;
192 public final Type incompatibleClassChangeErrorType;
193 public final Type cloneNotSupportedExceptionType;
194 public final Type matchExceptionType;
195 public final Type annotationType;
196 public final TypeSymbol enumSym;
197 public final Type listType;
198 public final Type collectionsType;
199 public final Type comparableType;
200 public final Type comparatorType;
201 public final Type arraysType;
202 public final Type iterableType;
203 public final Type iteratorType;
204 public final Type annotationTargetType;
205 public final Type overrideType;
206 public final Type retentionType;
207 public final Type deprecatedType;
208 public final Type suppressWarningsType;
209 public final Type supplierType;
210 public final Type inheritedType;
211 public final Type profileType;
212 public final Type proprietaryType;
213 public final Type systemType;
214 public final Type autoCloseableType;
215 public final Type trustMeType;
216 public final Type lambdaMetafactory;
217 public final Type stringConcatFactory;
218 public final Type repeatableType;
219 public final Type documentedType;
220 public final Type elementTypeType;
221 public final Type functionalInterfaceType;
222 public final Type previewFeatureType;
223 public final Type previewFeatureInternalType;
224 public final Type restrictedType;
225 public final Type restrictedInternalType;
226 public final Type typeDescriptorType;
227 public final Type recordType;
228 public final Type switchBootstrapsType;
229 public final Type constantBootstrapsType;
230 public final Type valueBasedType;
231 public final Type valueBasedInternalType;
232 public final Type classDescType;
233 public final Type enumDescType;
234 public final Type ioType;
235
236 // For serialization lint checking
237 public final Type objectStreamFieldType;
238 public final Type objectInputStreamType;
239 public final Type objectOutputStreamType;
240 public final Type ioExceptionType;
241 public final Type objectStreamExceptionType;
242 // For externalization lint checking
243 public final Type externalizableType;
244 public final Type objectInputType;
245 public final Type objectOutputType;
246
247 /** The symbol representing the length field of an array.
248 */
249 public final VarSymbol lengthVar;
250
251 /** The symbol representing the final finalize method on enums */
252 public final MethodSymbol enumFinalFinalize;
253
254 /** The symbol representing the close method on TWR AutoCloseable type */
255 public final MethodSymbol autoCloseableClose;
256
257 /** The predefined type that belongs to a tag.
258 */
259 public final Type[] typeOfTag = new Type[TypeTag.getTypeTagCount()];
260
261 /** The name of the class that belongs to a basic type tag.
262 */
263 public final Name[] boxedName = new Name[TypeTag.getTypeTagCount()];
264
265 /** A hashtable containing the encountered top-level and member classes,
266 * indexed by flat names. The table does not contain local classes.
267 * It should be updated from the outside to reflect classes defined
268 * by compiled source files.
269 */
270 private final Map<Name, Map<ModuleSymbol,ClassSymbol>> classes = new HashMap<>();
271
272 /** A hashtable containing the encountered packages.
273 * the table should be updated from outside to reflect packages defined
274 * by compiled source files.
275 */
276 private final Map<Name, Map<ModuleSymbol,PackageSymbol>> packages = new HashMap<>();
277
278 /** A hashtable giving the encountered modules.
279 */
280 private final Map<Name, ModuleSymbol> modules = new LinkedHashMap<>();
281
282 private final Map<Types.UniqueType, VarSymbol> classFields = new HashMap<>();
283
284 public VarSymbol getClassField(Type type, Types types) {
285 return classFields.computeIfAbsent(
286 new UniqueType(type, types), k -> {
287 Type arg = null;
288 if (type.getTag() == ARRAY || type.getTag() == CLASS)
289 arg = types.erasure(type);
290 else if (type.isPrimitiveOrVoid())
291 arg = types.boxedClass(type).type;
292 else
293 throw new AssertionError(type);
294
295 Type t = new ClassType(
296 classType.getEnclosingType(), List.of(arg), classType.tsym);
297 return new VarSymbol(
298 STATIC | PUBLIC | FINAL, names._class, t, type.tsym);
299 });
300 }
301
302 public void initType(Type type, ClassSymbol c) {
303 type.tsym = c;
304 typeOfTag[type.getTag().ordinal()] = type;
305 }
306
307 public void initType(Type type, String name) {
308 initType(
309 type,
310 new ClassSymbol(
311 PUBLIC, names.fromString(name), type, rootPackage));
312 }
313
314 public void initType(Type type, String name, String bname) {
315 initType(type, name);
316 boxedName[type.getTag().ordinal()] = names.fromString("java.lang." + bname);
317 }
318
319 /** The class symbol that owns all predefined symbols.
320 */
321 public final ClassSymbol predefClass;
322
323 /** Enter a class into symbol table.
324 * @param s The name of the class.
325 */
326 private Type enterClass(String s) {
327 return enterClass(java_base, names.fromString(s)).type;
328 }
329
330 public void synthesizeEmptyInterfaceIfMissing(final Type type) {
331 final Completer completer = type.tsym.completer;
332 type.tsym.completer = new Completer() {
333 @Override
334 public void complete(Symbol sym) throws CompletionFailure {
335 try {
336 completer.complete(sym);
337 } catch (CompletionFailure e) {
338 sym.flags_field |= (PUBLIC | INTERFACE);
339 ((ClassType) sym.type).supertype_field = objectType;
340 }
341 }
342
343 @Override
344 public boolean isTerminal() {
345 return completer.isTerminal();
346 }
347 };
348 }
349
350 public void synthesizeBoxTypeIfMissing(final Type type) {
351 ClassSymbol sym = enterClass(java_base, boxedName[type.getTag().ordinal()]);
352 final Completer completer = sym.completer;
353 sym.completer = new Completer() {
354 @Override
355 public void complete(Symbol sym) throws CompletionFailure {
356 try {
357 completer.complete(sym);
358 } catch (CompletionFailure e) {
359 sym.flags_field |= PUBLIC;
360 ((ClassType) sym.type).supertype_field = objectType;
361 MethodSymbol boxMethod =
362 new MethodSymbol(PUBLIC | STATIC, names.valueOf,
363 new MethodType(List.of(type), sym.type,
364 List.nil(), methodClass),
365 sym);
366 sym.members().enter(boxMethod);
367 MethodSymbol unboxMethod =
368 new MethodSymbol(PUBLIC,
369 type.tsym.name.append(names.Value), // x.intValue()
370 new MethodType(List.nil(), type,
371 List.nil(), methodClass),
372 sym);
373 sym.members().enter(unboxMethod);
374 }
375 }
376
377 @Override
378 public boolean isTerminal() {
379 return completer.isTerminal();
380 }
381 };
382 }
383
384 // Enter a synthetic class that is used to mark classes in ct.sym.
385 // This class does not have a class file.
386 private Type enterSyntheticAnnotation(String name) {
387 // for now, leave the module null, to prevent problems from synthesizing the
388 // existence of a class in any specific module, including noModule
389 ClassType type = (ClassType)enterClass(java_base, names.fromString(name)).type;
390 ClassSymbol sym = (ClassSymbol)type.tsym;
391 sym.completer = Completer.NULL_COMPLETER;
392 sym.flags_field = PUBLIC|ACYCLIC|ANNOTATION|INTERFACE;
393 sym.erasure_field = type;
394 sym.members_field = WriteableScope.create(sym);
395 type.typarams_field = List.nil();
396 type.allparams_field = List.nil();
397 type.supertype_field = annotationType;
398 type.interfaces_field = List.nil();
399 return type;
400 }
401
402 /** Constructor; enters all predefined identifiers and operators
403 * into symbol table.
404 */
405 @SuppressWarnings("this-escape")
406 protected Symtab(Context context) throws CompletionFailure {
407 context.put(symtabKey, this);
408
409 names = Names.instance(context);
410
411 // Create the unknown type
412 unknownType = new UnknownType();
413
414 messages = JavacMessages.instance(context);
415
416 MissingInfoHandler missingInfoHandler = MissingInfoHandler.instance(context);
417
418 Target target = Target.instance(context);
419 rootPackage = new RootPackageSymbol(names.empty, null,
420 missingInfoHandler,
421 target.runtimeUseNestAccess());
422
423 noModule = new ModuleSymbol(names.empty, null) {
424 @Override public boolean isNoModule() {
425 return true;
426 }
427 };
428 addRootPackageFor(noModule);
429
430 Source source = Source.instance(context);
431 if (Feature.MODULES.allowedInSource(source)) {
432 java_base = enterModule(names.java_base);
433 //avoid completing java.base during the Symtab initialization
434 java_base.completer = Completer.NULL_COMPLETER;
435 java_base.visiblePackages = Collections.emptyMap();
436 } else {
437 java_base = noModule;
438 }
439
440 // create the basic builtin symbols
441 unnamedModule = new ModuleSymbol(names.empty, null) {
442 {
443 directives = List.nil();
444 exports = List.nil();
445 provides = List.nil();
446 uses = List.nil();
447 com.sun.tools.javac.code.Directive.RequiresDirective d =
448 new com.sun.tools.javac.code.Directive.RequiresDirective(java_base,
449 EnumSet.of(com.sun.tools.javac.code.Directive.RequiresFlag.MANDATED));
450 requires = List.of(d);
451 }
452 @Override
453 public String toString() {
454 return messages.getLocalizedString("compiler.misc.unnamed.module");
455 }
456 };
457 addRootPackageFor(unnamedModule);
458 unnamedModule.enclosedPackages = unnamedModule.enclosedPackages.prepend(unnamedModule.unnamedPackage);
459
460 errModule = new ModuleSymbol(names.empty, null) {
461 {
462 directives = List.nil();
463 exports = List.nil();
464 provides = List.nil();
465 uses = List.nil();
466 com.sun.tools.javac.code.Directive.RequiresDirective d =
467 new com.sun.tools.javac.code.Directive.RequiresDirective(java_base,
468 EnumSet.of(com.sun.tools.javac.code.Directive.RequiresFlag.MANDATED));
469 requires = List.of(d);
470 }
471 };
472 addRootPackageFor(errModule);
473
474 noSymbol = new TypeSymbol(NIL, 0, names.empty, Type.noType, rootPackage) {
475 @Override @DefinedBy(Api.LANGUAGE_MODEL)
476 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
477 return v.visitUnknown(this, p);
478 }
479 };
480
481 // create the error symbols
482 errSymbol = new ClassSymbol(PUBLIC|STATIC|ACYCLIC, names.any, null, rootPackage);
483 errType = new ErrorType(errSymbol, Type.noType);
484
485 unknownSymbol = new ClassSymbol(PUBLIC|STATIC|ACYCLIC, names.fromString("<any?>"), null, rootPackage);
486 unknownSymbol.members_field = new Scope.ErrorScope(unknownSymbol);
487 unknownSymbol.type = unknownType;
488
489 // initialize builtin types
490 initType(byteType, "byte", "Byte");
491 initType(shortType, "short", "Short");
492 initType(charType, "char", "Character");
493 initType(intType, "int", "Integer");
494 initType(longType, "long", "Long");
495 initType(floatType, "float", "Float");
496 initType(doubleType, "double", "Double");
497 initType(booleanType, "boolean", "Boolean");
498 initType(voidType, "void", "Void");
499 initType(botType, "<nulltype>");
500 initType(errType, errSymbol);
501 initType(unknownType, unknownSymbol);
502
503 // the builtin class of all arrays
504 arrayClass = new ClassSymbol(PUBLIC|ACYCLIC, names.Array, noSymbol);
505
506 // VGJ
507 boundClass = new ClassSymbol(PUBLIC|ACYCLIC, names.Bound, noSymbol);
508 boundClass.members_field = new Scope.ErrorScope(boundClass);
509
510 // the builtin class of all methods
511 methodClass = new ClassSymbol(PUBLIC|ACYCLIC, names.Method, noSymbol);
512 methodClass.members_field = new Scope.ErrorScope(boundClass);
513
514 // Create class to hold all predefined constants and operations.
515 predefClass = new ClassSymbol(PUBLIC|ACYCLIC, names.empty, rootPackage);
516 WriteableScope scope = WriteableScope.create(predefClass);
517 predefClass.members_field = scope;
518
519 // Get the initial completer for Symbols from the ClassFinder
520 initialCompleter = ClassFinder.instance(context).getCompleter();
521 rootPackage.members_field = WriteableScope.create(rootPackage);
522
523 // Enter symbols for basic types.
524 scope.enter(byteType.tsym);
525 scope.enter(shortType.tsym);
526 scope.enter(charType.tsym);
527 scope.enter(intType.tsym);
528 scope.enter(longType.tsym);
529 scope.enter(floatType.tsym);
530 scope.enter(doubleType.tsym);
531 scope.enter(booleanType.tsym);
532 scope.enter(errType.tsym);
533
534 // Enter symbol for the errSymbol
535 scope.enter(errSymbol);
536
537 // Get the initial completer for ModuleSymbols from Modules
538 moduleCompleter = Modules.instance(context).getCompleter();
539
540 // Enter predefined classes. All are assumed to be in the java.base module.
541 objectType = enterClass("java.lang.Object");
542 objectMethodsType = enterClass("java.lang.runtime.ObjectMethods");
543 exactConversionsSupportType = enterClass("java.lang.runtime.ExactConversionsSupport");
544 objectsType = enterClass("java.util.Objects");
545 classType = enterClass("java.lang.Class");
546 stringType = enterClass("java.lang.String");
547 stringBufferType = enterClass("java.lang.StringBuffer");
548 stringBuilderType = enterClass("java.lang.StringBuilder");
549 cloneableType = enterClass("java.lang.Cloneable");
550 throwableType = enterClass("java.lang.Throwable");
551 serializableType = enterClass("java.io.Serializable");
552 serializedLambdaType = enterClass("java.lang.invoke.SerializedLambda");
553 varHandleType = enterClass("java.lang.invoke.VarHandle");
554 methodHandleType = enterClass("java.lang.invoke.MethodHandle");
555 methodHandlesType = enterClass("java.lang.invoke.MethodHandles");
556 methodHandleLookupType = enterClass("java.lang.invoke.MethodHandles$Lookup");
557 methodTypeType = enterClass("java.lang.invoke.MethodType");
558 errorType = enterClass("java.lang.Error");
559 illegalArgumentExceptionType = enterClass("java.lang.IllegalArgumentException");
560 interruptedExceptionType = enterClass("java.lang.InterruptedException");
561 exceptionType = enterClass("java.lang.Exception");
562 runtimeExceptionType = enterClass("java.lang.RuntimeException");
563 classNotFoundExceptionType = enterClass("java.lang.ClassNotFoundException");
564 noClassDefFoundErrorType = enterClass("java.lang.NoClassDefFoundError");
565 noSuchFieldErrorType = enterClass("java.lang.NoSuchFieldError");
566 assertionErrorType = enterClass("java.lang.AssertionError");
567 incompatibleClassChangeErrorType = enterClass("java.lang.IncompatibleClassChangeError");
568 cloneNotSupportedExceptionType = enterClass("java.lang.CloneNotSupportedException");
569 matchExceptionType = enterClass("java.lang.MatchException");
570 annotationType = enterClass("java.lang.annotation.Annotation");
571 classLoaderType = enterClass("java.lang.ClassLoader");
572 enumSym = enterClass(java_base, names.java_lang_Enum);
573 enumFinalFinalize =
574 new MethodSymbol(PROTECTED|FINAL|HYPOTHETICAL,
575 names.finalize,
576 new MethodType(List.nil(), voidType,
577 List.nil(), methodClass),
578 enumSym);
579 listType = enterClass("java.util.List");
580 collectionsType = enterClass("java.util.Collections");
581 comparableType = enterClass("java.lang.Comparable");
582 comparatorType = enterClass("java.util.Comparator");
583 arraysType = enterClass("java.util.Arrays");
584 iterableType = enterClass("java.lang.Iterable");
585 iteratorType = enterClass("java.util.Iterator");
586 annotationTargetType = enterClass("java.lang.annotation.Target");
587 overrideType = enterClass("java.lang.Override");
588 retentionType = enterClass("java.lang.annotation.Retention");
589 deprecatedType = enterClass("java.lang.Deprecated");
590 suppressWarningsType = enterClass("java.lang.SuppressWarnings");
591 supplierType = enterClass("java.util.function.Supplier");
592 inheritedType = enterClass("java.lang.annotation.Inherited");
593 repeatableType = enterClass("java.lang.annotation.Repeatable");
594 documentedType = enterClass("java.lang.annotation.Documented");
595 elementTypeType = enterClass("java.lang.annotation.ElementType");
596 systemType = enterClass("java.lang.System");
597 autoCloseableType = enterClass("java.lang.AutoCloseable");
598 autoCloseableClose = new MethodSymbol(PUBLIC,
599 names.close,
600 new MethodType(List.nil(), voidType,
601 List.of(exceptionType), methodClass),
602 autoCloseableType.tsym);
603 trustMeType = enterClass("java.lang.SafeVarargs");
604 nativeHeaderType = enterClass("java.lang.annotation.Native");
605 lambdaMetafactory = enterClass("java.lang.invoke.LambdaMetafactory");
606 stringConcatFactory = enterClass("java.lang.invoke.StringConcatFactory");
607 functionalInterfaceType = enterClass("java.lang.FunctionalInterface");
608 previewFeatureType = enterClass("jdk.internal.javac.PreviewFeature");
609 previewFeatureInternalType = enterSyntheticAnnotation("jdk.internal.PreviewFeature+Annotation");
610 restrictedType = enterClass("jdk.internal.javac.Restricted");
611 restrictedInternalType = enterSyntheticAnnotation("jdk.internal.javac.Restricted+Annotation");
612 typeDescriptorType = enterClass("java.lang.invoke.TypeDescriptor");
613 recordType = enterClass("java.lang.Record");
614 switchBootstrapsType = enterClass("java.lang.runtime.SwitchBootstraps");
615 constantBootstrapsType = enterClass("java.lang.invoke.ConstantBootstraps");
616 valueBasedType = enterClass("jdk.internal.ValueBased");
617 valueBasedInternalType = enterSyntheticAnnotation("jdk.internal.ValueBased+Annotation");
618 classDescType = enterClass("java.lang.constant.ClassDesc");
619 enumDescType = enterClass("java.lang.Enum$EnumDesc");
620 ioType = enterClass("java.io.IO");
621 // For serialization lint checking
622 objectStreamFieldType = enterClass("java.io.ObjectStreamField");
623 objectInputStreamType = enterClass("java.io.ObjectInputStream");
624 objectOutputStreamType = enterClass("java.io.ObjectOutputStream");
625 ioExceptionType = enterClass("java.io.IOException");
626 objectStreamExceptionType = enterClass("java.io.ObjectStreamException");
627 externalizableType = enterClass("java.io.Externalizable");
628 objectInputType = enterClass("java.io.ObjectInput");
629 objectOutputType = enterClass("java.io.ObjectOutput");
630 synthesizeEmptyInterfaceIfMissing(autoCloseableType);
631 synthesizeEmptyInterfaceIfMissing(cloneableType);
632 synthesizeEmptyInterfaceIfMissing(serializableType);
633 synthesizeEmptyInterfaceIfMissing(lambdaMetafactory);
634 synthesizeEmptyInterfaceIfMissing(serializedLambdaType);
635 synthesizeEmptyInterfaceIfMissing(stringConcatFactory);
636 synthesizeBoxTypeIfMissing(doubleType);
637 synthesizeBoxTypeIfMissing(floatType);
638 synthesizeBoxTypeIfMissing(voidType);
639
640 // Enter a synthetic class that is used to mark internal
641 // proprietary classes in ct.sym. This class does not have a
642 // class file.
643 proprietaryType = enterSyntheticAnnotation("sun.Proprietary+Annotation");
644
645 // Enter a synthetic class that is used to provide profile info for
646 // classes in ct.sym. This class does not have a class file.
647 profileType = enterSyntheticAnnotation("jdk.Profile+Annotation");
648 MethodSymbol m = new MethodSymbol(PUBLIC | ABSTRACT, names.value, intType, profileType.tsym);
649 profileType.tsym.members().enter(m);
650
651 // Enter a class for arrays.
652 // The class implements java.lang.Cloneable and java.io.Serializable.
653 // It has a final length field and a clone method.
654 ClassType arrayClassType = (ClassType)arrayClass.type;
655 arrayClassType.supertype_field = objectType;
656 arrayClassType.interfaces_field = List.of(cloneableType, serializableType);
657 arrayClass.members_field = WriteableScope.create(arrayClass);
658 lengthVar = new VarSymbol(
659 PUBLIC | FINAL,
660 names.length,
661 intType,
662 arrayClass);
663 arrayClass.members().enter(lengthVar);
664 arrayCloneMethod = new MethodSymbol(
665 PUBLIC,
666 names.clone,
667 new MethodType(List.nil(), objectType,
668 List.nil(), methodClass),
669 arrayClass);
670 arrayClass.members().enter(arrayCloneMethod);
671
672 if (java_base != noModule)
673 java_base.completer = moduleCompleter::complete; //bootstrap issues
674
675 }
676
677 /** Define a new class given its name and owner.
678 */
679 public ClassSymbol defineClass(Name name, Symbol owner) {
680 ClassSymbol c = new ClassSymbol(0, name, owner);
681 c.completer = initialCompleter;
682 return c;
683 }
684
685 /** Create a new toplevel or member class symbol with given name
686 * and owner and enter in `classes' unless already there.
687 */
688 public ClassSymbol enterClass(ModuleSymbol msym, Name name, TypeSymbol owner) {
689 Assert.checkNonNull(msym);
690 Name flatname = TypeSymbol.formFlatName(name, owner);
691 ClassSymbol c = getClass(msym, flatname);
692 if (c == null) {
693 c = defineClass(name, owner);
694 doEnterClass(msym, c);
695 } else if ((c.name != name || c.owner != owner) && owner.kind == TYP &&
696 c.owner.kind == PCK && ((c.flags_field & FROM_SOURCE) == 0)) {
697 // reassign fields of classes that might have been loaded with
698 // their flat names.
699 c.owner.members().remove(c);
700 c.name = name;
701 c.owner = owner;
702 c.fullname = ClassSymbol.formFullName(name, owner);
703 }
704 return c;
705 }
706
707 public ClassSymbol getClass(ModuleSymbol msym, Name flatName) {
708 Assert.checkNonNull(msym, flatName::toString);
709 return classes.getOrDefault(flatName, Collections.emptyMap()).get(msym);
710 }
711
712 public PackageSymbol lookupPackage(ModuleSymbol msym, Name flatName) {
713 return lookupPackage(msym, flatName, false);
714 }
715
716 private PackageSymbol lookupPackage(ModuleSymbol msym, Name flatName, boolean onlyExisting) {
717 Assert.checkNonNull(msym);
718
719 if (flatName.isEmpty()) {
720 //unnamed packages only from the current module - visiblePackages contains *root* package, not unnamed package!
721 return msym.unnamedPackage;
722 }
723
724 if (msym == noModule) {
725 return enterPackage(msym, flatName);
726 }
727
728 msym.complete();
729
730 PackageSymbol pack;
731
732 pack = msym.visiblePackages.get(flatName);
733
734 if (pack != null)
735 return pack;
736
737 pack = getPackage(msym, flatName);
738
739 if ((pack != null && pack.exists()) || onlyExisting)
740 return pack;
741
742 boolean dependsOnUnnamed = msym.requires != null &&
743 msym.requires.stream()
744 .map(rd -> rd.module)
745 .anyMatch(mod -> mod == unnamedModule);
746
747 if (dependsOnUnnamed) {
748 //msyms depends on the unnamed module, for which we generally don't know
749 //the list of packages it "exports" ahead of time. So try to lookup the package in the
750 //current module, and in the unnamed module and see if it exists in one of them
751 PackageSymbol unnamedPack = getPackage(unnamedModule, flatName);
752
753 if (unnamedPack != null && unnamedPack.exists()) {
754 msym.visiblePackages.put(unnamedPack.fullname, unnamedPack);
755 return unnamedPack;
756 }
757
758 pack = enterPackage(msym, flatName);
759 pack.complete();
760 if (pack.exists())
761 return pack;
762
763 unnamedPack = enterPackage(unnamedModule, flatName);
764 unnamedPack.complete();
765 if (unnamedPack.exists()) {
766 msym.visiblePackages.put(unnamedPack.fullname, unnamedPack);
767 return unnamedPack;
768 }
769
770 return pack;
771 }
772
773 return enterPackage(msym, flatName);
774 }
775
776 private static final Map<ModuleSymbol, ClassSymbol> EMPTY = new HashMap<>();
777
778 public void removeClass(ModuleSymbol msym, Name flatName) {
779 classes.getOrDefault(flatName, EMPTY).remove(msym);
780 }
781
782 public Iterable<ClassSymbol> getAllClasses() {
783 return () -> Iterators.createCompoundIterator(classes.values(), v -> v.values().iterator());
784 }
785
786 private void doEnterClass(ModuleSymbol msym, ClassSymbol cs) {
787 classes.computeIfAbsent(cs.flatname, n -> new HashMap<>()).put(msym, cs);
788 }
789
790 /** Create a new member or toplevel class symbol with given flat name
791 * and enter in `classes' unless already there.
792 */
793 public ClassSymbol enterClass(ModuleSymbol msym, Name flatname) {
794 Assert.checkNonNull(msym);
795 PackageSymbol ps = lookupPackage(msym, Convert.packagePart(flatname));
796 Assert.checkNonNull(ps);
797 Assert.checkNonNull(ps.modle);
798 ClassSymbol c = getClass(ps.modle, flatname);
799 if (c == null) {
800 c = defineClass(Convert.shortName(flatname), ps);
801 doEnterClass(ps.modle, c);
802 return c;
803 } else
804 return c;
805 }
806
807 /** Check to see if a package exists, given its fully qualified name.
808 */
809 public boolean packageExists(ModuleSymbol msym, Name fullname) {
810 Assert.checkNonNull(msym);
811 PackageSymbol pack = lookupPackage(msym, fullname, true);
812 return pack != null && pack.exists();
813 }
814
815 /** Make a package, given its fully qualified name.
816 */
817 public PackageSymbol enterPackage(ModuleSymbol currModule, Name fullname) {
818 Assert.checkNonNull(currModule);
819 PackageSymbol p = getPackage(currModule, fullname);
820 if (p == null) {
821 Assert.check(!fullname.isEmpty(), () -> "rootPackage missing!; currModule: " + currModule);
822 p = new PackageSymbol(
823 Convert.shortName(fullname),
824 enterPackage(currModule, Convert.packagePart(fullname)));
825 p.completer = initialCompleter;
826 p.modle = currModule;
827 doEnterPackage(currModule, p);
828 }
829 return p;
830 }
831
832 private void doEnterPackage(ModuleSymbol msym, PackageSymbol pack) {
833 packages.computeIfAbsent(pack.fullname, n -> new HashMap<>()).put(msym, pack);
834 msym.enclosedPackages = msym.enclosedPackages.prepend(pack);
835 }
836
837 private void addRootPackageFor(ModuleSymbol module) {
838 doEnterPackage(module, rootPackage);
839 PackageSymbol unnamedPackage = new PackageSymbol(names.empty, rootPackage) {
840 @Override
841 public String toString() {
842 return messages.getLocalizedString("compiler.misc.unnamed.package");
843 }
844 };
845 unnamedPackage.modle = module;
846 //we cannot use a method reference below, as initialCompleter might be null now
847 unnamedPackage.completer = s -> initialCompleter.complete(s);
848 unnamedPackage.flags_field |= EXISTS;
849 module.unnamedPackage = unnamedPackage;
850 }
851
852 public PackageSymbol getPackage(ModuleSymbol module, Name fullname) {
853 return packages.getOrDefault(fullname, Collections.emptyMap()).get(module);
854 }
855
856 public ModuleSymbol enterModule(Name name) {
857 ModuleSymbol msym = modules.get(name);
858 if (msym == null) {
859 msym = ModuleSymbol.create(name, names.module_info);
860 addRootPackageFor(msym);
861 msym.completer = s -> moduleCompleter.complete(s); //bootstrap issues
862 modules.put(name, msym);
863 }
864 return msym;
865 }
866
867 public ModuleSymbol getModule(Name name) {
868 return modules.get(name);
869 }
870
871 //temporary:
872 public ModuleSymbol inferModule(Name packageName) {
873 if (packageName.isEmpty())
874 return java_base == noModule ? noModule : unnamedModule;//!
875
876 ModuleSymbol msym = null;
877 Map<ModuleSymbol,PackageSymbol> map = packages.get(packageName);
878 if (map == null)
879 return null;
880 for (Map.Entry<ModuleSymbol,PackageSymbol> e: map.entrySet()) {
881 if (!e.getValue().members().isEmpty()) {
882 if (msym == null) {
883 msym = e.getKey();
884 } else {
885 return null;
886 }
887 }
888 }
889 return msym;
890 }
891
892 public List<ModuleSymbol> listPackageModules(Name packageName) {
893 if (packageName.isEmpty())
894 return List.nil();
895
896 List<ModuleSymbol> result = List.nil();
897 Map<ModuleSymbol,PackageSymbol> map = packages.get(packageName);
898 if (map != null) {
899 for (Map.Entry<ModuleSymbol, PackageSymbol> e: map.entrySet()) {
900 if (!e.getValue().members().isEmpty()) {
901 result = result.prepend(e.getKey());
902 }
903 }
904 }
905 return result;
906 }
907
908 public Collection<ModuleSymbol> getAllModules() {
909 return modules.values();
910 }
911
912 public Iterable<ClassSymbol> getClassesForName(Name candidate) {
913 return classes.getOrDefault(candidate, Collections.emptyMap()).values();
914 }
915
916 public Iterable<PackageSymbol> getPackagesForName(Name candidate) {
917 return packages.getOrDefault(candidate, Collections.emptyMap()).values();
918 }
919 }