Do not store file contents in SketchCode

Now that each file in the sketch has its own text area in the GUI, it is
no longer needed to store the (possibly modified) contents of each file
inside SketchCode. Keeping the contents in the text area is sufficient.
Doing so allows removing the code that dealt with copying contents from
the text area into the SketchCode instance at the right time, which was
fragile and messy.

However, when compiling a sketch, the current (modified) file contents
still should be used. To allow this, the TextStorage interface is
introduced. This is a simple interface implemented by EditorTab, that
allows the SketchCode class to query the GUI for the current contents.
By using an interface, there is no direct dependency on the GUI code. If
no TextStorage instance is attached to a SketchCode, it will just assume
that the contents are always unmodified and the contents from the file
will be used during compilation.

When not using the GUI (e.g. just compiling something from the
commandline), there is no need to load the file contents from disk at
all, the filenames just have to be passed to arduino-builder and the
compiler. So, the SketchCode constructor no longer calls its `load()`
function, leaving this to the GUI code to call when appropriate. This
also modifies the `SketchCode.load()` function to return the loaded
text, instead of storing it internally.

To still support adding new files to a sketch (whose file does not
exist on disk yet), the EditorTab constructor now allows an initial
contents to be passed in, to be used instead of loading from disk. Only
the empty string is passed for new files now, but this could also be
used for the bare minimum contents of a new sketch later (which is now
down by creating a .ino file in a temporary directory).

Another side effect of this change is that all changes to the contents
now happen through the text area, which keeps track of modifications
already. This allows removing all manual calls to `Sketch.setModified()`
(even more, the entire function is removed, making `Sketch.isModified()`
always check the modification status of the contained files).

Author: matthijskooijman

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

@@ -94,7 +94,6 @@ public void run() {
     textArea.getUndoManager().beginInternalAtomicEdit();
     editor.removeAllLineHighlights();
     editor.getCurrentTab().setText(formattedText);
-    editor.getSketch().setModified(true);
     textArea.getUndoManager().endInternalAtomicEdit();
 
     if (line != -1 && lineOffset != -1) {

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

@@ -392,7 +392,6 @@ private void replace() {
     if (find(false, false, searchAllFilesBox.isSelected(), -1)) {
       foundAtLeastOne = true;
       editor.getCurrentTab().setSelectedText(replaceField.getText());
-      editor.getSketch().setModified(true); // TODO is this necessary?
     }
 
     if (!foundAtLeastOne) {
@@ -430,7 +429,6 @@ private void replaceAll() {
       if (find(false, false, searchAllFilesBox.isSelected(), -1)) {
         foundAtLeastOne = true;
         editor.getCurrentTab().setSelectedText(replaceField.getText());
-        editor.getSketch().setModified(true); // TODO is this necessary?
       } else {
         break;
       }

app/src/processing/app/Editor.java

@@ -1342,7 +1342,6 @@ public void actionPerformed(ActionEvent e) {
     pasteItem.addActionListener(new ActionListener() {
         public void actionPerformed(ActionEvent e) {
           getCurrentTab().handlePaste();
-          sketch.setModified(true);
         }
       });
     menu.add(pasteItem);
@@ -1492,7 +1491,6 @@ public UndoAction() {
     public void actionPerformed(ActionEvent e) {
       try {
         getCurrentTab().handleRedo();
-        sketch.setModified(true);
       } catch (CannotUndoException ex) {
         //System.out.println("Unable to undo: " + ex);
         //ex.printStackTrace();
@@ -1526,7 +1524,6 @@ public RedoAction() {
     public void actionPerformed(ActionEvent e) {
       try {
         getCurrentTab().handleRedo();
-        sketch.setModified(true);
       } catch (CannotRedoException ex) {
         //System.out.println("Unable to redo: " + ex);
         //ex.printStackTrace();
@@ -1631,7 +1628,7 @@ public void sketchLoaded(Sketch sketch) {
     tabs.ensureCapacity(sketch.getCodeCount());
     for (SketchCode code : sketch.getCodes()) {
       try {
-        addTab(code);
+        addTab(code, null);
       } catch(IOException e) {
         // TODO: Improve / move error handling
         System.err.println(e);
@@ -1647,8 +1644,18 @@ protected void setCode(final SketchCodeDocument codeDoc) {
 		selectTab(findTabIndex(codeDoc.getCode()));
   }
 
-  protected void addTab(SketchCode code) throws IOException {
-    EditorTab tab = new EditorTab(this, code);
+  /**
+   * Add a new tab.
+   *
+   * @param code
+   *          The file to show in the tab.
+   * @param contents
+   *          The contents to show in the tab, or null to load the
+   *          contents from the given file.
+   * @throws IOException
+   */
+  protected void addTab(SketchCode code, String contents) throws IOException {
+    EditorTab tab = new EditorTab(this, code, contents);
     tabs.add(tab);
   }
 

app/src/processing/app/EditorTab.java

@@ -63,37 +63,63 @@
 /**
  * Single tab, editing a single file, in the main window.
  */
-public class EditorTab extends JPanel {
+public class EditorTab extends JPanel implements SketchCode.TextStorage {
   protected Editor editor;
   protected SketchTextArea textarea;
   protected RTextScrollPane scrollPane;
   protected SketchCode code;
+  protected boolean modified;
 
-  public EditorTab(Editor editor, SketchCode code) throws IOException {
+  /**
+   * Create a new EditorTab
+   *
+   * @param editor
+   *          The Editor this tab runs in
+   * @param code
+   *          The file to display in this tab
+   * @param contents
+   *          Initial contents to display in this tab. Can be used when
+   *          editing a file that doesn't exist yet. If null is passed,
+   *          code.load() is called and displayed instead.
+   * @throws IOException
+   */
+  public EditorTab(Editor editor, SketchCode code, String contents)
+      throws IOException {
     super(new BorderLayout());
+
+    // Load initial contents contents from file if nothing was specified.
+    if (contents == null) {
+      contents = code.load();
+      modified = false;
+    } else {
+      modified = true;
+    }
+
     this.editor = editor;
     this.code = code;
-    this.textarea = createTextArea();
+    RSyntaxDocument document = createDocument(contents);
+    this.textarea = createTextArea(document);
     this.scrollPane = createScrollPane(this.textarea);
     applyPreferences();
     add(this.scrollPane, BorderLayout.CENTER);
-    
+
     UndoManager undo = new LastUndoableEditAwareUndoManager(this.textarea, this.editor);
     ((RSyntaxDocument)textarea.getDocument()).addUndoableEditListener(undo);
+    code.setStorage(this);
   }
 
-  private RSyntaxDocument createDocument() {
+  private RSyntaxDocument createDocument(String contents) {
     RSyntaxDocument document = new RSyntaxDocument(new ArduinoTokenMakerFactory(editor.base.getPdeKeywords()), RSyntaxDocument.SYNTAX_STYLE_CPLUSPLUS);
     document.putProperty(PlainDocument.tabSizeAttribute, PreferencesData.getInteger("editor.tabs.size"));
-    
+
     // insert the program text into the document object
     try {
-      document.insertString(0, code.getProgram(), null);
+      document.insertString(0, contents, null);
     } catch (BadLocationException bl) {
       bl.printStackTrace();
     }
     document.addDocumentListener(new DocumentTextChangeListener(
-        () -> code.setModified(true)));
+        () -> setModified(true)));
     return document;
   }
 
@@ -112,8 +138,8 @@ private RTextScrollPane createScrollPane(SketchTextArea textArea) throws IOExcep
     return scrollPane;
   }
 
-  private SketchTextArea createTextArea() throws IOException {
-    RSyntaxDocument document = createDocument();    
+  private SketchTextArea createTextArea(RSyntaxDocument document)
+      throws IOException {
     final SketchTextArea textArea = new SketchTextArea(document, editor.base.getPdeKeywords());
     textArea.setName("editor");
     textArea.setFocusTraversalKeysEnabled(false);
@@ -316,6 +342,29 @@ public void setText(String what) {
     textarea.setText(what);
   }
 
+  /**
+   * Is the text modified since the last save / load?
+   */
+  public boolean isModified() {
+    return modified;
+  }
+
+  /**
+   * Clear modified status. Should only be called by SketchCode through
+   * the TextStorage interface.
+   */
+  public void clearModified() {
+    setModified(false);
+  }
+
+  private void setModified(boolean value) {
+    if (value != modified) {
+      modified = value;
+      // TODO: Improve decoupling
+      editor.getSketch().calcModified();
+    }
+  }
+
   public String getSelectedText() {
     return textarea.getSelectedText();
   }

app/src/processing/app/Sketch.java

@@ -58,9 +58,6 @@
 public class Sketch {
   private final Editor editor;
 
-  /** true if any of the files have been modified. */
-  private boolean modified;
-
   private SketchCodeDocument current;
   private int currentIndex;
 
@@ -320,7 +317,6 @@ protected void nameCode(String newName) {
 
         // first get the contents of the editor text area
         if (current.getCode().isModified()) {
-          current.getCode().setProgram(editor.getCurrentTab().getText());
           try {
             // save this new SketchCode
             current.getCode().save();
@@ -403,7 +399,7 @@ protected void nameCode(String newName) {
       ensureExistence();
       SketchCode code = (new SketchCodeDocument(this, newFile)).getCode();
       try {
-        editor.addTab(code);
+        editor.addTab(code, "");
       } catch (IOException e) {
         Base.showWarning(tr("Error"),
        I18n.format(
@@ -510,39 +506,28 @@ public void handleNextCode() {
     setCurrentCode((currentIndex + 1) % data.getCodeCount());
   }
 
-
   /**
-   * Sets the modified value for the code in the frontmost tab.
+   * Called whenever the modification status of one of the tabs changes. TODO:
+   * Move this code into Editor and improve decoupling from EditorTab
    */
-  public void setModified(boolean state) {
-    //System.out.println("setting modified to " + state);
-    //new Exception().printStackTrace();
-    current.getCode().setModified(state);
-    calcModified();
-  }
-
-
-  private void calcModified() {
-    modified = false;
-    for (SketchCode code : data.getCodes()) {
-      if (code.isModified()) {
-        modified = true;
-        break;
-      }
-    }
+  public void calcModified() {
     editor.header.repaint();
 
     if (OSUtils.isMacOS()) {
       // http://developer.apple.com/qa/qa2001/qa1146.html
-      Object modifiedParam = modified ? Boolean.TRUE : Boolean.FALSE;
+      Object modifiedParam = isModified() ? Boolean.TRUE : Boolean.FALSE;
       editor.getRootPane().putClientProperty("windowModified", modifiedParam);
       editor.getRootPane().putClientProperty("Window.documentModified", modifiedParam);
     }
   }
 
 
   public boolean isModified() {
-    return modified;
+    for (SketchCode code : data.getCodes()) {
+      if (code.isModified())
+        return true;
+    }
+    return false;
   }
 
 
@@ -553,14 +538,6 @@ public boolean save() throws IOException {
     // make sure the user didn't hide the sketch folder
     ensureExistence();
 
-    // first get the contents of the editor text area
-    if (current.getCode().isModified()) {
-      current.getCode().setProgram(editor.getCurrentTab().getText());
-    }
-
-    // don't do anything if not actually modified
-    //if (!modified) return false;
-
     if (isReadOnly(BaseNoGui.librariesIndexer.getInstalledLibraries(), BaseNoGui.getExamplesPath())) {
       Base.showMessage(tr("Sketch is read-only"),
         tr("Some files are marked \"read-only\", so you'll\n" +
@@ -606,7 +583,6 @@ public boolean save() throws IOException {
     }
 
     data.save();
-    calcModified();
     return true;
   }
 
@@ -708,12 +684,6 @@ protected boolean saveAs() throws IOException {
     // now make a fresh copy of the folder
     newFolder.mkdirs();
 
-    // grab the contents of the current tab before saving
-    // first get the contents of the editor text area
-    if (current.getCode().isModified()) {
-      current.getCode().setProgram(editor.getCurrentTab().getText());
-    }
-
     // save the other tabs to their new location
     for (SketchCode code : data.getCodes()) {
       if (data.indexOfCode(code) == 0) continue;
@@ -913,18 +883,6 @@ public boolean addFile(File sourceFile) {
         data.sortCode();
       }
       setCurrentCode(filename);
-      editor.header.repaint();
-      if (editor.untitled) {  // TODO probably not necessary? problematic?
-        // Mark the new code as modified so that the sketch is saved
-        current.getCode().setModified(true);
-      }
-
-    } else {
-      if (editor.untitled) {  // TODO probably not necessary? problematic?
-        // If a file has been added, mark the main code as modified so
-        // that the sketch is properly saved.
-        data.getCode(0).setModified(true);
-      }
     }
     return true;
   }
@@ -966,7 +924,6 @@ private void importLibrary(File jarPath) throws IOException {
     buffer.append(editor.getCurrentTab().getText());
     editor.getCurrentTab().setText(buffer.toString());
     editor.getCurrentTab().setSelection(0, 0);  // scroll to start
-    setModified(true);
   }
 
 
@@ -988,10 +945,6 @@ private void setCurrentCode(int which, boolean forceUpdate) {
       return;
     }
 
-    // get the text currently being edited
-    if (current != null)
-      current.getCode().setProgram(editor.getCurrentTab().getText());
-
     current = (SketchCodeDocument) data.getCode(which).getMetadata();
     currentIndex = which;
     editor.setCode(current);
@@ -1050,8 +1003,6 @@ public void prepare() throws IOException {
     // make sure the user didn't hide the sketch folder
     ensureExistence();
 
-    current.getCode().setProgram(editor.getCurrentTab().getText());
-
     // TODO record history here
     //current.history.record(program, SketchHistory.RUN);
 
@@ -1215,7 +1166,6 @@ private void ensureExistence() {
                        "but anything besides the code will be lost."), null);
     try {
       data.getFolder().mkdirs();
-      modified = true;
 
       for (SketchCode code : data.getCodes()) {
         code.save();  // this will force a save

app/src/processing/app/tools/FixEncoding.java

@@ -67,9 +67,7 @@ public void run() {
     try {
       for (int i = 0; i < sketch.getCodeCount(); i++) {
         SketchCode code = sketch.getCode(i);
-        code.setProgram(loadWithLocalEncoding(code.getFile()));
-        code.setModified(true);  // yes, because we want them to save this
-        editor.findTab(code).setText(code.getProgram());
+        editor.findTab(code).setText(loadWithLocalEncoding(code.getFile()));
       }
     } catch (IOException e) {
       String msg =