Factoring Library class

Author: cmaglie

app/src/processing/app/Base.java

@@ -37,7 +37,9 @@
 import processing.app.helpers.PreferencesMap;
 import processing.app.helpers.filefilters.OnlyDirs;
 import processing.app.helpers.filefilters.OnlyFilesWithExtension;
-import processing.app.javax.swing.filechooser.FileNameExtensionFilter;import processing.app.tools.MapWithSubkeys;
+import processing.app.javax.swing.filechooser.FileNameExtensionFilter;import processing.app.packages.Library;
+import processing.app.packages.LibraryList;
+import processing.app.tools.MapWithSubkeys;
 import processing.app.tools.ZipDeflater;
 import processing.core.*;
 import static processing.app.I18n._;
@@ -89,10 +91,10 @@ public class Base {
   static private List<File> librariesFolders;
 
   // maps library name to their library folder
-  static private Map<String, File> libraries;
+  static private LibraryList libraries;
 
   // maps #included files to their library folder
-  static Map<String, File> importToLibraryTable;
+  static Map<String, Library> importToLibraryTable;
 
   // classpath for all known libraries for p5
   // (both those in the p5/libs folder and those with lib subfolders
@@ -1038,26 +1040,26 @@ protected void rebuildSketchbookMenu(JMenu menu) {
     }
   }
 
-  public Map<String, File> getIDELibs() {
+  public LibraryList getIDELibs() {
+    LibraryList libs = new LibraryList();
     if (libraries == null)
-      return new HashMap<String, File>();
-    Map<String, File> ideLibs = new HashMap<String, File>(libraries);
-    for (String lib : libraries.keySet()) {
-      if (FileUtils.isSubDirectory(getSketchbookFolder(), libraries.get(lib)))
-        ideLibs.remove(lib);
+      return libs;
+    for (Library lib : libraries) {
+      if (!FileUtils.isSubDirectory(getSketchbookFolder(), lib.getRootFolder()))
+        libs.add(lib);
     }
-    return ideLibs;
+    return libs;
   }
 
-  public Map<String, File> getUserLibs() {
+  public LibraryList getUserLibs() {
+    LibraryList libs = new LibraryList();
     if (libraries == null)
-      return new HashMap<String, File>();
-    Map<String, File> userLibs = new HashMap<String, File>(libraries);
-    for (String lib : libraries.keySet()) {
-      if (!FileUtils.isSubDirectory(getSketchbookFolder(), libraries.get(lib)))
-        userLibs.remove(lib);
+      return libs;
+    for (Library lib : libraries) {
+      if (FileUtils.isSubDirectory(getSketchbookFolder(), lib.getRootFolder()))
+        libs.add(lib);
     }
-    return userLibs;
+    return libs;
   }
 
   public void rebuildImportMenu(JMenu importMenu, final Editor editor) {
@@ -1077,8 +1079,8 @@ public void actionPerformed(ActionEvent e) {
     // Split between user supplied libraries and IDE libraries
     TargetPlatform targetPlatform = getTargetPlatform();
     if (targetPlatform != null) {
-      Map<String, File> ideLibs = getIDELibs();
-      Map<String, File> userLibs = getUserLibs();
+      LibraryList ideLibs = getIDELibs();
+      LibraryList userLibs = getUserLibs();
       try {
         // Find the current target. Get the platform, and then select the
         // correct name and core path.
@@ -1118,24 +1120,24 @@ public void rebuildExamplesMenu(JMenu menu) {
       if (found) menu.addSeparator();
 
       // Add examples from libraries
-      Map<String, File> ideLibs = getIDELibs();
-      List<String> names = new ArrayList<String>(ideLibs.keySet());
-      Collections.sort(names, String.CASE_INSENSITIVE_ORDER);
-      for (String name : names) {
-        File folder = ideLibs.get(name);
+      LibraryList ideLibs = getIDELibs();
+      Collections.sort(ideLibs, Library.CASE_INSENSITIVE_ORDER);
+      for (Library lib : ideLibs) {
+        File folder = lib.getRootFolder();
+        String name = lib.getName();
         addSketchesSubmenu(menu, name, folder, false);
         // Allows "fat" libraries to have examples in the root folder
         if (folder.getName().equals(Base.getTargetPlatform().getName()))
           addSketchesSubmenu(menu, name, folder.getParentFile(), false);
       }
 
-      Map<String, File> userLibs = getUserLibs();
+      LibraryList userLibs = getUserLibs();
       if (userLibs.size()>0) {
         menu.addSeparator();
-        names = new ArrayList<String>(userLibs.keySet());
-        Collections.sort(names, String.CASE_INSENSITIVE_ORDER);
-        for (String name : names) {
-          File folder = userLibs.get(name);
+        Collections.sort(userLibs, Library.CASE_INSENSITIVE_ORDER);
+        for (Library lib : userLibs) {
+          File folder = lib.getRootFolder();
+          String name = lib.getName();
           addSketchesSubmenu(menu, name, folder, false);
           // Allows "fat" libraries to have examples in the root folder
           if (folder.getName().equals(Base.getTargetPlatform().getName()))
@@ -1147,15 +1149,16 @@ public void rebuildExamplesMenu(JMenu menu) {
     }
   }
 
-  public Map<String, File> scanLibraries(List<File> folders) {
-    Map<String, File> res = new HashMap<String, File>();
+  public LibraryList scanLibraries(List<File> folders) {
+    LibraryList res = new LibraryList();
     for (File folder : folders)
-      res.putAll(scanLibraries(folder));
+      res.addAll(scanLibraries(folder));
     return res;
   }
 
-  public Map<String, File> scanLibraries(File folder) {
-    Map<String, File> res = new HashMap<String, File>();
+  public LibraryList scanLibraries(File folder) {
+    LibraryList res = new LibraryList();
+
     String list[] = folder.list(new OnlyDirs());
     // if a bad folder or something like that, this might come back null
     if (list == null)
@@ -1172,41 +1175,15 @@ public Map<String, File> scanLibraries(File folder) {
         continue;
       }
 
-      subfolder = scanFatLibrary(subfolder);
+      Library lib = Library.fromFolder(subfolder, Base.getTargetPlatform().getName());
 
       // (also replace previously found libs with the same name) 
-      if (subfolder != null)
-        res.put(libName, subfolder);
+      if (lib != null)
+        res.addOrReplace(lib);
     }
     return res;
   }
 
-  /**
-   * Scans inside a "FAT" (multi-platform) library folder to see if it contains
-   * a version suitable for the actual selected architecture. If a suitable
-   * version is found the folder containing that version is returned, otherwise
-   * <b>null</b> is returned.<br />
-   * <br />
-   * If a non-"FAT" library is detected, we assume that the library is suitable
-   * for the current architecture and the libFolder parameter is returned.<br />
-   *
-   * @param libFolder
-   * @return
-   */
-  public File scanFatLibrary(File libFolder) {
-    // A library is considered "fat" if it contains a file called
-    // "library.properties"
-    File libraryPropFile = new File(libFolder, "library.properties");
-    if (!libraryPropFile.exists() || !libraryPropFile.isFile())
-      return libFolder;
-
-    // Search for a subfolder for actual architecture, return null if not found
-    File archSubfolder = new File(libFolder, Base.getTargetPlatform().getName());
-    if (!archSubfolder.exists() || !archSubfolder.isDirectory())
-      return null;
-    return archSubfolder;
-  }
-
   public void onBoardOrPortChange() {
     TargetPlatform targetPlatform = getTargetPlatform();
     if (targetPlatform == null)
@@ -1228,15 +1205,16 @@ public void onBoardOrPortChange() {
     libraries = scanLibraries(librariesFolders);
 
     // Populate importToLibraryTable
-    importToLibraryTable = new HashMap<String, File>();
-    for (File subfolder : libraries.values()) {
+    importToLibraryTable = new HashMap<String, Library>();
+    for (Library lib : libraries) {
       try {
-        String packages[] = headerListFromIncludePath(subfolder);
-        for (String pkg : packages) {
-          importToLibraryTable.put(pkg, subfolder);
+        String headers[] = headerListFromIncludePath(lib.getRootFolder());
+        for (String header : headers) {
+          importToLibraryTable.put(header, lib);
         }
       } catch (IOException e) {
-        showWarning(_("Error"), I18n.format("Unable to list header files in {0}", subfolder), e);
+        showWarning(_("Error"), I18n
+            .format("Unable to list header files in {0}", lib.getRootFolder()), e);
       }
     }
 
@@ -1580,10 +1558,10 @@ public void actionPerformed(ActionEvent e) {
     return found;
   }
 
-  protected void addLibraries(JMenu menu, Map<String, File> libs) throws IOException {
+  protected void addLibraries(JMenu menu, LibraryList libs) throws IOException {
 
-    List<String> list = new ArrayList<String>(libs.keySet());
-    Collections.sort(list, String.CASE_INSENSITIVE_ORDER);
+    LibraryList list = new LibraryList(libs);
+    Collections.sort(list, Library.CASE_INSENSITIVE_ORDER);
 
     ActionListener listener = new ActionListener() {
       public void actionPerformed(ActionEvent event) {
@@ -1596,11 +1574,11 @@ public void actionPerformed(ActionEvent event) {
       }
     };
 
-    for (String name : list) {
-      File folder = libs.get(name);
+    for (Library lib : list) {
+      File folder = lib.getRootFolder();
 
       // Add new element at the bottom
-      JMenuItem item = new JMenuItem(name);
+      JMenuItem item = new JMenuItem(lib.getName());
       item.addActionListener(listener);
       item.setActionCommand(folder.getAbsolutePath());
       menu.add(item);
@@ -1874,7 +1852,7 @@ static public File createTempFolder(String name) {
   }
 
 
-  static public Map<String, File> getLibraries() {
+  static public LibraryList getLibraries() {
     return libraries;
   }
 

app/src/processing/app/Sketch.java

@@ -29,6 +29,8 @@
 import processing.app.debug.Sizer;
 import processing.app.debug.Uploader;
 import processing.app.helpers.PreferencesMap;
+import processing.app.packages.Library;
+import processing.app.packages.LibraryList;
 import processing.app.preproc.*;
 import processing.core.*;
 import static processing.app.I18n._;
@@ -96,7 +98,7 @@ public class Sketch {
   /**
    * List of library folders. 
    */
-  private ArrayList<File> importedLibraries;
+  private LibraryList importedLibraries;
 
   /**
    * path is location of the main .pde file, because this is also
@@ -1421,18 +1423,18 @@ public String preprocess(String buildPath, PdePreprocessor preprocessor) throws
 
     // grab the imports from the code just preproc'd
 
-    importedLibraries = new ArrayList<File>();
+    importedLibraries = new LibraryList();
     //Remember to clear library path before building it.
     libraryPath = "";
     for (String item : preprocessor.getExtraImports()) {
 
-        File libFolder = (File) Base.importToLibraryTable.get(item);
-        //If needed can Debug libraryPath here
+      Library lib = Base.importToLibraryTable.get(item);
+      //If needed can Debug libraryPath here
 
-      if (libFolder != null && !importedLibraries.contains(libFolder)) {
-        importedLibraries.add(libFolder);
+      if (lib != null && !importedLibraries.contains(lib)) {
+        importedLibraries.add(lib);
         //classPath += Compiler.contentsToClassPath(libFolder);
-        libraryPath += File.pathSeparator + libFolder.getAbsolutePath();
+        libraryPath += File.pathSeparator + lib.getRootFolder().getAbsolutePath();
       }
     }
 
@@ -1462,7 +1464,7 @@ public String preprocess(String buildPath, PdePreprocessor preprocessor) throws
   }
 
 
-  public ArrayList<File> getImportedLibraries() {
+  public LibraryList getImportedLibraries() {
     return importedLibraries;
   }
 

app/src/processing/app/debug/Compiler.java

@@ -41,6 +41,7 @@
 import processing.app.helpers.PreferencesMap;
 import processing.app.helpers.StringReplacer;
 import processing.app.helpers.filefilters.OnlyDirs;
+import processing.app.packages.Library;
 import processing.core.PApplet;
 
 public class Compiler implements MessageConsumer {
@@ -84,8 +85,8 @@ public boolean compile(Sketch _sketch, String _buildPath,
     includePaths.add(prefs.get("build.core.path"));
     if (prefs.get("build.variant.path").length() != 0)
       includePaths.add(prefs.get("build.variant.path"));
-    for (File file : sketch.getImportedLibraries())
-      includePaths.add(file.getPath());
+    for (Library lib : sketch.getImportedLibraries())
+      includePaths.add(lib.getRootFolder().getPath());
 
     // 1. compile the sketch (already in the buildPath)
     sketch.setCompilingProgress(30);
@@ -580,11 +581,12 @@ void compileSketch(List<String> includePaths) throws RunnerException {
   // <buildPath>/<library>/
   void compileLibraries(List<String> includePaths) throws RunnerException {
     File outputPath = new File(prefs.get("build.path"));
-    for (File libraryFolder : sketch.getImportedLibraries()) {
-      if (new File(libraryFolder.getParentFile(), "library.properties").exists()) {
-        recursiveCompileLibrary(outputPath, libraryFolder, includePaths);
+    for (Library lib : sketch.getImportedLibraries()) {
+      File libFolder = lib.getRootFolder();
+      if (lib.isNewLib()) {
+        recursiveCompileLibrary(outputPath, libFolder, includePaths);
       } else {
-        compileLibrary(outputPath, libraryFolder, includePaths);
+        compileLibrary(outputPath, libFolder, includePaths);
       }
     }
   }