1 /*
2 * Copyright (c) 1999, 2025, 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.main;
27
28 import java.io.*;
29 import java.nio.file.FileSystemNotFoundException;
30 import java.nio.file.InvalidPathException;
31 import java.nio.file.ReadOnlyFileSystemException;
32 import java.util.Collection;
33 import java.util.Comparator;
34 import java.util.HashMap;
35 import java.util.HashSet;
36 import java.util.LinkedHashMap;
37 import java.util.LinkedHashSet;
38 import java.util.Map;
39 import java.util.MissingResourceException;
40 import java.util.Queue;
41 import java.util.ResourceBundle;
42 import java.util.Set;
43 import java.util.function.Function;
44 import java.util.function.ToIntFunction;
45
46 import javax.annotation.processing.Processor;
47 import javax.lang.model.SourceVersion;
48 import javax.lang.model.element.ElementVisitor;
49 import javax.tools.DiagnosticListener;
50 import javax.tools.JavaFileManager;
51 import javax.tools.JavaFileObject;
52 import javax.tools.JavaFileObject.Kind;
53 import javax.tools.StandardLocation;
54
55 import com.sun.source.util.TaskEvent;
56 import com.sun.tools.javac.api.MultiTaskListener;
57 import com.sun.tools.javac.code.*;
58 import com.sun.tools.javac.code.Lint.LintCategory;
59 import com.sun.tools.javac.code.Source.Feature;
60 import com.sun.tools.javac.code.Symbol.ClassSymbol;
61 import com.sun.tools.javac.code.Symbol.CompletionFailure;
62 import com.sun.tools.javac.code.Symbol.PackageSymbol;
63 import com.sun.tools.javac.comp.*;
64 import com.sun.tools.javac.comp.CompileStates.CompileState;
65 import com.sun.tools.javac.file.JavacFileManager;
66 import com.sun.tools.javac.jvm.*;
67 import com.sun.tools.javac.parser.*;
68 import com.sun.tools.javac.platform.PlatformDescription;
69 import com.sun.tools.javac.processing.*;
70 import com.sun.tools.javac.tree.*;
71 import com.sun.tools.javac.tree.JCTree.JCClassDecl;
72 import com.sun.tools.javac.tree.JCTree.JCCompilationUnit;
73 import com.sun.tools.javac.tree.JCTree.JCExpression;
74 import com.sun.tools.javac.tree.JCTree.JCLambda;
75 import com.sun.tools.javac.tree.JCTree.JCMemberReference;
76 import com.sun.tools.javac.tree.JCTree.JCMethodDecl;
77 import com.sun.tools.javac.tree.JCTree.JCVariableDecl;
78 import com.sun.tools.javac.util.*;
79 import com.sun.tools.javac.util.Context.Key;
80 import com.sun.tools.javac.util.DefinedBy.Api;
81 import com.sun.tools.javac.util.JCDiagnostic.Factory;
82 import com.sun.tools.javac.util.Log.DiagnosticHandler;
83 import com.sun.tools.javac.util.Log.DiscardDiagnosticHandler;
84 import com.sun.tools.javac.util.Log.WriterKind;
85
86 import static com.sun.tools.javac.code.Kinds.Kind.*;
87
88 import com.sun.tools.javac.code.Lint;
89 import com.sun.tools.javac.code.Lint.LintCategory;
90 import com.sun.tools.javac.code.Symbol.ModuleSymbol;
91
92 import com.sun.tools.javac.resources.CompilerProperties.Errors;
93 import com.sun.tools.javac.resources.CompilerProperties.Fragments;
94 import com.sun.tools.javac.resources.CompilerProperties.Notes;
95 import com.sun.tools.javac.resources.CompilerProperties.Warnings;
96
97 import static com.sun.tools.javac.code.TypeTag.CLASS;
98 import static com.sun.tools.javac.main.Option.*;
99 import com.sun.tools.javac.tree.JCTree.JCBindingPattern;
100 import com.sun.tools.javac.tree.JCTree.JCInstanceOf;
101 import static com.sun.tools.javac.util.JCDiagnostic.DiagnosticFlag.*;
102
103 import static javax.tools.StandardLocation.CLASS_OUTPUT;
104 import static javax.tools.StandardLocation.ANNOTATION_PROCESSOR_PATH;
105
106 import com.sun.tools.javac.tree.JCTree.JCModuleDecl;
107 import com.sun.tools.javac.tree.JCTree.JCRecordPattern;
108 import com.sun.tools.javac.tree.JCTree.JCSwitch;
109 import com.sun.tools.javac.tree.JCTree.JCSwitchExpression;
110
111 /** This class could be the main entry point for GJC when GJC is used as a
112 * component in a larger software system. It provides operations to
113 * construct a new compiler, and to run a new compiler on a set of source
114 * files.
115 *
116 * <p><b>This is NOT part of any supported API.
117 * If you write code that depends on this, you do so at your own risk.
118 * This code and its internal interfaces are subject to change or
119 * deletion without notice.</b>
120 */
121 public class JavaCompiler {
122 /** The context key for the compiler. */
123 public static final Context.Key<JavaCompiler> compilerKey = new Context.Key<>();
124
125 /** Get the JavaCompiler instance for this context. */
126 public static JavaCompiler instance(Context context) {
127 JavaCompiler instance = context.get(compilerKey);
128 if (instance == null)
129 instance = new JavaCompiler(context);
130 return instance;
131 }
132
133 /** The current version number as a string.
134 */
135 public static String version() {
136 return version("release"); // mm.nn.oo[-milestone]
137 }
138
139 /** The current full version number as a string.
140 */
141 public static String fullVersion() {
142 return version("full"); // mm.mm.oo[-milestone]-build
143 }
144
145 private static final String versionRBName = "com.sun.tools.javac.resources.version";
146 private static ResourceBundle versionRB;
147
148 private static String version(String key) {
149 if (versionRB == null) {
150 try {
151 versionRB = ResourceBundle.getBundle(versionRBName);
152 } catch (MissingResourceException e) {
153 return Log.getLocalizedString("version.not.available");
154 }
155 }
156 try {
157 return versionRB.getString(key);
158 }
159 catch (MissingResourceException e) {
160 return Log.getLocalizedString("version.not.available");
161 }
162 }
163
164 /**
165 * Control how the compiler's latter phases (attr, flow, desugar, generate)
166 * are connected. Each individual file is processed by each phase in turn,
167 * but with different compile policies, you can control the order in which
168 * each class is processed through its next phase.
169 *
170 * <p>Generally speaking, the compiler will "fail fast" in the face of
171 * errors, although not aggressively so. flow, desugar, etc become no-ops
172 * once any errors have occurred. No attempt is currently made to determine
173 * if it might be safe to process a class through its next phase because
174 * it does not depend on any unrelated errors that might have occurred.
175 */
176 protected static enum CompilePolicy {
177 /**
178 * Attribute everything, then do flow analysis for everything,
179 * then desugar everything, and only then generate output.
180 * This means no output will be generated if there are any
181 * errors in any classes.
182 */
183 SIMPLE,
184
185 /**
186 * Groups the classes for each source file together, then process
187 * each group in a manner equivalent to the {@code SIMPLE} policy.
188 * This means no output will be generated if there are any
189 * errors in any of the classes in a source file.
190 */
191 BY_FILE,
192
193 /**
194 * Completely process each entry on the todo list in turn.
195 * -- this is the same for 1.5.
196 * Means output might be generated for some classes in a compilation unit
197 * and not others.
198 */
199 BY_TODO;
200
201 static CompilePolicy decode(String option) {
202 if (option == null)
203 return DEFAULT_COMPILE_POLICY;
204 else if (option.equals("simple"))
205 return SIMPLE;
206 else if (option.equals("byfile"))
207 return BY_FILE;
208 else if (option.equals("bytodo"))
209 return BY_TODO;
210 else
211 return DEFAULT_COMPILE_POLICY;
212 }
213 }
214
215 private static final CompilePolicy DEFAULT_COMPILE_POLICY = CompilePolicy.BY_TODO;
216
217 protected static enum ImplicitSourcePolicy {
218 /** Don't generate or process implicitly read source files. */
219 NONE,
220 /** Generate classes for implicitly read source files. */
221 CLASS,
222 /** Like CLASS, but generate warnings if annotation processing occurs */
223 UNSET;
224
225 static ImplicitSourcePolicy decode(String option) {
226 if (option == null)
227 return UNSET;
228 else if (option.equals("none"))
229 return NONE;
230 else if (option.equals("class"))
231 return CLASS;
232 else
233 return UNSET;
234 }
235 }
236
237 /** The log to be used for error reporting.
238 */
239 public Log log;
240
241 /** Whether or not the options lint category was initially disabled
242 */
243 boolean optionsCheckingInitiallyDisabled;
244
245 /** Factory for creating diagnostic objects
246 */
247 JCDiagnostic.Factory diagFactory;
248
249 /** The tree factory module.
250 */
251 protected TreeMaker make;
252
253 /** The class finder.
254 */
255 protected ClassFinder finder;
256
257 /** The class reader.
258 */
259 protected ClassReader reader;
260
261 /** The class writer.
262 */
263 protected ClassWriter writer;
264
265 /** The native header writer.
266 */
267 protected JNIWriter jniWriter;
268
269 /** The module for the symbol table entry phases.
270 */
271 protected Enter enter;
272
273 /** The symbol table.
274 */
275 protected Symtab syms;
276
277 /** The language version.
278 */
279 protected Source source;
280
281 /** The preview language version.
282 */
283 protected Preview preview;
284
285 /** The module for code generation.
286 */
287 protected Gen gen;
288
289 /** The name table.
290 */
291 protected Names names;
292
293 /** The attributor.
294 */
295 protected Attr attr;
296
297 /** The analyzer
298 */
299 protected Analyzer analyzer;
300
301 /** The attributor.
302 */
303 protected Check chk;
304
305 /** The flow analyzer.
306 */
307 protected Flow flow;
308
309 /** The warning analyzer.
310 */
311 protected WarningAnalyzer warningAnalyzer;
312
313 /** The modules visitor
314 */
315 protected Modules modules;
316
317 /** The module finder
318 */
319 protected ModuleFinder moduleFinder;
320
321 /** The diagnostics factory
322 */
323 protected JCDiagnostic.Factory diags;
324
325 protected DeferredCompletionFailureHandler dcfh;
326
327 /** The type eraser.
328 */
329 protected TransTypes transTypes;
330
331 /** The syntactic sugar desweetener.
332 */
333 protected Lower lower;
334
335 /** The annotation annotator.
336 */
337 protected Annotate annotate;
338
339 /** Force a completion failure on this name
340 */
341 protected final Name completionFailureName;
342
343 /** Type utilities.
344 */
345 protected Types types;
346
347 /** Access to file objects.
348 */
349 protected JavaFileManager fileManager;
350
351 /** Factory for parsers.
352 */
353 protected ParserFactory parserFactory;
354
355 /** Broadcasting listener for progress events
356 */
357 protected MultiTaskListener taskListener;
358
359 /**
360 * SourceCompleter that delegates to the readSourceFile method of this class.
361 */
362 protected final Symbol.Completer sourceCompleter =
363 sym -> readSourceFile((ClassSymbol) sym);
364
365 /**
366 * Command line options.
367 */
368 protected Options options;
369
370 protected Context context;
371
372 /**
373 * Flag set if any annotation processing occurred.
374 **/
375 protected boolean annotationProcessingOccurred;
376
377 /**
378 * Flag set if any implicit source files read.
379 **/
380 protected boolean implicitSourceFilesRead;
381
382 private boolean enterDone;
383
384 protected CompileStates compileStates;
385
386 /** Construct a new compiler using a shared context.
387 */
388 @SuppressWarnings("this-escape")
389 public JavaCompiler(Context context) {
390 this.context = context;
391 context.put(compilerKey, this);
392
393 // if fileManager not already set, register the JavacFileManager to be used
394 if (context.get(JavaFileManager.class) == null)
395 JavacFileManager.preRegister(context);
396
397 names = Names.instance(context);
398 log = Log.instance(context);
399 diagFactory = JCDiagnostic.Factory.instance(context);
400 finder = ClassFinder.instance(context);
401 reader = ClassReader.instance(context);
402 make = TreeMaker.instance(context);
403 writer = ClassWriter.instance(context);
404 jniWriter = JNIWriter.instance(context);
405 enter = Enter.instance(context);
406 todo = Todo.instance(context);
407
408 fileManager = context.get(JavaFileManager.class);
409 parserFactory = ParserFactory.instance(context);
410 compileStates = CompileStates.instance(context);
411
412 try {
413 // catch completion problems with predefineds
414 syms = Symtab.instance(context);
415 } catch (CompletionFailure ex) {
416 // inlined Check.completionError as it is not initialized yet
417 log.error(Errors.CantAccess(ex.sym, ex.getDetailValue()));
418 }
419 source = Source.instance(context);
420 preview = Preview.instance(context);
421 attr = Attr.instance(context);
422 analyzer = Analyzer.instance(context);
423 chk = Check.instance(context);
424 gen = Gen.instance(context);
425 flow = Flow.instance(context);
426 warningAnalyzer = WarningAnalyzer.instance(context);
427 transTypes = TransTypes.instance(context);
428 lower = Lower.instance(context);
429 annotate = Annotate.instance(context);
430 types = Types.instance(context);
431 taskListener = MultiTaskListener.instance(context);
432 modules = Modules.instance(context);
433 moduleFinder = ModuleFinder.instance(context);
434 diags = Factory.instance(context);
435 dcfh = DeferredCompletionFailureHandler.instance(context);
436
437 finder.sourceCompleter = sourceCompleter;
438 modules.findPackageInFile = this::findPackageInFile;
439 moduleFinder.moduleNameFromSourceReader = this::readModuleName;
440
441 options = Options.instance(context);
442 // See if lint options checking was explicitly disabled by the
443 // user; this is distinct from the options check being
444 // enabled/disabled.
445 optionsCheckingInitiallyDisabled =
446 options.isSet(Option.XLINT_CUSTOM, "-options") ||
447 options.isSet(Option.XLINT_CUSTOM, "none");
448
449 verbose = options.isSet(VERBOSE);
450 sourceOutput = options.isSet(PRINTSOURCE); // used to be -s
451 lineDebugInfo = options.isUnset(G_CUSTOM) ||
452 options.isSet(G_CUSTOM, "lines");
453 genEndPos = options.isSet(XJCOV) ||
454 context.get(DiagnosticListener.class) != null;
455 devVerbose = options.isSet("dev");
456 processPcks = options.isSet("process.packages");
457 werror = options.isSet(WERROR);
458
459 verboseCompilePolicy = options.isSet("verboseCompilePolicy");
460
461 compilePolicy = CompilePolicy.decode(options.get("compilePolicy"));
462
463 implicitSourcePolicy = ImplicitSourcePolicy.decode(options.get("-implicit"));
464
465 completionFailureName =
466 options.isSet("failcomplete")
467 ? names.fromString(options.get("failcomplete"))
468 : null;
469
470 shouldStopPolicyIfError =
471 options.isSet("should-stop.at") // backwards compatible
472 ? CompileState.valueOf(options.get("should-stop.at"))
473 : options.isSet("should-stop.ifError")
474 ? CompileState.valueOf(options.get("should-stop.ifError"))
475 : CompileState.INIT;
476 shouldStopPolicyIfNoError =
477 options.isSet("should-stop.ifNoError")
478 ? CompileState.valueOf(options.get("should-stop.ifNoError"))
479 : CompileState.GENERATE;
480
481 if (options.isUnset("diags.legacy"))
482 log.setDiagnosticFormatter(RichDiagnosticFormatter.instance(context));
483
484 PlatformDescription platformProvider = context.get(PlatformDescription.class);
485
486 if (platformProvider != null)
487 closeables = closeables.prepend(platformProvider);
488
489 silentFail = new Symbol(ABSENT_TYP, 0, names.empty, Type.noType, syms.rootPackage) {
490 @DefinedBy(Api.LANGUAGE_MODEL)
491 public <R, P> R accept(ElementVisitor<R, P> v, P p) {
492 return v.visitUnknown(this, p);
493 }
494 @Override
495 public boolean exists() {
496 return false;
497 }
498 };
499
500 }
501
502 /* Switches:
503 */
504
505 /** Verbose output.
506 */
507 public boolean verbose;
508
509 /** Emit plain Java source files rather than class files.
510 */
511 public boolean sourceOutput;
512
513
514 /** Generate code with the LineNumberTable attribute for debugging
515 */
516 public boolean lineDebugInfo;
517
518 /** Switch: should we store the ending positions?
519 */
520 public boolean genEndPos;
521
522 /** Switch: should we debug ignored exceptions
523 */
524 protected boolean devVerbose;
525
526 /** Switch: should we (annotation) process packages as well
527 */
528 protected boolean processPcks;
529
530 /** Switch: treat warnings as errors
531 */
532 protected boolean werror;
533
534 /** Switch: is annotation processing requested explicitly via
535 * CompilationTask.setProcessors?
536 */
537 protected boolean explicitAnnotationProcessingRequested = false;
538
539 /**
540 * The policy for the order in which to perform the compilation
541 */
542 protected CompilePolicy compilePolicy;
543
544 /**
545 * The policy for what to do with implicitly read source files
546 */
547 protected ImplicitSourcePolicy implicitSourcePolicy;
548
549 /**
550 * Report activity related to compilePolicy
551 */
552 public boolean verboseCompilePolicy;
553
554 /**
555 * Policy of how far to continue compilation after errors have occurred.
556 * Set this to minimum CompileState (INIT) to stop as soon as possible
557 * after errors.
558 */
559 public CompileState shouldStopPolicyIfError;
560
561 /**
562 * Policy of how far to continue compilation when no errors have occurred.
563 * Set this to maximum CompileState (GENERATE) to perform full compilation.
564 * Set this lower to perform partial compilation, such as -proc:only.
565 */
566 public CompileState shouldStopPolicyIfNoError;
567
568 /** A queue of all as yet unattributed classes.
569 */
570 public Todo todo;
571
572 /** A list of items to be closed when the compilation is complete.
573 */
574 public List<Closeable> closeables = List.nil();
575
576 /** The set of currently compiled inputfiles, needed to ensure
577 * we don't accidentally overwrite an input file when -s is set.
578 * initialized by `compile'.
579 */
580 protected Set<JavaFileObject> inputFiles = new HashSet<>();
581
582 /** Used by the resolveBinaryNameOrIdent to say that the given type cannot be found, and that
583 * an error has already been produced about that.
584 */
585 private final Symbol silentFail;
586
587 protected boolean shouldStop(CompileState cs) {
588 CompileState shouldStopPolicy = (errorCount() > 0 || unrecoverableError())
589 ? shouldStopPolicyIfError
590 : shouldStopPolicyIfNoError;
591 return cs.isAfter(shouldStopPolicy);
592 }
593
594 /** The number of errors reported so far.
595 */
596 public int errorCount() {
597 if (werror && log.nerrors == 0 && log.nwarnings > 0) {
598 log.error(Errors.WarningsAndWerror);
599 }
600 return log.nerrors;
601 }
602
603 protected final <T> Queue<T> stopIfError(CompileState cs, Queue<T> queue) {
604 return shouldStop(cs) ? new ListBuffer<T>() : queue;
605 }
606
607 protected final <T> List<T> stopIfError(CompileState cs, List<T> list) {
608 return shouldStop(cs) ? List.nil() : list;
609 }
610
611 /** The number of warnings reported so far.
612 */
613 public int warningCount() {
614 return log.nwarnings;
615 }
616
617 /** Try to open input stream with given name.
618 * Report an error if this fails.
619 * @param filename The file name of the input stream to be opened.
620 */
621 public CharSequence readSource(JavaFileObject filename) {
622 try {
623 inputFiles.add(filename);
624 return filename.getCharContent(false);
625 } catch (IOException e) {
626 log.error(Errors.ErrorReadingFile(filename, JavacFileManager.getMessage(e)));
627 return null;
628 }
629 }
630
631 /** Parse contents of input stream.
632 * @param filename The name of the file from which input stream comes.
633 * @param content The characters to be parsed.
634 */
635 protected JCCompilationUnit parse(JavaFileObject filename, CharSequence content) {
636 return parse(filename, content, false);
637 }
638
639 /** Parse contents of input stream.
640 * @param filename The name of the file from which input stream comes.
641 * @param content The characters to be parsed.
642 * @param silent true if TaskListeners should not be notified
643 */
644 private JCCompilationUnit parse(JavaFileObject filename, CharSequence content, boolean silent) {
645 long msec = now();
646 JCCompilationUnit tree = make.TopLevel(List.nil());
647 if (content != null) {
648 if (verbose) {
649 log.printVerbose("parsing.started", filename);
650 }
651 if (!taskListener.isEmpty() && !silent) {
652 TaskEvent e = new TaskEvent(TaskEvent.Kind.PARSE, filename);
653 taskListener.started(e);
654 keepComments = true;
655 genEndPos = true;
656 }
657 Parser parser = parserFactory.newParser(content, keepComments(), genEndPos,
658 lineDebugInfo, filename.isNameCompatible("module-info", Kind.SOURCE));
659 tree = parser.parseCompilationUnit();
660 if (verbose) {
661 log.printVerbose("parsing.done", Long.toString(elapsed(msec)));
662 }
663 }
664
665 tree.sourcefile = filename;
666
667 if (content != null && !taskListener.isEmpty() && !silent) {
668 TaskEvent e = new TaskEvent(TaskEvent.Kind.PARSE, tree);
669 taskListener.finished(e);
670 }
671
672 return tree;
673 }
674 // where
675 public boolean keepComments = false;
676 protected boolean keepComments() {
677 return keepComments || sourceOutput;
678 }
679
680
681 /** Parse contents of file.
682 * @param filename The name of the file to be parsed.
683 */
684 @Deprecated
685 public JCTree.JCCompilationUnit parse(String filename) {
686 JavacFileManager fm = (JavacFileManager)fileManager;
687 return parse(fm.getJavaFileObjectsFromStrings(List.of(filename)).iterator().next());
688 }
689
690 /** Parse contents of file.
691 * @param filename The name of the file to be parsed.
692 */
693 public JCTree.JCCompilationUnit parse(JavaFileObject filename) {
694 JavaFileObject prev = log.useSource(filename);
695 try {
696 JCTree.JCCompilationUnit t = parse(filename, readSource(filename));
697 if (t.endPositions != null)
698 log.setEndPosTable(filename, t.endPositions);
699 return t;
700 } finally {
701 log.useSource(prev);
702 }
703 }
704
705 /** Resolve an identifier which may be the binary name of a class or
706 * the Java name of a class or package.
707 * @param name The name to resolve
708 */
709 public Symbol resolveBinaryNameOrIdent(String name) {
710 ModuleSymbol msym;
711 String typeName;
712 int sep = name.indexOf('/');
713 if (sep == -1) {
714 msym = modules.getDefaultModule();
715 typeName = name;
716 } else if (Feature.MODULES.allowedInSource(source)) {
717 Name modName = names.fromString(name.substring(0, sep));
718
719 msym = moduleFinder.findModule(modName);
720 typeName = name.substring(sep + 1);
721 } else {
722 log.error(Errors.InvalidModuleSpecifier(name));
723 return silentFail;
724 }
725
726 return resolveBinaryNameOrIdent(msym, typeName);
727 }
728
729 /** Resolve an identifier which may be the binary name of a class or
730 * the Java name of a class or package.
731 * @param msym The module in which the search should be performed
732 * @param name The name to resolve
733 */
734 public Symbol resolveBinaryNameOrIdent(ModuleSymbol msym, String name) {
735 try {
736 Name flatname = names.fromString(name.replace("/", "."));
737 return finder.loadClass(msym, flatname);
738 } catch (CompletionFailure ignore) {
739 return resolveIdent(msym, name);
740 }
741 }
742
743 /** Resolve an identifier.
744 * @param msym The module in which the search should be performed
745 * @param name The identifier to resolve
746 */
747 public Symbol resolveIdent(ModuleSymbol msym, String name) {
748 if (name.equals(""))
749 return syms.errSymbol;
750 JavaFileObject prev = log.useSource(null);
751 try {
752 JCExpression tree = null;
753 for (String s : name.split("\\.", -1)) {
754 if (!SourceVersion.isIdentifier(s)) // TODO: check for keywords
755 return syms.errSymbol;
756 tree = (tree == null) ? make.Ident(names.fromString(s))
757 : make.Select(tree, names.fromString(s));
758 }
759 JCCompilationUnit toplevel =
760 make.TopLevel(List.nil());
761 toplevel.modle = msym;
762 toplevel.packge = msym.unnamedPackage;
763 return attr.attribIdent(tree, toplevel);
764 } finally {
765 log.useSource(prev);
766 }
767 }
768
769 /** Generate code and emit a class file for a given class
770 * @param env The attribution environment of the outermost class
771 * containing this class.
772 * @param cdef The class definition from which code is generated.
773 */
774 JavaFileObject genCode(Env<AttrContext> env, JCClassDecl cdef) throws IOException {
775 try {
776 if (gen.genClass(env, cdef) && (errorCount() == 0))
777 return writer.writeClass(cdef.sym);
778 } catch (ClassWriter.PoolOverflow ex) {
779 log.error(cdef.pos(), Errors.LimitPool);
780 } catch (ClassWriter.StringOverflow ex) {
781 log.error(cdef.pos(),
782 Errors.LimitStringOverflow(ex.value.substring(0, 20)));
783 } catch (CompletionFailure ex) {
784 chk.completionError(cdef.pos(), ex);
785 }
786 return null;
787 }
788
789 /** Emit plain Java source for a class.
790 * @param env The attribution environment of the outermost class
791 * containing this class.
792 * @param cdef The class definition to be printed.
793 */
794 JavaFileObject printSource(Env<AttrContext> env, JCClassDecl cdef) throws IOException {
795 JavaFileObject outFile
796 = fileManager.getJavaFileForOutput(CLASS_OUTPUT,
797 cdef.sym.flatname.toString(),
798 JavaFileObject.Kind.SOURCE,
799 null);
800 if (inputFiles.contains(outFile)) {
801 log.error(cdef.pos(), Errors.SourceCantOverwriteInputFile(outFile));
802 return null;
803 } else {
804 try (BufferedWriter out = new BufferedWriter(outFile.openWriter())) {
805 new Pretty(out, true).printUnit(env.toplevel, cdef);
806 if (verbose)
807 log.printVerbose("wrote.file", outFile.getName());
808 }
809 return outFile;
810 }
811 }
812
813 /** Compile a source file that has been accessed by the class finder.
814 * @param c The class the source file of which needs to be compiled.
815 */
816 private void readSourceFile(ClassSymbol c) throws CompletionFailure {
817 readSourceFile(null, c);
818 }
819
820 /** Compile a ClassSymbol from source, optionally using the given compilation unit as
821 * the source tree.
822 * @param tree the compilation unit in which the given ClassSymbol resides,
823 * or null if should be parsed from source
824 * @param c the ClassSymbol to complete
825 */
826 public void readSourceFile(JCCompilationUnit tree, ClassSymbol c) throws CompletionFailure {
827 if (completionFailureName == c.fullname) {
828 throw new CompletionFailure(
829 c, () -> diagFactory.fragment(Fragments.UserSelectedCompletionFailure), dcfh);
830 }
831 JavaFileObject filename = c.classfile;
832 JavaFileObject prev = log.useSource(filename);
833
834 if (tree == null) {
835 try {
836 tree = parse(filename, filename.getCharContent(false));
837 } catch (IOException e) {
838 log.error(Errors.ErrorReadingFile(filename, JavacFileManager.getMessage(e)));
839 tree = make.TopLevel(List.<JCTree>nil());
840 } finally {
841 log.useSource(prev);
842 }
843 }
844
845 if (!taskListener.isEmpty()) {
846 TaskEvent e = new TaskEvent(TaskEvent.Kind.ENTER, tree);
847 taskListener.started(e);
848 }
849
850 // Process module declarations.
851 // If module resolution fails, ignore trees, and if trying to
852 // complete a specific symbol, throw CompletionFailure.
853 // Note that if module resolution failed, we may not even
854 // have enough modules available to access java.lang, and
855 // so risk getting FatalError("no.java.lang") from MemberEnter.
856 if (!modules.enter(List.of(tree), c)) {
857 throw new CompletionFailure(c, () -> diags.fragment(Fragments.CantResolveModules), dcfh);
858 }
859
860 enter.complete(List.of(tree), c);
861
862 if (!taskListener.isEmpty()) {
863 TaskEvent e = new TaskEvent(TaskEvent.Kind.ENTER, tree);
864 taskListener.finished(e);
865 }
866
867 if (enter.getEnv(c) == null) {
868 boolean isPkgInfo =
869 tree.sourcefile.isNameCompatible("package-info",
870 JavaFileObject.Kind.SOURCE);
871 boolean isModuleInfo =
872 tree.sourcefile.isNameCompatible("module-info",
873 JavaFileObject.Kind.SOURCE);
874 if (isModuleInfo) {
875 if (enter.getEnv(tree.modle) == null) {
876 JCDiagnostic diag =
877 diagFactory.fragment(Fragments.FileDoesNotContainModule);
878 throw new ClassFinder.BadClassFile(c, filename, diag, diagFactory, dcfh);
879 }
880 } else if (isPkgInfo) {
881 if (enter.getEnv(tree.packge) == null) {
882 JCDiagnostic diag =
883 diagFactory.fragment(Fragments.FileDoesNotContainPackage(c.location()));
884 throw new ClassFinder.BadClassFile(c, filename, diag, diagFactory, dcfh);
885 }
886 } else {
887 JCDiagnostic diag =
888 diagFactory.fragment(Fragments.FileDoesntContainClass(c.getQualifiedName()));
889 throw new ClassFinder.BadClassFile(c, filename, diag, diagFactory, dcfh);
890 }
891 }
892
893 implicitSourceFilesRead = true;
894 }
895
896 /** Track when the JavaCompiler has been used to compile something. */
897 private boolean hasBeenUsed = false;
898 private long start_msec = 0;
899 public long elapsed_msec = 0;
900
901 public void compile(List<JavaFileObject> sourceFileObject)
902 throws Throwable {
903 compile(sourceFileObject, List.nil(), null, List.nil());
904 }
905
906 /**
907 * Main method: compile a list of files, return all compiled classes
908 *
909 * @param sourceFileObjects file objects to be compiled
910 * @param classnames class names to process for annotations
911 * @param processors user provided annotation processors to bypass
912 * discovery, {@code null} means that no processors were provided
913 * @param addModules additional root modules to be used during
914 * module resolution.
915 */
916 public void compile(Collection<JavaFileObject> sourceFileObjects,
917 Collection<String> classnames,
918 Iterable<? extends Processor> processors,
919 Collection<String> addModules)
920 {
921 if (!taskListener.isEmpty()) {
922 taskListener.started(new TaskEvent(TaskEvent.Kind.COMPILATION));
923 }
924
925 // as a JavaCompiler can only be used once, throw an exception if
926 // it has been used before.
927 if (hasBeenUsed)
928 checkReusable();
929 hasBeenUsed = true;
930
931 // forcibly set the equivalent of -Xlint:-options, so that no further
932 // warnings about command line options are generated from this point on
933 options.put(XLINT_CUSTOM.primaryName + "-" + LintCategory.OPTIONS.option, "true");
934 options.remove(XLINT_CUSTOM.primaryName + LintCategory.OPTIONS.option);
935
936 start_msec = now();
937
938 try {
939 initProcessAnnotations(processors, sourceFileObjects, classnames);
940
941 for (String className : classnames) {
942 int sep = className.indexOf('/');
943 if (sep != -1) {
944 modules.addExtraAddModules(className.substring(0, sep));
945 }
946 }
947
948 for (String moduleName : addModules) {
949 modules.addExtraAddModules(moduleName);
950 }
951
952 // These method calls must be chained to avoid memory leaks
953 processAnnotations(
954 enterTrees(
955 stopIfError(CompileState.ENTER,
956 initModules(stopIfError(CompileState.ENTER, parseFiles(sourceFileObjects))))
957 ),
958 classnames
959 );
960
961 // If it's safe to do so, skip attr / flow / gen for implicit classes
962 if (taskListener.isEmpty() &&
963 implicitSourcePolicy == ImplicitSourcePolicy.NONE) {
964 todo.retainFiles(inputFiles);
965 }
966
967 if (!CompileState.ATTR.isAfter(shouldStopPolicyIfNoError)) {
968 switch (compilePolicy) {
969 case SIMPLE:
970 generate(desugar(warn(flow(attribute(todo)))));
971 break;
972
973 case BY_FILE: {
974 Queue<Queue<Env<AttrContext>>> q = todo.groupByFile();
975 while (!q.isEmpty() && !shouldStop(CompileState.ATTR)) {
976 generate(desugar(warn(flow(attribute(q.remove())))));
977 }
978 }
979 break;
980
981 case BY_TODO:
982 while (!todo.isEmpty())
983 generate(desugar(warn(flow(attribute(todo.remove())))));
984 break;
985
986 default:
987 Assert.error("unknown compile policy");
988 }
989 }
990 } catch (Abort ex) {
991 if (devVerbose)
992 ex.printStackTrace(System.err);
993
994 // In case an Abort was thrown before processAnnotations could be called,
995 // we could have deferred diagnostics that haven't been reported.
996 reportDeferredDiagnosticAndClearHandler();
997 } finally {
998 if (verbose) {
999 elapsed_msec = elapsed(start_msec);
1000 log.printVerbose("total", Long.toString(elapsed_msec));
1001 }
1002
1003 reportDeferredDiagnostics();
1004
1005 if (!log.hasDiagnosticListener()) {
1006 printCount("error", errorCount());
1007 printCount("warn", warningCount());
1008 printSuppressedCount(errorCount(), log.nsuppressederrors, "count.error.recompile");
1009 printSuppressedCount(warningCount(), log.nsuppressedwarns, "count.warn.recompile");
1010 }
1011 if (!taskListener.isEmpty()) {
1012 taskListener.finished(new TaskEvent(TaskEvent.Kind.COMPILATION));
1013 }
1014 close();
1015 if (procEnvImpl != null)
1016 procEnvImpl.close();
1017 }
1018 }
1019
1020 protected void checkReusable() {
1021 throw new AssertionError("attempt to reuse JavaCompiler");
1022 }
1023
1024 /**
1025 * The list of classes explicitly supplied on the command line for compilation.
1026 * Not always populated.
1027 */
1028 private List<JCClassDecl> rootClasses;
1029
1030 /**
1031 * Parses a list of files.
1032 */
1033 public List<JCCompilationUnit> parseFiles(Iterable<JavaFileObject> fileObjects) {
1034 return InitialFileParser.instance(context).parse(fileObjects);
1035 }
1036
1037 public List<JCCompilationUnit> parseFiles(Iterable<JavaFileObject> fileObjects, boolean force) {
1038 if (!force && shouldStop(CompileState.PARSE))
1039 return List.nil();
1040
1041 //parse all files
1042 ListBuffer<JCCompilationUnit> trees = new ListBuffer<>();
1043 Set<JavaFileObject> filesSoFar = new HashSet<>();
1044 for (JavaFileObject fileObject : fileObjects) {
1045 if (!filesSoFar.contains(fileObject)) {
1046 filesSoFar.add(fileObject);
1047 trees.append(parse(fileObject));
1048 }
1049 }
1050 return trees.toList();
1051 }
1052
1053 /**
1054 * Returns true iff the compilation will continue after annotation processing
1055 * is done.
1056 */
1057 public boolean continueAfterProcessAnnotations() {
1058 return !shouldStop(CompileState.ATTR);
1059 }
1060
1061 public List<JCCompilationUnit> initModules(List<JCCompilationUnit> roots) {
1062 modules.initModules(roots);
1063 if (roots.isEmpty()) {
1064 enterDone();
1065 }
1066 return roots;
1067 }
1068
1069 /**
1070 * Enter the symbols found in a list of parse trees.
1071 * As a side-effect, this puts elements on the "todo" list.
1072 * Also stores a list of all top level classes in rootClasses.
1073 */
1074 public List<JCCompilationUnit> enterTrees(List<JCCompilationUnit> roots) {
1075 //enter symbols for all files
1076 if (!taskListener.isEmpty()) {
1077 for (JCCompilationUnit unit: roots) {
1078 TaskEvent e = new TaskEvent(TaskEvent.Kind.ENTER, unit);
1079 taskListener.started(e);
1080 }
1081 }
1082
1083 enter.main(roots);
1084
1085 enterDone();
1086
1087 if (!taskListener.isEmpty()) {
1088 for (JCCompilationUnit unit: roots) {
1089 TaskEvent e = new TaskEvent(TaskEvent.Kind.ENTER, unit);
1090 taskListener.finished(e);
1091 }
1092 }
1093
1094 // If generating source, or if tracking public apis,
1095 // then remember the classes declared in
1096 // the original compilation units listed on the command line.
1097 if (sourceOutput) {
1098 ListBuffer<JCClassDecl> cdefs = new ListBuffer<>();
1099 for (JCCompilationUnit unit : roots) {
1100 for (List<JCTree> defs = unit.defs;
1101 defs.nonEmpty();
1102 defs = defs.tail) {
1103 if (defs.head instanceof JCClassDecl classDecl)
1104 cdefs.append(classDecl);
1105 }
1106 }
1107 rootClasses = cdefs.toList();
1108 }
1109
1110 // Ensure the input files have been recorded. Although this is normally
1111 // done by readSource, it may not have been done if the trees were read
1112 // in a prior round of annotation processing, and the trees have been
1113 // cleaned and are being reused.
1114 for (JCCompilationUnit unit : roots) {
1115 inputFiles.add(unit.sourcefile);
1116 }
1117
1118 return roots;
1119 }
1120
1121 /**
1122 * Set to true to enable skeleton annotation processing code.
1123 * Currently, we assume this variable will be replaced more
1124 * advanced logic to figure out if annotation processing is
1125 * needed.
1126 */
1127 boolean processAnnotations = false;
1128
1129 Log.DeferredDiagnosticHandler deferredDiagnosticHandler;
1130
1131 /**
1132 * Object to handle annotation processing.
1133 */
1134 private JavacProcessingEnvironment procEnvImpl = null;
1135
1136 /**
1137 * Check if we should process annotations.
1138 * If so, and if no scanner is yet registered, then set up the DocCommentScanner
1139 * to catch doc comments, and set keepComments so the parser records them in
1140 * the compilation unit.
1141 *
1142 * @param processors user provided annotation processors to bypass
1143 * discovery, {@code null} means that no processors were provided
1144 */
1145 public void initProcessAnnotations(Iterable<? extends Processor> processors,
1146 Collection<? extends JavaFileObject> initialFiles,
1147 Collection<String> initialClassNames) {
1148 if (processors != null && processors.iterator().hasNext())
1149 explicitAnnotationProcessingRequested = true;
1150
1151 if (options.isSet(PROC, "none")) {
1152 processAnnotations = false;
1153 } else if (procEnvImpl == null) {
1154 procEnvImpl = JavacProcessingEnvironment.instance(context);
1155 procEnvImpl.setProcessors(processors);
1156
1157 // Process annotations if processing is requested and there
1158 // is at least one Processor available.
1159 processAnnotations = procEnvImpl.atLeastOneProcessor() &&
1160 explicitAnnotationProcessingRequested();
1161
1162 if (processAnnotations) {
1163 options.put("parameters", "parameters");
1164 reader.saveParameterNames = true;
1165 keepComments = true;
1166 genEndPos = true;
1167 if (!taskListener.isEmpty())
1168 taskListener.started(new TaskEvent(TaskEvent.Kind.ANNOTATION_PROCESSING));
1169 deferredDiagnosticHandler = new Log.DeferredDiagnosticHandler(log);
1170 procEnvImpl.getFiler().setInitialState(initialFiles, initialClassNames);
1171 }
1172 } else { // free resources
1173 procEnvImpl.close();
1174 }
1175 }
1176
1177 // TODO: called by JavacTaskImpl
1178 public void processAnnotations(List<JCCompilationUnit> roots) {
1179 processAnnotations(roots, List.nil());
1180 }
1181
1182 /**
1183 * Process any annotations found in the specified compilation units.
1184 * @param roots a list of compilation units
1185 */
1186 // Implementation note: when this method is called, log.deferredDiagnostics
1187 // will have been set true by initProcessAnnotations, meaning that any diagnostics
1188 // that are reported will go into the log.deferredDiagnostics queue.
1189 // By the time this method exits, log.deferDiagnostics must be set back to false,
1190 // and all deferredDiagnostics must have been handled: i.e. either reported
1191 // or determined to be transient, and therefore suppressed.
1192 public void processAnnotations(List<JCCompilationUnit> roots,
1193 Collection<String> classnames) {
1194 if (shouldStop(CompileState.PROCESS)) {
1195 // Errors were encountered.
1196 // Unless all the errors are resolve errors, the errors were parse errors
1197 // or other errors during enter which cannot be fixed by running
1198 // any annotation processors.
1199 if (processAnnotations) {
1200 reportDeferredDiagnosticAndClearHandler();
1201 return ;
1202 }
1203 }
1204
1205 // ASSERT: processAnnotations and procEnvImpl should have been set up by
1206 // by initProcessAnnotations
1207
1208 // NOTE: The !classnames.isEmpty() checks should be refactored to Main.
1209
1210 if (!processAnnotations) {
1211 // If there are no annotation processors present, and
1212 // annotation processing is to occur with compilation,
1213 // emit a warning.
1214 if (options.isSet(PROC, "only")) {
1215 log.warning(Warnings.ProcProcOnlyRequestedNoProcs);
1216 todo.clear();
1217 }
1218 // If not processing annotations, classnames must be empty
1219 if (!classnames.isEmpty()) {
1220 log.error(Errors.ProcNoExplicitAnnotationProcessingRequested(classnames));
1221 }
1222 Assert.checkNull(deferredDiagnosticHandler);
1223 return ; // continue regular compilation
1224 }
1225
1226 Assert.checkNonNull(deferredDiagnosticHandler);
1227
1228 try {
1229 List<ClassSymbol> classSymbols = List.nil();
1230 List<PackageSymbol> pckSymbols = List.nil();
1231 if (!classnames.isEmpty()) {
1232 // Check for explicit request for annotation
1233 // processing
1234 if (!explicitAnnotationProcessingRequested()) {
1235 log.error(Errors.ProcNoExplicitAnnotationProcessingRequested(classnames));
1236 reportDeferredDiagnosticAndClearHandler();
1237 return ; // TODO: Will this halt compilation?
1238 } else {
1239 boolean errors = false;
1240 for (String nameStr : classnames) {
1241 Symbol sym = resolveBinaryNameOrIdent(nameStr);
1242 if (sym == null ||
1243 (sym.kind == PCK && !processPcks) ||
1244 sym.kind == ABSENT_TYP) {
1245 if (sym != silentFail)
1246 log.error(Errors.ProcCantFindClass(nameStr));
1247 errors = true;
1248 continue;
1249 }
1250 try {
1251 if (sym.kind == PCK)
1252 sym.complete();
1253 if (sym.exists()) {
1254 if (sym.kind == PCK)
1255 pckSymbols = pckSymbols.prepend((PackageSymbol)sym);
1256 else
1257 classSymbols = classSymbols.prepend((ClassSymbol)sym);
1258 continue;
1259 }
1260 Assert.check(sym.kind == PCK);
1261 log.warning(Warnings.ProcPackageDoesNotExist(nameStr));
1262 pckSymbols = pckSymbols.prepend((PackageSymbol)sym);
1263 } catch (CompletionFailure e) {
1264 log.error(Errors.ProcCantFindClass(nameStr));
1265 errors = true;
1266 continue;
1267 }
1268 }
1269 if (errors) {
1270 reportDeferredDiagnosticAndClearHandler();
1271 return ;
1272 }
1273 }
1274 }
1275 try {
1276 annotationProcessingOccurred =
1277 procEnvImpl.doProcessing(roots,
1278 classSymbols,
1279 pckSymbols,
1280 deferredDiagnosticHandler);
1281 // doProcessing will have handled deferred diagnostics
1282 } finally {
1283 procEnvImpl.close();
1284 }
1285 } catch (CompletionFailure ex) {
1286 log.error(Errors.CantAccess(ex.sym, ex.getDetailValue()));
1287 reportDeferredDiagnosticAndClearHandler();
1288 }
1289 }
1290
1291 private boolean unrecoverableError() {
1292 if (deferredDiagnosticHandler != null) {
1293 for (JCDiagnostic d: deferredDiagnosticHandler.getDiagnostics()) {
1294 if (d.getKind() == JCDiagnostic.Kind.ERROR && !d.isFlagSet(RECOVERABLE))
1295 return true;
1296 }
1297 }
1298 return false;
1299 }
1300
1301 boolean explicitAnnotationProcessingRequested() {
1302 return
1303 explicitAnnotationProcessingRequested ||
1304 explicitAnnotationProcessingRequested(options, fileManager);
1305 }
1306
1307 static boolean explicitAnnotationProcessingRequested(Options options, JavaFileManager fileManager) {
1308 return
1309 options.isSet(PROCESSOR) ||
1310 options.isSet(PROCESSOR_PATH) ||
1311 options.isSet(PROCESSOR_MODULE_PATH) ||
1312 options.isSet(PROC, "only") ||
1313 options.isSet(PROC, "full") ||
1314 options.isSet(A) ||
1315 options.isSet(XPRINT) ||
1316 fileManager.hasLocation(ANNOTATION_PROCESSOR_PATH);
1317 // Skipping -XprintRounds and -XprintProcessorInfo
1318 }
1319
1320 public void setDeferredDiagnosticHandler(Log.DeferredDiagnosticHandler deferredDiagnosticHandler) {
1321 this.deferredDiagnosticHandler = deferredDiagnosticHandler;
1322 }
1323
1324 /**
1325 * Attribute a list of parse trees, such as found on the "todo" list.
1326 * Note that attributing classes may cause additional files to be
1327 * parsed and entered via the SourceCompleter.
1328 * Attribution of the entries in the list does not stop if any errors occur.
1329 * @return a list of environments for attribute classes.
1330 */
1331 public Queue<Env<AttrContext>> attribute(Queue<Env<AttrContext>> envs) {
1332 ListBuffer<Env<AttrContext>> results = new ListBuffer<>();
1333 while (!envs.isEmpty())
1334 results.append(attribute(envs.remove()));
1335 return stopIfError(CompileState.ATTR, results);
1336 }
1337
1338 /**
1339 * Attribute a parse tree.
1340 * @return the attributed parse tree
1341 */
1342 public Env<AttrContext> attribute(Env<AttrContext> env) {
1343 if (compileStates.isDone(env, CompileState.ATTR))
1344 return env;
1345
1346 if (verboseCompilePolicy)
1347 printNote("[attribute " + env.enclClass.sym + "]");
1348 if (verbose)
1349 log.printVerbose("checking.attribution", env.enclClass.sym);
1350
1351 if (!taskListener.isEmpty()) {
1352 TaskEvent e = newAnalyzeTaskEvent(env);
1353 taskListener.started(e);
1354 }
1355
1356 JavaFileObject prev = log.useSource(
1357 env.enclClass.sym.sourcefile != null ?
1358 env.enclClass.sym.sourcefile :
1359 env.toplevel.sourcefile);
1360 try {
1361 attr.attrib(env);
1362 if (errorCount() > 0 && !shouldStop(CompileState.ATTR)) {
1363 //if in fail-over mode, ensure that AST expression nodes
1364 //are correctly initialized (e.g. they have a type/symbol)
1365 attr.postAttr(env.tree);
1366 }
1367 compileStates.put(env, CompileState.ATTR);
1368 }
1369 finally {
1370 log.useSource(prev);
1371 }
1372
1373 return env;
1374 }
1375
1376 /**
1377 * Perform dataflow checks on attributed parse trees.
1378 * These include checks for definite assignment and unreachable statements.
1379 * If any errors occur, an empty list will be returned.
1380 * @return the list of attributed parse trees
1381 */
1382 public Queue<Env<AttrContext>> flow(Queue<Env<AttrContext>> envs) {
1383 ListBuffer<Env<AttrContext>> results = new ListBuffer<>();
1384 for (Env<AttrContext> env: envs) {
1385 flow(env, results);
1386 }
1387 return stopIfError(CompileState.FLOW, results);
1388 }
1389
1390 /**
1391 * Perform dataflow checks on an attributed parse tree.
1392 */
1393 public Queue<Env<AttrContext>> flow(Env<AttrContext> env) {
1394 ListBuffer<Env<AttrContext>> results = new ListBuffer<>();
1395 flow(env, results);
1396 return stopIfError(CompileState.FLOW, results);
1397 }
1398
1399 /**
1400 * Perform dataflow checks on an attributed parse tree.
1401 */
1402 protected void flow(Env<AttrContext> env, Queue<Env<AttrContext>> results) {
1403 if (compileStates.isDone(env, CompileState.FLOW)) {
1404 results.add(env);
1405 return;
1406 }
1407
1408 try {
1409 if (shouldStop(CompileState.FLOW))
1410 return;
1411
1412 if (verboseCompilePolicy)
1413 printNote("[flow " + env.enclClass.sym + "]");
1414 JavaFileObject prev = log.useSource(
1415 env.enclClass.sym.sourcefile != null ?
1416 env.enclClass.sym.sourcefile :
1417 env.toplevel.sourcefile);
1418 try {
1419 make.at(Position.FIRSTPOS);
1420 TreeMaker localMake = make.forToplevel(env.toplevel);
1421 flow.analyzeTree(env, localMake);
1422 compileStates.put(env, CompileState.FLOW);
1423
1424 if (shouldStop(CompileState.FLOW))
1425 return;
1426
1427 analyzer.flush(env);
1428
1429 results.add(env);
1430 }
1431 finally {
1432 log.useSource(prev);
1433 }
1434 }
1435 finally {
1436 if (!taskListener.isEmpty()) {
1437 TaskEvent e = newAnalyzeTaskEvent(env);
1438 taskListener.finished(e);
1439 }
1440 }
1441 }
1442
1443 /**
1444 * Check for various things to warn about.
1445 *
1446 * @return the list of attributed parse trees
1447 */
1448 public Queue<Env<AttrContext>> warn(Queue<Env<AttrContext>> envs) {
1449 ListBuffer<Env<AttrContext>> results = new ListBuffer<>();
1450 for (Env<AttrContext> env: envs) {
1451 warn(env, results);
1452 }
1453 return stopIfError(CompileState.WARN, results);
1454 }
1455
1456 /**
1457 * Check for various things to warn about in an attributed parse tree.
1458 */
1459 public Queue<Env<AttrContext>> warn(Env<AttrContext> env) {
1460 ListBuffer<Env<AttrContext>> results = new ListBuffer<>();
1461 warn(env, results);
1462 return stopIfError(CompileState.WARN, results);
1463 }
1464
1465 /**
1466 * Check for various things to warn about in an attributed parse tree.
1467 */
1468 protected void warn(Env<AttrContext> env, Queue<Env<AttrContext>> results) {
1469 if (compileStates.isDone(env, CompileState.WARN)) {
1470 results.add(env);
1471 return;
1472 }
1473
1474 if (shouldStop(CompileState.WARN))
1475 return;
1476
1477 if (verboseCompilePolicy)
1478 printNote("[warn " + env.enclClass.sym + "]");
1479 JavaFileObject prev = log.useSource(
1480 env.enclClass.sym.sourcefile != null ?
1481 env.enclClass.sym.sourcefile :
1482 env.toplevel.sourcefile);
1483 try {
1484 warningAnalyzer.analyzeTree(env);
1485 compileStates.put(env, CompileState.WARN);
1486 results.add(env);
1487 }
1488 finally {
1489 log.useSource(prev);
1490 }
1491 }
1492
1493 private TaskEvent newAnalyzeTaskEvent(Env<AttrContext> env) {
1494 JCCompilationUnit toplevel = env.toplevel;
1495 ClassSymbol sym;
1496 if (env.enclClass.sym == syms.predefClass) {
1497 if (TreeInfo.isModuleInfo(toplevel)) {
1498 sym = toplevel.modle.module_info;
1499 } else if (TreeInfo.isPackageInfo(toplevel)) {
1500 sym = toplevel.packge.package_info;
1501 } else {
1502 throw new IllegalStateException("unknown env.toplevel");
1503 }
1504 } else {
1505 sym = env.enclClass.sym;
1506 }
1507
1508 return new TaskEvent(TaskEvent.Kind.ANALYZE, toplevel, sym);
1509 }
1510
1511 /**
1512 * Prepare attributed parse trees, in conjunction with their attribution contexts,
1513 * for source or code generation.
1514 * If any errors occur, an empty list will be returned.
1515 * @return a list containing the classes to be generated
1516 */
1517 public Queue<Pair<Env<AttrContext>, JCClassDecl>> desugar(Queue<Env<AttrContext>> envs) {
1518 ListBuffer<Pair<Env<AttrContext>, JCClassDecl>> results = new ListBuffer<>();
1519 for (Env<AttrContext> env: envs)
1520 desugar(env, results);
1521 return stopIfError(CompileState.FLOW, results);
1522 }
1523
1524 HashMap<Env<AttrContext>, Queue<Pair<Env<AttrContext>, JCClassDecl>>> desugaredEnvs = new HashMap<>();
1525
1526 /**
1527 * Prepare attributed parse trees, in conjunction with their attribution contexts,
1528 * for source or code generation. If the file was not listed on the command line,
1529 * the current implicitSourcePolicy is taken into account.
1530 * The preparation stops as soon as an error is found.
1531 */
1532 protected void desugar(final Env<AttrContext> env, Queue<Pair<Env<AttrContext>, JCClassDecl>> results) {
1533 if (shouldStop(CompileState.TRANSTYPES))
1534 return;
1535
1536 if (implicitSourcePolicy == ImplicitSourcePolicy.NONE
1537 && !inputFiles.contains(env.toplevel.sourcefile)) {
1538 return;
1539 }
1540
1541 if (!modules.multiModuleMode && env.toplevel.modle != modules.getDefaultModule()) {
1542 //can only generate classfiles for a single module:
1543 return;
1544 }
1545
1546 if (compileStates.isDone(env, CompileState.LOWER)) {
1547 results.addAll(desugaredEnvs.get(env));
1548 return;
1549 }
1550
1551 // Ensure the file has reached the WARN state
1552 if (!compileStates.isDone(env, CompileState.WARN))
1553 warn(env);
1554
1555 /**
1556 * Ensure that superclasses of C are desugared before C itself. This is
1557 * required for two reasons: (i) as erasure (TransTypes) destroys
1558 * information needed in flow analysis and (ii) as some checks carried
1559 * out during lowering require that all synthetic fields/methods have
1560 * already been added to C and its superclasses.
1561 */
1562 class ScanNested extends TreeScanner {
1563 Set<Env<AttrContext>> dependencies = new LinkedHashSet<>();
1564 protected boolean hasLambdas;
1565 protected boolean hasPatterns;
1566 @Override
1567 public void visitClassDef(JCClassDecl node) {
1568 Type st = types.supertype(node.sym.type);
1569 boolean envForSuperTypeFound = false;
1570 while (!envForSuperTypeFound && st.hasTag(CLASS)) {
1571 ClassSymbol c = st.tsym.outermostClass();
1572 Env<AttrContext> stEnv = enter.getEnv(c);
1573 if (stEnv != null && env != stEnv) {
1574 if (dependencies.add(stEnv)) {
1575 boolean prevHasLambdas = hasLambdas;
1576 boolean prevHasPatterns = hasPatterns;
1577 try {
1578 scan(stEnv.tree);
1579 } finally {
1580 /*
1581 * ignore any updates to hasLambdas and hasPatterns
1582 * made during the nested scan, this ensures an
1583 * initialized LambdaToMethod or TransPatterns is
1584 * available only to those classes that contain
1585 * lambdas or patterns, respectivelly
1586 */
1587 hasLambdas = prevHasLambdas;
1588 hasPatterns = prevHasPatterns;
1589 }
1590 }
1591 envForSuperTypeFound = true;
1592 }
1593 st = types.supertype(st);
1594 }
1595 super.visitClassDef(node);
1596 }
1597 @Override
1598 public void visitLambda(JCLambda tree) {
1599 hasLambdas = true;
1600 super.visitLambda(tree);
1601 }
1602 @Override
1603 public void visitReference(JCMemberReference tree) {
1604 hasLambdas = true;
1605 super.visitReference(tree);
1606 }
1607 @Override
1608 public void visitBindingPattern(JCBindingPattern tree) {
1609 hasPatterns = true;
1610 super.visitBindingPattern(tree);
1611 }
1612 @Override
1613 public void visitTypeTest(JCInstanceOf tree) {
1614 if (tree.pattern.type.isPrimitive()) {
1615 hasPatterns = true;
1616 }
1617 super.visitTypeTest(tree);
1618 }
1619 @Override
1620 public void visitRecordPattern(JCRecordPattern that) {
1621 hasPatterns = true;
1622 super.visitRecordPattern(that);
1623 }
1624 @Override
1625 public void visitSwitch(JCSwitch tree) {
1626 hasPatterns |= tree.patternSwitch;
1627 super.visitSwitch(tree);
1628 }
1629 @Override
1630 public void visitSwitchExpression(JCSwitchExpression tree) {
1631 hasPatterns |= tree.patternSwitch;
1632 super.visitSwitchExpression(tree);
1633 }
1634 }
1635 ScanNested scanner = new ScanNested();
1636 scanner.scan(env.tree);
1637 for (Env<AttrContext> dep: scanner.dependencies) {
1638 if (!compileStates.isDone(dep, CompileState.WARN))
1639 desugaredEnvs.put(dep, desugar(warn(flow(attribute(dep)))));
1640 }
1641
1642 //We need to check for error another time as more classes might
1643 //have been attributed and analyzed at this stage
1644 if (shouldStop(CompileState.TRANSTYPES))
1645 return;
1646
1647 if (verboseCompilePolicy)
1648 printNote("[desugar " + env.enclClass.sym + "]");
1649
1650 JavaFileObject prev = log.useSource(env.enclClass.sym.sourcefile != null ?
1651 env.enclClass.sym.sourcefile :
1652 env.toplevel.sourcefile);
1653 try {
1654 //save tree prior to rewriting
1655 JCTree untranslated = env.tree;
1656
1657 make.at(Position.FIRSTPOS);
1658 TreeMaker localMake = make.forToplevel(env.toplevel);
1659
1660 if (env.tree.hasTag(JCTree.Tag.PACKAGEDEF) || env.tree.hasTag(JCTree.Tag.MODULEDEF)) {
1661 if (!(sourceOutput)) {
1662 if (shouldStop(CompileState.LOWER))
1663 return;
1664 List<JCTree> def = lower.translateTopLevelClass(env, env.tree, localMake);
1665 if (def.head != null) {
1666 Assert.check(def.tail.isEmpty());
1667 results.add(new Pair<>(env, (JCClassDecl)def.head));
1668 }
1669 }
1670 return;
1671 }
1672
1673 if (shouldStop(CompileState.TRANSTYPES))
1674 return;
1675
1676 env.tree = transTypes.translateTopLevelClass(env.tree, localMake);
1677 compileStates.put(env, CompileState.TRANSTYPES);
1678
1679 if (shouldStop(CompileState.TRANSPATTERNS))
1680 return;
1681
1682 if (scanner.hasPatterns) {
1683 env.tree = TransPatterns.instance(context).translateTopLevelClass(env, env.tree, localMake);
1684 }
1685
1686 compileStates.put(env, CompileState.TRANSPATTERNS);
1687
1688 if (shouldStop(CompileState.LOWER))
1689 return;
1690
1691 if (sourceOutput) {
1692 //emit standard Java source file, only for compilation
1693 //units enumerated explicitly on the command line
1694 JCClassDecl cdef = (JCClassDecl)env.tree;
1695 if (untranslated instanceof JCClassDecl classDecl &&
1696 rootClasses.contains(classDecl)) {
1697 results.add(new Pair<>(env, cdef));
1698 }
1699 return;
1700 }
1701
1702 //translate out inner classes
1703 List<JCTree> cdefs = lower.translateTopLevelClass(env, env.tree, localMake);
1704 compileStates.put(env, CompileState.LOWER);
1705
1706 if (shouldStop(CompileState.LOWER))
1707 return;
1708
1709 if (scanner.hasLambdas) {
1710 if (shouldStop(CompileState.UNLAMBDA))
1711 return;
1712
1713 for (JCTree def : cdefs) {
1714 LambdaToMethod.instance(context).translateTopLevelClass(env, def, localMake);
1715 }
1716 compileStates.put(env, CompileState.UNLAMBDA);
1717 }
1718
1719 //generate code for each class
1720 for (List<JCTree> l = cdefs; l.nonEmpty(); l = l.tail) {
1721 JCClassDecl cdef = (JCClassDecl)l.head;
1722 results.add(new Pair<>(env, cdef));
1723 }
1724 }
1725 finally {
1726 log.useSource(prev);
1727 }
1728
1729 }
1730
1731 /** Generates the source or class file for a list of classes.
1732 * The decision to generate a source file or a class file is
1733 * based upon the compiler's options.
1734 * Generation stops if an error occurs while writing files.
1735 */
1736 public void generate(Queue<Pair<Env<AttrContext>, JCClassDecl>> queue) {
1737 generate(queue, null);
1738 }
1739
1740 public void generate(Queue<Pair<Env<AttrContext>, JCClassDecl>> queue, Queue<JavaFileObject> results) {
1741 if (shouldStop(CompileState.GENERATE))
1742 return;
1743
1744 for (Pair<Env<AttrContext>, JCClassDecl> x: queue) {
1745 Env<AttrContext> env = x.fst;
1746 JCClassDecl cdef = x.snd;
1747
1748 if (verboseCompilePolicy) {
1749 printNote("[generate " + (sourceOutput ? " source" : "code") + " " + cdef.sym + "]");
1750 }
1751
1752 if (!taskListener.isEmpty()) {
1753 TaskEvent e = new TaskEvent(TaskEvent.Kind.GENERATE, env.toplevel, cdef.sym);
1754 taskListener.started(e);
1755 }
1756
1757 JavaFileObject prev = log.useSource(env.enclClass.sym.sourcefile != null ?
1758 env.enclClass.sym.sourcefile :
1759 env.toplevel.sourcefile);
1760 try {
1761 JavaFileObject file;
1762 if (sourceOutput) {
1763 file = printSource(env, cdef);
1764 } else {
1765 if (fileManager.hasLocation(StandardLocation.NATIVE_HEADER_OUTPUT)
1766 && jniWriter.needsHeader(cdef.sym)) {
1767 jniWriter.write(cdef.sym);
1768 }
1769 file = genCode(env, cdef);
1770 }
1771 if (results != null && file != null)
1772 results.add(file);
1773 } catch (IOException
1774 | UncheckedIOException
1775 | FileSystemNotFoundException
1776 | InvalidPathException
1777 | ReadOnlyFileSystemException ex) {
1778 log.error(cdef.pos(),
1779 Errors.ClassCantWrite(cdef.sym, ex.getMessage()));
1780 return;
1781 } finally {
1782 log.useSource(prev);
1783 }
1784
1785 if (!taskListener.isEmpty()) {
1786 TaskEvent e = new TaskEvent(TaskEvent.Kind.GENERATE, env.toplevel, cdef.sym);
1787 taskListener.finished(e);
1788 }
1789 }
1790 }
1791
1792 // where
1793 Map<JCCompilationUnit, Queue<Env<AttrContext>>> groupByFile(Queue<Env<AttrContext>> envs) {
1794 // use a LinkedHashMap to preserve the order of the original list as much as possible
1795 Map<JCCompilationUnit, Queue<Env<AttrContext>>> map = new LinkedHashMap<>();
1796 for (Env<AttrContext> env: envs) {
1797 Queue<Env<AttrContext>> sublist = map.get(env.toplevel);
1798 if (sublist == null) {
1799 sublist = new ListBuffer<>();
1800 map.put(env.toplevel, sublist);
1801 }
1802 sublist.add(env);
1803 }
1804 return map;
1805 }
1806
1807 JCClassDecl removeMethodBodies(JCClassDecl cdef) {
1808 final boolean isInterface = (cdef.mods.flags & Flags.INTERFACE) != 0;
1809 class MethodBodyRemover extends TreeTranslator {
1810 @Override
1811 public void visitMethodDef(JCMethodDecl tree) {
1812 tree.mods.flags &= ~Flags.SYNCHRONIZED;
1813 for (JCVariableDecl vd : tree.params)
1814 vd.mods.flags &= ~Flags.FINAL;
1815 tree.body = null;
1816 super.visitMethodDef(tree);
1817 }
1818 @Override
1819 public void visitVarDef(JCVariableDecl tree) {
1820 if (tree.init != null && tree.init.type.constValue() == null)
1821 tree.init = null;
1822 super.visitVarDef(tree);
1823 }
1824 @Override
1825 public void visitClassDef(JCClassDecl tree) {
1826 ListBuffer<JCTree> newdefs = new ListBuffer<>();
1827 for (List<JCTree> it = tree.defs; it.tail != null; it = it.tail) {
1828 JCTree t = it.head;
1829 switch (t.getTag()) {
1830 case CLASSDEF:
1831 if (isInterface ||
1832 (((JCClassDecl) t).mods.flags & (Flags.PROTECTED|Flags.PUBLIC)) != 0 ||
1833 (((JCClassDecl) t).mods.flags & (Flags.PRIVATE)) == 0 && ((JCClassDecl) t).sym.packge().getQualifiedName() == names.java_lang)
1834 newdefs.append(t);
1835 break;
1836 case METHODDEF:
1837 if (isInterface ||
1838 (((JCMethodDecl) t).mods.flags & (Flags.PROTECTED|Flags.PUBLIC)) != 0 ||
1839 ((JCMethodDecl) t).sym.name == names.init ||
1840 (((JCMethodDecl) t).mods.flags & (Flags.PRIVATE)) == 0 && ((JCMethodDecl) t).sym.packge().getQualifiedName() == names.java_lang)
1841 newdefs.append(t);
1842 break;
1843 case VARDEF:
1844 if (isInterface || (((JCVariableDecl) t).mods.flags & (Flags.PROTECTED|Flags.PUBLIC)) != 0 ||
1845 (((JCVariableDecl) t).mods.flags & (Flags.PRIVATE)) == 0 && ((JCVariableDecl) t).sym.packge().getQualifiedName() == names.java_lang)
1846 newdefs.append(t);
1847 break;
1848 default:
1849 break;
1850 }
1851 }
1852 tree.defs = newdefs.toList();
1853 super.visitClassDef(tree);
1854 }
1855 }
1856 MethodBodyRemover r = new MethodBodyRemover();
1857 return r.translate(cdef);
1858 }
1859
1860 public void reportDeferredDiagnostics() {
1861 if (errorCount() == 0
1862 && annotationProcessingOccurred
1863 && implicitSourceFilesRead
1864 && implicitSourcePolicy == ImplicitSourcePolicy.UNSET) {
1865 if (explicitAnnotationProcessingRequested())
1866 log.warning(Warnings.ProcUseImplicit);
1867 else
1868 log.warning(Warnings.ProcUseProcOrImplicit);
1869 }
1870 chk.reportDeferredDiagnostics();
1871 preview.reportDeferredDiagnostics();
1872 if (log.compressedOutput) {
1873 log.mandatoryNote(null, Notes.CompressedDiags);
1874 }
1875 }
1876
1877 public void enterDone() {
1878 enterDone = true;
1879 annotate.enterDone();
1880 }
1881
1882 public boolean isEnterDone() {
1883 return enterDone;
1884 }
1885
1886 private Name readModuleName(JavaFileObject fo) {
1887 return parseAndGetName(fo, t -> {
1888 JCModuleDecl md = t.getModuleDecl();
1889
1890 return md != null ? TreeInfo.fullName(md.getName()) : null;
1891 });
1892 }
1893
1894 private Name findPackageInFile(JavaFileObject fo) {
1895 return parseAndGetName(fo, t -> t.getPackage() != null ?
1896 TreeInfo.fullName(t.getPackage().getPackageName()) : null);
1897 }
1898
1899 private Name parseAndGetName(JavaFileObject fo,
1900 Function<JCTree.JCCompilationUnit, Name> tree2Name) {
1901 DiagnosticHandler dh = new DiscardDiagnosticHandler(log);
1902 JavaFileObject prevSource = log.useSource(fo);
1903 try {
1904 JCTree.JCCompilationUnit t = parse(fo, fo.getCharContent(false), true);
1905 return tree2Name.apply(t);
1906 } catch (IOException e) {
1907 return null;
1908 } finally {
1909 log.popDiagnosticHandler(dh);
1910 log.useSource(prevSource);
1911 }
1912 }
1913
1914 public void reportDeferredDiagnosticAndClearHandler() {
1915 if (deferredDiagnosticHandler != null) {
1916 ToIntFunction<JCDiagnostic> diagValue =
1917 d -> d.isFlagSet(RECOVERABLE) ? 1 : 0;
1918 Comparator<JCDiagnostic> compareDiags =
1919 (d1, d2) -> diagValue.applyAsInt(d1) - diagValue.applyAsInt(d2);
1920 deferredDiagnosticHandler.reportDeferredDiagnostics(compareDiags);
1921 log.popDiagnosticHandler(deferredDiagnosticHandler);
1922 deferredDiagnosticHandler = null;
1923 }
1924 }
1925
1926 /** Close the compiler, flushing the logs
1927 */
1928 public void close() {
1929 rootClasses = null;
1930 finder = null;
1931 reader = null;
1932 make = null;
1933 writer = null;
1934 enter = null;
1935 if (todo != null)
1936 todo.clear();
1937 todo = null;
1938 parserFactory = null;
1939 syms = null;
1940 source = null;
1941 attr = null;
1942 chk = null;
1943 gen = null;
1944 flow = null;
1945 transTypes = null;
1946 lower = null;
1947 annotate = null;
1948 types = null;
1949
1950 log.flush();
1951 try {
1952 fileManager.flush();
1953 } catch (IOException e) {
1954 throw new Abort(e);
1955 } finally {
1956 if (names != null)
1957 names.dispose();
1958 names = null;
1959
1960 FatalError fatalError = null;
1961 for (Closeable c: closeables) {
1962 try {
1963 c.close();
1964 } catch (IOException e) {
1965 if (fatalError == null) {
1966 JCDiagnostic msg = diagFactory.fragment(Fragments.FatalErrCantClose);
1967 fatalError = new FatalError(msg, e);
1968 } else {
1969 fatalError.addSuppressed(e);
1970 }
1971 }
1972 }
1973 if (fatalError != null) {
1974 throw fatalError;
1975 }
1976 closeables = List.nil();
1977 }
1978 }
1979
1980 protected void printNote(String lines) {
1981 log.printRawLines(Log.WriterKind.NOTICE, lines);
1982 }
1983
1984 /** Print numbers of errors and warnings.
1985 */
1986 public void printCount(String kind, int count) {
1987 if (count != 0) {
1988 String key;
1989 if (count == 1)
1990 key = "count." + kind;
1991 else
1992 key = "count." + kind + ".plural";
1993 log.printLines(WriterKind.ERROR, key, String.valueOf(count));
1994 log.flush(Log.WriterKind.ERROR);
1995 }
1996 }
1997
1998 private void printSuppressedCount(int shown, int suppressed, String diagKey) {
1999 if (suppressed > 0) {
2000 int total = shown + suppressed;
2001 log.printLines(WriterKind.ERROR, diagKey,
2002 String.valueOf(shown), String.valueOf(total));
2003 log.flush(Log.WriterKind.ERROR);
2004 }
2005 }
2006
2007 private static long now() {
2008 return System.currentTimeMillis();
2009 }
2010
2011 private static long elapsed(long then) {
2012 return now() - then;
2013 }
2014
2015 public void newRound() {
2016 inputFiles.clear();
2017 todo.clear();
2018 }
2019
2020 public interface InitialFileParserIntf {
2021 public List<JCCompilationUnit> parse(Iterable<JavaFileObject> files);
2022 }
2023
2024 public static class InitialFileParser implements InitialFileParserIntf {
2025
2026 public static final Key<InitialFileParserIntf> initialParserKey = new Key<>();
2027
2028 public static InitialFileParserIntf instance(Context context) {
2029 InitialFileParserIntf instance = context.get(initialParserKey);
2030 if (instance == null)
2031 instance = new InitialFileParser(context);
2032 return instance;
2033 }
2034
2035 private final JavaCompiler compiler;
2036
2037 private InitialFileParser(Context context) {
2038 context.put(initialParserKey, this);
2039 this.compiler = JavaCompiler.instance(context);
2040 }
2041
2042 @Override
2043 public List<JCCompilationUnit> parse(Iterable<JavaFileObject> fileObjects) {
2044 return compiler.parseFiles(fileObjects, false);
2045 }
2046 }
2047 }