Formatting and documentation

Author: FliegendeWurst

key.ui/src/main/java/de/uka/ilkd/key/gui/IssueDialog.java

@@ -60,6 +60,17 @@
 public final class IssueDialog extends JDialog {
     private static final Logger LOGGER = LoggerFactory.getLogger(IssueDialog.class);
 
+    /**
+     * Default text for critical issues (runtime exceptions).
+     */
+    private static final String CRITICAL_ISSUE = "The following exception occurred:";
+    /**
+     * Default text for non-critical issues (JML specification warnings).
+     */
+    private static final String NON_CRITICAL_ISSUE = String.format(
+        "The following non-fatal problems occurred when translating your %s specifications:",
+        SLEnvInput.getLanguage());
+
     /** regex to find web urls in string messages */
     private static final Pattern HTTP_REGEX = Pattern.compile("https?://[^\\s]+");
 
@@ -129,7 +140,20 @@ public final class IssueDialog extends JDialog {
 
     public IssueDialog(Window owner, String title, Set<PositionedIssueString> issues,
             boolean critical) {
-        this(owner, title, issues, critical, null);
+        this(owner, title, critical ? CRITICAL_ISSUE : NON_CRITICAL_ISSUE, issues, critical, null);
+    }
+
+    /**
+     * Create an issue dialog with the given title and description.
+     *
+     * @param owner parent window
+     * @param title window title
+     * @param description description to show
+     * @param issues the issues
+     */
+    public IssueDialog(Window owner, String title, String description,
+            Set<PositionedIssueString> issues) {
+        this(owner, title, description, issues, false, null);
     }
 
     /**
@@ -166,8 +190,33 @@ private static List<PositionedIssueString> decorateHTML(Set<PositionedIssueStrin
         }).collect(Collectors.toList());
     }
 
+    /**
+     * Construct a new issue dialog based on the title, the warnings to show and the exception to show.
+     *
+     * @param owner parent window
+     * @param title dialog title
+     * @param warnings warnings to show
+     * @param critical whether the issue is critical
+     * @param throwable exception to show (may be null)
+     */
     IssueDialog(Window owner, String title, Set<PositionedIssueString> warnings,
             boolean critical, Throwable throwable) {
+        this(owner, title, critical ? CRITICAL_ISSUE : NON_CRITICAL_ISSUE, warnings, critical,
+            throwable);
+    }
+
+    /**
+     * Construct a new issue dialog given the title, description, warnings and exception.
+     *
+     * @param owner parent window
+     * @param title dialog title
+     * @param head description
+     * @param warnings warnings to show
+     * @param critical criticality of the issue
+     * @param throwable exception to show (may be null)
+     */
+    IssueDialog(Window owner, String title, String head, Set<PositionedIssueString> warnings,
+            boolean critical, Throwable throwable) {
         super(owner, title, ModalityType.APPLICATION_MODAL);
 
         this.throwable = throwable;
@@ -195,14 +244,6 @@ private static List<PositionedIssueString> decorateHTML(Set<PositionedIssueStrin
         // stTextArea
 
         // set descriptive text in top label
-        final String head;
-        if (critical) {
-            head = "The following exception occurred:";
-        } else {
-            head = String.format(
-                "The following non-fatal problems occurred when translating your %s specifications:",
-                SLEnvInput.getLanguage());
-        }
         JLabel label = new JLabel(head);
         label.setBorder(BorderFactory.createEmptyBorder(5, 5, 2, 5));
         add(label, BorderLayout.NORTH);

key.ui/src/main/java/de/uka/ilkd/key/gui/plugins/javac/JavaCompilerCheckFacade.java

@@ -43,14 +43,13 @@ public class JavaCompilerCheckFacade {
      * and
      * reports any issues to the provided <code>listener</code>
      *
-     * @param listener      the {@link ProblemInitializer.ProblemInitializerListener} to be informed
-     *                      about any
-     *                      issues found in the target Java program
+     * @param listener the {@link ProblemInitializer.ProblemInitializerListener} to be informed
+     *        about any issues found in the target Java program
      * @param bootClassPath the {@link File} referring to the path containing the core Java classes
-     * @param classPath     the {@link List} of {@link File}s referring to the directory that make up
-     *                      the target Java programs classpath
-     * @param javaPath      the {@link String} with the path to the source of the target Java program
-     * @return
+     * @param classPath the {@link List} of {@link File}s referring to the directory that make up
+     *        the target Java programs classpath
+     * @param javaPath the {@link String} with the path to the source of the target Java program
+     * @return future providing the list of diagnostics
      */
     @Nonnull
     public static CompletableFuture<List<PositionedIssueString>> check(
@@ -71,60 +70,77 @@ public static CompletableFuture<List<PositionedIssueString>> check(
             return CompletableFuture.completedFuture(Collections.emptyList());
         }
 
-        var fileManager =
-                new JavaFileManagerDelegate(
-                        compiler.getStandardFileManager(
-                                diagnostics, Locale.ENGLISH, Charset.defaultCharset()));
+        JavaFileManagerDelegate fileManager =
+            new JavaFileManagerDelegate(
+                compiler.getStandardFileManager(
+                    diagnostics, Locale.ENGLISH, Charset.defaultCharset()));
 
-        var output = new StringWriter();
-        var classes = new ArrayList<String>();
+        StringWriter output = new StringWriter();
+        List<String> classes = new ArrayList<>();
 
-        var paths = new ArrayList<File>();
+        // gather configured bootstrap classpath and regular classpath
+        List<File> paths = new ArrayList<>();
         if (bootClassPath != null) {
             paths.add(bootClassPath);
         }
         if (classPath != null && !classPath.isEmpty()) {
             paths.addAll(classPath);
         }
         paths.add(javaPath);
-        var compilationUnits =
-                fileManager.getJavaFileObjects(paths.stream()
-                        .filter(File::isDirectory)
-                        .flatMap(it -> {
-                            try {
-                                return Files.walk(it.toPath())
-                                        .filter(f -> !Files.isDirectory(f))
-                                        .filter(f -> f.getFileName().toString().endsWith(".java"));
-                            } catch (IOException e) {
-                                LOGGER.info("", e);
-                                return Stream.empty();
-                            }
-                        }).toArray(Path[]::new));
-
-        var task = compiler.getTask(output, fileManager, diagnostics,
-                new ArrayList<>(), classes, compilationUnits);
+        Iterable<? extends JavaFileObject> compilationUnits =
+            fileManager.getJavaFileObjects(paths.stream()
+                    .filter(File::isDirectory)
+                    .flatMap(it -> {
+                        try {
+                            return Files.walk(it.toPath())
+                                    .filter(f -> !Files.isDirectory(f))
+                                    .filter(f -> f.getFileName().toString().endsWith(".java"));
+                        } catch (IOException e) {
+                            LOGGER.info("", e);
+                            return Stream.empty();
+                        }
+                    }).toArray(Path[]::new));
+
+        JavaCompiler.CompilationTask task = compiler.getTask(output, fileManager, diagnostics,
+            new ArrayList<>(), classes, compilationUnits);
 
         return CompletableFuture.supplyAsync(() -> {
             long start = System.currentTimeMillis();
             var b = task.call();
             LOGGER.info("Javac check took {} ms.", System.currentTimeMillis() - start);
-            for (var diagnostic : diagnostics.getDiagnostics()) {
+            for (Diagnostic<? extends JavaFileObject> diagnostic : diagnostics.getDiagnostics()) {
                 LOGGER.info("{}", diagnostic);
             }
             return diagnostics.getDiagnostics().stream().map(
-                            it -> new PositionedIssueString(
-                                    it.getMessage(Locale.ENGLISH),
-                                    fileManager.asPath(it.getSource()).toFile().getAbsolutePath(),
-                                    new Position((int) it.getLineNumber(), (int) it.getColumnNumber()),
-                                    "" + it.getCode() + " " + it.getKind()))
+                it -> new PositionedIssueString(
+                    it.getMessage(Locale.ENGLISH),
+                    fileManager.asPath(it.getSource()).toFile().getAbsolutePath(),
+                    new Position((int) it.getLineNumber(), (int) it.getColumnNumber()),
+                    "" + it.getCode() + " " + it.getKind()))
                     .collect(Collectors.toList());
         });
     }
 }
 
+
+/**
+ * Wrapper around a {@link StandardJavaFileManager} that returns a dummy output for
+ * class files ({@link #getJavaFileForOutput(Location, String, JavaFileObject.Kind, FileObject)}.
+ * Every other request is delegated to the provided file manager.
+ *
+ * @author Alexander Weigl
+ */
 class JavaFileManagerDelegate implements StandardJavaFileManager {
+    /**
+     * The file manager most calls are delegated to.
+     */
     private final StandardJavaFileManager fileManager;
 
+    /**
+     * Construct a new wrapper.
+     *
+     * @param jfm file manager
+     */
     public JavaFileManagerDelegate(StandardJavaFileManager jfm) {
         this.fileManager = jfm;
     }
@@ -135,14 +151,16 @@ public boolean isSameFile(FileObject a, FileObject b) {
     }
 
     @Override
-    public Iterable<? extends JavaFileObject> getJavaFileObjectsFromFiles(Iterable<? extends File> files) {
+    public Iterable<? extends JavaFileObject> getJavaFileObjectsFromFiles(
+            Iterable<? extends File> files) {
         return fileManager.getJavaFileObjectsFromFiles(files);
     }
 
 
     @Override
     @Deprecated(since = "13")
-    public Iterable<? extends JavaFileObject> getJavaFileObjectsFromPaths(Iterable<? extends Path> paths) {
+    public Iterable<? extends JavaFileObject> getJavaFileObjectsFromPaths(
+            Iterable<? extends Path> paths) {
         return fileManager.getJavaFileObjectsFromPaths(paths);
     }
 
@@ -157,7 +175,8 @@ public Iterable<? extends JavaFileObject> getJavaFileObjects(Path... paths) {
     }
 
     @Override
-    public Iterable<? extends JavaFileObject> getJavaFileObjectsFromStrings(Iterable<String> names) {
+    public Iterable<? extends JavaFileObject> getJavaFileObjectsFromStrings(
+            Iterable<String> names) {
         return fileManager.getJavaFileObjectsFromStrings(names);
     }
 
@@ -172,12 +191,14 @@ public void setLocation(Location location, Iterable<? extends File> files) throw
     }
 
     @Override
-    public void setLocationFromPaths(Location location, Collection<? extends Path> paths) throws IOException {
+    public void setLocationFromPaths(Location location, Collection<? extends Path> paths)
+            throws IOException {
         fileManager.setLocationFromPaths(location, paths);
     }
 
     @Override
-    public void setLocationForModule(Location location, String moduleName, Collection<? extends Path> paths) throws IOException {
+    public void setLocationForModule(Location location, String moduleName,
+            Collection<? extends Path> paths) throws IOException {
         fileManager.setLocationForModule(location, moduleName, paths);
     }
 
@@ -207,7 +228,8 @@ public ClassLoader getClassLoader(Location location) {
     }
 
     @Override
-    public Iterable<JavaFileObject> list(Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse) throws IOException {
+    public Iterable<JavaFileObject> list(Location location, String packageName,
+            Set<JavaFileObject.Kind> kinds, boolean recurse) throws IOException {
         return fileManager.list(location, packageName, kinds, recurse);
     }
 
@@ -227,13 +249,16 @@ public boolean hasLocation(Location location) {
     }
 
     @Override
-    public JavaFileObject getJavaFileForInput(Location location, String className, JavaFileObject.Kind kind) throws IOException {
+    public JavaFileObject getJavaFileForInput(Location location, String className,
+            JavaFileObject.Kind kind) throws IOException {
         return fileManager.getJavaFileForInput(location, className, kind);
     }
 
     @Override
-    public JavaFileObject getJavaFileForOutput(Location location, String className, JavaFileObject.Kind kind, FileObject sibling) throws IOException {
+    public JavaFileObject getJavaFileForOutput(Location location, String className,
+            JavaFileObject.Kind kind, FileObject sibling) throws IOException {
         if (kind == JavaFileObject.Kind.CLASS && location == StandardLocation.CLASS_OUTPUT) {
+            // do not save compiled .class files on disk
             try {
                 return new IgnoreOutputJavaFileObject(className, kind);
             } catch (URISyntaxException e) {
@@ -245,12 +270,14 @@ public JavaFileObject getJavaFileForOutput(Location location, String className,
 
 
     @Override
-    public FileObject getFileForInput(Location location, String packageName, String relativeName) throws IOException {
+    public FileObject getFileForInput(Location location, String packageName, String relativeName)
+            throws IOException {
         return fileManager.getFileForInput(location, packageName, relativeName);
     }
 
     @Override
-    public FileObject getFileForOutput(Location location, String packageName, String relativeName, FileObject sibling) throws IOException {
+    public FileObject getFileForOutput(Location location, String packageName, String relativeName,
+            FileObject sibling) throws IOException {
         return fileManager.getFileForOutput(location, packageName, relativeName, sibling);
     }
 
@@ -276,7 +303,8 @@ public Location getLocationForModule(Location location, JavaFileObject fo) throw
     }
 
     @Override
-    public <S> ServiceLoader<S> getServiceLoader(Location location, Class<S> service) throws IOException {
+    public <S> ServiceLoader<S> getServiceLoader(Location location, Class<S> service)
+            throws IOException {
         return fileManager.getServiceLoader(location, service);
     }
 
@@ -302,6 +330,11 @@ public int isSupportedOption(String option) {
 }
 
 
+/**
+ * Java file object that ignores all writes.
+ *
+ * @author Alexander Weigl
+ */
 class IgnoreOutputJavaFileObject extends SimpleJavaFileObject {
     public IgnoreOutputJavaFileObject(final String name, Kind kind) throws URISyntaxException {
         super(new URI("memory://" + name + ".class"), kind);
@@ -310,10 +343,6 @@ public IgnoreOutputJavaFileObject(final String name, Kind kind) throws URISyntax
     // ignore written class output
     @Override
     public OutputStream openOutputStream() {
-        return new OutputStream() {
-            @Override
-            public void write(int b) {
-            }
-        };
+        return OutputStream.nullOutputStream();
     }
 }