New console: replaces previous EditorConsoleStream with one that's faster and doesn't discard end chars. See arduino#2798

Author: Federico Fissore

app/src/cc/arduino/MessageConsole.java

@@ -0,0 +1,145 @@
+/**
+ * Original version of this file courtesy of Rob Camick
+ * <p>
+ * https://tips4java.wordpress.com/2008/11/08/message-console/
+ * <p>
+ * About page at https://tips4java.wordpress.com/about/ says something
+ * like MIT
+ */
+
+package cc.arduino;
+
+import javax.swing.*;
+import javax.swing.text.BadLocationException;
+import javax.swing.text.DefaultCaret;
+import javax.swing.text.Document;
+import javax.swing.text.SimpleAttributeSet;
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+
+/*
+ *  Create a simple console to display text messages.
+ *
+ *  Messages can be directed here from different sources. Each source can
+ *  have its messages displayed in a different color.
+ */
+public class MessageConsole {
+
+  private final JTextPane textComponent;
+  private final JScrollPane scrollPane;
+  private final Document document;
+
+  public MessageConsole(JTextPane textComponent, JScrollPane scrollPane) {
+    this.textComponent = textComponent;
+    this.scrollPane = scrollPane;
+    this.document = textComponent.getDocument();
+    this.textComponent.setEditable(false);
+    DefaultCaret caret = (DefaultCaret) this.textComponent.getCaret();
+    caret.setUpdatePolicy(DefaultCaret.NEVER_UPDATE);
+  }
+
+  /*
+   *  Redirect the output from the standard output to the console using the specified
+   *  color and PrintStream. The message will be added to the Document before it is
+   *  also written to the PrintStream.
+   */
+  public void redirectOut(SimpleAttributeSet style, PrintStream printStream) {
+    ConsoleOutputStream cos = new ConsoleOutputStream(style, scrollPane, printStream);
+    System.setOut(new PrintStream(cos, true));
+  }
+
+  /*
+   *  Redirect the output from the standard error to the console using the specified
+   *  color and PrintStream. The message will be added to the Document before it is
+   *  also written to the PrintStream.
+   */
+  public void redirectErr(SimpleAttributeSet style, PrintStream printStream) {
+    ConsoleOutputStream cos = new ConsoleOutputStream(style, scrollPane, printStream);
+    System.setErr(new PrintStream(cos, true));
+  }
+
+  public synchronized void clear() {
+    try {
+      document.remove(0, document.getLength());
+    } catch (BadLocationException e) {
+      // ignore the error otherwise this will cause an infinite loop
+      // maybe not a good idea in the long run?
+    }
+  }
+
+  public synchronized String getText() {
+    return textComponent.getText().trim();
+  }
+
+  /*
+   *	Class to intercept output from a PrintStream and add it to a Document.
+   *  The output can optionally be redirected to a different PrintStream.
+   *  The text displayed in the Document can be color coded to indicate
+   *  the output source.
+   */
+  class ConsoleOutputStream extends ByteArrayOutputStream {
+
+    private final SimpleAttributeSet attributes;
+    private final PrintStream printStream;
+    private final StringBuilder buffer;
+    private final Timer timer;
+
+    public ConsoleOutputStream(SimpleAttributeSet attributes, JScrollPane scrollPane, PrintStream printStream) {
+      this.attributes = attributes;
+      this.printStream = printStream;
+      this.buffer = new StringBuilder();
+
+      this.timer = new Timer(100, (e) -> {
+        scrollPane.getHorizontalScrollBar().setValue(0);
+        scrollPane.getVerticalScrollBar().setValue(scrollPane.getVerticalScrollBar().getMaximum());
+      });
+      timer.setRepeats(false);
+    }
+
+    public synchronized void flush() {
+      String message = toString();
+
+      if (message.length() == 0) {
+        return;
+      }
+
+      handleAppend(message);
+
+      reset();
+    }
+
+    private void handleAppend(String message) {
+      resetBufferIfDocumentEmpty();
+
+      buffer.append(message);
+
+      clearBuffer();
+    }
+
+    private void resetBufferIfDocumentEmpty() {
+      if (document.getLength() == 0) {
+        buffer.setLength(0);
+      }
+    }
+
+    private void clearBuffer() {
+      String line = buffer.toString();
+      buffer.setLength(0);
+
+      printStream.print(line);
+
+      SwingUtilities.invokeLater(() -> {
+        try {
+          int offset = document.getLength();
+          document.insertString(offset, line, attributes);
+        } catch (BadLocationException ble) {
+          //ignore
+        }
+      });
+
+      if (!timer.isRunning()) {
+        timer.restart();
+      }
+    }
+  }
+}

app/src/processing/app/Base.java

@@ -639,9 +639,6 @@ protected void handleActivated(Editor whichEditor) {
         // noop
       }
     }
-
-    // set the current window to be the console that's getting output
-    EditorConsoleStream.setCurrent(activeEditor.console);
   }
 
 

app/src/processing/app/Editor.java

@@ -263,7 +263,7 @@ public void windowDeactivated(WindowEvent e) {
     status = new EditorStatus(this);
     consolePanel.add(status, BorderLayout.NORTH);
 
-    console = new EditorConsole(this);
+    console = new EditorConsole();
     console.setName("console");
     // windows puts an ugly border on this guy
     console.setBorder(null);