adding a install handler

Author: jantje

io.sloeber.core/src/io/sloeber/core/api/IInstallLibraryHandler.java

@@ -0,0 +1,35 @@
+package io.sloeber.core.api;
+
+import java.util.Map;
+
+import io.sloeber.core.managers.Library;
+
+/**
+ * this interface is to allow the ui to handle the automatic installation
+ * of libraries.
+ * If you do not register your implementation of this interface there will be
+ * no automatic install of libraries
+ *
+ * registering your inmplementation is done in the library manager
+ *
+ * @author jan
+ *
+ */
+
+public interface  IInstallLibraryHandler {
+	/**
+	 * The core will call this method to find out if you want to install
+	 * the libraries automatically or not
+	 *
+	 * @return true if you want libraries to beinstalled automatically
+	 */
+ abstract boolean autoInstall();
+ /**
+  * given the set of proposed libraries to install
+  * let the user decide on what to install
+  * @param proposedLibsToInstall the libraries Sloeber proposes to install
+  *
+  * @return The libraries the user wants to install
+  */
+ abstract Map<String, Library> selectLibrariesToInstall(Map<String, Library> proposedLibsToInstall);
+}

io.sloeber.core/src/io/sloeber/core/api/LibraryManager.java

@@ -26,6 +26,7 @@
 import io.sloeber.core.common.Common;
 import io.sloeber.core.common.ConfigurationPreferences;
 import io.sloeber.core.common.InstancePreferences;
+import io.sloeber.core.core.DefaultInstallHandler;
 import io.sloeber.core.managers.Library;
 import io.sloeber.core.managers.LibraryIndex;
 import io.sloeber.core.managers.Manager;
@@ -34,6 +35,7 @@
 
 public class LibraryManager {
 	static private List<LibraryIndex> libraryIndices;
+	private static IInstallLibraryHandler myInstallLibraryHandler = new DefaultInstallHandler();
 
 	static public List<LibraryIndex> getLibraryIndices() {
 		if (libraryIndices == null) {
@@ -237,6 +239,7 @@ public static IStatus setLibraryTree(LibraryTree libs, IProgressMonitor monitor,
 	public static String getPrivateLibraryPathsString() {
 		return InstancePreferences.getPrivateLibraryPathsString();
 	}
+
 	public static void setPrivateLibraryPaths(String[] libraryPaths) {
 		InstancePreferences.setPrivateLibraryPaths(libraryPaths);
 
@@ -296,9 +299,9 @@ static public void loadJson(File jsonFile) {
 	}
 
 	/**
-	 * Install the latest version of all the libraries belonging to this
-	 * category If a earlier version is installed this version will be removed
-	 * before installation of the newer version
+	 * Install the latest version of all the libraries belonging to this category If
+	 * a earlier version is installed this version will be removed before
+	 * installation of the newer version
 	 *
 	 * @param category
 	 */
@@ -352,30 +355,37 @@ public static void removeAllLibs() {
 	}
 
 	/**
-	 * Searches for all libraries that can be installed but are not yet installed.
-	 * A library is considered installed when 1 version of the library is installed.
+	 * Searches for all libraries that can be installed but are not yet installed. A
+	 * library is considered installed when 1 version of the library is installed.
 	 *
 	 * @return a map of all instalable libraries
 	 */
 	public static Map<String, io.sloeber.core.managers.Library> getAllInstallableLibraries() {
 		Map<String, Library> ret = new HashMap<>();
 		for (LibraryIndex libraryIndex : libraryIndices) {
-			 ret.putAll(libraryIndex.getLatestInstallableLibraries());
+			ret.putAll(libraryIndex.getLatestInstallableLibraries());
 		}
 
 		return ret;
 	}
 
-	public static Map<String, io.sloeber.core.managers.Library> getLatestInstallableLibraries(
-			Set<String> libnames) {
-		Set<String> remainingLibNames=new TreeSet<>(libnames);
+	public static Map<String, io.sloeber.core.managers.Library> getLatestInstallableLibraries(Set<String> libnames) {
+		Set<String> remainingLibNames = new TreeSet<>(libnames);
 		Map<String, Library> ret = new HashMap<>();
 		for (LibraryIndex libraryIndex : libraryIndices) {
-			 ret.putAll(libraryIndex.getLatestInstallableLibraries(remainingLibNames));
-			 remainingLibNames.removeAll(ret.keySet());
+			ret.putAll(libraryIndex.getLatestInstallableLibraries(remainingLibNames));
+			remainingLibNames.removeAll(ret.keySet());
 		}
 
 		return ret;
 	}
 
+	public static void registerInstallLibraryHandler(IInstallLibraryHandler installLibraryHandler) {
+		myInstallLibraryHandler = installLibraryHandler;
+	}
+
+	public static IInstallLibraryHandler getInstallLibraryHandler() {
+		return myInstallLibraryHandler;
+	}
+
 }

io.sloeber.core/src/io/sloeber/core/core/DefaultInstallHandler.java

@@ -0,0 +1,22 @@
+package io.sloeber.core.core;
+
+import java.util.Map;
+
+import io.sloeber.core.api.IInstallLibraryHandler;
+import io.sloeber.core.managers.Library;
+
+public class DefaultInstallHandler implements IInstallLibraryHandler {
+
+	@Override
+	public boolean autoInstall() {
+		return false;
+	}
+
+
+	@Override
+	public Map<String, Library> selectLibrariesToInstall(Map<String, Library> proposedLibsToInstall) {
+
+		return proposedLibsToInstall;
+	}
+
+}

io.sloeber.core/src/io/sloeber/core/tools/Libraries.java

@@ -36,6 +36,7 @@
 
 import io.sloeber.core.InternalBoardDescriptor;
 import io.sloeber.core.api.BoardDescriptor;
+import io.sloeber.core.api.IInstallLibraryHandler;
 import io.sloeber.core.api.LibraryManager;
 import io.sloeber.core.common.Common;
 import io.sloeber.core.common.ConfigurationPreferences;
@@ -394,7 +395,8 @@ public static void checkLibraries(IProject affectedProject) {
 					}
 					UnresolvedIncludedHeaders.removeAll(alreadyAddedLibs);
 
-
+					IInstallLibraryHandler installHandler =LibraryManager.getInstallLibraryHandler();
+					if (installHandler.autoInstall()) {
 					//Check if there are libraries that are not found in the installed libraries
 					Map<String, IPath> installedLibs = getAllInstalledLibraries(configurationDescription);
 					Set<String> uninstalledIncludedHeaders=new TreeSet<>(UnresolvedIncludedHeaders);
@@ -408,13 +410,15 @@ public static void checkLibraries(IProject affectedProject) {
 							//We now know which libraries to install
 							//TODO for now I just install but there should be some user
 							//interaction
+							availableLibs=installHandler.selectLibrariesToInstall(availableLibs);
 							for (Entry<String, Library> curLib : availableLibs.entrySet()) {
 								curLib.getValue().install(new NullProgressMonitor());
 							}
 						}
 					}
+					}
 
-					installedLibs = getAllInstalledLibraries(configurationDescription);
+					Map<String, IPath> installedLibs = getAllInstalledLibraries(configurationDescription);
 					installedLibs.keySet().retainAll(UnresolvedIncludedHeaders);
 					if (!installedLibs.isEmpty()) {
 						// there are possible libraries to add