1 /*
2 * Copyright (c) 1999, 2023, 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 // templated string
231 public final Name process;
232 public final Name STR;
233 public final Name RAW;
234 public final Name newStringTemplate;
235 public final Name newLargeStringTemplate;
236 public final Name processStringTemplate;
237
238 public final Name.Table table;
239
240 @SuppressWarnings("this-escape")
241 public Names(Context context) {
242 Options options = Options.instance(context);
243 table = createTable(options);
244
245 // operators and punctuation
246 asterisk = fromString("*");
247 comma = fromString(",");
248 empty = fromString("");
249 hyphen = fromString("-");
250 one = fromString("1");
251 slash = fromString("/");
252
253 // keywords
254 _class = fromString("class");
255 _super = fromString("super");
256 _this = fromString("this");
257 var = fromString("var");
258 exports = fromString("exports");
259 opens = fromString("opens");
260 module = fromString("module");
261 provides = fromString("provides");
262 requires = fromString("requires");
263 to = fromString("to");
264 transitive = fromString("transitive");
265 uses = fromString("uses");
266 open = fromString("open");
267 underscore = fromString("_");
268 when = fromString("when");
269 with = fromString("with");
270 yield = fromString("yield");
271
272 // field and method names
273 _name = fromString("name");
274 addSuppressed = fromString("addSuppressed");
275 any = fromString("<any>");
276 append = fromString("append");
277 clinit = fromString("<clinit>");
278 clone = fromString("clone");
279 close = fromString("close");
280 deserializeLambda = fromString("$deserializeLambda$");
281 desiredAssertionStatus = fromString("desiredAssertionStatus");
282 equals = fromString("equals");
283 error = fromString("<error>");
284 finalize = fromString("finalize");
285 forRemoval = fromString("forRemoval");
286 reflective = fromString("reflective");
287 getClass = fromString("getClass");
288 hasNext = fromString("hasNext");
289 hashCode = fromString("hashCode");
290 init = fromString("<init>");
291 invoke = fromString("invoke");
292 iterator = fromString("iterator");
293 length = fromString("length");
294 next = fromString("next");
295 of = fromString("of");
296 ordinal = fromString("ordinal");
297 provider = fromString("provider");
298 serialVersionUID = fromString("serialVersionUID");
299 toString = fromString("toString");
300 value = fromString("value");
301 valueOf = fromString("valueOf");
302 values = fromString("values");
303 readResolve = fromString("readResolve");
304 readObject = fromString("readObject");
305 dollarThis = fromString("$this");
306
307 // class names
308 java_io_Serializable = fromString("java.io.Serializable");
309 java_lang_Class = fromString("java.lang.Class");
310 java_lang_Cloneable = fromString("java.lang.Cloneable");
311 java_lang_Enum = fromString("java.lang.Enum");
312 java_lang_Object = fromString("java.lang.Object");
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 jdk_unsupported = fromString("jdk.unsupported");
327
328 // attribute names
329 Annotation = fromString("Annotation");
330 AnnotationDefault = fromString("AnnotationDefault");
331 BootstrapMethods = fromString("BootstrapMethods");
332 Bridge = fromString("Bridge");
333 CharacterRangeTable = fromString("CharacterRangeTable");
334 Code = fromString("Code");
335 CompilationID = fromString("CompilationID");
336 ConstantValue = fromString("ConstantValue");
337 Deprecated = fromString("Deprecated");
338 EnclosingMethod = fromString("EnclosingMethod");
339 Enum = fromString("Enum");
340 Exceptions = fromString("Exceptions");
341 InnerClasses = fromString("InnerClasses");
342 LineNumberTable = fromString("LineNumberTable");
343 LocalVariableTable = fromString("LocalVariableTable");
344 LocalVariableTypeTable = fromString("LocalVariableTypeTable");
345 MethodParameters = fromString("MethodParameters");
346 Module = fromString("Module");
347 ModuleResolution = fromString("ModuleResolution");
348 NestHost = fromString("NestHost");
349 NestMembers = fromString("NestMembers");
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 bootstrap = fromString("bootstrap");
404 record = fromString("record");
405 non = fromString("non");
406
407 serialPersistentFields = fromString("serialPersistentFields");
408 writeObject = fromString("writeObject");
409 writeReplace = fromString("writeReplace");
410 readObjectNoData = fromString("readObjectNoData");
411
412 // sealed types
413 permits = fromString("permits");
414 sealed = fromString("sealed");
415
416 // templated string
417 process = fromString("process");
418 STR = fromString("STR");
419 RAW = fromString("RAW");
420 newStringTemplate = fromString("newStringTemplate");
421 newLargeStringTemplate = fromString("newLargeStringTemplate");
422 processStringTemplate = fromString("processStringTemplate");
423
424 // pattern switches
425 typeSwitch = fromString("typeSwitch");
426 enumSwitch = fromString("enumSwitch");
427 enumConstant = fromString("enumConstant");
428 }
429
430 protected Name.Table createTable(Options options) {
431 boolean useUnsharedTable = options.isSet("useUnsharedTable");
432 if (useUnsharedTable)
433 return newUnsharedNameTable();
434 boolean useSharedTable = options.isSet("useSharedTable");
435 if (useSharedTable)
436 return newSharedNameTable();
437 boolean internStringTable = options.isSet("internStringTable");
438 return newStringNameTable(internStringTable);
439 }
440
441 public StringNameTable newStringNameTable(boolean intern) {
442 return StringNameTable.create(this, intern);
443 }
444
445 public SharedNameTable newSharedNameTable() {
446 return SharedNameTable.create(this);
447 }
448
449 public UnsharedNameTable newUnsharedNameTable() {
450 return UnsharedNameTable.create(this);
451 }
452
453 public void dispose() {
454 table.dispose();
455 }
456
457 public Name fromChars(char[] cs, int start, int len) {
458 return table.fromChars(cs, start, len);
459 }
460
461 public Name fromString(String s) {
462 return table.fromString(s);
463 }
464
465 public Name fromUtf(byte[] cs) throws InvalidUtfException {
466 return table.fromUtf(cs);
467 }
468
469 public Name fromUtf(byte[] cs, int start, int len, Convert.Validation validation) throws InvalidUtfException {
470 return table.fromUtf(cs, start, len, validation);
471 }
472
473 public Name fromUtfLax(byte[] cs, int start, int len) {
474 try {
475 return table.fromUtf(cs, start, len, Convert.Validation.NONE);
476 } catch (InvalidUtfException e) {
477 throw new AssertionError(e);
478 }
479 }
480 }