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