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