Factoring Library class, step 2: first try parsing library metadata

Author: cmaglie

app/src/processing/app/Base.java

@@ -1044,25 +1044,17 @@ protected void rebuildSketchbookMenu(JMenu menu) {
   }
 
   public LibraryList getIDELibs() {
-    LibraryList libs = new LibraryList();
     if (libraries == null)
-      return libs;
-    for (Library lib : libraries) {
-      if (!FileUtils.isSubDirectory(getSketchbookFolder(), lib.getRootFolder()))
-        libs.add(lib);
-    }
-    return libs;
+      return new LibraryList();
+    LibraryList res = new LibraryList(libraries);
+    res.removeAll(getUserLibs());
+    return res;
   }
 
   public LibraryList getUserLibs() {
-    LibraryList libs = new LibraryList();
     if (libraries == null)
-      return libs;
-    for (Library lib : libraries) {
-      if (FileUtils.isSubDirectory(getSketchbookFolder(), lib.getRootFolder()))
-        libs.add(lib);
-    }
-    return libs;
+      return new LibraryList();
+    return libraries.filterLibrariesInSubfolder(getSketchbookFolder());
   }
 
   public void rebuildImportMenu(JMenu importMenu, final Editor editor) {
@@ -1124,28 +1116,16 @@ public void rebuildExamplesMenu(JMenu menu) {
 
       // Add examples from libraries
       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);
-      }
+      ideLibs.sort();
+      for (Library lib : ideLibs)
+        addSketchesSubmenu(menu, lib, false);
 
       LibraryList userLibs = getUserLibs();
       if (userLibs.size()>0) {
         menu.addSeparator();
-        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()))
-            addSketchesSubmenu(menu, name, folder.getParentFile(), false);
-        }
+        userLibs.sort();
+        for (Library lib : userLibs)
+          addSketchesSubmenu(menu, lib, false);
       }
     } catch (IOException e) {
       e.printStackTrace();
@@ -1155,7 +1135,7 @@ public void rebuildExamplesMenu(JMenu menu) {
   public LibraryList scanLibraries(List<File> folders) {
     LibraryList res = new LibraryList();
     for (File folder : folders)
-      res.addAll(scanLibraries(folder));
+      res.addOrReplaceAll(scanLibraries(folder));
     return res;
   }
 
@@ -1178,8 +1158,7 @@ public LibraryList scanLibraries(File folder) {
         continue;
       }
 
-      Library lib = Library.fromFolder(subfolder, Base.getTargetPlatform().getName());
-
+      Library lib = Library.create(subfolder);
       // (also replace previously found libs with the same name) 
       if (lib != null)
         res.addOrReplace(lib);
@@ -1206,18 +1185,20 @@ public void onBoardOrPortChange() {
     // Libraries located in the latest folders on the list can override
     // other libraries with the same name.
     libraries = scanLibraries(librariesFolders);
-
+    String currentArch = Base.getTargetPlatform().getName();
+    libraries = libraries.filterByArchitecture(currentArch);
+    
     // Populate importToLibraryTable
     importToLibraryTable = new HashMap<String, Library>();
     for (Library lib : libraries) {
       try {
-        String headers[] = headerListFromIncludePath(lib.getRootFolder());
+        String headers[] = headerListFromIncludePath(lib.getSrcFolder());
         for (String header : headers) {
           importToLibraryTable.put(header, lib);
         }
       } catch (IOException e) {
         showWarning(_("Error"), I18n
-            .format("Unable to list header files in {0}", lib.getRootFolder()), e);
+            .format("Unable to list header files in {0}", lib.getSrcFolder()), e);
       }
     }
 
@@ -1495,6 +1476,13 @@ protected boolean addSketches(JMenu menu, File folder,
     return ifound;  // actually ignored, but..
   }
 
+  private boolean addSketchesSubmenu(JMenu menu, Library lib,
+                                     boolean replaceExisting)
+      throws IOException {
+    return addSketchesSubmenu(menu, lib.getName(), lib.getFolder(),
+                              replaceExisting);
+  }
+
   private boolean addSketchesSubmenu(JMenu menu, String name, File folder,
                          final boolean replaceExisting) throws IOException {
 
@@ -1564,26 +1552,25 @@ public void actionPerformed(ActionEvent e) {
   protected void addLibraries(JMenu menu, LibraryList libs) throws IOException {
 
     LibraryList list = new LibraryList(libs);
-    Collections.sort(list, Library.CASE_INSENSITIVE_ORDER);
-
-    ActionListener listener = new ActionListener() {
-      public void actionPerformed(ActionEvent event) {
-        String jarPath = event.getActionCommand();
-        try {
-          activeEditor.getSketch().importLibrary(jarPath);
-        } catch (IOException e) {
-          showWarning(_("Error"), I18n.format("Unable to list header files in {0}", jarPath), e);
-        }
-      }
-    };
+    list.sort();
 
     for (Library lib : list) {
-      File folder = lib.getRootFolder();
-
+      @SuppressWarnings("serial")
+      AbstractAction action = new AbstractAction(lib.getName()) {
+        public void actionPerformed(ActionEvent event) {
+          Library l = (Library) getValue("library");
+          try {
+            activeEditor.getSketch().importLibrary(l);
+          } catch (IOException e) {
+            showWarning(_("Error"), I18n.format("Unable to list header files in {0}", l.getSrcFolder()), e);
+          }
+        }
+      };
+      action.putValue("library", lib);
+      
       // Add new element at the bottom
-      JMenuItem item = new JMenuItem(lib.getName());
-      item.addActionListener(listener);
-      item.setActionCommand(folder.getAbsolutePath());
+      JMenuItem item = new JMenuItem(action);
+      item.putClientProperty("library", lib);
       menu.add(item);
 
       // XXX: DAM: should recurse here so that library folders can be nested

app/src/processing/app/Sketch.java

@@ -89,12 +89,6 @@ public class Sketch {
   /** Class path determined during build. */
   private String classPath;
 
-  /**
-   * This is *not* the "Processing" libraries path, this is the Java libraries
-   * path, as in java.library.path=BlahBlah, which identifies search paths for
-   * DLLs or JNILIBs.
-   */
-  private String libraryPath;
   /**
    * List of library folders. 
    */
@@ -1122,15 +1116,19 @@ public boolean addFile(File sourceFile) {
   }
 
 
+  public void importLibrary(Library lib) throws IOException {
+    importLibrary(lib.getSrcFolder());
+  }
+  
   /**
    * Add import statements to the current tab for all of packages inside
    * the specified jar file.
    */
-  public void importLibrary(String jarPath) throws IOException {
+  public void importLibrary(File jarPath) throws IOException {
     // make sure the user didn't hide the sketch folder
     ensureExistence();
 
-    String list[] = Base.headerListFromIncludePath(new File(jarPath));
+    String list[] = Base.headerListFromIncludePath(jarPath);
 
     // import statements into the main sketch file (code[0])
     // if the current code is a .java file, insert into current
@@ -1424,17 +1422,13 @@ public String preprocess(String buildPath, PdePreprocessor preprocessor) throws
     // grab the imports from the code just preproc'd
 
     importedLibraries = new LibraryList();
-    //Remember to clear library path before building it.
-    libraryPath = "";
     for (String item : preprocessor.getExtraImports()) {
 
       Library lib = Base.importToLibraryTable.get(item);
       //If needed can Debug libraryPath here
 
       if (lib != null && !importedLibraries.contains(lib)) {
         importedLibraries.add(lib);
-        //classPath += Compiler.contentsToClassPath(libFolder);
-        libraryPath += File.pathSeparator + lib.getRootFolder().getAbsolutePath();
       }
     }
 
@@ -1889,11 +1883,6 @@ public String getClassPath() {
   }
 
 
-  public String getLibraryPath() {
-    return libraryPath;
-  }
-
-
   public SketchCode[] getCode() {
     return code;
   }

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

@@ -86,7 +86,7 @@ public boolean compile(Sketch _sketch, String _buildPath,
     if (prefs.get("build.variant.path").length() != 0)
       includePaths.add(prefs.get("build.variant.path"));
     for (Library lib : sketch.getImportedLibraries())
-      includePaths.add(lib.getRootFolder().getPath());
+      includePaths.add(lib.getSrcFolder().getPath());
 
     // 1. compile the sketch (already in the buildPath)
     sketch.setCompilingProgress(30);
@@ -582,11 +582,11 @@ void compileSketch(List<String> includePaths) throws RunnerException {
   void compileLibraries(List<String> includePaths) throws RunnerException {
     File outputPath = new File(prefs.get("build.path"));
     for (Library lib : sketch.getImportedLibraries()) {
-      File libFolder = lib.getRootFolder();
-      if (lib.isNewLib()) {
-        recursiveCompileLibrary(outputPath, libFolder, includePaths);
-      } else {
+      File libFolder = lib.getSrcFolder();
+      if (lib.isPre15Lib()) {
         compileLibrary(outputPath, libFolder, includePaths);
+      } else {
+        recursiveCompileLibrary(outputPath, libFolder, includePaths);
       }
     }
   }

app/src/processing/app/helpers/StringMatchers.java

@@ -0,0 +1,21 @@
+package processing.app.helpers;
+
+public class StringMatchers {
+
+  /**
+   * Tries to match <b>input</b> with <b>pattern</b>. The pattern can use the
+   * "*" and "?" globs to match any-char-sequence and any-char respectively.
+   * 
+   * @param input
+   *          The string to be checked
+   * @param pattern
+   *          The pattern to match
+   * @return <b>true</b> if the <b>input</b> matches the <b>pattern</b>,
+   *         <b>false</b> otherwise.
+   */
+  public static boolean wildcardMatch(String input, String pattern) {
+    String regex = pattern.replace("?", ".?").replace("*", ".*?");
+    return input.matches(regex);
+  }
+
+}