2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
23 import java.awt.BorderLayout;
24 import java.awt.Color;
25 import java.awt.Dimension;
26 import java.awt.GraphicsEnvironment;
27 import java.awt.GridBagConstraints;
28 import java.awt.GridBagLayout;
29 import java.awt.Rectangle;
30 import java.awt.Toolkit;
31 import java.awt.datatransfer.Clipboard;
32 import java.awt.datatransfer.StringSelection;
33 import java.awt.event.ActionEvent;
34 import java.awt.event.ActionListener;
35 import java.awt.event.MouseAdapter;
36 import java.awt.event.MouseEvent;
37 import java.awt.event.WindowAdapter;
38 import java.awt.event.WindowEvent;
39 import java.awt.event.WindowListener;
40 import java.io.IOException;
41 import java.io.PipedInputStream;
42 import java.io.PipedOutputStream;
43 import java.io.PrintStream;
45 import javax.swing.BorderFactory;
46 import javax.swing.JButton;
47 import javax.swing.JComboBox;
48 import javax.swing.JFrame;
49 import javax.swing.JLabel;
50 import javax.swing.JPanel;
51 import javax.swing.JScrollPane;
52 import javax.swing.JTextArea;
53 import javax.swing.SwingUtilities;
54 import javax.swing.border.Border;
55 import javax.swing.text.DefaultCaret;
57 import jalview.log.JLoggerI.LogLevel;
58 import jalview.log.JLoggerLog4j;
59 import jalview.log.JalviewAppender;
60 import jalview.util.ChannelProperties;
61 import jalview.util.MessageManager;
62 import jalview.util.Platform;
65 * Simple Jalview Java Console. Version 1 - allows viewing of console output
66 * after desktop is created. Acquired with thanks from RJHM's site
67 * http://www.comweb.nl/java/Console/Console.html A simple Java Console for your
68 * application (Swing version) Requires Java 1.1.5 or higher Disclaimer the use
69 * of this source is at your own risk. Permision to use and distribute into your
70 * own applications RJHM van den Bergh , rvdb@comweb.nl
73 public class Console extends WindowAdapter
74 implements WindowListener, ActionListener, Runnable
78 private JTextArea textArea;
81 * unused - tally and limit for lines in console window int lines = 0;
85 int byteslim = 102400, bytescut = 76800; // 100k and 75k cut point.
87 private Thread reader, reader2, textAppender;
91 private final PrintStream stdout = System.out, stderr = System.err;
93 private PipedInputStream pin = new PipedInputStream();
95 private PipedInputStream pin2 = new PipedInputStream();
97 private StringBuffer displayPipe = new StringBuffer();
99 Thread errorThrower; // just for testing (Throws an Exception at this Console
101 // are we attached to some parent Desktop
102 Desktop parent = null;
104 private int MIN_WIDTH = 300;
106 private int MIN_HEIGHT = 250;
108 private JComboBox<LogLevel> logLevelCombo = new JComboBox<LogLevel>();
110 protected LogLevel startingLogLevel = null;
114 // create all components and add them
115 Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
116 frame = initFrame("Java Console", screenSize.width / 2,
117 screenSize.height / 2, -1, -1);
118 frame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
122 private void initConsole(boolean visible)
124 initConsole(visible, true);
134 private void initConsole(boolean visible, boolean redirect)
136 // CutAndPasteTransfer cpt = new CutAndPasteTransfer();
137 // textArea = cpt.getTextArea();
138 textArea = new JTextArea();
139 textArea.setEditable(false);
141 DefaultCaret caret = (DefaultCaret) textArea.getCaret();
142 caret.setUpdatePolicy(DefaultCaret.ALWAYS_UPDATE);
143 // toggle autoscroll by clicking on the text area
144 Border pausedBorder = BorderFactory.createMatteBorder(2, 2, 2, 2,
145 textArea.getForeground());
146 Border noBorder = BorderFactory.createEmptyBorder(2, 2, 2, 2);
147 JScrollPane scrollPane = new JScrollPane(textArea);
148 scrollPane.setBorder(noBorder);
149 textArea.addMouseListener(new MouseAdapter()
152 public void mouseClicked(MouseEvent e)
154 if (e.getButton() == MouseEvent.BUTTON1)
156 if (caret.getUpdatePolicy() == DefaultCaret.ALWAYS_UPDATE)
158 caret.setUpdatePolicy(DefaultCaret.NEVER_UPDATE);
159 scrollPane.setBorder(pausedBorder);
163 caret.setUpdatePolicy(DefaultCaret.ALWAYS_UPDATE);
164 textArea.setCaretPosition(textArea.getDocument().getLength());
165 scrollPane.setBorder(noBorder);
171 JButton clearButton = new JButton(
172 MessageManager.getString("action.clear"));
173 JButton copyToClipboardButton = new JButton(
174 MessageManager.getString("label.copy_to_clipboard"));
175 copyToClipboardButton.addActionListener(new ActionListener()
178 public void actionPerformed(ActionEvent e)
180 copyConsoleTextToClipboard();
183 copyToClipboardButton.addMouseListener(new MouseAdapter()
185 private Color bg = textArea.getBackground();
187 private Color fg = textArea.getForeground();
190 public void mousePressed(MouseEvent e)
192 textArea.setBackground(textArea.getSelectionColor());
193 textArea.setForeground(textArea.getSelectedTextColor());
197 public void mouseReleased(MouseEvent e)
199 textArea.setBackground(bg);
200 textArea.setForeground(fg);
204 copyToClipboardButton.setToolTipText(
205 MessageManager.getString("label.copy_to_clipboard_tooltip"));
207 JLabel logLevelLabel = new JLabel(
208 MessageManager.getString("label.log_level") + ":");
210 // logLevelCombo.addItem(LogLevel.ALL);
211 logLevelCombo.addItem(LogLevel.TRACE);
212 logLevelCombo.addItem(LogLevel.DEBUG);
213 logLevelCombo.addItem(LogLevel.INFO);
214 logLevelCombo.addItem(LogLevel.WARN);
215 // logLevelCombo.addItem(LogLevel.ERROR);
216 // logLevelCombo.addItem(LogLevel.FATAL);
217 // logLevelCombo.addItem(LogLevel.ERROR);
218 // logLevelCombo.addItem(LogLevel.OFF);
219 // set startingLogLevel
221 if (jalview.bin.Console.getLogger() == null)
223 startingLogLevel = jalview.bin.Console.getCachedLogLevel();
227 startingLogLevel = jalview.bin.Console.getLogger().getLevel();
229 setChosenLogLevelCombo();
230 logLevelCombo.addActionListener(new ActionListener()
233 public void actionPerformed(ActionEvent e)
235 if (jalview.bin.Console.log != null)
237 jalview.bin.Console.log
238 .setLevel((LogLevel) logLevelCombo.getSelectedItem());
245 frame.getContentPane().setLayout(new BorderLayout());
246 frame.getContentPane().add(scrollPane, BorderLayout.CENTER);
247 JPanel southPanel = new JPanel();
248 southPanel.setLayout(new GridBagLayout());
250 JPanel logLevelPanel = new JPanel();
251 logLevelPanel.setAlignmentX(JPanel.LEFT_ALIGNMENT);
252 logLevelPanel.add(logLevelLabel);
253 logLevelPanel.add(logLevelCombo);
254 String logLevelTooltip = MessageManager.formatMessage(
255 "label.log_level_tooltip", startingLogLevel.toString());
256 logLevelLabel.setToolTipText(logLevelTooltip);
257 logLevelCombo.setToolTipText(logLevelTooltip);
259 GridBagConstraints gbc = new GridBagConstraints();
265 southPanel.add(logLevelPanel, gbc);
269 gbc.fill = GridBagConstraints.HORIZONTAL;
270 southPanel.add(clearButton, gbc);
274 gbc.fill = GridBagConstraints.NONE;
275 southPanel.add(copyToClipboardButton, gbc);
277 southPanel.setVisible(true);
278 frame.getContentPane().add(southPanel, BorderLayout.SOUTH);
279 frame.setVisible(visible);
280 updateConsole = visible;
281 frame.addWindowListener(this);
282 clearButton.addActionListener(this);
292 quit = false; // signals the Threads that they should exit
294 // Starting two seperate threads to read from the PipedInputStreams
296 reader = new Thread(this);
297 reader.setDaemon(true);
300 reader2 = new Thread(this);
301 reader2.setDaemon(true);
303 // and a thread to append text to the textarea
304 textAppender = new Thread(this);
305 textAppender.setDaemon(true);
306 textAppender.start();
309 frame.setIconImages(ChannelProperties.getIconList());
312 private void setChosenLogLevelCombo()
314 setChosenLogLevelCombo(startingLogLevel);
317 private void setChosenLogLevelCombo(LogLevel setLogLevel)
319 logLevelCombo.setSelectedItem(setLogLevel);
320 if (!logLevelCombo.getSelectedItem().equals(setLogLevel))
322 // setLogLevel not (yet) in list
323 if (setLogLevel != null && setLogLevel instanceof LogLevel)
325 // add new item to list (might be set via .jalview_properties)
326 boolean added = false;
327 for (int i = 0; i < logLevelCombo.getItemCount(); i++)
329 LogLevel l = logLevelCombo.getItemAt(i);
330 if (l.compareTo(setLogLevel) >= 0)
332 logLevelCombo.insertItemAt(setLogLevel, i);
337 if (!added) // lower priority than others or some confusion -- add to
340 logLevelCombo.addItem(setLogLevel);
342 logLevelCombo.setSelectedItem(setLogLevel);
346 logLevelCombo.setSelectedItem(LogLevel.INFO);
351 private void copyConsoleTextToClipboard()
353 String consoleText = textArea.getText();
354 StringSelection consoleTextSelection = new StringSelection(consoleText);
355 Clipboard cb = Toolkit.getDefaultToolkit().getSystemClipboard();
356 cb.setContents(consoleTextSelection, null);
359 PipedOutputStream pout = null, perr = null;
361 public void redirectStreams()
367 pout = new PipedOutputStream(this.pin);
368 System.setOut(new PrintStream(pout, true));
369 } catch (java.io.IOException io)
371 textArea.append("Couldn't redirect STDOUT to this console\n"
373 io.printStackTrace(stderr);
374 } catch (SecurityException se)
376 textArea.append("Couldn't redirect STDOUT to this console\n"
378 se.printStackTrace(stderr);
383 perr = new PipedOutputStream(this.pin2);
384 System.setErr(new PrintStream(perr, true));
385 } catch (java.io.IOException io)
387 textArea.append("Couldn't redirect STDERR to this console\n"
389 io.printStackTrace(stderr);
390 } catch (SecurityException se)
392 textArea.append("Couldn't redirect STDERR to this console\n"
394 se.printStackTrace(stderr);
399 public void unredirectStreams()
405 System.setOut(stdout);
408 pin = new PipedInputStream();
410 } catch (java.io.IOException io)
412 textArea.append("Couldn't unredirect STDOUT to this console\n"
414 io.printStackTrace(stderr);
415 } catch (SecurityException se)
417 textArea.append("Couldn't unredirect STDOUT to this console\n"
419 se.printStackTrace(stderr);
424 System.setErr(stderr);
427 pin2 = new PipedInputStream();
429 } catch (java.io.IOException io)
431 textArea.append("Couldn't unredirect STDERR to this console\n"
433 io.printStackTrace(stderr);
434 } catch (SecurityException se)
436 textArea.append("Couldn't unredirect STDERR to this console\n"
438 se.printStackTrace(stderr);
446 // you may omit this part for your application
449 jalview.bin.Console.outPrintln("Hello World 2");
450 jalview.bin.Console.outPrintln("All fonts available to Graphic2D:\n");
451 GraphicsEnvironment ge = GraphicsEnvironment
452 .getLocalGraphicsEnvironment();
453 String[] fontNames = ge.getAvailableFontFamilyNames();
454 for (int n = 0; n < fontNames.length; n++)
456 jalview.bin.Console.outPrintln(fontNames[n]);
458 // Testing part: simple an error thrown anywhere in this JVM will be printed
460 // We do it with a seperate Thread becasue we don't wan't to break a Thread
461 // used by the Console.
462 jalview.bin.Console.outPrintln("\nLets throw an error on this console");
463 errorThrower = new Thread(this);
464 errorThrower.setDaemon(true);
465 errorThrower.start();
468 private JFrame initFrame(String string, int i, int j, int x, int y)
470 JFrame frame = new JFrame(string);
471 frame.setName(string);
480 frame.setBounds(x, y, i, j);
485 * attach a console to the desktop - the desktop will open it if requested.
489 public Console(Desktop desktop)
492 // window name - get x,y,width, height possibly scaled
493 Rectangle bounds = parent == null ? null
494 : parent.getLastKnownDimensions("JAVA_CONSOLE_");
498 ChannelProperties.getProperty("app_name") + " Java Console",
499 bounds.width, bounds.height, bounds.x, bounds.y);
501 else if (parent != null && parent.getWidth() > 0
502 && parent.getHeight() > 0)
505 ChannelProperties.getProperty("app_name") + " Java Console",
506 parent.getWidth() / 2, parent.getHeight() / 4, parent.getX(),
512 ChannelProperties.getProperty("app_name") + " Java Console",
513 MIN_WIDTH, MIN_HEIGHT, 10, 10);
515 frame.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
516 // parent.add(frame);
518 LogLevel level = (LogLevel) logLevelCombo.getSelectedItem();
519 if (!Platform.isJS())
521 JalviewAppender jappender = new JalviewAppender(level);
522 JalviewAppender.setTextArea(textArea);
524 if (jalview.bin.Console.log != null
525 && jalview.bin.Console.log instanceof JLoggerLog4j)
527 JLoggerLog4j.addAppender(jalview.bin.Console.log, jappender);
532 public synchronized void stopConsole()
537 * reader.notify(); reader2.notify(); if (errorThrower!=null)
538 * errorThrower.notify(); // stop all threads if (textAppender!=null)
539 * textAppender.notify();
547 } catch (Exception e)
549 jalview.bin.Console.debug("pin.close() error", e);
555 } catch (Exception e)
557 jalview.bin.Console.debug("pin2.close() error", e);
561 textAppender.join(10);
562 } catch (Exception e)
564 jalview.bin.Console.debug("textAppender.join(10) error", e);
568 if (!frame.isVisible())
577 public synchronized void windowClosed(WindowEvent evt)
579 frame.setVisible(false);
583 private void closeConsoleGui()
585 updateConsole = false;
593 parent.showConsole(false);
598 public synchronized void windowClosing(WindowEvent evt)
600 frame.setVisible(false); // default behaviour of JFrame
607 public synchronized void actionPerformed(ActionEvent evt)
610 // textArea.setText("");
614 public synchronized void run()
618 while (Thread.currentThread() == reader)
620 if (pin == null || pin.available() == 0)
625 } catch (InterruptedException ie)
627 jalview.bin.Console.debug("pin.available() error", ie);
631 while (pin.available() != 0)
633 String input = this.readLine(pin);
635 long time = System.nanoTime();
636 appendToTextArea(input);
637 // stderr.println("Time taken to stdout append:\t"
638 // + (System.nanoTime() - time) + " ns");
647 while (Thread.currentThread() == reader2)
649 if (pin2.available() == 0)
653 this.wait(100); // ##### implicated BLOCKED
654 if (pin2.available() == 0)
658 } catch (InterruptedException ie)
660 jalview.bin.Console.debug("pin.available() error", ie);
663 while (pin2.available() != 0)
665 String input = this.readLine(pin2);
667 long time = System.nanoTime();
668 appendToTextArea(input);
669 // stderr.println("Time taken to stderr append:\t"
670 // + (System.nanoTime() - time) + " ns");
678 while (Thread.currentThread() == textAppender)
682 // check string buffer - if greater than console, clear console and
683 // replace with last segment of content, otherwise, append all to
685 while (displayPipe.length() > 0)
687 StringBuffer tmp = new StringBuffer(), replace;
688 synchronized (displayPipe)
690 replace = displayPipe;
693 // Append formatted message to textarea using the Swing Thread.
694 SwingUtilities.invokeLater(new Runnable()
698 textArea.append(replace.toString());
703 if (displayPipe.length() == 0)
708 if (displayPipe.length() == 0)
710 // post a trim on Swing Thread.
711 SwingUtilities.invokeLater(new Runnable()
719 } catch (InterruptedException e)
721 jalview.bin.Console.debug("displayPipe.length() error", e);
730 } catch (InterruptedException e)
732 jalview.bin.Console.debug("this.wait(100) error", e);
741 } catch (Exception e)
743 textArea.append("\nConsole reports an Internal error.");
744 textArea.append("The error is: " + e.getMessage());
745 // Need to uncomment this to ensure that line tally is synched.
748 "Console reports an Internal error.\nThe error is: " + e);
751 // just for testing (Throw a Nullpointer after 1 second)
752 if (Thread.currentThread() == errorThrower)
757 } catch (InterruptedException ie)
759 jalview.bin.Console.debug("this.wait(1000) error", ie);
761 throw new NullPointerException(
762 MessageManager.getString("exception.application_test_npe"));
766 private void appendToTextArea(final String input)
768 if (updateConsole == false)
773 long time = System.nanoTime();
774 javax.swing.SwingUtilities.invokeLater(new Runnable()
779 displayPipe.append(input);
782 // stderr.println("Time taken to Spawnappend:\t" + (System.nanoTime() -
787 private String header = null;
789 private boolean updateConsole = false;
791 private synchronized void trimBuffer(boolean clear)
793 if (header == null && textArea.getLineCount() > 5)
797 header = textArea.getText(0, textArea.getLineStartOffset(5))
798 + "\nTruncated...\n";
799 } catch (Exception e)
801 jalview.bin.Console.warn("textArea Exception", e);
805 int tlength = textArea.getDocument().getLength();
808 if (clear || (tlength > byteslim))
814 long time = System.nanoTime();
815 textArea.replaceRange(header, 0, tlength - bytescut);
816 // stderr.println("Time taken to cut:\t"
817 // + (System.nanoTime() - time) + " ns");
821 textArea.setText(header);
823 } catch (Exception e)
825 jalview.bin.Console.warn("textArea Exception", e);
827 // lines = textArea.getLineCount();
833 public synchronized String readLine(PipedInputStream in)
840 int available = in.available();
845 byte b[] = new byte[available];
847 input = input + new String(b, 0, b.length);
848 // counts lines - we don't do this for speed.
849 // while ((lp = input.indexOf("\n", lp + 1)) > -1)
853 } while (!input.endsWith("\n") && !input.endsWith("\r\n") && !quit);
861 public static void main(String[] arg)
863 new Console().test(); // create console with not reference
867 public void setVisible(boolean selected)
869 frame.setVisible(selected);
870 if (selected == true)
872 setChosenLogLevelCombo();
874 updateConsole = true;
879 // reset log level to what it was before
880 if (jalview.bin.Console.log != null)
882 jalview.bin.Console.log.setLevel(startingLogLevel);
886 updateConsole = false;
890 public Rectangle getBounds()
894 return frame.getBounds();
900 * set the banner that appears at the top of the console output
904 public void setHeader(String string)
907 if (header.charAt(header.length() - 1) != '\n')
911 textArea.insert(header, 0);
919 public String getHeader()