Removed the now useless UserLibraryFolder

Author: cmaglie

app/src/processing/app/Base.java

@@ -57,7 +57,6 @@
 import processing.app.macosx.ThinkDifferent;
 import processing.app.packages.LibraryList;
 import processing.app.packages.UserLibrary;
-import processing.app.packages.UserLibraryFolder.Location;
 import processing.app.syntax.PdeKeywords;
 import processing.app.syntax.SketchTextAreaDefaultInputMap;
 import processing.app.tools.MenuScroller;
@@ -78,6 +77,10 @@
 
 import static processing.app.I18n.format;
 import static processing.app.I18n.tr;
+import static processing.app.packages.UserLibrary.LOCATION_CORE;
+import static processing.app.packages.UserLibrary.LOCATION_IDE;
+import static processing.app.packages.UserLibrary.LOCATION_REF_CORE;
+import static processing.app.packages.UserLibrary.LOCATION_SKETCHBOOK;
 
 
 /**
@@ -1214,7 +1217,7 @@ public void rebuildExamplesMenu(JMenu menu) {
     LibraryList otherLibs = new LibraryList();
     for (UserLibrary lib : allLibraries) {
       // Get the library's location - used for sorting into categories
-      Location location = lib.getLocation();
+      String location = lib.getLocation();
       // Is this library compatible?
       Collection<String> arch = lib.getArchitectures();
       boolean compatible;
@@ -1224,7 +1227,7 @@ public void rebuildExamplesMenu(JMenu menu) {
         compatible = arch.contains(myArch);
       }
       // IDE Libaries (including retired)
-      if (location == Location.IDE_BUILTIN) {
+      if (location.equals(LOCATION_IDE)) {
         if (compatible) {
           // only compatible IDE libs are shown
           if (lib.getTypes().contains("Retired")) {
@@ -1234,15 +1237,15 @@ public void rebuildExamplesMenu(JMenu menu) {
           }
         }
       // Platform Libraries
-      } else if (location == Location.CORE) {
+      } else if (location.equals(LOCATION_CORE)) {
         // all platform libs are assumed to be compatible
         platformLibs.add(lib);
       // Referenced Platform Libraries
-      } else if (location == Location.REFERENCED_CORE) {
+      } else if (location.equals(LOCATION_REF_CORE)) {
         // all referenced platform libs are assumed to be compatible
         referencedPlatformLibs.add(lib);
       // Sketchbook Libraries (including incompatible)
-      } else if (location == Location.SKETCHBOOK) {
+      } else if (location.equals(LOCATION_SKETCHBOOK)) {
         if (compatible) {
           // libraries promoted from sketchbook (behave as builtin)
           if (!lib.getTypes().isEmpty() && lib.getTypes().contains("Arduino")
@@ -2417,7 +2420,7 @@ public void handleAddLibrary() {
       }
 
       // copy folder
-      File destinationFolder = new File(BaseNoGui.getSketchbookLibrariesFolder().folder, sourceFile.getName());
+      File destinationFolder = new File(BaseNoGui.getSketchbookLibrariesFolder(), sourceFile.getName());
       if (!destinationFolder.mkdir()) {
         activeEditor.statusError(format(tr("A library named {0} already exists"), sourceFile.getName()));
         return;

arduino-core/src/cc/arduino/Compiler.java

@@ -247,7 +247,7 @@ private void callArduinoBuilder(TargetBoard board, TargetPlatform platform, Targ
     addPathFlagIfPathExists(cmd, "-tools", installedPackagesFolder);
 
     addPathFlagIfPathExists(cmd, "-built-in-libraries", BaseNoGui.getContentFile("libraries"));
-    addPathFlagIfPathExists(cmd, "-libraries", BaseNoGui.getSketchbookLibrariesFolder().folder);
+    addPathFlagIfPathExists(cmd, "-libraries", BaseNoGui.getSketchbookLibrariesFolder());
 
     String fqbn = Stream.of(aPackage.getId(), platform.getId(), board.getId(), boardOptions(board)).filter(s -> !s.isEmpty()).collect(Collectors.joining(":"));
     cmd.add("-fqbn=" + fqbn);

arduino-core/src/cc/arduino/contributions/libraries/ContributedLibrary.java

@@ -35,7 +35,8 @@
 import java.util.Optional;
 
 import cc.arduino.contributions.VersionComparator;
-import processing.app.packages.UserLibraryFolder.Location;
+
+import static processing.app.packages.UserLibrary.LOCATION_SKETCHBOOK;
 
 public class ContributedLibrary {
 
@@ -77,12 +78,12 @@ public Optional<ContributedLibraryRelease> getInstalled() {
     return releases.values().stream() //
         .filter(ContributedLibraryRelease::isLibraryInstalled) //
         .reduce((x, y) -> {
-          Location lx = x.getInstalledLibrary().get().getLocation();
-          Location ly = y.getInstalledLibrary().get().getLocation();
-          if (lx == ly) {
+          String lx = x.getInstalledLibrary().get().getLocation();
+          String ly = y.getInstalledLibrary().get().getLocation();
+          if (lx.equals(ly)) {
             return VersionComparator.max(x, y);
           }
-          return lx == Location.SKETCHBOOK ? x : y;
+          return lx.equals(LOCATION_SKETCHBOOK) ? x : y;
         });
   }
 

arduino-core/src/cc/arduino/contributions/libraries/LibrariesIndexer.java

@@ -31,6 +31,9 @@
 
 import static processing.app.I18n.format;
 import static processing.app.I18n.tr;
+import static processing.app.packages.UserLibrary.LOCATION_CORE;
+import static processing.app.packages.UserLibrary.LOCATION_REF_CORE;
+import static processing.app.packages.UserLibrary.LOCATION_SKETCHBOOK;
 
 import java.io.File;
 import java.io.IOException;
@@ -49,7 +52,6 @@
 import processing.app.helpers.FileUtils;
 import processing.app.packages.LibraryList;
 import processing.app.packages.UserLibrary;
-import processing.app.packages.UserLibraryFolder.Location;
 import processing.app.packages.UserLibraryPriorityComparator;
 
 public class LibrariesIndexer {
@@ -206,8 +208,8 @@ public void rescanLibraries() {
                                        lib.getSrcFolder()));
         }
 
-        Location loc = lib.getLocation();
-        if (loc != Location.CORE && loc != Location.REFERENCED_CORE) {
+        String loc = lib.getLocation();
+        if (!loc.equals(LOCATION_CORE) && !loc.equals(LOCATION_REF_CORE)) {
           // Check if we can find the same library in the index
           // and mark it as installed
           index.find(lib.getName(), lib.getVersion()).ifPresent(foundLib -> {
@@ -216,7 +218,7 @@ public void rescanLibraries() {
           });
         }
 
-        if (lib.getTypes().isEmpty() && loc == Location.SKETCHBOOK) {
+        if (lib.getTypes().isEmpty() && loc.equals(LOCATION_SKETCHBOOK)) {
           lib.setTypes(lib.getDeclaredTypes());
         }
 
@@ -233,8 +235,8 @@ public void rescanLibraries() {
     // TODO: Should be done on the CLI?
     installedLibraries.stream() //
         .filter(l -> l.getTypes().contains("Contributed")) //
-        .filter(l -> l.getLocation() == Location.CORE
-                     || l.getLocation() == Location.REFERENCED_CORE) //
+        .filter(l -> l.getLocation().equals(LOCATION_CORE)
+                     || l.getLocation().equals(LOCATION_REF_CORE)) //
         .forEach(l -> {
           File libFolder = l.getInstalledFolder();
           Optional<ContributedPlatform> platform = BaseNoGui.indexer

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

@@ -21,8 +21,6 @@
 import processing.app.legacy.PApplet;
 import processing.app.packages.LibraryList;
 import processing.app.packages.UserLibrary;
-import processing.app.packages.UserLibraryFolder;
-import processing.app.packages.UserLibraryFolder.Location;
 import cc.arduino.files.DeleteFilesOnShutdown;
 import processing.app.helpers.FileUtils;
 
@@ -337,7 +335,7 @@ static public File getSketchbookHardwareFolder() {
     return new File(getSketchbookFolder(), "hardware");
   }
 
-  static public UserLibraryFolder getSketchbookLibrariesFolder() {
+  static public File getSketchbookLibrariesFolder() {
     File libdir = new File(getSketchbookFolder(), "libraries");
     if (!libdir.exists()) {
       FileWriter freadme = null;
@@ -351,7 +349,7 @@ static public UserLibraryFolder getSketchbookLibrariesFolder() {
         IOUtils.closeQuietly(freadme);
       }
     }
-    return new UserLibraryFolder(libdir, Location.SKETCHBOOK);
+    return libdir;
   }
 
   static public String getSketchbookPath() {

arduino-core/src/processing/app/packages/UserLibrary.java

@@ -47,7 +47,6 @@
 import cc.arduino.contributions.VersionHelper;
 import cc.arduino.contributions.libraries.ContributedLibraryDependency;
 import processing.app.helpers.PreferencesMap;
-import processing.app.packages.UserLibraryFolder.Location;
 
 public class UserLibrary {
 
@@ -66,12 +65,14 @@ public class UserLibrary {
   private boolean onGoingDevelopment;
   private Collection<String> includes;
   protected File installedFolder;
-  protected Location location;
 
-  public static UserLibrary create(UserLibraryFolder libFolderDesc) throws IOException {
-    File libFolder = libFolderDesc.folder;
-    String location = libFolderDesc.location.toString();
+  public static final String LOCATION_IDE = "ide";
+  public static final String LOCATION_SKETCHBOOK = "sketchbook";
+  public static final String LOCATION_CORE = "platform";
+  public static final String LOCATION_REF_CORE = "ref-platform";
+  protected String location;
 
+  public static UserLibrary create(File libFolder, String location) throws IOException {
     // Parse metadata
     File propertiesFile = new File(libFolder, "library.properties");
     PreferencesMap properties = new PreferencesMap();
@@ -211,15 +212,12 @@ public UserLibrary(File installedFolder, String name, String version,
     this.declaredTypes = declaredTypes;
     this.onGoingDevelopment = onGoingDevelopment;
     this.includes = includes;
+    this.location = location;
     switch (location) {
-    case "ide":
-      this.location = Location.IDE_BUILTIN;
-      break;
-    case "sketchbook":
-      this.location = Location.SKETCHBOOK;
-      break;
-    case "platform":
-      this.location = Location.CORE;
+    case LOCATION_IDE:
+    case LOCATION_SKETCHBOOK:
+    case LOCATION_CORE:
+    case LOCATION_REF_CORE:
       break;
     default:
       throw new IllegalArgumentException(
@@ -316,12 +314,12 @@ public boolean useRecursion() {
     return (layout == LibraryLayout.RECURSIVE);
   }
 
-  public Location getLocation() {
+  public String getLocation() {
     return location;
   }
 
   public boolean isIDEBuiltIn() {
-    return getLocation() == Location.IDE_BUILTIN;
+    return getLocation().equals(LOCATION_IDE);
   }
 
   @Override

arduino-core/src/processing/app/packages/UserLibraryFolder.java

@@ -32,16 +32,19 @@
 import java.util.HashMap;
 import java.util.Map;
 
-import processing.app.packages.UserLibraryFolder.Location;
+import static processing.app.packages.UserLibrary.LOCATION_CORE;
+import static processing.app.packages.UserLibrary.LOCATION_IDE;
+import static processing.app.packages.UserLibrary.LOCATION_REF_CORE;
+import static processing.app.packages.UserLibrary.LOCATION_SKETCHBOOK;
 
 public class UserLibraryPriorityComparator implements Comparator<UserLibrary> {
 
-  private final static Map<Location, Integer> priorities = new HashMap<>();
+  private final static Map<String, Integer> priorities = new HashMap<>();
   static {
-    priorities.put(Location.SKETCHBOOK, 4);
-    priorities.put(Location.CORE, 3);
-    priorities.put(Location.REFERENCED_CORE, 2);
-    priorities.put(Location.IDE_BUILTIN, 1);
+    priorities.put(LOCATION_SKETCHBOOK, 4);
+    priorities.put(LOCATION_CORE, 3);
+    priorities.put(LOCATION_REF_CORE, 2);
+    priorities.put(LOCATION_IDE, 1);
   }
 
   private String arch;