Merge pull request #3433 from ffissore/new-console

New console

Author: ffissore

app/src/cc/arduino/ConsoleOutputStream.java

@@ -0,0 +1,132 @@
+/*
+ * This file is part of Arduino.
+ *
+ * Arduino 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 2 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2015 Arduino LLC (http://www.arduino.cc/)
+ *
+ * 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 processing.app.EditorConsole;
+
+import javax.swing.*;
+import javax.swing.text.BadLocationException;
+import javax.swing.text.Document;
+import javax.swing.text.SimpleAttributeSet;
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+
+/*
+ *  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.
+ */
+public class ConsoleOutputStream extends ByteArrayOutputStream {
+
+  private final SimpleAttributeSet attributes;
+  private final PrintStream printStream;
+  private final StringBuilder buffer;
+  private final Timer timer;
+  private JScrollPane scrollPane;
+  private Document document;
+
+  public ConsoleOutputStream(SimpleAttributeSet attributes, PrintStream printStream) {
+    this.attributes = attributes;
+    this.printStream = printStream;
+    this.buffer = new StringBuilder();
+
+    this.timer = new Timer(100, (e) -> {
+      if (scrollPane != null) {
+        synchronized (scrollPane) {
+          scrollPane.getHorizontalScrollBar().setValue(0);
+          scrollPane.getVerticalScrollBar().setValue(scrollPane.getVerticalScrollBar().getMaximum());
+        }
+      }
+    });
+    timer.setRepeats(false);
+  }
+
+  public synchronized void setCurrentEditorConsole(EditorConsole console) {
+    this.scrollPane = console;
+    this.document = console.getDocument();
+  }
+
+  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 != null && document.getLength() == 0) {
+      buffer.setLength(0);
+    }
+  }
+
+  private void clearBuffer() {
+    String line = buffer.toString();
+    buffer.setLength(0);
+
+    printStream.print(line);
+
+    if (document != null) {
+      SwingUtilities.invokeLater(() -> {
+        try {
+          String lineWithoutSlashR = line.replace("\r\n", "\n").replace("\r", "\n");
+          int offset = document.getLength();
+          document.insertString(offset, lineWithoutSlashR, attributes);
+        } catch (BadLocationException ble) {
+          //ignore
+        }
+      });
+
+      if (!timer.isRunning()) {
+        timer.restart();
+      }
+    }
+  }
+}

app/src/processing/app/Base.java

@@ -641,7 +641,7 @@ protected void handleActivated(Editor whichEditor) {
     }
 
     // set the current window to be the console that's getting output
-    EditorConsoleStream.setCurrent(activeEditor.console);
+    EditorConsole.setCurrentEditorConsole(activeEditor.console);
   }
 
 

app/src/processing/app/Editor.java

@@ -264,7 +264,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);