cli: Improve format of printed paths

This also introduces better detection of the IntelliJ environment.

Author: flofriday

vadl-cli/main/vadl/cli/BaseCommand.java

@@ -49,6 +49,7 @@
 import vadl.pass.PassManager;
 import vadl.pass.PassOrder;
 import vadl.pass.exception.DuplicatedPassKeyException;
+import vadl.utils.EditorUtils;
 import vadl.utils.SourceLocation;
 import vadl.viam.Specification;
 
@@ -211,6 +212,37 @@ private Specification parseToVIAM() {
     return spec;
   }
 
+  protected void printDumps(String message) {
+    if (ArtifactTracker.getDumpPaths().isEmpty()) {
+      return;
+    }
+
+    System.out.println(message);
+    for (var path : ArtifactTracker.getDumpPaths()) {
+      if (EditorUtils.isIntelliJIDE()) {
+        var uri = path.toAbsolutePath().toUri();
+        System.out.printf("\t- %s\n", uri);
+      } else {
+        System.out.printf("\t- %s\n", path);
+      }
+    }
+  }
+
+  protected void printArtifacts(String message) {
+    if (ArtifactTracker.getArtifactPathsPaths().isEmpty()) {
+      return;
+    }
+    System.out.println(message);
+    for (var path : ArtifactTracker.getArtifactPathsPaths()) {
+      if (EditorUtils.isIntelliJIDE()) {
+        var uri = path.toAbsolutePath().toUri();
+        System.out.printf("\t- %s\n", uri);
+      } else {
+        System.out.printf("\t- %s\n", path);
+      }
+    }
+  }
+
   // lazy evaluated config, do NOT use this directly.
   // use getConfig() instead.
   @Nullable
@@ -266,14 +298,7 @@ public Integer call() {
           https://ea.complang.tuwien.ac.at/vadl/open-vadl/issues/new
           """);
 
-      if (!ArtifactTracker.getDumpPaths().isEmpty()) {
-        var dumpMessage = "\nBefore the crash, the following dumps were generated:";
-        System.out.println(dumpMessage);
-        for (var path : ArtifactTracker.getDumpPaths()) {
-          System.out.printf("\t- %s\n", path);
-        }
-        System.out.println("");
-      }
+      printDumps("\nBefore the crash, the following dumps were generated:");
 
       // Dirty hack to avoid stdout and stderr getting mixed in IntelliJ (flushing wasn't enough).
       try {
@@ -296,25 +321,13 @@ public Integer call() {
       }
     }
 
-    if (!ArtifactTracker.getArtifactPathsPaths().isEmpty()) {
-      var artifactMessage = returnVal == 0
-          ? "\nThe following artifacts were generated:"
-          : "\nEven though some errors occurred, the following artifacts were generated:";
-      System.out.println(artifactMessage);
-      for (var path : ArtifactTracker.getArtifactPathsPaths()) {
-        System.out.printf("\t- %s\n", path);
-      }
-    }
+    printArtifacts(returnVal == 0
+        ? "\nThe following artifacts were generated:"
+        : "\nEven though some errors occurred, the following artifacts were generated:");
 
-    if (!ArtifactTracker.getDumpPaths().isEmpty()) {
-      var dumpMessage = returnVal == 0
-          ? "\nThe following dumps were generated:"
-          : "\nEven though some errors occurred, the following dumps were generated:";
-      System.out.println(dumpMessage);
-      for (var path : ArtifactTracker.getDumpPaths()) {
-        System.out.printf("\t- %s\n", path);
-      }
-    }
+    printDumps(returnVal == 0
+        ? "\nThe following dumps were generated:"
+        : "\nEven though some errors occurred, the following dumps were generated:");
 
     return returnVal;
   }

vadl/main/vadl/utils/EditorUtils.java

@@ -0,0 +1,44 @@
+// SPDX-FileCopyrightText : © 2025 TU Wien <vadl@tuwien.ac.at>
+// SPDX-License-Identifier: GPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package vadl.utils;
+
+import java.util.Objects;
+import javax.annotation.Nullable;
+
+/**
+ * A file to work around the "quirks" of some editors and IDE's.
+ */
+public class EditorUtils {
+
+  @Nullable
+  private static Boolean isIntelliJ = null;
+
+  /**
+   * Detect whether the program is currently executing inside IntelliJ.
+   */
+  public static boolean isIntelliJIDE() {
+    if (isIntelliJ == null) {
+      isIntelliJ = Objects.requireNonNullElse(System.getenv("TERMINAL_EMULATOR"), "")
+          .equals("JetBrains-JediTerm")
+          || Objects.requireNonNullElse(System.getenv("XPC_SERVICE_NAME"), "")
+          .startsWith("application.com.jetbrains")
+      ;
+    }
+
+    return isIntelliJ;
+  }
+}

vadl/main/vadl/utils/SourceLocation.java

@@ -16,6 +16,8 @@
 
 package vadl.utils;
 
+import static vadl.utils.EditorUtils.isIntelliJIDE;
+
 import java.io.IOException;
 import java.net.URI;
 import java.nio.file.Files;
@@ -173,8 +175,7 @@ public String toIDEString() {
 
     String printablePath;
 
-    if (Objects.requireNonNullElse(System.getenv("TERMINAL_EMULATOR"), "")
-        .equals("JetBrains-JediTerm") || this.uri.getScheme().equals("memory")) {
+    if (isIntelliJIDE() || this.uri.getScheme().equals("memory")) {
       // IntelliJ integrated terminal needs special treatment
       printablePath = this.uri.toString();
     } else {