Advise of duplicate libraries after compiling

backport from arduino/Arduino#2850

Author: PaulStoffregen

app/src/processing/app/Base.java

@@ -88,7 +88,7 @@ public class Base {
   static HashSet<File> libraries;
 
   // maps imported packages to their library folder
-  static HashMap<String, File> importToLibraryTable;
+  static HashMap<String, LinkedList<File>> importToLibraryTable;
 
   // classpath for all known libraries for p5
   // (both those in the p5/libs folder and those with lib subfolders
@@ -1117,7 +1117,7 @@ public void actionPerformed(ActionEvent e) {
     libraries = new HashSet<File>();
 
     // reset the table mapping imports to libraries
-    importToLibraryTable = new HashMap<String, File>();
+    importToLibraryTable = new HashMap<String, LinkedList<File>>();
 
     // Add from the "libraries" subfolder in the Processing directory
     try {
@@ -1377,12 +1377,16 @@ public void actionPerformed(ActionEvent event) {
         String headers[] = Compiler.headerListFromIncludePath(libFolderPath);
         for (String header : headers) {
 
-          File old = importToLibraryTable.get(header);
-          if (old == null) {
+          LinkedList<File> liblist = importToLibraryTable.get(header);
+          if (liblist == null) {
             // found a header file not on the list
             //System.out.println("library " + libFolder + " for header " + header);
-            importToLibraryTable.put(header, libFolder);
+            liblist = new LinkedList<File>();
+            liblist.addFirst(libFolder);
+            importToLibraryTable.put(header, liblist);
           } else {
+            File old = liblist.peekFirst();
+            boolean useThisLib = false;
             // found a header file already on the list,
             // so we must decide whether to use the library already
             // found, or use this library when this header is #include
@@ -1393,15 +1397,20 @@ public void actionPerformed(ActionEvent event) {
             if (name.equalsIgnoreCase(libFolder.getName()) || name.startsWith(libFolder.getName())) {
               // header name clearly matches this new library, so use it
               //System.out.println("  use:  " + libFolder.getPath());
-              importToLibraryTable.put(header, libFolder);
+              useThisLib = true;
             } else if (name.equalsIgnoreCase(old.getName()) || name.startsWith(old.getName())) {
               // header name clearly matches the previously found library, so keep it
               //System.out.println("  use:  " + old.getPath());
 	    } else {
               // neither is a good match, so go with the last one found
               //System.out.println("  use:  " + libFolder.getPath());
-              importToLibraryTable.put(header, libFolder);
+              useThisLib = true;
 	    }
+            if (useThisLib) {
+              liblist.addFirst(libFolder);
+            } else {
+              liblist.addLast(libFolder);
+            }
           }
         }
       } catch (IOException e) {

app/src/processing/app/Sketch.java

@@ -96,6 +96,8 @@ public class Sketch {
    * List of library folders. 
    */
   private ArrayList<File> importedLibraries;
+  private ArrayList<String> importedDuplicateHeaders;
+  private ArrayList<LinkedList<File>> importedDuplicateLibraries;
 
   /**
    * path is location of the main .pde file, because this is also
@@ -1436,14 +1438,20 @@ public String preprocess(String buildPath, PdePreprocessor preprocessor) throws
     // grab the imports from the code just preproc'd
 
     importedLibraries = new ArrayList<File>();
+    importedDuplicateHeaders = new ArrayList<String>();
+    importedDuplicateLibraries = new ArrayList<LinkedList<File>>();
 
     for (String item : preprocessor.getExtraImports()) {
-      File libFolder = (File) Base.importToLibraryTable.get(item);
-
-      if (libFolder != null && !importedLibraries.contains(libFolder)) {
-        importedLibraries.add(libFolder);
-        //classPath += Compiler.contentsToClassPath(libFolder);
-        libraryPath += File.pathSeparator + libFolder.getAbsolutePath();
+      LinkedList<File> liblist = Base.importToLibraryTable.get(item);
+      if (liblist != null) {
+        File libFolder = liblist.peekFirst();
+        if (libFolder != null && !importedLibraries.contains(libFolder)) {
+          importedLibraries.add(libFolder);
+          if (liblist.size() > 1) {
+            importedDuplicateHeaders.add(item);
+            importedDuplicateLibraries.add(liblist);
+          }
+        }
       }
     }
 
@@ -1582,14 +1590,38 @@ public String build(String buildPath, boolean verbose)
     // compile the program. errors will happen as a RunnerException
     // that will bubble up to whomever called build().
     Compiler compiler = new Compiler();
-    if (compiler.compile(this, buildPath, primaryClassName, verbose)) {
-      size(buildPath, primaryClassName);
-      return primaryClassName;
+    try {
+      if (compiler.compile(this, buildPath, primaryClassName, verbose)) {
+        size(buildPath, primaryClassName);
+        return primaryClassName;
+      }
+    } catch (RunnerException e) {
+      // when the compile fails, take this opportunity to show
+      // any helpful info possible before throwing the exception
+      adviseDuplicateLibraries();
+      throw e;
     }
     return null;
   }
 
 
+  public void adviseDuplicateLibraries() {
+    for (int i=0; i < importedDuplicateHeaders.size(); i++) {
+      System.out.println(I18n.format(_("Multiple libraries were found for \"{0}\""),
+        importedDuplicateHeaders.get(i)));
+      boolean first = true;
+      for (File libFolder : importedDuplicateLibraries.get(i)) {
+        if (first) {
+          System.out.println(I18n.format(_(" Used: {0}"), libFolder.getPath()));
+          first = false;
+        } else {
+          System.out.println(I18n.format(_(" Not Used: {0}"), libFolder.getPath()));
+        }
+      }
+    }
+  }
+
+
   protected boolean exportApplet(boolean usingProgrammer) throws Exception {
     return exportApplet(tempBuildFolder.getAbsolutePath(), usingProgrammer);
   }

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

@@ -343,9 +343,11 @@ public boolean compile(Sketch sketch,
       commandScript.add("-file=" + primaryClassName);
       execTeensySimple(commandScript);
     }
+    sketch.adviseDuplicateLibraries();
     return true;
   }
 
+
   private List<File> recursiveCompile(String avrBasePath, File srcFolder,
       File outputFolder, List<File> includePaths,
       Map<String, String> boardPreferences) throws RunnerException {