LoggingPanel: process log messages separately

This enables the LoggingPanel to treat console output and log messages
differently.

Author: maarzt

src/main/java/org/scijava/ui/swing/console/LogFormatter.java

@@ -0,0 +1,68 @@
+/*
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2017 Board of Regents of the University of
+ * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
+ * Institute of Molecular Cell Biology and Genetics.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package org.scijava.ui.swing.console;
+
+import java.io.PrintWriter;
+import java.io.StringWriter;
+
+import org.scijava.log.LogLevel;
+import org.scijava.log.LogMessage;
+
+/**
+ * Used by {@link LoggingPanel} to simplify formatting log messages.
+ *
+ * @author Matthias Arzt
+ */
+public class LogFormatter {
+
+	public String format(LogMessage message) {
+
+		final StringWriter sw = new StringWriter();
+		final PrintWriter printer = new PrintWriter(sw);
+
+		printWithBrackets(printer, message.time().toString());
+		printWithBrackets(printer, LogLevel.prefix(message.level()));
+		printWithBrackets(printer, message.source().toString());
+		printer.println(message.text());
+		if (message.throwable() != null)
+			message.throwable().printStackTrace(printer);
+
+		return sw.toString();
+	}
+
+	private void printWithBrackets(PrintWriter printer, String prefix) {
+		printer.print('[');
+		printer.print(prefix);
+		printer.print("] ");
+	}
+
+}

src/main/java/org/scijava/ui/swing/console/LoggingPanel.java

@@ -40,10 +40,10 @@
 
 import net.miginfocom.swing.MigLayout;
 
-import org.scijava.console.OutputEvent;
 import org.scijava.console.OutputListener;
 import org.scijava.log.IgnoreAsCallingClass;
 import org.scijava.log.LogListener;
+import org.scijava.log.LogMessage;
 import org.scijava.log.LogService;
 import org.scijava.log.Logger;
 import org.scijava.thread.ThreadService;
@@ -62,16 +62,15 @@
  * @author Matthias Arzt
  */
 @IgnoreAsCallingClass
-public class LoggingPanel extends JPanel implements OutputListener
+public class LoggingPanel extends JPanel implements LogListener
 {
 	private JTextPane textPane;
 	private JScrollPane scrollPane;
 
 	private StyledDocument doc;
-	private Style stdoutLocal;
-	private Style stderrLocal;
-	private Style stdoutGlobal;
-	private Style stderrGlobal;
+	private Style defaultStyle;
+
+	private final LogFormatter formatter = new LogFormatter();
 
 	private final ThreadService threadService;
 
@@ -84,16 +83,24 @@ public void clear() {
 		textPane.setText("");
 	}
 
+	// -- LogListener methods --
+
 	@Override
-	public void outputOccurred(OutputEvent event) {
+	public void messageLogged(LogMessage message) {
+		appendText(formatter.format(message), defaultStyle);
+	}
+
+	// -- Helper methods --
+
+	private void appendText(final String text, final Style style) {
 		threadService.queue(new Runnable() {
 
 			@Override
 			public void run() {
 				final boolean atBottom =
 						StaticSwingUtils.isScrolledToBottom(scrollPane);
 				try {
-					doc.insertString(doc.getLength(), event.getOutput(), getStyle(event));
+					doc.insertString(doc.getLength(), text, style);
 				}
 				catch (final BadLocationException exc) {
 					throw new RuntimeException(exc);
@@ -112,10 +119,7 @@ private synchronized void initGui() {
 
 		doc = textPane.getStyledDocument();
 
-		stdoutLocal = createStyle("stdoutLocal", null, Color.black, null, null);
-		stderrLocal = createStyle("stderrLocal", null, Color.red, null, null);
-		stdoutGlobal = createStyle("stdoutGlobal", stdoutLocal, null, null, true);
-		stderrGlobal = createStyle("stderrGlobal", stderrLocal, null, null, true);
+		defaultStyle = createStyle("stdoutLocal", null, Color.black, null, null);
 
 		// NB: We wrap the JTextPane in a JPanel to disable
 		// the text pane's intelligent line wrapping behavior.
@@ -138,7 +142,6 @@ private synchronized void initGui() {
 
 		add(scrollPane);
 	}
-	// -- Helper methods --
 
 	private Style createStyle(final String name, final Style parent,
 							  final Color foreground, final Boolean bold, final Boolean italic)
@@ -150,14 +153,9 @@ private Style createStyle(final String name, final Style parent,
 		return style;
 	}
 
-	private Style getStyle(final OutputEvent event) {
-		final boolean stderr = event.getSource() == OutputEvent.Source.STDERR;
-		final boolean contextual = event.isContextual();
-		if (stderr) return contextual ? stderrLocal : stderrGlobal;
-		return contextual ? stdoutLocal : stdoutGlobal;
-	}
+	// -- Helper methods - testing --
 
-	public JTextPane getTextPane() {
+	JTextPane getTextPane() {
 		return textPane;
 	}
 }

src/main/java/org/scijava/ui/swing/console/SwingConsolePane.java

@@ -32,13 +32,13 @@
 
 import java.awt.Component;
 
-import javax.swing.JPanel;
-import javax.swing.JTextPane;
+import javax.swing.*;
 
 import net.miginfocom.swing.MigLayout;
 
 import org.scijava.Context;
 import org.scijava.console.OutputEvent;
+import org.scijava.log.LogService;
 import org.scijava.plugin.Parameter;
 import org.scijava.thread.ThreadService;
 import org.scijava.ui.console.AbstractConsolePane;
@@ -54,8 +54,13 @@ public class SwingConsolePane extends AbstractConsolePane<JPanel> {
 	@Parameter
 	private ThreadService threadService;
 
+	@Parameter
+	private LogService logService;
+
 	private ConsolePanel consolePanel;
 
+	private LoggingPanel loggingPanel;
+
 	/**
 	 * The console pane's containing window; e.g., a {@link javax.swing.JFrame} or
 	 * {@link javax.swing.JInternalFrame}.
@@ -121,8 +126,13 @@ private ConsolePanel consolePanel() {
 	private synchronized void initLoggingPanel() {
 		if (consolePanel != null) return;
 		consolePanel = new ConsolePanel(threadService);
+		loggingPanel = new LoggingPanel(threadService);
+		logService.addLogListener(loggingPanel);
 		component = new JPanel(new MigLayout("", "[grow]", "[grow]"));
-		component.add(consolePanel, "grow");
+		JTabbedPane tabs = new JTabbedPane();
+		tabs.addTab("Console", consolePanel);
+		tabs.addTab("Log Messages", loggingPanel);
+		component.add(tabs, "grow");
 	}
 
 	// -- Helper methods - testing --