Skip to content

Commit cfb53a6

Browse files
facchinmfacchinm
committed
Initial implementation of bookmarks
Toggle on the left, find next with F3
1 parent 7925d40 commit cfb53a6

File tree

2 files changed

+139
-2
lines changed

2 files changed

+139
-2
lines changed

‎app/src/cc/arduino/view/preferences/Preferences.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ private void initComponents() {
130130
checkboxesContainer = new javax.swing.JPanel();
131131
displayLineNumbersBox = new javax.swing.JCheckBox();
132132
enableCodeFoldingBox = new javax.swing.JCheckBox();
133+
enableBookmarks = new javax.swing.JCheckBox();
133134
verifyUploadBox = new javax.swing.JCheckBox();
134135
externalEditorBox = new javax.swing.JCheckBox();
135136
checkUpdatesBox = new javax.swing.JCheckBox();
@@ -254,6 +255,9 @@ public void mouseEntered(java.awt.event.MouseEvent evt) {
254255
enableCodeFoldingBox.setText(tr("Enable Code Folding"));
255256
checkboxesContainer.add(enableCodeFoldingBox);
256257

258+
enableBookmarks.setText(tr("Enable Bookmarks"));
259+
checkboxesContainer.add(enableBookmarks);
260+
257261
verifyUploadBox.setText(tr("Verify code after upload"));
258262
checkboxesContainer.add(verifyUploadBox);
259263

@@ -720,6 +724,7 @@ private void autoScaleCheckBoxItemStateChanged(java.awt.event.ItemEvent evt) {//
720724
private javax.swing.JLabel comboWarningsLabel;
721725
private javax.swing.JCheckBox displayLineNumbersBox;
722726
private javax.swing.JCheckBox enableCodeFoldingBox;
727+
private javax.swing.JCheckBox enableBookmarks;
723728
private javax.swing.JButton extendedAdditionalUrlFieldWindow;
724729
private javax.swing.JCheckBox externalEditorBox;
725730
private javax.swing.JTextField fontSizeField;
@@ -818,6 +823,8 @@ private void savePreferencesData() {
818823

819824
PreferencesData.setBoolean("editor.code_folding", enableCodeFoldingBox.isSelected());
820825

826+
PreferencesData.setBoolean("editor.bookmarks", enableBookmarks.isSelected());
827+
821828
PreferencesData.setBoolean("upload.verify", verifyUploadBox.isSelected());
822829

823830
PreferencesData.setBoolean("editor.save_on_verify", saveVerifyUploadBox.isSelected());
@@ -888,6 +895,8 @@ private void showPreferencesData() {
888895

889896
enableCodeFoldingBox.setSelected(PreferencesData.getBoolean("editor.code_folding"));
890897

898+
enableBookmarks.setSelected(PreferencesData.getBoolean("editor.bookmarks"));
899+
891900
verifyUploadBox.setSelected(PreferencesData.getBoolean("upload.verify"));
892901

893902
externalEditorBox.setSelected(PreferencesData.getBoolean("editor.external"));

‎app/src/processing/app/EditorTab.java‎

Lines changed: 130 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,28 @@
2828

2929
import java.awt.BorderLayout;
3030
import java.awt.Font;
31+
import java.awt.Toolkit;
3132
import java.awt.event.ActionEvent;
3233
import java.awt.event.ActionListener;
34+
import java.awt.event.InputEvent;
35+
import java.awt.event.KeyEvent;
36+
import java.awt.event.MouseWheelListener;
37+
import java.awt.event.MouseWheelEvent;
3338

3439
import java.io.IOException;
3540

3641
import javax.swing.Action;
3742
import javax.swing.BorderFactory;
43+
import javax.swing.Icon;
44+
import javax.swing.InputMap;
45+
import javax.swing.JComponent;
3846
import javax.swing.JMenuItem;
3947
import javax.swing.JPanel;
4048
import javax.swing.JPopupMenu;
49+
import javax.swing.KeyStroke;
50+
import javax.swing.SwingUtilities;
4151
import javax.swing.ToolTipManager;
52+
import javax.swing.UIManager;
4253
import javax.swing.border.MatteBorder;
4354
import javax.swing.event.PopupMenuEvent;
4455
import javax.swing.event.PopupMenuListener;
@@ -50,6 +61,8 @@
5061

5162
import static java.nio.file.StandardWatchEventKinds.*;
5263
import java.nio.file.WatchService;
64+
import java.util.ArrayList;
65+
import java.util.List;
5366
import java.nio.file.WatchKey;
5467
import java.nio.file.WatchEvent;
5568
import java.nio.file.FileSystems;
@@ -60,15 +73,23 @@
6073
import org.fife.ui.autocomplete.AutoCompletion;
6174
import org.fife.ui.autocomplete.DefaultCompletionProvider;
6275
import org.fife.ui.rsyntaxtextarea.RSyntaxDocument;
76+
import org.fife.ui.rsyntaxtextarea.RSyntaxTextArea;
6377
import org.fife.ui.rsyntaxtextarea.RSyntaxTextAreaEditorKit;
6478
import org.fife.ui.rsyntaxtextarea.RSyntaxUtilities;
6579
import org.fife.ui.rtextarea.Gutter;
80+
import org.fife.ui.rtextarea.GutterIconInfo;
81+
import org.fife.ui.rtextarea.RTADefaultInputMap;
82+
import org.fife.ui.rtextarea.RTextArea;
83+
import org.fife.ui.rtextarea.RTextAreaEditorKit;
6684
import org.fife.ui.rtextarea.RTextScrollPane;
85+
import org.fife.ui.rtextarea.RecordableTextAction;
6786

6887
import cc.arduino.UpdatableBoardsLibsFakeURLsHandler;
6988
import cc.arduino.autocomplete.ClangCompletionProvider;
89+
import cc.arduino.autocomplete.CompletionType;
7090
import cc.arduino.autocomplete.CompletionsRenderer;
7191
import processing.app.helpers.DocumentTextChangeListener;
92+
import processing.app.helpers.PreferencesMap;
7293
import processing.app.syntax.ArduinoTokenMakerFactory;
7394
import processing.app.syntax.PdeKeywords;
7495
import processing.app.syntax.SketchTextArea;
@@ -152,6 +173,8 @@ private RSyntaxDocument createDocument(String contents) {
152173
return document;
153174
}
154175

176+
public static final String rtaNextBookmarkAction = "RTA.NextBookmarkAction";
177+
155178
private RTextScrollPane createScrollPane(SketchTextArea textArea) throws IOException {
156179
RTextScrollPane scrollPane = new RTextScrollPane(textArea, true);
157180
scrollPane.setBorder(new MatteBorder(0, 6, 0, 0, Theme.getColor("editor.bgcolor")));
@@ -160,13 +183,118 @@ private RTextScrollPane createScrollPane(SketchTextArea textArea) throws IOExcep
160183
scrollPane.setIconRowHeaderEnabled(false);
161184

162185
Gutter gutter = scrollPane.getGutter();
163-
gutter.setBookmarkingEnabled(false);
164-
//gutter.setBookmarkIcon(CompletionsRenderer.getIcon(CompletionType.TEMPLATE));
186+
187+
if (PreferencesData.getBoolean("editor.bookmarks")) {
188+
gutter.setBookmarkingEnabled(true);
189+
gutter.setBookmarkIcon(CompletionsRenderer.getIcon(CompletionType.FUNCTION));
190+
InputMap map = SwingUtilities.getUIInputMap(textArea, JComponent.WHEN_FOCUSED);
191+
NextBookmarkAction action = new NextBookmarkAction(rtaNextBookmarkAction);
192+
map.put(KeyStroke.getKeyStroke(KeyEvent.VK_F3, 0), action);
193+
SwingUtilities.replaceUIInputMap(textArea,JComponent.WHEN_FOCUSED,map);
194+
}
195+
165196
gutter.setIconRowHeaderInheritsGutterBackground(true);
166197

167198
return scrollPane;
168199
}
169200

201+
public class GutterIconInfoTabs {
202+
GutterIconInfo bookmark;
203+
SketchFile file;
204+
RTextArea textArea;
205+
206+
public String toString( ) {
207+
return "File:" + file.getFileName() + " -- Line:" + bookmark.getMarkedOffset();
208+
}
209+
}
210+
211+
/**
212+
* Action that moves the caret to the next bookmark.
213+
*/
214+
public class NextBookmarkAction extends RecordableTextAction {
215+
216+
public NextBookmarkAction(String name) {
217+
super(name);
218+
}
219+
220+
@Override
221+
public void actionPerformedImpl(ActionEvent e, RTextArea textArea) {
222+
223+
Gutter gutter = RSyntaxUtilities.getGutter(textArea);
224+
225+
List<GutterIconInfoTabs> bookmarks = new ArrayList<GutterIconInfoTabs>();
226+
227+
try {
228+
229+
for (EditorTab tab : editor.getTabs()) {
230+
gutter = RSyntaxUtilities.getGutter(tab.getTextArea());
231+
232+
if (gutter!=null) {
233+
GutterIconInfo[] tabBookmarks = gutter.getBookmarks();
234+
for (GutterIconInfo element : tabBookmarks) {
235+
GutterIconInfoTabs bookmark = new GutterIconInfoTabs();
236+
bookmark.file = tab.getSketchFile();
237+
bookmark.bookmark = element;
238+
bookmark.textArea = tab.getTextArea();
239+
bookmarks.add(bookmark);
240+
}
241+
}
242+
}
243+
244+
if (bookmarks.size()==0) {
245+
UIManager.getLookAndFeel().
246+
provideErrorFeedback(textArea);
247+
return;
248+
}
249+
250+
GutterIconInfoTabs moveTo = null;
251+
int curLine = textArea.getCaretLineNumber();
252+
253+
for (int i=0; i<bookmarks.size(); i++) {
254+
GutterIconInfo bookmark = bookmarks.get(i).bookmark;
255+
int offs = bookmark.getMarkedOffset();
256+
int line = 0;
257+
int curTabIndex = editor.getCurrentTabIndex();
258+
int bookmarkTabIndex = editor.findTabIndex(bookmarks.get(i).file);
259+
if (curTabIndex == bookmarkTabIndex) {
260+
line = textArea.getLineOfOffset(offs);
261+
}
262+
if ((curTabIndex == bookmarkTabIndex && line>curLine) || (curTabIndex < bookmarkTabIndex)) {
263+
moveTo = bookmarks.get(i);
264+
break;
265+
}
266+
}
267+
if (moveTo==null) { // Loop back to beginning
268+
moveTo = bookmarks.get(0);
269+
}
270+
271+
editor.selectTab(editor.findTabIndex(moveTo.file));
272+
273+
int offs = moveTo.bookmark.getMarkedOffset();
274+
if (moveTo.textArea instanceof RSyntaxTextArea) {
275+
RSyntaxTextArea rsta = (RSyntaxTextArea)moveTo.textArea;
276+
if (rsta.isCodeFoldingEnabled()) {
277+
rsta.getFoldManager().
278+
ensureOffsetNotInClosedFold(offs);
279+
}
280+
}
281+
int line = moveTo.textArea.getLineOfOffset(offs);
282+
offs = moveTo.textArea.getLineStartOffset(line);
283+
moveTo.textArea.setCaretPosition(offs);
284+
285+
} catch (BadLocationException ble) { // Never happens
286+
UIManager.getLookAndFeel().
287+
provideErrorFeedback(textArea);
288+
ble.printStackTrace();
289+
}
290+
}
291+
292+
@Override
293+
public String getMacroID() {
294+
return getName();
295+
}
296+
}
297+
170298
private SketchTextArea createTextArea(RSyntaxDocument document)
171299
throws IOException {
172300
final SketchTextArea textArea = new SketchTextArea(document, editor.base.getPdeKeywords());

0 commit comments

Comments
 (0)