Rename Sketch and SketchData classes

Sketch is now called SketchController, since it didn't really represent
a sketch, but just handled the GUI-related stuff for a given sketch
(note that it is not strictly a controller in the MVC-sense, but it does
have a similar function). SketchData more accurately represented the
actual sketch, so it is now called Sketch. Below, the new names are
used.

Editor now keeps both a current Sketch and SketchController object, and
the Sketch object is created by Editor and passed to SketchController,
instead passing a File and letting SketchController create the Sketch.
Wherever possible, code now uses the Sketch directly (or indirectly,
through the new `SketchController.getSketch()`) and the accessors in
SketchController that merely forwarded to Sketch have been removed.
There are few things that now live in SketchController but should be
moved to Sketch (`isModified()`, `isUntitled()`), so some of the code
still has a dependency on SketchController that should be removed later.

This commit mostly renames classes, methods and variables, it should not
change the behaviour in any way.

Author: matthijskooijman

app/src/processing/app/Base.java

@@ -570,7 +570,7 @@ protected void storeSketches() {
       String path = editor.getSketch().getMainFilePath();
       // In case of a crash, save untitled sketches if they contain changes.
       // (Added this for release 0158, may not be a good idea.)
-      if (path.startsWith(untitledPath) && !editor.getSketch().isModified()) {
+      if (path.startsWith(untitledPath) && !editor.getSketchController().isModified()) {
         continue;
       }
       PreferencesData.set("last.sketch" + index + ".path", path);
@@ -583,13 +583,13 @@ protected void storeSketches() {
     PreferencesData.setInteger("last.sketch.count", index);
   }
 
-  protected void storeRecentSketches(Sketch sketch) {
+  protected void storeRecentSketches(SketchController sketch) {
     if (sketch.isUntitled()) {
       return;
     }
 
     Set<String> sketches = new LinkedHashSet<String>();
-    sketches.add(sketch.getMainFilePath());
+    sketches.add(sketch.getSketch().getMainFilePath());
     sketches.addAll(PreferencesData.getCollection("recent.sketches"));
 
     PreferencesData.setCollection("recent.sketches", sketches);
@@ -876,7 +876,7 @@ protected Editor handleOpen(File file, int[] storedLocation, int[] defaultLocati
     Editor editor = new Editor(this, file, storedLocation, defaultLocation, BaseNoGui.getPlatform());
 
     // Make sure that the sketch actually loaded
-    if (editor.getSketch() == null) {
+    if (editor.getSketchController() == null) {
       return null;  // Just walk away quietly
     }
 
@@ -888,7 +888,7 @@ protected Editor handleOpen(File file, int[] storedLocation, int[] defaultLocati
       // Store information on who's open and running
       // (in case there's a crash or something that can't be recovered)
       storeSketches();
-      storeRecentSketches(editor.getSketch());
+      storeRecentSketches(editor.getSketchController());
       rebuildRecentSketchesMenuItems();
       PreferencesData.save();
     }
@@ -1184,7 +1184,7 @@ public void actionPerformed(ActionEvent e) {
           public void actionPerformed(ActionEvent event) {
             UserLibrary l = (UserLibrary) getValue("library");
             try {
-              activeEditor.getSketch().importLibrary(l);
+              activeEditor.getSketchController().importLibrary(l);
             } catch (IOException e) {
               showWarning(tr("Error"), I18n.format("Unable to list header files in {0}", l.getSrcFolder()), e);
             }
@@ -1719,7 +1719,7 @@ protected void addLibraries(JMenu menu, LibraryList libs) throws IOException {
         public void actionPerformed(ActionEvent event) {
           UserLibrary l = (UserLibrary) getValue("library");
           try {
-            activeEditor.getSketch().importLibrary(l);
+            activeEditor.getSketchController().importLibrary(l);
           } catch (IOException e) {
             showWarning(tr("Error"), I18n.format("Unable to list header files in {0}", l.getSrcFolder()), e);
           }

app/src/processing/app/Editor.java

@@ -84,18 +84,18 @@ public class Editor extends JFrame implements RunnerListener {
   private ArrayList<EditorTab> tabs = new ArrayList<>();
   private int currentTabIndex = -1;
 
-  private static class ShouldSaveIfModified implements Predicate<Sketch> {
+  private static class ShouldSaveIfModified implements Predicate<SketchController> {
 
     @Override
-    public boolean test(Sketch sketch) {
+    public boolean test(SketchController sketch) {
       return PreferencesData.getBoolean("editor.save_on_verify") && sketch.isModified() && !sketch.isReadOnly(BaseNoGui.librariesIndexer.getInstalledLibraries(), BaseNoGui.getExamplesPath());
     }
   }
 
-  private static class ShouldSaveReadOnly implements Predicate<Sketch> {
+  private static class ShouldSaveReadOnly implements Predicate<SketchController> {
 
     @Override
-    public boolean test(Sketch sketch) {
+    public boolean test(SketchController sketch) {
       return sketch.isReadOnly(BaseNoGui.librariesIndexer.getInstalledLibraries(), BaseNoGui.getExamplesPath());
     }
   }
@@ -155,6 +155,7 @@ public boolean test(Sketch sketch) {
   private JSplitPane splitPane;
 
   // currently opened program
+  SketchController sketchController;
   Sketch sketch;
 
   EditorLineStatus lineStatus;
@@ -341,7 +342,7 @@ public void windowDeactivated(WindowEvent e) {
 
     // Open the document that was passed in
     boolean loaded = handleOpenInternal(file);
-    if (!loaded) sketch = null;
+    if (!loaded) sketchController = null;
 
 //    System.out.println("t5");
 
@@ -372,7 +373,7 @@ public boolean importData(JComponent src, Transferable transferable) {
           List<File> list = (List<File>)
             transferable.getTransferData(DataFlavor.javaFileListFlavor);
           for (File file : list) {
-            if (sketch.addFile(file)) {
+            if (sketchController.addFile(file)) {
               successful++;
             }
           }
@@ -390,7 +391,7 @@ public boolean importData(JComponent src, Transferable transferable) {
             } else if (piece.startsWith("file:/")) {
               path = piece.substring(5);
             }
-            if (sketch.addFile(new File(path))) {
+            if (sketchController.addFile(new File(path))) {
               successful++;
             }
           }
@@ -701,7 +702,7 @@ public void actionPerformed(ActionEvent e) {
     item = newJMenuItemAlt(tr("Export compiled Binary"), 'S');
     item.addActionListener(new ActionListener() {
         public void actionPerformed(ActionEvent e) {
-          if (new ShouldSaveReadOnly().test(sketch) && !handleSave(true)) {
+          if (new ShouldSaveReadOnly().test(sketchController) && !handleSave(true)) {
             System.out.println(tr("Export canceled, changes must first be saved."));
             return;
           }
@@ -739,7 +740,7 @@ public void actionPerformed(ActionEvent e) {
     item = new JMenuItem(tr("Add File..."));
     item.addActionListener(new ActionListener() {
       public void actionPerformed(ActionEvent e) {
-        sketch.handleAddFile();
+        sketchController.handleAddFile();
       }
     });
     sketchMenu.add(item);
@@ -1571,7 +1572,14 @@ private void resetHandlers() {
 
 
   /**
-   * Gets the current sketch object.
+   * Gets the current sketch controller.
+   */
+  public SketchController getSketchController() {
+    return sketchController;
+  }
+
+  /**
+   * Gets the current sketch.
    */
   public Sketch getSketch() {
     return sketch;
@@ -1728,9 +1736,9 @@ public void handleRun(final boolean verbose, Runnable verboseHandler, Runnable n
     handleRun(verbose, new ShouldSaveIfModified(), verboseHandler, nonVerboseHandler);
   }
 
-  private void handleRun(final boolean verbose, Predicate<Sketch> shouldSavePredicate, Runnable verboseHandler, Runnable nonVerboseHandler) {
+  private void handleRun(final boolean verbose, Predicate<SketchController> shouldSavePredicate, Runnable verboseHandler, Runnable nonVerboseHandler) {
     internalCloseRunner();
-    if (shouldSavePredicate.test(sketch)) {
+    if (shouldSavePredicate.test(sketchController)) {
       handleSave(true);
     }
     toolbar.activateRun();
@@ -1771,7 +1779,7 @@ public BuildHandler(boolean verbose, boolean saveHex) {
     public void run() {
       try {
         removeAllLineHighlights();
-        sketch.build(verbose, saveHex);
+        sketchController.build(verbose, saveHex);
         statusNotice(tr("Done compiling."));
       } catch (PreferencesMapException e) {
         statusError(I18n.format(
@@ -1838,14 +1846,15 @@ public void internalCloseRunner() {
    * @return false if canceling the close/quit operation
    */
   protected boolean checkModified() {
-    if (!sketch.isModified()) return true;
+    if (!sketchController.isModified()) return true;
 
     // As of Processing 1.0.10, this always happens immediately.
     // http://dev.processing.org/bugs/show_bug.cgi?id=1456
 
     toFront();
 
-    String prompt = I18n.format(tr("Save changes to \"{0}\"?  "), sketch.getName());
+    String prompt = I18n.format(tr("Save changes to \"{0}\"?  "),
+                                sketch.getName());
 
     if (!OSUtils.isMacOS()) {
       int result =
@@ -1932,7 +1941,7 @@ protected boolean handleOpenInternal(File sketchFile) {
     // in a folder of the same name
     String fileName = sketchFile.getName();
 
-    File file = SketchData.checkSketchFile(sketchFile);
+    File file = Sketch.checkSketchFile(sketchFile);
 
     if (file == null) {
       if (!fileName.endsWith(".ino") && !fileName.endsWith(".pde")) {
@@ -1988,11 +1997,12 @@ protected boolean handleOpenInternal(File sketchFile) {
     }
 
     try {
-      sketch = new Sketch(this, file);
+      sketch = new Sketch(file);
     } catch (IOException e) {
       Base.showWarning(tr("Error"), tr("Could not create the sketch."), e);
       return false;
     }
+    sketchController = new SketchController(this, sketch);
     createTabs();
 
     // Disable untitled setting from previous document, if any
@@ -2003,12 +2013,13 @@ protected boolean handleOpenInternal(File sketchFile) {
   }
 
   private void updateTitle() {
-    if (sketch == null) {
+    if (sketchController == null) {
       return;
     }
     SketchCode current = getCurrentTab().getSketchCode();
     if (sketch.getName().equals(current.getPrettyName())) {
-      setTitle(I18n.format(tr("{0} | Arduino {1}"), sketch.getName(), BaseNoGui.VERSION_NAME_LONG));
+      setTitle(I18n.format(tr("{0} | Arduino {1}"), sketch.getName(),
+                           BaseNoGui.VERSION_NAME_LONG));
     } else {
       setTitle(I18n.format(tr("{0} - {1} | Arduino {2}"), sketch.getName(),
                            current.getFileName(), BaseNoGui.VERSION_NAME_LONG));
@@ -2053,15 +2064,15 @@ private boolean handleSave2() {
     statusNotice(tr("Saving..."));
     boolean saved = false;
     try {
-      boolean wasReadOnly = sketch.isReadOnly(BaseNoGui.librariesIndexer.getInstalledLibraries(), BaseNoGui.getExamplesPath());
+      boolean wasReadOnly = sketchController.isReadOnly(BaseNoGui.librariesIndexer.getInstalledLibraries(), BaseNoGui.getExamplesPath());
       String previousMainFilePath = sketch.getMainFilePath();
-      saved = sketch.save();
+      saved = sketchController.save();
       if (saved) {
         statusNotice(tr("Done Saving."));
         if (wasReadOnly) {
           base.removeRecentSketchPath(previousMainFilePath);
         }
-        base.storeRecentSketches(sketch);
+        base.storeRecentSketches(sketchController);
         base.rebuildRecentSketchesMenuItems();
       } else {
         statusEmpty();
@@ -2098,8 +2109,8 @@ public boolean handleSaveAs() {
     //public void run() {
     statusNotice(tr("Saving..."));
     try {
-      if (sketch.saveAs()) {
-        base.storeRecentSketches(sketch);
+      if (sketchController.saveAs()) {
+        base.storeRecentSketches(sketchController);
         base.rebuildRecentSketchesMenuItems();
         statusNotice(tr("Done Saving."));
         // Disabling this for 0125, instead rebuild the menu inside
@@ -2166,7 +2177,7 @@ private boolean serialPrompt() {
    */
   synchronized public void handleExport(final boolean usingProgrammer) {
     if (PreferencesData.getBoolean("editor.save_on_verify")) {
-      if (sketch.isModified() && !sketch.isReadOnly(BaseNoGui.librariesIndexer.getInstalledLibraries(), BaseNoGui.getExamplesPath())) {
+      if (sketchController.isModified() && !sketchController.isReadOnly(BaseNoGui.librariesIndexer.getInstalledLibraries(), BaseNoGui.getExamplesPath())) {
         handleSave(true);
       }
     }
@@ -2192,7 +2203,7 @@ public void run() {
 
         uploading = true;
 
-        boolean success = sketch.exportApplet(false);
+        boolean success = sketchController.exportApplet(false);
         if (success) {
           statusNotice(tr("Done uploading."));
         }
@@ -2287,7 +2298,7 @@ public void run() {
 
         uploading = true;
 
-        boolean success = sketch.exportApplet(true);
+        boolean success = sketchController.exportApplet(true);
         if (success) {
           statusNotice(tr("Done uploading."));
         }

app/src/processing/app/EditorHeader.java

@@ -82,14 +82,14 @@ public class EditorHeader extends JComponent {
   public class Actions {
     public final Action newTab = new SimpleAction(tr("New Tab"),
         Keys.ctrlShift(KeyEvent.VK_N),
-        () -> editor.getSketch().handleNewCode());
+        () -> editor.getSketchController().handleNewCode());
 
     public final Action renameTab = new SimpleAction(tr("Rename"),
-        () -> editor.getSketch().handleRenameCode());
+        () -> editor.getSketchController().handleRenameCode());
 
     public final Action deleteTab = new SimpleAction(tr("Delete"), () -> {
       try {
-        editor.getSketch().handleDeleteCode();
+        editor.getSketchController().handleDeleteCode();
       } catch (IOException e) {
         e.printStackTrace();
       }
@@ -184,7 +184,7 @@ public void mousePressed(MouseEvent e) {
   public void paintComponent(Graphics screen) {
     if (screen == null) return;
 
-    Sketch sketch = editor.getSketch();
+    SketchController sketch = editor.getSketchController();
     if (sketch == null) return;  // ??
 
     Dimension size = getSize();

app/src/processing/app/EditorStatus.java

@@ -242,7 +242,7 @@ private void initialize() {
       // answering to rename/new code question
       if (mode == EDIT) {  // this if() isn't (shouldn't be?) necessary
         String answer = editField.getText();
-        editor.getSketch().nameCode(answer);
+        editor.getSketchController().nameCode(answer);
         unedit();
       }
     });
@@ -281,7 +281,7 @@ public void keyTyped(KeyEvent event) {
 
         if (c == KeyEvent.VK_ENTER) {  // accept the input
           String answer = editField.getText();
-          editor.getSketch().nameCode(answer);
+          editor.getSketchController().nameCode(answer);
           unedit();
           event.consume();
 

app/src/processing/app/EditorTab.java

@@ -157,7 +157,8 @@ private SketchTextArea createTextArea(RSyntaxDocument document)
       @Override
       public void hyperlinkUpdate(HyperlinkEvent hyperlinkEvent) {
         try {
-          editor.platform.openURL(editor.getSketch().getFolder(), hyperlinkEvent.getURL().toExternalForm());
+          editor.platform.openURL(editor.getSketch().getFolder(),
+                                  hyperlinkEvent.getURL().toExternalForm());
         } catch (Exception e) {
           Base.showWarning(e.getMessage(), e.getMessage(), e);
         }
@@ -357,8 +358,8 @@ public SketchTextArea getTextArea() {
   /**
    * Get the sketch this tab is editing a file from.
    */
-  public Sketch getSketch() {
-    return editor.getSketch();
+  public SketchController getSketch() {
+    return editor.getSketchController();
   }
 
   /**
@@ -415,7 +416,7 @@ private void setModified(boolean value) {
     if (value != modified) {
       modified = value;
       // TODO: Improve decoupling
-      editor.getSketch().calcModified();
+      editor.getSketchController().calcModified();
     }
   }