Skip to content

Commit 6bbf054

Browse files
facchinmfacchinm
committed
Add clickable HTML view of Serial Monitor
The HTML view only activates if: - the output is steady - the "frame" contains a link - the length of the entire content is < 1KB No performance penalty compared to normal view (in standard conditions)
1 parent 479351c commit 6bbf054

File tree

3 files changed

+257
-0
lines changed

3 files changed

+257
-0
lines changed

Diff for: ‎app/src/processing/app/AbstractTextMonitor.java

+93
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@
2929
import javax.swing.border.EmptyBorder;
3030
import javax.swing.text.DefaultCaret;
3131
import javax.swing.text.DefaultEditorKit;
32+
import javax.swing.event.UndoableEditListener;
33+
import javax.swing.text.AbstractDocument;
34+
import javax.swing.text.Document;
3235

3336
import cc.arduino.packages.BoardPort;
3437

@@ -37,14 +40,20 @@ public abstract class AbstractTextMonitor extends AbstractMonitor {
3740

3841
protected JLabel noLineEndingAlert;
3942
protected TextAreaFIFO textArea;
43+
protected HTMLTextAreaFIFO htmlTextArea;
4044
protected JScrollPane scrollPane;
45+
protected JScrollPane htmlScrollPane;
4146
protected JTextField textField;
4247
protected JButton sendButton;
4348
protected JButton clearButton;
4449
protected JCheckBox autoscrollBox;
4550
protected JCheckBox addTimeStampBox;
4651
protected JComboBox<String> lineEndings;
4752
protected JComboBox<String> serialRates;
53+
protected Container mainPane;
54+
private long lastMessage;
55+
private javax.swing.Timer updateTimer;
56+
private boolean htmlView = true;
4857

4958
public AbstractTextMonitor(Base base, BoardPort boardPort) {
5059
super(boardPort);
@@ -57,21 +66,97 @@ public AbstractTextMonitor(Base base, BoardPort boardPort) {
5766
@Override
5867
protected void onCreateWindow(Container mainPane) {
5968

69+
this.mainPane = mainPane;
6070
mainPane.setLayout(new BorderLayout());
6171

6272
textArea = new TextAreaFIFO(8_000_000);
6373
textArea.setRows(16);
6474
textArea.setColumns(40);
6575
textArea.setEditable(false);
6676

77+
htmlTextArea = new HTMLTextAreaFIFO(8000000);
78+
htmlTextArea.setEditable(false);
79+
htmlTextArea.setOpaque(false);
80+
6781
// don't automatically update the caret. that way we can manually decide
6882
// whether or not to do so based on the autoscroll checkbox.
6983
((DefaultCaret) textArea.getCaret()).setUpdatePolicy(DefaultCaret.NEVER_UPDATE);
84+
((DefaultCaret) htmlTextArea.getCaret()).setUpdatePolicy(DefaultCaret.NEVER_UPDATE);
85+
86+
Document doc = textArea.getDocument();
87+
if (doc instanceof AbstractDocument)
88+
{
89+
UndoableEditListener[] undoListeners =
90+
( (AbstractDocument) doc).getUndoableEditListeners();
91+
if (undoListeners.length > 0)
92+
{
93+
for (UndoableEditListener undoListener : undoListeners)
94+
{
95+
doc.removeUndoableEditListener(undoListener);
96+
}
97+
}
98+
}
99+
100+
doc = htmlTextArea.getDocument();
101+
if (doc instanceof AbstractDocument)
102+
{
103+
UndoableEditListener[] undoListeners =
104+
( (AbstractDocument) doc).getUndoableEditListeners();
105+
if (undoListeners.length > 0)
106+
{
107+
for (UndoableEditListener undoListener : undoListeners)
108+
{
109+
doc.removeUndoableEditListener(undoListener);
110+
}
111+
}
112+
}
70113

71114
scrollPane = new JScrollPane(textArea);
115+
scrollPane.setVerticalScrollBarPolicy(JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED);
116+
htmlScrollPane = new JScrollPane(htmlTextArea);
117+
htmlScrollPane.setVerticalScrollBarPolicy(JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED);
118+
119+
ActionListener checkIfSteady = new ActionListener() {
120+
public void actionPerformed(ActionEvent evt) {
121+
if (System.currentTimeMillis() - lastMessage > 200) {
122+
if (htmlView == false && textArea.getLength() < 1000) {
123+
124+
htmlTextArea.setText("");
125+
boolean res = htmlTextArea.append(textArea.getText());
126+
if (res) {
127+
htmlView = true;
128+
mainPane.remove(scrollPane);
129+
if (textArea.getCaretPosition() > htmlTextArea.getDocument().getLength()) {
130+
htmlTextArea.setCaretPosition(htmlTextArea.getDocument().getLength());
131+
} else {
132+
htmlTextArea.setCaretPosition(textArea.getCaretPosition());
133+
}
134+
mainPane.add(htmlScrollPane, BorderLayout.CENTER);
135+
scrollPane.setVisible(false);
136+
mainPane.validate();
137+
mainPane.repaint();
138+
}
139+
}
140+
} else {
141+
if (htmlView == true) {
142+
htmlView = false;
143+
mainPane.remove(htmlScrollPane);
144+
mainPane.add(scrollPane, BorderLayout.CENTER);
145+
scrollPane.setVisible(true);
146+
mainPane.validate();
147+
mainPane.repaint();
148+
}
149+
}
150+
}
151+
};
152+
153+
updateTimer = new javax.swing.Timer(33, checkIfSteady);
72154

73155
mainPane.add(scrollPane, BorderLayout.CENTER);
74156

157+
htmlTextArea.setVisible(true);
158+
htmlScrollPane.setVisible(true);
159+
75160
JPanel upperPane = new JPanel();
76161
upperPane.setLayout(new BoxLayout(upperPane, BoxLayout.X_AXIS));
77162
upperPane.setBorder(new EmptyBorder(4, 4, 4, 4));
@@ -156,20 +241,27 @@ public void windowGainedFocus(WindowEvent e) {
156241
applyPreferences();
157242

158243
mainPane.add(pane, BorderLayout.SOUTH);
244+
245+
updateTimer.start();
159246
}
160247

161248
@Override
162249
protected void onEnableWindow(boolean enable)
163250
{
164251
textArea.setEnabled(enable);
165252
clearButton.setEnabled(enable);
253+
htmlTextArea.setEnabled(enable);
166254
scrollPane.setEnabled(enable);
255+
htmlScrollPane.setEnabled(enable);
167256
textField.setEnabled(enable);
168257
sendButton.setEnabled(enable);
169258
autoscrollBox.setEnabled(enable);
170259
addTimeStampBox.setEnabled(enable);
171260
lineEndings.setEnabled(enable);
172261
serialRates.setEnabled(enable);
262+
if (enable == false) {
263+
htmlTextArea.setText("");
264+
}
173265
}
174266

175267
public void onSendCommand(ActionListener listener) {
@@ -187,6 +279,7 @@ public void onSerialRateChange(ActionListener listener) {
187279

188280
@Override
189281
public void message(String msg) {
282+
lastMessage = System.currentTimeMillis();
190283
SwingUtilities.invokeLater(() -> updateTextArea(msg));
191284
}
192285

Diff for: ‎app/src/processing/app/HTMLTextAreaFIFO.java

+160
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
/*
2+
Copyright (c) 2014 Paul Stoffregen <[email protected]>
3+
4+
This program is free software; you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation; either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program; if not, write to the Free Software Foundation,
16+
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17+
*/
18+
19+
// adapted from https://community.oracle.com/thread/1479784
20+
21+
package processing.app;
22+
23+
import java.io.IOException;
24+
import java.net.URL;
25+
import java.awt.Desktop;
26+
import java.net.URLEncoder;
27+
28+
import java.util.*;
29+
import java.util.regex.*;
30+
31+
import javax.swing.text.html.HTMLDocument;
32+
import javax.swing.JEditorPane;
33+
import javax.swing.JTextPane;
34+
import javax.swing.SwingUtilities;
35+
import javax.swing.event.HyperlinkEvent;
36+
import javax.swing.event.HyperlinkListener;
37+
import javax.swing.event.DocumentEvent;
38+
import javax.swing.event.DocumentListener;
39+
import javax.swing.text.BadLocationException;
40+
import javax.swing.text.html.HTMLEditorKit;
41+
42+
import cc.arduino.UpdatableBoardsLibsFakeURLsHandler;
43+
44+
public class HTMLTextAreaFIFO extends JTextPane implements DocumentListener {
45+
private int maxChars;
46+
private int trimMaxChars;
47+
48+
private int updateCount; // limit how often we trim the document
49+
50+
private boolean doTrim;
51+
private final HTMLEditorKit kit;
52+
53+
public HTMLTextAreaFIFO(int max) {
54+
maxChars = max;
55+
trimMaxChars = max / 2;
56+
updateCount = 0;
57+
doTrim = true;
58+
setContentType("text/html");
59+
getDocument().addDocumentListener(this);
60+
setText("");
61+
kit = new HTMLEditorKit();
62+
this.addHyperlinkListener(new UpdatableBoardsLibsFakeURLsHandler(Base.INSTANCE));
63+
}
64+
65+
public void insertUpdate(DocumentEvent e) {
66+
}
67+
68+
public void removeUpdate(DocumentEvent e) {
69+
}
70+
71+
public void changedUpdate(DocumentEvent e) {
72+
}
73+
74+
public void trimDocument() {
75+
int len = 0;
76+
len = getDocument().getLength();
77+
if (len > trimMaxChars) {
78+
int n = len - trimMaxChars;
79+
//System.out.println("trimDocument: remove " + n + " chars");
80+
try {
81+
getDocument().remove(0, n);
82+
} catch (BadLocationException ble) {
83+
}
84+
}
85+
}
86+
87+
private static List<String> extractUrls(String input) {
88+
List<String> result = new ArrayList<String>();
89+
90+
Pattern pattern = Pattern.compile(
91+
"(http|ftp|https)://([^\\s]+)");
92+
93+
Matcher matcher = pattern.matcher(input);
94+
while (matcher.find()) {
95+
result.add(matcher.group());
96+
}
97+
98+
return result;
99+
}
100+
101+
static public final String WITH_DELIMITER = "((?<=%1$s)|(?=%1$s))";
102+
103+
public boolean append(String s) {
104+
boolean htmlFound = false;
105+
try {
106+
HTMLDocument doc = (HTMLDocument) getDocument();
107+
108+
String strings[] = s.split(String.format(WITH_DELIMITER, "\\r?\\n"));
109+
110+
for (int l = 0; l < strings.length; l++) {
111+
String str = strings[l];
112+
List<String> urls = extractUrls(str);
113+
114+
if (urls.size() > 0) {
115+
116+
for (int i = 0; i < urls.size(); i++) {
117+
if (!((urls.get(i)).contains("</a>"))) {
118+
str = str.replace(urls.get(i), "<a href='" + urls.get(i) + "'>" + urls.get(i) + "</a>");
119+
}
120+
}
121+
122+
kit.insertHTML(doc, doc.getLength(), str, 0, 0, null);
123+
htmlFound = true;
124+
} else {
125+
doc.insertString(doc.getLength(), str, null);
126+
}
127+
}
128+
} catch(BadLocationException exc) {
129+
exc.printStackTrace();
130+
} catch(IOException exc) {
131+
exc.printStackTrace();
132+
}
133+
134+
if (++updateCount > 150 && doTrim) {
135+
updateCount = 0;
136+
SwingUtilities.invokeLater(new Runnable() {
137+
public void run() {
138+
trimDocument();
139+
}
140+
});
141+
}
142+
return htmlFound;
143+
}
144+
145+
public void appendNoTrim(String s) {
146+
int free = maxChars - getDocument().getLength();
147+
if (free <= 0)
148+
return;
149+
if (s.length() > free)
150+
append(s.substring(0, free));
151+
else
152+
append(s);
153+
doTrim = false;
154+
}
155+
156+
public void appendTrim(String str) {
157+
append(str);
158+
doTrim = true;
159+
}
160+
}

Diff for: ‎app/src/processing/app/TextAreaFIFO.java

+4
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ public void trimDocument() {
7272
}
7373
}
7474

75+
public int getLength() {
76+
return getDocument().getLength();
77+
}
78+
7579
public void appendNoTrim(String s) {
7680
int free = maxChars - getDocument().getLength();
7781
if (free <= 0)

0 commit comments

Comments
 (0)