Change Editor status message only from EDT

JakubValtar · JakubValtar · commit ec8de86dbf7a · 2018-04-24T11:31:27.000+02:00
This adapter invokes all status changes on the EDT instead of worker thread of the Runner. Modifying AWT components from the worker threads may introduce strange bugs and in this case caused UI changes to run out of order, hiding runtime exceptions under problems displayed when cursor moves to the offending line.
diff --git a/app/src/processing/app/RunnerListenerEdtAdapter.java b/app/src/processing/app/RunnerListenerEdtAdapter.java
@@ -0,0 +1,48 @@
+package processing.app;
+
+import java.awt.EventQueue;
+
+public class RunnerListenerEdtAdapter implements RunnerListener {
+
+  private RunnerListener wrapped;
+
+  public RunnerListenerEdtAdapter(RunnerListener wrapped) {
+    this.wrapped = wrapped;
+  }
+
+  @Override
+  public void statusError(String message) {
+    EventQueue.invokeLater(() -> wrapped.statusError(message));
+  }
+
+  @Override
+  public void statusError(Exception exception) {
+    EventQueue.invokeLater(() -> wrapped.statusError(exception));
+  }
+
+  @Override
+  public void statusNotice(String message) {
+    EventQueue.invokeLater(() -> wrapped.statusNotice(message));
+  }
+
+  @Override
+  public void startIndeterminate() {
+    EventQueue.invokeLater(() -> wrapped.startIndeterminate());
+  }
+
+  @Override
+  public void stopIndeterminate() {
+    EventQueue.invokeLater(() -> wrapped.stopIndeterminate());
+  }
+
+  @Override
+  public void statusHalt() {
+    EventQueue.invokeLater(() -> wrapped.statusHalt());
+  }
+
+  @Override
+  public boolean isHalted() {
+    return wrapped.isHalted();
+  }
+}
+
diff --git a/java/src/processing/mode/java/Debugger.java b/java/src/processing/mode/java/Debugger.java
@@ -39,6 +39,7 @@
 import javax.swing.tree.DefaultMutableTreeNode;
 
 import processing.app.Messages;
+import processing.app.RunnerListenerEdtAdapter;
 import processing.app.Sketch;
 import processing.app.SketchCode;
 import processing.mode.java.debug.*;
@@ -201,7 +202,7 @@ public synchronized void startDebug() {
         //lineMap = LineMapping.generateMapping(srcPath + File.separator + mainClassName + ".java");
 
         log("launching debuggee runtime");
-        runtime = new Runner(build, editor);
+        runtime = new Runner(build, new RunnerListenerEdtAdapter(editor));
         VirtualMachine vm = runtime.debug(null); // non-blocking
         if (vm == null) {
           loge("error 37: launch failed", null);
diff --git a/java/src/processing/mode/java/JavaEditor.java b/java/src/processing/mode/java/JavaEditor.java
@@ -1093,10 +1093,11 @@ protected void handleLaunch(boolean present, boolean tweak) {
         synchronized (runtimeLock) {
           if (runtimeLaunchRequested) {
             runtimeLaunchRequested = false;
+            RunnerListener listener = new RunnerListenerEdtAdapter(JavaEditor.this);
             if (!tweak) {
-              runtime = jmode.handleLaunch(sketch, JavaEditor.this, present);
+              runtime = jmode.handleLaunch(sketch, listener, present);
             } else {
-              runtime = jmode.handleTweak(sketch, JavaEditor.this);
+              runtime = jmode.handleTweak(sketch, listener);
             }
           }
         }

Original file line number	Diff line number	Diff line change
`@@ -1093,10 +1093,11 @@ protected void handleLaunch(boolean present, boolean tweak) {`
`1093`	`1093`	`synchronized (runtimeLock) {`
`1094`	`1094`	`if (runtimeLaunchRequested) {`
`1095`	`1095`	`runtimeLaunchRequested = false;`
	`1096`	`+ RunnerListener listener = new RunnerListenerEdtAdapter(JavaEditor.this);`
`1096`	`1097`	`if (!tweak) {`
`1097`		`- runtime = jmode.handleLaunch(sketch, JavaEditor.this, present);`
	`1098`	`+ runtime = jmode.handleLaunch(sketch, listener, present);`
`1098`	`1099`	`} else {`
`1099`		`- runtime = jmode.handleTweak(sketch, JavaEditor.this);`
	`1100`	`+ runtime = jmode.handleTweak(sketch, listener);`
`1100`	`1101`	`}`
`1101`	`1102`	`}`
`1102`	`1103`	`}`