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 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 // templated string
237 public final Name process;
238 public final Name STR;
239 public final Name RAW;
240 public final Name newStringTemplate;
241 public final Name newLargeStringTemplate;
242 public final Name processStringTemplate;
243
244 public final Name.Table table;
245
246 @SuppressWarnings("this-escape")
247 public Names(Context context) {
248 Options options = Options.instance(context);
249 table = createTable(options);
250
251 // operators and punctuation
252 asterisk = fromString("*");
253 comma = fromString(",");
254 empty = fromString("");
255 hyphen = fromString("-");
256 one = fromString("1");
257 slash = fromString("/");
258
259 // keywords
260 _class = fromString("class");
261 _super = fromString("super");
262 _this = fromString("this");
263 var = fromString("var");
264 exports = fromString("exports");
265 opens = fromString("opens");
266 module = fromString("module");
267 provides = fromString("provides");
268 requires = fromString("requires");
269 to = fromString("to");
270 transitive = fromString("transitive");
271 uses = fromString("uses");
272 open = fromString("open");
273 underscore = fromString("_");
274 when = fromString("when");
275 with = fromString("with");
276 yield = fromString("yield");
277
278 // field and method names
279 _name = fromString("name");
280 addSuppressed = fromString("addSuppressed");
281 any = fromString("<any>");
282 append = fromString("append");
283 clinit = fromString("<clinit>");
284 clone = fromString("clone");
285 close = fromString("close");
286 deserializeLambda = fromString("$deserializeLambda$");
287 desiredAssertionStatus = fromString("desiredAssertionStatus");
288 equals = fromString("equals");
289 error = fromString("<error>");
290 finalize = fromString("finalize");
291 forRemoval = fromString("forRemoval");
292 reflective = fromString("reflective");
293 getClass = fromString("getClass");
294 hasNext = fromString("hasNext");
295 hashCode = fromString("hashCode");
296 init = fromString("<init>");
297 invoke = fromString("invoke");
298 iterator = fromString("iterator");
299 length = fromString("length");
300 next = fromString("next");
301 of = fromString("of");
302 ordinal = fromString("ordinal");
303 provider = fromString("provider");
304 serialVersionUID = fromString("serialVersionUID");
305 toString = fromString("toString");
306 value = fromString("value");
307 valueOf = fromString("valueOf");
308 values = fromString("values");
309 readResolve = fromString("readResolve");
310 readObject = fromString("readObject");
311 dollarThis = fromString("$this");
312
313 // class names
314 java_io_Serializable = fromString("java.io.Serializable");
315 java_lang_Class = fromString("java.lang.Class");
316 java_lang_Cloneable = fromString("java.lang.Cloneable");
317 java_lang_Enum = fromString("java.lang.Enum");
318 java_lang_Object = fromString("java.lang.Object");
319 java_lang_System = fromString("java.lang.System");
320
321 // names of builtin classes
322 Array = fromString("Array");
323 Bound = fromString("Bound");
324 Method = fromString("Method");
325
326 // package names
327 java = fromString("java");
328 java_lang = fromString("java.lang");
329 jdk_internal_javac = fromString("jdk.internal.javac");
330
331 // module names
332 java_base = fromString("java.base");
333 jdk_unsupported = fromString("jdk.unsupported");
334
335 // attribute names
336 Annotation = fromString("Annotation");
337 AnnotationDefault = fromString("AnnotationDefault");
338 BootstrapMethods = fromString("BootstrapMethods");
339 Bridge = fromString("Bridge");
340 CharacterRangeTable = fromString("CharacterRangeTable");
341 Code = fromString("Code");
342 CompilationID = fromString("CompilationID");
343 ConstantValue = fromString("ConstantValue");
344 Deprecated = fromString("Deprecated");
345 EnclosingMethod = fromString("EnclosingMethod");
346 Enum = fromString("Enum");
347 Exceptions = fromString("Exceptions");
348 InnerClasses = fromString("InnerClasses");
349 LineNumberTable = fromString("LineNumberTable");
350 LocalVariableTable = fromString("LocalVariableTable");
351 LocalVariableTypeTable = fromString("LocalVariableTypeTable");
352 MethodParameters = fromString("MethodParameters");
353 Module = fromString("Module");
354 ModuleResolution = fromString("ModuleResolution");
355 NestHost = fromString("NestHost");
356 NestMembers = fromString("NestMembers");
357 LoadableDescriptors = fromString("LoadableDescriptors");
358 Record = fromString("Record");
359 RuntimeInvisibleAnnotations = fromString("RuntimeInvisibleAnnotations");
360 RuntimeInvisibleParameterAnnotations = fromString("RuntimeInvisibleParameterAnnotations");
361 RuntimeInvisibleTypeAnnotations = fromString("RuntimeInvisibleTypeAnnotations");
362 RuntimeVisibleAnnotations = fromString("RuntimeVisibleAnnotations");
363 RuntimeVisibleParameterAnnotations = fromString("RuntimeVisibleParameterAnnotations");
364 RuntimeVisibleTypeAnnotations = fromString("RuntimeVisibleTypeAnnotations");
365 Signature = fromString("Signature");
366 SourceFile = fromString("SourceFile");
367 SourceID = fromString("SourceID");
368 StackMap = fromString("StackMap");
369 StackMapTable = fromString("StackMapTable");
370 Synthetic = fromString("Synthetic");
371 Value = fromString("Value");
372 Varargs = fromString("Varargs");
373 PermittedSubclasses = fromString("PermittedSubclasses");
374
375 // members of java.lang.annotation.ElementType
376 ANNOTATION_TYPE = fromString("ANNOTATION_TYPE");
377 CONSTRUCTOR = fromString("CONSTRUCTOR");
378 FIELD = fromString("FIELD");
379 LOCAL_VARIABLE = fromString("LOCAL_VARIABLE");
380 METHOD = fromString("METHOD");
381 MODULE = fromString("MODULE");
382 PACKAGE = fromString("PACKAGE");
383 PARAMETER = fromString("PARAMETER");
384 TYPE = fromString("TYPE");
385 TYPE_PARAMETER = fromString("TYPE_PARAMETER");
386 TYPE_USE = fromString("TYPE_USE");
387 RECORD_COMPONENT = fromString("RECORD_COMPONENT");
388
389 // members of java.lang.annotation.RetentionPolicy
390 CLASS = fromString("CLASS");
391 RUNTIME = fromString("RUNTIME");
392 SOURCE = fromString("SOURCE");
393
394 // other identifiers
395 T = fromString("T");
396 ex = fromString("ex");
397 module_info = fromString("module-info");
398 package_info = fromString("package-info");
399 requireNonNull = fromString("requireNonNull");
400 main = fromString("main");
401
402 //lambda-related
403 lambda = fromString("lambda$");
404 metafactory = fromString("metafactory");
405 altMetafactory = fromString("altMetafactory");
406
407 // string concat
408 makeConcat = fromString("makeConcat");
409 makeConcatWithConstants = fromString("makeConcatWithConstants");
410
411 dollarValue = fromString("$value");
412
413 bootstrap = fromString("bootstrap");
414 record = fromString("record");
415 non = fromString("non");
416
417 serialPersistentFields = fromString("serialPersistentFields");
418 writeObject = fromString("writeObject");
419 writeReplace = fromString("writeReplace");
420 readObjectNoData = fromString("readObjectNoData");
421
422 // sealed types
423 permits = fromString("permits");
424 sealed = fromString("sealed");
425
426 // templated string
427 process = fromString("process");
428 STR = fromString("STR");
429 RAW = fromString("RAW");
430 newStringTemplate = fromString("newStringTemplate");
431 newLargeStringTemplate = fromString("newLargeStringTemplate");
432 processStringTemplate = fromString("processStringTemplate");
433
434 // pattern switches
435 typeSwitch = fromString("typeSwitch");
436 enumSwitch = fromString("enumSwitch");
437 enumConstant = fromString("enumConstant");
438 }
439
440 protected Name.Table createTable(Options options) {
441 boolean useUnsharedTable = options.isSet("useUnsharedTable");
442 if (useUnsharedTable)
443 return newUnsharedNameTable();
444 boolean useSharedTable = options.isSet("useSharedTable");
445 if (useSharedTable)
446 return newSharedNameTable();
447 boolean internStringTable = options.isSet("internStringTable");
448 return newStringNameTable(internStringTable);
449 }
450
451 public StringNameTable newStringNameTable(boolean intern) {
452 return StringNameTable.create(this, intern);
453 }
454
455 public SharedNameTable newSharedNameTable() {
456 return SharedNameTable.create(this);
457 }
458
459 public UnsharedNameTable newUnsharedNameTable() {
460 return UnsharedNameTable.create(this);
461 }
462
463 public boolean isInit(Name name) {
464 return name == init;
465 }
466
467 public void dispose() {
468 table.dispose();
469 }
470
471 public Name fromChars(char[] cs, int start, int len) {
472 return table.fromChars(cs, start, len);
473 }
474
475 public Name fromString(String s) {
476 return table.fromString(s);
477 }
478
479 public Name fromUtf(byte[] cs) throws InvalidUtfException {
480 return table.fromUtf(cs);
481 }
482
483 public Name fromUtf(byte[] cs, int start, int len, Convert.Validation validation) throws InvalidUtfException {
484 return table.fromUtf(cs, start, len, validation);
485 }
486
487 public Name fromUtfLax(byte[] cs, int start, int len) {
488 try {
489 return table.fromUtf(cs, start, len, Convert.Validation.NONE);
490 } catch (InvalidUtfException e) {
491 throw new AssertionError(e);
492 }
493 }
494 }