improve formating and displaying of script errors

Author: Gubaer

src/main/java/org/openstreetmap/josm/plugins/scripting/ui/console/ErrorOutputPanel.java

@@ -2,8 +2,10 @@
 
 
 import org.graalvm.polyglot.PolyglotException;
+import org.mozilla.javascript.EcmaError;
 import org.openstreetmap.josm.plugins.scripting.graalvm.GraalVMFacadeFactory;
 
+import javax.script.ScriptException;
 import javax.swing.*;
 import javax.validation.constraints.NotNull;
 import javax.validation.constraints.Null;
@@ -20,7 +22,6 @@
 public class ErrorOutputPanel extends JPanel {
 
     private JTextPane paneOutput;
-    private JScrollPane editorScrollPane;
 
     public ErrorOutputPanel() {
         build();
@@ -30,7 +31,7 @@ protected void build() {
         setLayout(new BorderLayout());
         paneOutput = new JTextPane();
         paneOutput.setEditable(false);
-        editorScrollPane = new JScrollPane(paneOutput);
+        JScrollPane editorScrollPane = new JScrollPane(paneOutput);
         editorScrollPane.setVerticalScrollBarPolicy(
             JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED);
         editorScrollPane.setHorizontalScrollBarPolicy(
@@ -40,6 +41,17 @@ protected void build() {
 
     protected void displayPolyglotException(PolyglotException exception) {
         paneOutput.setText(formatPolyglotException(exception));
+        paneOutput.setCaretPosition(0);
+    }
+
+    protected void displayMozillaEcmaError(EcmaError exception) {
+        paneOutput.setText(exception.getMessage());
+        paneOutput.setCaretPosition(0);
+    }
+
+    protected void displayScriptException(ScriptException exception) {
+        paneOutput.setText(exception.getMessage());
+        paneOutput.setCaretPosition(0);
     }
 
     protected void displayGeneralException(Throwable exception) {
@@ -49,39 +61,50 @@ protected void displayGeneralException(Throwable exception) {
         final var writer = new StringWriter();
         exception.printStackTrace(new PrintWriter(writer));
         builder.append(writer.getBuffer());
-        paneOutput.setText(builder.toString());    }
-
+        paneOutput.setText(builder.toString());
+        paneOutput.setCaretPosition(0);
+    }
 
     /**
-     * Displays an exception
+     * Displays an exception. If <code>exception</code> is null, an empty
+     * string is displayed.
      *
      * @param exception the exception
      */
-    public void displayException(@NotNull Throwable exception) {
+    public void displayException(@Null Throwable exception) {
+        if (exception == null) {
+            paneOutput.setText("");
+            paneOutput.setCaretPosition(0);
+            return;
+        }
         if (GraalVMFacadeFactory.isGraalVMPresent()) {
-            final var polyglotException = lookupPolyglotException(exception);
+            final var polyglotException = lookupCauseByExceptionType(exception, PolyglotException.class);
             if (polyglotException != null) {
-                displayPolyglotException(polyglotException);
+                displayPolyglotException((PolyglotException) polyglotException);
                 return;
             }
         }
+        final var mozillaEcmaError = lookupCauseByExceptionType(exception, EcmaError.class);
+        if (mozillaEcmaError != null) {
+            displayMozillaEcmaError((EcmaError) mozillaEcmaError);
+            return;
+        }
+        final var scriptException = lookupCauseByExceptionType(exception, ScriptException.class);
+        if (scriptException != null) {
+            displayScriptException((ScriptException) scriptException);
+            return;
+        }
         displayGeneralException(exception);
-        // scroll to top
-        paneOutput.setCaretPosition(0);
     }
 
-    protected @Null PolyglotException lookupPolyglotException(Throwable t) {
+    protected @Null Throwable lookupCauseByExceptionType(Throwable t, Class<? extends Throwable> clazz) {
         while(t != null) {
-            if (t instanceof  PolyglotException) {
+            if (clazz.isInstance(t)) {
                 break;
             }
             t = t.getCause();
         }
-        if (t == null) {
-            return null;
-        } else {
-            return (PolyglotException) t;
-        }
+        return t;
     }
 
     protected String formatPolyglotException(@NotNull final PolyglotException exception) {

src/main/java/org/openstreetmap/josm/plugins/scripting/ui/console/ScriptingConsolePanel.java

@@ -56,6 +56,9 @@ protected JPanel buildOutputTabPanel() {
         tabPane.addTab(tr("Console"), log = new ScriptLogPanel());
         tabPane.setToolTipTextAt(0, tr("Displays script output"));
         tabPane.addTab(tr("Errors"), errorOutput);
+        tabPane.setIconAt(1, ImageProvider.get(
+            "circle-check-solid",
+            ImageProvider.ImageSizes.SMALLICON));
         tabPane.setToolTipTextAt(1, tr("Displays scripting errors"));
 
         ErrorModel.getInstance().addPropertyChangeListener(
@@ -207,6 +210,7 @@ public RunScriptAction(ScriptEditorModel model) {
 
         @Override
         public void actionPerformed(ActionEvent e) {
+            ErrorModel.getInstance().clearError();
             final String source = editor.getScript();
             switch(model.getScriptEngineDescriptor().getEngineType()) {
             case EMBEDDED:
@@ -274,16 +278,19 @@ public void propertyChange(PropertyChangeEvent event) {
             if (! ErrorModel.PROP_ERROR.equals(event.getPropertyName())) {
                 return;
             }
-            //TODO(gubaer): set an icon depending on status instead of background colors
             if (event.getNewValue() != null) {
-                outputTabs.setBackgroundAt(1, Color.RED);
+                outputTabs.setIconAt(1, ImageProvider.get("bug-solid",
+                    ImageProvider.ImageSizes.SMALLICON));
             } else {
-                outputTabs.setBackgroundAt(1, outputTabs.getBackgroundAt(0));
+                outputTabs.setIconAt(1, ImageProvider.get("circle-check-solid",
+                    ImageProvider.ImageSizes.SMALLICON));
             }
-            if (! (event.getNewValue() instanceof Throwable)) {
-                return;
+            if (event.getNewValue() == null) {
+                // clear the panel
+                outputPanel.displayException(null);
+            } if (event.getNewValue() instanceof Throwable) {
+                outputPanel.displayException((Throwable) event.getNewValue());
             }
-            outputPanel.displayException((Throwable) event.getNewValue());
         }
     }
 }