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