Use a separate RSyntaxTextArea for each editor tab

RSyntaxTextArea appears to support using a single instance and replacing
the underlying text and document when switching between tabs, but in
practice this support is not complete and even though the
RSyntaxTextArea developers did some work to improve the situation, they
recommend to just use a seperate instance for each tab.

This commit implements exactly that. A new class EditorTab is introduce
to wrap the RSyntaxTextArea and containing scroll pane, and to
encapsulate the code related to handling the text area itself. Doing so
removes some quirks and prepares for some later additions. In
particular, error highlights are now no longer shared between all tabs,
which was previously the case.

This commit mostly moves code from Editor into EditorTab, and updates
the callers to use getCurrentTab() and call methods on the result
instead of calling them on Editor. Some code is added to take care of
creating multiple EditorTab objects and switching between them. Some
small changes have been made to make the flow of opening files work,
though these are mostly a bit hacky.

While moving code, changes to the rest of the code were kept minimal,
retaining existing interfaces as much as possible. This sometimes result
in less than ideal code, which should be cleaned up in subsequent
commits.

The SketchCodeDocument class has been pretty much emptied out, since
it was mostly used to store things for tabs in the background, which are
now just stored in each RSyntaxTextArea separately. The last remaining
bits of this class can probably be moved or implemented differently
later, so it can be removed.

The entire flow of working with sketches and files needs to be cleaned
up next, so no thorough attempt at testing this commit was done. It is
likely that there are plenty of corner cases and race conditions, which
will be fixed once the reset of the code is cleaned up.

Fixes #3441

Author: matthijskooijman

app/src/cc/arduino/packages/formatter/AStyle.java

@@ -78,22 +78,22 @@ public void init(Editor editor) {
 
   @Override
   public void run() {
-    String originalText = editor.getText();
+    String originalText = editor.getCurrentTab().getText();
     String formattedText = aStyleInterface.AStyleMain(originalText, formatterConfiguration);
 
     if (formattedText.equals(originalText)) {
       editor.statusNotice(tr("No changes necessary for Auto Format."));
       return;
     }
 
-    SketchTextArea textArea = editor.getTextArea();
+    SketchTextArea textArea = editor.getCurrentTab().getTextArea();
 
     int line = getLineOfOffset(textArea);
     int lineOffset = getLineOffset(textArea, line);
 
     textArea.getUndoManager().beginInternalAtomicEdit();
     editor.removeAllLineHighlights();
-    editor.setText(formattedText);
+    editor.getCurrentTab().setText(formattedText);
     editor.getSketch().setModified(true);
     textArea.getUndoManager().endInternalAtomicEdit();
 

app/src/cc/arduino/view/GoToLineNumber.java

@@ -127,7 +127,7 @@ public void actionPerformed(java.awt.event.ActionEvent evt) {
   private void okActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_okActionPerformed
     try {
       int line = Integer.parseInt(lineNumber.getText());
-      editor.goToLine(line);
+      editor.getCurrentTab().goToLine(line);
       cancelActionPerformed(evt);
     } catch (Exception e) {
       // ignore

app/src/cc/arduino/view/findreplace/FindReplace.java

@@ -292,7 +292,7 @@ private boolean find(boolean wrap, boolean backwards, boolean searchTabs, int or
       return false;
     }
 
-    String text = editor.getText();
+    String text = editor.getCurrentTab().getText();
 
     if (ignoreCaseBox.isSelected()) {
       search = search.toLowerCase();
@@ -302,7 +302,7 @@ private boolean find(boolean wrap, boolean backwards, boolean searchTabs, int or
     int nextIndex;
     if (!backwards) {
       // int selectionStart = editor.textarea.getSelectionStart();
-      int selectionEnd = editor.getSelectionStop();
+      int selectionEnd = editor.getCurrentTab().getSelectionStop();
 
       nextIndex = text.indexOf(search, selectionEnd);
       if (wrap && nextIndex == -1) {
@@ -311,7 +311,7 @@ private boolean find(boolean wrap, boolean backwards, boolean searchTabs, int or
       }
     } else {
       // int selectionStart = editor.textarea.getSelectionStart();
-      int selectionStart = editor.getSelectionStart() - 1;
+      int selectionStart = editor.getCurrentTab().getSelectionStart() - 1;
 
       if (selectionStart >= 0) {
         nextIndex = text.lastIndexOf(search, selectionStart);
@@ -346,12 +346,12 @@ private boolean find(boolean wrap, boolean backwards, boolean searchTabs, int or
             if (backwards) {
               sketch.handlePrevCode();
               this.setVisible(true);
-              int l = editor.getText().length() - 1;
-              editor.setSelection(l, l);
+              int l = editor.getCurrentTab().getText().length() - 1;
+              editor.getCurrentTab().setSelection(l, l);
             } else {
               sketch.handleNextCode();
               this.setVisible(true);
-              editor.setSelection(0, 0);
+              editor.getCurrentTab().setSelection(0, 0);
             }
 
             return find(wrap, backwards, true, originTab);
@@ -365,7 +365,7 @@ private boolean find(boolean wrap, boolean backwards, boolean searchTabs, int or
     }
 
     if (nextIndex != -1) {
-      editor.setSelection(nextIndex, nextIndex + search.length());
+      editor.getCurrentTab().setSelection(nextIndex, nextIndex + search.length());
       return true;
     }
 
@@ -381,17 +381,17 @@ private void replace() {
       return;
     }
 
-    int newpos = editor.getSelectionStart() - findField.getText().length();
+    int newpos = editor.getCurrentTab().getSelectionStart() - findField.getText().length();
     if (newpos < 0) {
       newpos = 0;
     }
-    editor.setSelection(newpos, newpos);
+    editor.getCurrentTab().setSelection(newpos, newpos);
 
     boolean foundAtLeastOne = false;
 
     if (find(false, false, searchAllFilesBox.isSelected(), -1)) {
       foundAtLeastOne = true;
-      editor.setSelectedText(replaceField.getText());
+      editor.getCurrentTab().setSelectedText(replaceField.getText());
       editor.getSketch().setModified(true); // TODO is this necessary?
     }
 
@@ -423,13 +423,13 @@ private void replaceAll() {
       editor.getSketch().setCurrentCode(0); // select the first tab
     }
 
-    editor.setSelection(0, 0); // move to the beginning
+    editor.getCurrentTab().setSelection(0, 0); // move to the beginning
 
     boolean foundAtLeastOne = false;
     while (true) {
       if (find(false, false, searchAllFilesBox.isSelected(), -1)) {
         foundAtLeastOne = true;
-        editor.setSelectedText(replaceField.getText());
+        editor.getCurrentTab().setSelectedText(replaceField.getText());
         editor.getSketch().setModified(true); // TODO is this necessary?
       } else {
         break;

app/src/processing/app/Base.java

@@ -610,10 +610,10 @@ protected void handleActivated(Editor whichEditor) {
     activeEditor.rebuildRecentSketchesMenu();
     if (PreferencesData.getBoolean("editor.external")) {
       try {
-        int previousCaretPosition = activeEditor.getTextArea().getCaretPosition();
+        int previousCaretPosition = activeEditor.getCurrentTab().getTextArea().getCaretPosition();
         activeEditor.getSketch().load(true);
-        if (previousCaretPosition < activeEditor.getText().length()) {
-          activeEditor.getTextArea().setCaretPosition(previousCaretPosition);
+        if (previousCaretPosition < activeEditor.getCurrentTab().getText().length()) {
+          activeEditor.getCurrentTab().getTextArea().setCaretPosition(previousCaretPosition);
         }
       } catch (IOException e) {
         // noop