Added Contributions for libraries

Author: cmaglie

app/src/processing/app/Base.java

@@ -22,6 +22,15 @@
 
 package processing.app;
 
+import java.awt.*;
+import java.awt.event.*;
+import java.io.*;
+import java.util.*;
+import java.util.List;
+
+import javax.swing.*;
+
+import cc.arduino.libraries.contributions.LibrariesIndexer;
 import cc.arduino.packages.DiscoveryManager;
 import cc.arduino.packages.contributions.ui.ContributionManagerUI;
 import cc.arduino.view.SplashScreenHelper;
@@ -34,8 +43,9 @@
 import processing.app.javax.swing.filechooser.FileNameExtensionFilter;
 import processing.app.legacy.PApplet;
 import processing.app.macosx.ThinkDifferent;
-import processing.app.packages.Library;
+import processing.app.legacy.PConstants;
 import processing.app.packages.LibraryList;
+import processing.app.packages.UserLibrary;
 import processing.app.tools.MenuScroller;
 import processing.app.tools.ZipDeflater;
 
@@ -1083,29 +1093,21 @@ public void rebuildExamplesMenu(JMenu menu) {
       // Add examples from libraries
       LibraryList ideLibs = getIDELibs();
       ideLibs.sort();
-      for (Library lib : ideLibs)
+      for (UserLibrary lib : ideLibs)
         addSketchesSubmenu(menu, lib, false);
 
       LibraryList userLibs = getUserLibs();
       if (userLibs.size()>0) {
         menu.addSeparator();
         userLibs.sort();
-        for (Library lib : userLibs)
+        for (UserLibrary lib : userLibs)
           addSketchesSubmenu(menu, lib, false);
       }
     } catch (IOException e) {
       e.printStackTrace();
     }
   }
 
-  public LibraryList scanLibraries(List<File> folders) throws IOException {
-    return BaseNoGui.scanLibraries(folders);
-  }
-
-  public LibraryList scanLibraries(File folder) throws IOException {
-    return BaseNoGui.scanLibraries(folder);
-  }
-
   public void onBoardOrPortChange() {
     BaseNoGui.onBoardOrPortChange();
 
@@ -1431,10 +1433,10 @@ public int compare(File file, File file2) {
     return ifound;
   }
 
-  private boolean addSketchesSubmenu(JMenu menu, Library lib,
+  private boolean addSketchesSubmenu(JMenu menu, UserLibrary lib,
                                      boolean replaceExisting)
       throws IOException {
-    return addSketchesSubmenu(menu, lib.getName(), lib.getFolder(),
+    return addSketchesSubmenu(menu, lib.getName(), lib.getInstalledFolder(),
                               replaceExisting);
   }
 
@@ -1516,11 +1518,11 @@ protected void addLibraries(JMenu menu, LibraryList libs) throws IOException {
     LibraryList list = new LibraryList(libs);
     list.sort();
 
-    for (Library lib : list) {
+    for (UserLibrary lib : list) {
       @SuppressWarnings("serial")
       AbstractAction action = new AbstractAction(lib.getName()) {
         public void actionPerformed(ActionEvent event) {
-          Library l = (Library) getValue("library");
+          UserLibrary l = (UserLibrary) getValue("library");
           try {
             activeEditor.getSketch().importLibrary(l);
           } catch (IOException e) {

app/src/processing/app/Sketch.java

@@ -34,7 +34,8 @@
 import processing.app.helpers.OSUtils;
 import processing.app.helpers.PreferencesMap;
 import processing.app.helpers.PreferencesMapException;
-import processing.app.packages.Library;
+import processing.app.packages.UserLibrary;
+import static processing.app.I18n._;
 
 import javax.swing.*;
 import java.awt.*;
@@ -938,7 +939,7 @@ public boolean addFile(File sourceFile) {
   }
 
 
-  public void importLibrary(Library lib) throws IOException {
+  public void importLibrary(UserLibrary lib) throws IOException {
     importLibrary(lib.getSrcFolder());
   }
 

app/src/processing/app/syntax/PdeKeywords.java

@@ -26,11 +26,12 @@
 
 import processing.app.*;
 import processing.app.legacy.PApplet;
-import processing.app.packages.Library;
 
 import java.io.*;
 import java.util.*;
 
+import cc.arduino.libraries.contributions.ContributedLibrary;
+
 
 public class PdeKeywords extends CTokenMarker {
 
@@ -61,8 +62,8 @@ static public KeywordMap getKeywords() {
         keywordColoring = new KeywordMap(false);
         keywordToReference = new Hashtable();
         getKeywords(Base.getLibStream("keywords.txt"));
-        for (Library lib : Base.getLibraries()) {
-          File keywords = new File(lib.getFolder(), "keywords.txt");
+        for (ContributedLibrary lib : Base.getLibraries()) {
+          File keywords = new File(lib.getInstalledFolder(), "keywords.txt");
           if (keywords.exists()) getKeywords(new FileInputStream(keywords));
         }
       } catch (Exception e) {

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

@@ -0,0 +1,140 @@
+/*
+ * This file is part of Arduino.
+ *
+ * Copyright 2014 Arduino LLC (http://www.arduino.cc/)
+ *
+ * Arduino is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ */
+package cc.arduino.libraries.contributions;
+
+import java.util.Comparator;
+import java.util.List;
+
+import cc.arduino.packages.contributions.DownloadableContribution;
+
+public abstract class ContributedLibrary extends DownloadableContribution {
+
+  public abstract String getName();
+
+  public abstract String getVersion();
+
+  public abstract String getMaintainer();
+
+  public abstract String getAuthor();
+
+  public abstract String getWebsite();
+
+  public abstract String getCategory();
+
+  public abstract String getLicense();
+
+  public abstract String getParagraph();
+
+  public abstract String getSentence();
+
+  public abstract String getSupportLevel();
+
+  public abstract List<String> getArchitectures();
+
+  public abstract List<ContributedLibraryReference> getRequires();
+
+  private boolean readOnly;
+
+  public boolean isReadOnly() {
+    return readOnly;
+  }
+
+  public void setReadOnly(boolean readOnly) {
+    this.readOnly = readOnly;
+  }
+
+  public static final Comparator<ContributedLibrary> CASE_INSENSITIVE_ORDER = new Comparator<ContributedLibrary>() {
+    @Override
+    public int compare(ContributedLibrary o1, ContributedLibrary o2) {
+      return o1.getName().compareToIgnoreCase(o2.getName());
+    }
+  };
+
+  /**
+   * Returns <b>true</b> if the library declares to support the specified
+   * architecture (through the "architectures" property field).
+   * 
+   * @param reqArch
+   * @return
+   */
+  public boolean supportsArchitecture(String reqArch) {
+    return getArchitectures().contains(reqArch) ||
+        getArchitectures().contains("*");
+  }
+
+  /**
+   * Returns <b>true</b> if the library declares to support at least one of the
+   * specified architectures.
+   * 
+   * @param reqArchs
+   *          A List of architectures to check
+   * @return
+   */
+  public boolean supportsArchitecture(List<String> reqArchs) {
+    if (reqArchs.contains("*"))
+      return true;
+    for (String reqArch : reqArchs)
+      if (supportsArchitecture(reqArch))
+        return true;
+    return false;
+  }
+
+  @Override
+  public String toString() {
+    String res = "";
+    res += "  ContributedLibrary : " + getName() + "\n";
+    res += "              author : " + getAuthor() + "\n";
+    res += "          maintainer : " + getMaintainer() + "\n";
+    res += "             version : " + getVersion() + "\n";
+    res += "             website : " + getUrl() + "\n";
+    res += "            category : " + getCategory() + "\n";
+    res += "             license : " + getLicense() + "\n";
+    res += "             descrip : " + getSentence() + "\n";
+    if (getParagraph() != null && !getParagraph().isEmpty())
+      res += "                       " + getParagraph() + "\n";
+    res += "       architectures : ";
+    if (getArchitectures() != null)
+      for (String a : getArchitectures()) {
+        res += a + ",";
+      }
+    res += "\n";
+    res += "            requires :\n";
+    if (getRequires() != null)
+      for (ContributedLibraryReference r : getRequires()) {
+        res += "                       " + r;
+      }
+    res += "\n";
+
+    // DownloadableContribution
+    res += super.toString();
+
+    return res;
+  }
+
+}

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

@@ -0,0 +1,43 @@
+/*
+ * This file is part of Arduino.
+ *
+ * Copyright 2014 Arduino LLC (http://www.arduino.cc/)
+ *
+ * Arduino is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ */
+package cc.arduino.libraries.contributions;
+
+public abstract class ContributedLibraryReference {
+
+  public abstract String getName();
+
+  public abstract String getMaintainer();
+
+  public abstract String getVersion();
+
+  @Override
+  public String toString() {
+    return getName() + " " + getVersion() + " (" + getMaintainer() + ")";
+  }
+}

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

@@ -0,0 +1,52 @@
+/*
+ * This file is part of Arduino.
+ *
+ * Copyright 2014 Arduino LLC (http://www.arduino.cc/)
+ *
+ * Arduino is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ */
+package cc.arduino.libraries.contributions;
+
+import java.util.List;
+
+public abstract class LibrariesIndex {
+
+  public abstract List<ContributedLibrary> getLibraries();
+
+  public ContributedLibrary find(String name, String version) {
+    for (ContributedLibrary lib : getLibraries()) {
+      if (lib.getName().equals(name) && lib.getVersion().equals(version))
+        return lib;
+    }
+    return null;
+  }
+
+  @Override
+  public String toString() {
+    String res = "";
+    for (ContributedLibrary l : getLibraries())
+      res += l.toString();
+    return res;
+  }
+}