Working on how sketches are marked readonly.

Initial refactorings: stopped using static members (static is evil)

Author: Federico Fissore

app/src/processing/app/Base.java

@@ -1772,10 +1772,6 @@ public List<JMenu> getBoardsCustomMenus() {
     return boardsCustomMenus;
   }
 
-  static public String getSketchbookLibrariesPath() {
-    return BaseNoGui.getSketchbookLibrariesFolder().getAbsolutePath();
-  }
-
   public File getDefaultSketchbookFolderOrPromptForIt() {
 
     File sketchbookFolder = BaseNoGui.getDefaultSketchbookFolder();

app/src/processing/app/Editor.java

@@ -93,15 +93,15 @@ private static class ShouldSaveIfModified implements Predicate<Sketch> {
 
     @Override
     public boolean test(Sketch sketch) {
-      return PreferencesData.getBoolean("editor.save_on_verify") && sketch.isModified() && !sketch.isReadOnly();
+      return PreferencesData.getBoolean("editor.save_on_verify") && sketch.isModified() && !sketch.isReadOnly(BaseNoGui.getLibrariesPath(), BaseNoGui.getExamplesPath());
     }
   }
 
   private static class ShouldSaveReadOnly implements Predicate<Sketch> {
 
     @Override
     public boolean test(Sketch sketch) {
-      return sketch.isReadOnly();
+      return sketch.isReadOnly(BaseNoGui.getLibrariesPath(), BaseNoGui.getExamplesPath());
     }
   }
 
@@ -2282,7 +2282,7 @@ private boolean handleSave2() {
     statusNotice(tr("Saving..."));
     boolean saved = false;
     try {
-      boolean wasReadOnly = sketch.isReadOnly();
+      boolean wasReadOnly = sketch.isReadOnly(BaseNoGui.getLibrariesPath(), BaseNoGui.getExamplesPath());
       String previousMainFilePath = sketch.getMainFilePath();
       saved = sketch.save();
       if (saved) {
@@ -2395,7 +2395,7 @@ private boolean serialPrompt() {
    */
   synchronized public void handleExport(final boolean usingProgrammer) {
     if (PreferencesData.getBoolean("editor.save_on_verify")) {
-      if (sketch.isModified() && !sketch.isReadOnly()) {
+      if (sketch.isModified() && !sketch.isReadOnly(BaseNoGui.getLibrariesPath(), BaseNoGui.getExamplesPath())) {
         handleSave(true);
       }
     }

app/src/processing/app/Sketch.java

@@ -133,7 +133,7 @@ public void handleNewCode() {
     ensureExistence();
 
     // if read-only, give an error
-    if (isReadOnly()) {
+    if (isReadOnly(BaseNoGui.getLibrariesPath(), BaseNoGui.getExamplesPath())) {
       // if the files are read-only, need to first do a "save as".
       Base.showMessage(tr("Sketch is Read-Only"),
                        tr("Some files are marked \"read-only\", so you'll\n" +
@@ -162,7 +162,7 @@ public void handleRenameCode() {
     }
 
     // if read-only, give an error
-    if (isReadOnly()) {
+    if (isReadOnly(BaseNoGui.getLibrariesPath(), BaseNoGui.getExamplesPath())) {
       // if the files are read-only, need to first do a "save as".
       Base.showMessage(tr("Sketch is Read-Only"),
                        tr("Some files are marked \"read-only\", so you'll\n" +
@@ -432,7 +432,7 @@ public void handleDeleteCode() {
     ensureExistence();
 
     // if read-only, give an error
-    if (isReadOnly()) {
+    if (isReadOnly(BaseNoGui.getLibrariesPath(), BaseNoGui.getExamplesPath())) {
       // if the files are read-only, need to first do a "save as".
       Base.showMessage(tr("Sketch is Read-Only"),
                        tr("Some files are marked \"read-only\", so you'll\n" +
@@ -558,7 +558,7 @@ public boolean save() throws IOException {
     // don't do anything if not actually modified
     //if (!modified) return false;
 
-    if (isReadOnly()) {
+    if (isReadOnly(BaseNoGui.getLibrariesPath(), BaseNoGui.getExamplesPath())) {
       // if the files are read-only, need to first do a "save as".
       Base.showMessage(tr("Sketch is read-only"),
                        tr("Some files are marked \"read-only\", so you'll\n" +
@@ -637,7 +637,7 @@ private boolean renameCodeToInoExtension(File pdeFile) {
   protected boolean saveAs() throws IOException {
     // get new name for folder
     FileDialog fd = new FileDialog(editor, tr("Save sketch folder as..."), FileDialog.SAVE);
-    if (isReadOnly() || isUntitled()) {
+    if (isReadOnly(BaseNoGui.getLibrariesPath(), BaseNoGui.getExamplesPath()) || isUntitled()) {
       // default to the sketchbook folder
       fd.setDirectory(BaseNoGui.getSketchbookFolder().getAbsolutePath());
     } else {
@@ -772,7 +772,7 @@ public void handleAddFile() {
     ensureExistence();
 
     // if read-only, give an error
-    if (isReadOnly()) {
+    if (isReadOnly(BaseNoGui.getLibrariesPath(), BaseNoGui.getExamplesPath())) {
       // if the files are read-only, need to first do a "save as".
       Base.showMessage(tr("Sketch is Read-Only"),
                        tr("Some files are marked \"read-only\", so you'll\n" +
@@ -1223,25 +1223,27 @@ private void ensureExistence() {
    * Returns true if this is a read-only sketch. Used for the
    * examples directory, or when sketches are loaded from read-only
    * volumes or folders without appropriate permissions.
+   * @param librariesPaths
+   * @param examplesPath
    */
-  public boolean isReadOnly() {
+  public boolean isReadOnly(List<File> librariesPaths, String examplesPath) {
     String apath = data.getFolder().getAbsolutePath();
-    for (File folder : BaseNoGui.getLibrariesPath()) {
-      if (apath.startsWith(folder.getAbsolutePath()))
+    for (File folder : librariesPaths) {
+      if (apath.startsWith(folder.getAbsolutePath())) {
         return true;
-    }
-    if (apath.startsWith(BaseNoGui.getExamplesPath()) ||
-        apath.startsWith(Base.getSketchbookLibrariesPath())) {
-      return true;
+      }
     }
 
-    // canWrite() doesn't work on directories
-    // } else if (!folder.canWrite()) {
+    return sketchIsSystemExample(apath, examplesPath) || sketchFilesAreReadOnly();
+  }
+
+  private boolean sketchIsSystemExample(String apath, String examplesPath) {
+    return apath.startsWith(examplesPath);
+  }
 
-    // check to see if each modified code file can be written to
+  private boolean sketchFilesAreReadOnly() {
     for (SketchCode code : data.getCodes()) {
       if (code.isModified() && code.fileReadOnly() && code.fileExists()) {
-        // System.err.println("found a read-only file " + code[i].file);
         return true;
       }
     }

arduino-core/src/processing/app/BaseNoGui.java

@@ -69,9 +69,6 @@ public class BaseNoGui {
   // maps #included files to their library folder
   public static Map<String, LibraryList> importToLibraryTable;
 
-  // maps library name to their library folder
-  static private LibraryList libraries;
-
   // XXX: Remove this field
   static private List<File> librariesFolders;
 
@@ -237,10 +234,6 @@ static public String getHardwarePath() {
     return getHardwareFolder().getAbsolutePath();
   }
 
-  static public LibraryList getLibraries() {
-    return libraries;
-  }
-
   static public List<File> getLibrariesPath() {
     return librariesFolders;
   }