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.util;
27
28 /**
29 * Access to the compiler's name table. Standard names are defined,
30 * as well as methods to create new names.
31 *
32 * <p><b>This is NOT part of any supported API.
33 * If you write code that depends on this, you do so at your own risk.
34 * This code and its internal interfaces are subject to change or
35 * deletion without notice.</b>
36 */
37 public class Names {
38
39 public static final Context.Key<Names> namesKey = new Context.Key<>();
40
41 public static Names instance(Context context) {
42 Names instance = context.get(namesKey);
43 if (instance == null) {
44 instance = new Names(context);
45 context.put(namesKey, instance);
46 }
47 return instance;
48 }
49
50 // operators and punctuation
51 public final Name asterisk;
52 public final Name comma;
53 public final Name empty;
54 public final Name hyphen;
55 public final Name one;
56 public final Name slash;
57
58 // keywords
59 public final Name _class;
60 public final Name _super;
61 public final Name _this;
62 public final Name var;
63 public final Name exports;
64 public final Name opens;
65 public final Name module;
66 public final Name provides;
67 public final Name requires;
68 public final Name to;
69 public final Name transitive;
70 public final Name uses;
71 public final Name open;
72 public final Name underscore;
73 public final Name when;
74 public final Name with;
75 public final Name yield;
76
77 // field and method names
78 public final Name _name;
79 public final Name addSuppressed;
80 public final Name any;
81 public final Name append;
82 public final Name clinit;
83 public final Name clone;
84 public final Name close;
85 public final Name deserializeLambda;
86 public final Name desiredAssertionStatus;
87 public final Name equals;
88 public final Name error;
89 public final Name finalize;
90 public final Name forRemoval;
91 public final Name reflective;
92 public final Name getClass;
93 public final Name hasNext;
94 public final Name hashCode;
95 public final Name init;
96 public final Name invoke;
97 public final Name iterator;
98 public final Name length;
99 public final Name next;
100 public final Name of;
101 public final Name ordinal;
102 public final Name provider;
103 public final Name serialVersionUID;
104 public final Name toString;
105 public final Name value;
106 public final Name valueOf;
107 public final Name values;
108 public final Name readResolve;
109 public final Name readObject;
110
111 // class names
112 public final Name java_io_Serializable;
113 public final Name java_lang_Class;
114 public final Name java_lang_Cloneable;
115 public final Name java_lang_Enum;
116 public final Name java_lang_Object;
117 public final Name java_lang_System;
118
119 // names of builtin classes
120 public final Name Array;
121 public final Name Bound;
122 public final Name Method;
123
124 // package names
125 public final Name java;
126 public final Name java_lang;
127 public final Name jdk_internal_javac;
128
129 // module names
130 public final Name java_base;
131 public final Name jdk_unsupported;
132
133 // attribute names
134 public final Name Annotation;
135 public final Name AnnotationDefault;
136 public final Name BootstrapMethods;
137 public final Name Bridge;
138 public final Name CharacterRangeTable;
139 public final Name Code;
140 public final Name CompilationID;
141 public final Name ConstantValue;
142 public final Name Deprecated;
143 public final Name EnclosingMethod;
144 public final Name Enum;
145 public final Name Exceptions;
146 public final Name InnerClasses;
147 public final Name LineNumberTable;
148 public final Name LocalVariableTable;
149 public final Name LocalVariableTypeTable;
150 public final Name MethodParameters;
151 public final Name Module;
152 public final Name ModuleResolution;
153 public final Name NestHost;
154 public final Name NestMembers;
155 public final Name LoadableDescriptors;
156 public final Name Record;
157 public final Name RuntimeInvisibleAnnotations;
158 public final Name RuntimeInvisibleParameterAnnotations;
159 public final Name RuntimeInvisibleTypeAnnotations;
160 public final Name RuntimeVisibleAnnotations;
161 public final Name RuntimeVisibleParameterAnnotations;
162 public final Name RuntimeVisibleTypeAnnotations;
163 public final Name Signature;
164 public final Name SourceFile;
165 public final Name SourceID;
166 public final Name StackMap;
167 public final Name StackMapTable;
168 public final Name Synthetic;
169 public final Name Value;
170 public final Name Varargs;
171 public final Name PermittedSubclasses;
172
173 // members of java.lang.annotation.ElementType
174 public final Name ANNOTATION_TYPE;
175 public final Name CONSTRUCTOR;
176 public final Name FIELD;
177 public final Name LOCAL_VARIABLE;
178 public final Name METHOD;
179 public final Name MODULE;
180 public final Name PACKAGE;
181 public final Name PARAMETER;
182 public final Name TYPE;
183 public final Name TYPE_PARAMETER;
184 public final Name TYPE_USE;
185 public final Name RECORD_COMPONENT;
186
187 // members of java.lang.annotation.RetentionPolicy
188 public final Name CLASS;
189 public final Name RUNTIME;
190 public final Name SOURCE;
191
192 // other identifiers
193 public final Name T;
194 public final Name ex;
195 public final Name module_info;
196 public final Name package_info;
197 public final Name requireNonNull;
198 public final Name main;
199
200 // lambda-related
201 public final Name lambda;
202 public final Name metafactory;
203 public final Name altMetafactory;
204 public final Name dollarThis;
205
206 // string concat
207 public final Name makeConcat;
208 public final Name makeConcatWithConstants;
209
210 // values
211 public final Name dollarValue;
212
213
214 // record related
215 // members of java.lang.runtime.ObjectMethods
216 public final Name bootstrap;
217
218 public final Name record;
219 public final Name non;
220
221 // serialization members, used by records too
222 public final Name serialPersistentFields;
223 public final Name writeObject;
224 public final Name writeReplace;
225 public final Name readObjectNoData;
226
227 // sealed types
228 public final Name permits;
229 public final Name sealed;
230
231 // pattern switches
232 public final Name typeSwitch;
233 public final Name enumSwitch;
234 public final Name enumConstant;
235
236 public final Name.Table table;
237
238 @SuppressWarnings("this-escape")
239 public Names(Context context) {
240 Options options = Options.instance(context);
241 table = createTable(options);
242
243 // operators and punctuation
244 asterisk = fromString("*");
245 comma = fromString(",");
246 empty = fromString("");
247 hyphen = fromString("-");
248 one = fromString("1");
249 slash = fromString("/");
250
251 // keywords
252 _class = fromString("class");
253 _super = fromString("super");
254 _this = fromString("this");
255 var = fromString("var");
256 exports = fromString("exports");
257 opens = fromString("opens");
258 module = fromString("module");
259 provides = fromString("provides");
260 requires = fromString("requires");
261 to = fromString("to");
262 transitive = fromString("transitive");
263 uses = fromString("uses");
264 open = fromString("open");
265 underscore = fromString("_");
266 when = fromString("when");
267 with = fromString("with");
268 yield = fromString("yield");
269
270 // field and method names
271 _name = fromString("name");
272 addSuppressed = fromString("addSuppressed");
273 any = fromString("<any>");
274 append = fromString("append");
275 clinit = fromString("<clinit>");
276 clone = fromString("clone");
277 close = fromString("close");
278 deserializeLambda = fromString("$deserializeLambda$");
279 desiredAssertionStatus = fromString("desiredAssertionStatus");
280 equals = fromString("equals");
281 error = fromString("<error>");
282 finalize = fromString("finalize");
283 forRemoval = fromString("forRemoval");
284 reflective = fromString("reflective");
285 getClass = fromString("getClass");
286 hasNext = fromString("hasNext");
287 hashCode = fromString("hashCode");
288 init = fromString("<init>");
289 invoke = fromString("invoke");
290 iterator = fromString("iterator");
291 length = fromString("length");
292 next = fromString("next");
293 of = fromString("of");
294 ordinal = fromString("ordinal");
295 provider = fromString("provider");
296 serialVersionUID = fromString("serialVersionUID");
297 toString = fromString("toString");
298 value = fromString("value");
299 valueOf = fromString("valueOf");
300 values = fromString("values");
301 readResolve = fromString("readResolve");
302 readObject = fromString("readObject");
303 dollarThis = fromString("$this");
304
305 // class names
306 java_io_Serializable = fromString("java.io.Serializable");
307 java_lang_Class = fromString("java.lang.Class");
308 java_lang_Cloneable = fromString("java.lang.Cloneable");
309 java_lang_Enum = fromString("java.lang.Enum");
310 java_lang_Object = fromString("java.lang.Object");
311 java_lang_System = fromString("java.lang.System");
312
313 // names of builtin classes
314 Array = fromString("Array");
315 Bound = fromString("Bound");
316 Method = fromString("Method");
317
318 // package names
319 java = fromString("java");
320 java_lang = fromString("java.lang");
321 jdk_internal_javac = fromString("jdk.internal.javac");
322
323 // module names
324 java_base = fromString("java.base");
325 jdk_unsupported = fromString("jdk.unsupported");
326
327 // attribute names
328 Annotation = fromString("Annotation");
329 AnnotationDefault = fromString("AnnotationDefault");
330 BootstrapMethods = fromString("BootstrapMethods");
331 Bridge = fromString("Bridge");
332 CharacterRangeTable = fromString("CharacterRangeTable");
333 Code = fromString("Code");
334 CompilationID = fromString("CompilationID");
335 ConstantValue = fromString("ConstantValue");
336 Deprecated = fromString("Deprecated");
337 EnclosingMethod = fromString("EnclosingMethod");
338 Enum = fromString("Enum");
339 Exceptions = fromString("Exceptions");
340 InnerClasses = fromString("InnerClasses");
341 LineNumberTable = fromString("LineNumberTable");
342 LocalVariableTable = fromString("LocalVariableTable");
343 LocalVariableTypeTable = fromString("LocalVariableTypeTable");
344 MethodParameters = fromString("MethodParameters");
345 Module = fromString("Module");
346 ModuleResolution = fromString("ModuleResolution");
347 NestHost = fromString("NestHost");
348 NestMembers = fromString("NestMembers");
349 LoadableDescriptors = fromString("LoadableDescriptors");
350 Record = fromString("Record");
351 RuntimeInvisibleAnnotations = fromString("RuntimeInvisibleAnnotations");
352 RuntimeInvisibleParameterAnnotations = fromString("RuntimeInvisibleParameterAnnotations");
353 RuntimeInvisibleTypeAnnotations = fromString("RuntimeInvisibleTypeAnnotations");
354 RuntimeVisibleAnnotations = fromString("RuntimeVisibleAnnotations");
355 RuntimeVisibleParameterAnnotations = fromString("RuntimeVisibleParameterAnnotations");
356 RuntimeVisibleTypeAnnotations = fromString("RuntimeVisibleTypeAnnotations");
357 Signature = fromString("Signature");
358 SourceFile = fromString("SourceFile");
359 SourceID = fromString("SourceID");
360 StackMap = fromString("StackMap");
361 StackMapTable = fromString("StackMapTable");
362 Synthetic = fromString("Synthetic");
363 Value = fromString("Value");
364 Varargs = fromString("Varargs");
365 PermittedSubclasses = fromString("PermittedSubclasses");
366
367 // members of java.lang.annotation.ElementType
368 ANNOTATION_TYPE = fromString("ANNOTATION_TYPE");
369 CONSTRUCTOR = fromString("CONSTRUCTOR");
370 FIELD = fromString("FIELD");
371 LOCAL_VARIABLE = fromString("LOCAL_VARIABLE");
372 METHOD = fromString("METHOD");
373 MODULE = fromString("MODULE");
374 PACKAGE = fromString("PACKAGE");
375 PARAMETER = fromString("PARAMETER");
376 TYPE = fromString("TYPE");
377 TYPE_PARAMETER = fromString("TYPE_PARAMETER");
378 TYPE_USE = fromString("TYPE_USE");
379 RECORD_COMPONENT = fromString("RECORD_COMPONENT");
380
381 // members of java.lang.annotation.RetentionPolicy
382 CLASS = fromString("CLASS");
383 RUNTIME = fromString("RUNTIME");
384 SOURCE = fromString("SOURCE");
385
386 // other identifiers
387 T = fromString("T");
388 ex = fromString("ex");
389 module_info = fromString("module-info");
390 package_info = fromString("package-info");
391 requireNonNull = fromString("requireNonNull");
392 main = fromString("main");
393
394 //lambda-related
395 lambda = fromString("lambda$");
396 metafactory = fromString("metafactory");
397 altMetafactory = fromString("altMetafactory");
398
399 // string concat
400 makeConcat = fromString("makeConcat");
401 makeConcatWithConstants = fromString("makeConcatWithConstants");
402
403 dollarValue = fromString("$value");
404
405 bootstrap = fromString("bootstrap");
406 record = fromString("record");
407 non = fromString("non");
408
409 serialPersistentFields = fromString("serialPersistentFields");
410 writeObject = fromString("writeObject");
411 writeReplace = fromString("writeReplace");
412 readObjectNoData = fromString("readObjectNoData");
413
414 // sealed types
415 permits = fromString("permits");
416 sealed = fromString("sealed");
417
418
419 // pattern switches
420 typeSwitch = fromString("typeSwitch");
421 enumSwitch = fromString("enumSwitch");
422 enumConstant = fromString("enumConstant");
423 }
424
425 protected Name.Table createTable(Options options) {
426 boolean useUnsharedTable = options.isSet("useUnsharedTable");
427 if (useUnsharedTable)
428 return newUnsharedNameTable();
429 boolean useSharedTable = options.isSet("useSharedTable");
430 if (useSharedTable)
431 return newSharedNameTable();
432 boolean internStringTable = options.isSet("internStringTable");
433 return newStringNameTable(internStringTable);
434 }
435
436 public StringNameTable newStringNameTable(boolean intern) {
437 return StringNameTable.create(this, intern);
438 }
439
440 public SharedNameTable newSharedNameTable() {
441 return SharedNameTable.create(this);
442 }
443
444 public UnsharedNameTable newUnsharedNameTable() {
445 return UnsharedNameTable.create(this);
446 }
447
448 public boolean isInit(Name name) {
449 return name == init;
450 }
451
452 public void dispose() {
453 table.dispose();
454 }
455
456 public Name fromChars(char[] cs, int start, int len) {
457 return table.fromChars(cs, start, len);
458 }
459
460 public Name fromString(String s) {
461 return table.fromString(s);
462 }
463
464 public Name fromUtf(byte[] cs) throws InvalidUtfException {
465 return table.fromUtf(cs);
466 }
467
468 public Name fromUtf(byte[] cs, int start, int len, Convert.Validation validation) throws InvalidUtfException {
469 return table.fromUtf(cs, start, len, validation);
470 }
471
472 public Name fromUtfLax(byte[] cs, int start, int len) {
473 try {
474 return table.fromUtf(cs, start, len, Convert.Validation.NONE);
475 } catch (InvalidUtfException e) {
476 throw new AssertionError(e);
477 }
478 }
479 }