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
118 // names of builtin classes
119 public final Name Array;
120 public final Name Bound;
121 public final Name Method;
122
123 // package names
124 public final Name java;
125 public final Name java_lang;
126 public final Name jdk_internal_javac;
127
128 // module names
129 public final Name java_base;
130 public final Name jdk_unsupported;
131
132 // attribute names
133 public final Name Annotation;
134 public final Name AnnotationDefault;
135 public final Name BootstrapMethods;
136 public final Name Bridge;
137 public final Name CharacterRangeTable;
138 public final Name Code;
139 public final Name CompilationID;
140 public final Name ConstantValue;
141 public final Name Deprecated;
142 public final Name EnclosingMethod;
143 public final Name Enum;
144 public final Name Exceptions;
145 public final Name InnerClasses;
146 public final Name LineNumberTable;
147 public final Name LocalVariableTable;
148 public final Name LocalVariableTypeTable;
149 public final Name MethodParameters;
150 public final Name Module;
151 public final Name ModuleResolution;
152 public final Name NestHost;
153 public final Name NestMembers;
154 public final Name Record;
155 public final Name RuntimeInvisibleAnnotations;
156 public final Name RuntimeInvisibleParameterAnnotations;
157 public final Name RuntimeInvisibleTypeAnnotations;
158 public final Name RuntimeVisibleAnnotations;
159 public final Name RuntimeVisibleParameterAnnotations;
160 public final Name RuntimeVisibleTypeAnnotations;
161 public final Name Signature;
162 public final Name SourceFile;
163 public final Name SourceID;
164 public final Name StackMap;
165 public final Name StackMapTable;
166 public final Name Synthetic;
167 public final Name Value;
168 public final Name Varargs;
169 public final Name PermittedSubclasses;
170
171 // members of java.lang.annotation.ElementType
172 public final Name ANNOTATION_TYPE;
173 public final Name CONSTRUCTOR;
174 public final Name FIELD;
175 public final Name LOCAL_VARIABLE;
176 public final Name METHOD;
177 public final Name MODULE;
178 public final Name PACKAGE;
179 public final Name PARAMETER;
180 public final Name TYPE;
181 public final Name TYPE_PARAMETER;
182 public final Name TYPE_USE;
183 public final Name RECORD_COMPONENT;
184
185 // members of java.lang.annotation.RetentionPolicy
186 public final Name CLASS;
187 public final Name RUNTIME;
188 public final Name SOURCE;
189
190 // other identifiers
191 public final Name T;
192 public final Name ex;
193 public final Name module_info;
194 public final Name package_info;
195 public final Name requireNonNull;
196 public final Name main;
197
198 // lambda-related
199 public final Name lambda;
200 public final Name metafactory;
201 public final Name altMetafactory;
202 public final Name dollarThis;
203
204 // string concat
205 public final Name makeConcat;
206 public final Name makeConcatWithConstants;
207
208 // record related
209 // members of java.lang.runtime.ObjectMethods
210 public final Name bootstrap;
211
212 public final Name record;
213 public final Name non;
214
215 // serialization members, used by records too
216 public final Name serialPersistentFields;
217 public final Name writeObject;
218 public final Name writeReplace;
219 public final Name readObjectNoData;
220
221 // sealed types
222 public final Name permits;
223 public final Name sealed;
224
225 // pattern switches
226 public final Name typeSwitch;
227 public final Name enumSwitch;
228 public final Name enumConstant;
229
230 public final Name.Table table;
231
232 @SuppressWarnings("this-escape")
233 public Names(Context context) {
234 Options options = Options.instance(context);
235 table = createTable(options);
236
237 // operators and punctuation
238 asterisk = fromString("*");
239 comma = fromString(",");
240 empty = fromString("");
241 hyphen = fromString("-");
242 one = fromString("1");
243 slash = fromString("/");
244
245 // keywords
246 _class = fromString("class");
247 _super = fromString("super");
248 _this = fromString("this");
249 var = fromString("var");
250 exports = fromString("exports");
251 opens = fromString("opens");
252 module = fromString("module");
253 provides = fromString("provides");
254 requires = fromString("requires");
255 to = fromString("to");
256 transitive = fromString("transitive");
257 uses = fromString("uses");
258 open = fromString("open");
259 underscore = fromString("_");
260 when = fromString("when");
261 with = fromString("with");
262 yield = fromString("yield");
263
264 // field and method names
265 _name = fromString("name");
266 addSuppressed = fromString("addSuppressed");
267 any = fromString("<any>");
268 append = fromString("append");
269 clinit = fromString("<clinit>");
270 clone = fromString("clone");
271 close = fromString("close");
272 deserializeLambda = fromString("$deserializeLambda$");
273 desiredAssertionStatus = fromString("desiredAssertionStatus");
274 equals = fromString("equals");
275 error = fromString("<error>");
276 finalize = fromString("finalize");
277 forRemoval = fromString("forRemoval");
278 reflective = fromString("reflective");
279 getClass = fromString("getClass");
280 hasNext = fromString("hasNext");
281 hashCode = fromString("hashCode");
282 init = fromString("<init>");
283 invoke = fromString("invoke");
284 iterator = fromString("iterator");
285 length = fromString("length");
286 next = fromString("next");
287 of = fromString("of");
288 ordinal = fromString("ordinal");
289 provider = fromString("provider");
290 serialVersionUID = fromString("serialVersionUID");
291 toString = fromString("toString");
292 value = fromString("value");
293 valueOf = fromString("valueOf");
294 values = fromString("values");
295 readResolve = fromString("readResolve");
296 readObject = fromString("readObject");
297 dollarThis = fromString("$this");
298
299 // class names
300 java_io_Serializable = fromString("java.io.Serializable");
301 java_lang_Class = fromString("java.lang.Class");
302 java_lang_Cloneable = fromString("java.lang.Cloneable");
303 java_lang_Enum = fromString("java.lang.Enum");
304 java_lang_Object = fromString("java.lang.Object");
305
306 // names of builtin classes
307 Array = fromString("Array");
308 Bound = fromString("Bound");
309 Method = fromString("Method");
310
311 // package names
312 java = fromString("java");
313 java_lang = fromString("java.lang");
314 jdk_internal_javac = fromString("jdk.internal.javac");
315
316 // module names
317 java_base = fromString("java.base");
318 jdk_unsupported = fromString("jdk.unsupported");
319
320 // attribute names
321 Annotation = fromString("Annotation");
322 AnnotationDefault = fromString("AnnotationDefault");
323 BootstrapMethods = fromString("BootstrapMethods");
324 Bridge = fromString("Bridge");
325 CharacterRangeTable = fromString("CharacterRangeTable");
326 Code = fromString("Code");
327 CompilationID = fromString("CompilationID");
328 ConstantValue = fromString("ConstantValue");
329 Deprecated = fromString("Deprecated");
330 EnclosingMethod = fromString("EnclosingMethod");
331 Enum = fromString("Enum");
332 Exceptions = fromString("Exceptions");
333 InnerClasses = fromString("InnerClasses");
334 LineNumberTable = fromString("LineNumberTable");
335 LocalVariableTable = fromString("LocalVariableTable");
336 LocalVariableTypeTable = fromString("LocalVariableTypeTable");
337 MethodParameters = fromString("MethodParameters");
338 Module = fromString("Module");
339 ModuleResolution = fromString("ModuleResolution");
340 NestHost = fromString("NestHost");
341 NestMembers = fromString("NestMembers");
342 Record = fromString("Record");
343 RuntimeInvisibleAnnotations = fromString("RuntimeInvisibleAnnotations");
344 RuntimeInvisibleParameterAnnotations = fromString("RuntimeInvisibleParameterAnnotations");
345 RuntimeInvisibleTypeAnnotations = fromString("RuntimeInvisibleTypeAnnotations");
346 RuntimeVisibleAnnotations = fromString("RuntimeVisibleAnnotations");
347 RuntimeVisibleParameterAnnotations = fromString("RuntimeVisibleParameterAnnotations");
348 RuntimeVisibleTypeAnnotations = fromString("RuntimeVisibleTypeAnnotations");
349 Signature = fromString("Signature");
350 SourceFile = fromString("SourceFile");
351 SourceID = fromString("SourceID");
352 StackMap = fromString("StackMap");
353 StackMapTable = fromString("StackMapTable");
354 Synthetic = fromString("Synthetic");
355 Value = fromString("Value");
356 Varargs = fromString("Varargs");
357 PermittedSubclasses = fromString("PermittedSubclasses");
358
359 // members of java.lang.annotation.ElementType
360 ANNOTATION_TYPE = fromString("ANNOTATION_TYPE");
361 CONSTRUCTOR = fromString("CONSTRUCTOR");
362 FIELD = fromString("FIELD");
363 LOCAL_VARIABLE = fromString("LOCAL_VARIABLE");
364 METHOD = fromString("METHOD");
365 MODULE = fromString("MODULE");
366 PACKAGE = fromString("PACKAGE");
367 PARAMETER = fromString("PARAMETER");
368 TYPE = fromString("TYPE");
369 TYPE_PARAMETER = fromString("TYPE_PARAMETER");
370 TYPE_USE = fromString("TYPE_USE");
371 RECORD_COMPONENT = fromString("RECORD_COMPONENT");
372
373 // members of java.lang.annotation.RetentionPolicy
374 CLASS = fromString("CLASS");
375 RUNTIME = fromString("RUNTIME");
376 SOURCE = fromString("SOURCE");
377
378 // other identifiers
379 T = fromString("T");
380 ex = fromString("ex");
381 module_info = fromString("module-info");
382 package_info = fromString("package-info");
383 requireNonNull = fromString("requireNonNull");
384 main = fromString("main");
385
386 //lambda-related
387 lambda = fromString("lambda$");
388 metafactory = fromString("metafactory");
389 altMetafactory = fromString("altMetafactory");
390
391 // string concat
392 makeConcat = fromString("makeConcat");
393 makeConcatWithConstants = fromString("makeConcatWithConstants");
394
395 bootstrap = fromString("bootstrap");
396 record = fromString("record");
397 non = fromString("non");
398
399 serialPersistentFields = fromString("serialPersistentFields");
400 writeObject = fromString("writeObject");
401 writeReplace = fromString("writeReplace");
402 readObjectNoData = fromString("readObjectNoData");
403
404 // sealed types
405 permits = fromString("permits");
406 sealed = fromString("sealed");
407
408
409 // pattern switches
410 typeSwitch = fromString("typeSwitch");
411 enumSwitch = fromString("enumSwitch");
412 enumConstant = fromString("enumConstant");
413 }
414
415 protected Name.Table createTable(Options options) {
416 boolean useUnsharedTable = options.isSet("useUnsharedTable");
417 if (useUnsharedTable)
418 return newUnsharedNameTable();
419 boolean useSharedTable = options.isSet("useSharedTable");
420 if (useSharedTable)
421 return newSharedNameTable();
422 boolean internStringTable = options.isSet("internStringTable");
423 return newStringNameTable(internStringTable);
424 }
425
426 public StringNameTable newStringNameTable(boolean intern) {
427 return StringNameTable.create(this, intern);
428 }
429
430 public SharedNameTable newSharedNameTable() {
431 return SharedNameTable.create(this);
432 }
433
434 public UnsharedNameTable newUnsharedNameTable() {
435 return UnsharedNameTable.create(this);
436 }
437
438 public void dispose() {
439 table.dispose();
440 }
441
442 public Name fromChars(char[] cs, int start, int len) {
443 return table.fromChars(cs, start, len);
444 }
445
446 public Name fromString(String s) {
447 return table.fromString(s);
448 }
449
450 public Name fromUtf(byte[] cs) throws InvalidUtfException {
451 return table.fromUtf(cs);
452 }
453
454 public Name fromUtf(byte[] cs, int start, int len, Convert.Validation validation) throws InvalidUtfException {
455 return table.fromUtf(cs, start, len, validation);
456 }
457
458 public Name fromUtfLax(byte[] cs, int start, int len) {
459 try {
460 return table.fromUtf(cs, start, len, Convert.Validation.NONE);
461 } catch (InvalidUtfException e) {
462 throw new AssertionError(e);
463 }
464 }
465 }