#1204 Add libraries at new library example crreation

That is the creation of a project based on a library example should also
link in the library

Author: jantje

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

@@ -42,6 +42,7 @@
 import org.eclipse.core.runtime.SubMonitor;
 import org.eclipse.core.runtime.preferences.IEclipsePreferences;
 import org.eclipse.core.runtime.preferences.InstanceScope;
+
 import io.sloeber.core.Activator;
 import io.sloeber.core.InternalBoardDescriptor;
 import io.sloeber.core.Messages;
@@ -52,6 +53,7 @@
 import io.sloeber.core.managers.InternalPackageManager;
 import io.sloeber.core.tools.Helpers;
 import io.sloeber.core.tools.KeyValue;
+import io.sloeber.core.tools.Libraries;
 import io.sloeber.core.tools.Programmers;
 import io.sloeber.core.tools.TxtFile;
 
@@ -624,12 +626,15 @@ public void  run(IProgressMonitor internalMonitor) throws CoreException {
                     for (int i = 0; i < cfgs.length; i++) {
                         cfgs[i].setArtifactName(newProject.getDefaultArtifactName());
                     }
-                    codeDescription.createFiles(newProjectHandle, new NullProgressMonitor());
+                    Map<String, IPath> librariesToAdd = codeDescription.createFiles(newProjectHandle,
+                            new NullProgressMonitor());
+
                     ManagedCProjectNature.addNature(newProjectHandle, "org.eclipse.cdt.core.ccnature", internalMonitor); //$NON-NLS-1$
                     ManagedCProjectNature.addNature(newProjectHandle, Const.ARDUINO_NATURE_ID, internalMonitor);
 
                     CCorePlugin cCorePlugin = CCorePlugin.getDefault();
                     ICProjectDescription prjCDesc = cCorePlugin.getProjectDescription(newProjectHandle);
+                    Libraries.addLibrariesToProject(newProjectHandle, prjCDesc.getActiveConfiguration(), librariesToAdd);
                     for (ICConfigurationDescription curConfig : prjCDesc.getConfigurations()) {
                         compileOptions.save(curConfig);
                         save(curConfig);

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

@@ -5,9 +5,7 @@
 import java.io.InputStream;
 import java.util.ArrayList;
 import java.util.Map;
-import java.util.Set;
 import java.util.TreeMap;
-import java.util.TreeSet;
 
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang.StringUtils;
@@ -24,6 +22,7 @@
 import io.sloeber.core.common.InstancePreferences;
 import io.sloeber.core.tools.FileModifiers;
 import io.sloeber.core.tools.Helpers;
+import io.sloeber.core.tools.Libraries;
 import io.sloeber.core.tools.Stream;
 
 /**
@@ -140,8 +139,8 @@ public void save() {
 	 * of libraries that need to be installed
 	 **/
 	@SuppressWarnings("nls")
-	public Set<String> createFiles(IProject project, IProgressMonitor monitor) throws CoreException {
-		Set<String> libraries = new TreeSet<>();
+	public Map<String, IPath>  createFiles(IProject project, IProgressMonitor monitor) throws CoreException {
+	    Map<String, IPath>  libraries = new TreeMap<>();
 
 		save();
 		Map<String, String> replacers=new TreeMap<>();
@@ -201,7 +200,7 @@ public Set<String> createFiles(IProject project, IProgressMonitor monitor) throw
 						FileUtils.copyDirectory(curPath.toFile(), project.getLocation().toFile());
 						FileModifiers.addPragmaOnce(curPath);
 					}
-					libraries.add(getLibraryName(curPath));
+                    libraries.put(getLibraryName(curPath), Libraries.getLibraryCodeFolder(curPath));
 				}
 			} catch (IOException e) {
 				e.printStackTrace();

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

@@ -92,18 +92,6 @@ public class Helpers extends Common {
 
 	private static boolean myHasBeenLogged = false;
 
-	/**
-	 * conveniance method because java does not know default values as parameters
-	 * default is isWorkSpace=true
-	 * 
-	 * @param configurationDescription
-	 * @param IncludePath
-	 */
-
-	public static void addIncludeFolder(ICFolderDescription folderDescription,  IPath IncludePath) 
-	{
-		   addIncludeFolder( folderDescription,  IncludePath,true) ;
-	}
 
 	/**
 	 * This method is the internal working class that adds the provided include path
@@ -114,8 +102,10 @@ public static void addIncludeFolder(ICFolderDescription folderDescription,  IPat
 	 * @param IncludePath              The path to add to the include folders
 	 * @see addLibraryDependency {@link #addLibraryDependency(IProject, IProject)}
 	 */
-	public static void addIncludeFolder(ICFolderDescription folderDescription, IPath IncludePath,boolean isWorkspacePath) {
-		ICLanguageSetting[] languageSettings = folderDescription.getLanguageSettings();
+    public static void addIncludeFolder(ICConfigurationDescription configurationDescription, IPath IncludePath,
+            boolean isWorkspacePath) {
+        ICLanguageSetting[] languageSettings = configurationDescription.getRootFolderDescription()
+                .getLanguageSettings();
 		int pathSetting = ICSettingEntry.VALUE_WORKSPACE_PATH;
 		if (!isWorkspacePath) {
 			pathSetting = 0;
@@ -241,8 +231,7 @@ public static void LinkFolderToFolder(IProject project, IPath source, IPath targ
 	 */
 	public static void addCodeFolder(IProject project, IPath toLinkFolder, String LinkName,
 			ICConfigurationDescription configurationDescription, boolean forceRoot) throws CoreException {
-		IFolder link = project.getFolder(LinkName);
-		ICFolderDescription folderDescription = configurationDescription.getRootFolderDescription();
+		IFolder link = project.getFolder(LinkName);		
 
 		LinkFolderToFolder(project, toLinkFolder, new Path(LinkName));
 
@@ -252,29 +241,35 @@ public static void addCodeFolder(IProject project, IPath toLinkFolder, String Li
 		String possibleIncludeFolder = "utility"; //$NON-NLS-1$
 		File file = toLinkFolder.append(possibleIncludeFolder).toFile();
 		if (file.exists()) {
-			addIncludeFolder(folderDescription, link.getFullPath().append(possibleIncludeFolder));
+            addIncludeFolder(configurationDescription, link.getFullPath().append(possibleIncludeFolder), true);
 		}
 
 		if (forceRoot) {
-			addIncludeFolder(folderDescription, link.getFullPath());
+            addIncludeFolder(configurationDescription, link.getFullPath(), true);
 		} else {
 			// add src or root give priority to src
 			possibleIncludeFolder = Library.LIBRARY_SOURCE_FODER;
 			file = toLinkFolder.append(possibleIncludeFolder).toFile();
 			if (file.exists()) {
-				addIncludeFolder(folderDescription, link.getFullPath().append(possibleIncludeFolder));
+                addIncludeFolder(configurationDescription, link.getFullPath().append(possibleIncludeFolder), true);
 			} else {
-				addIncludeFolder(folderDescription, link.getFullPath());
+                addIncludeFolder(configurationDescription, link.getFullPath(), true);
 			}
 		}
-
-		possibleIncludeFolder = "arch"; //$NON-NLS-1$
-		file = toLinkFolder.append(possibleIncludeFolder).toFile();
-		if (file.exists()) {
-			InternalBoardDescriptor boardDescriptor = new InternalBoardDescriptor(configurationDescription);
-			addIncludeFolder(folderDescription,
-					link.getFullPath().append(possibleIncludeFolder).append(boardDescriptor.getArchitecture()));
-		}
+        // TOFIX removed this code as part of libraries not included in project after
+        // creation,
+        // Should run a lib test to see how this works without this code
+        // if this is needed I should create a include with a environment var so I do
+        // not need to get the boardDescriptor
+
+        // possibleIncludeFolder = "arch"; //$NON-NLS-1$
+        // file = toLinkFolder.append(possibleIncludeFolder).toFile();
+        // if (file.exists()) {
+        // InternalBoardDescriptor boardDescriptor = new
+        // InternalBoardDescriptor(configurationDescription);
+        // addIncludeFolder(rootFolderDescr,
+        // link.getFullPath().append(possibleIncludeFolder).append(boardDescriptor.getArchitecture()));
+        // }
 	}
 
 	public static void removeCodeFolder(IProject project, String LinkName) throws CoreException {
@@ -285,30 +280,30 @@ public static void removeCodeFolder(IProject project, String LinkName) throws Co
 	}
 
 	/**
-	 * This method creates a link folder in the project and adds the folder as a
-	 * source path to the project it also adds the path to the include folder if the
-	 * include path parameter points to a path that contains a subfolder named
-	 * "utility" this subfolder will be added to the include path as well <br/>
-	 * <br/>
-	 *
-	 * note Arduino has these subfolders in the libraries that need to be
-	 * include.<br/>
-	 * <br/>
-	 *
-	 * note that in the current eclipse version, there is no need to add the
-	 * subfolder as a code folder. This may change in the future as it looks like a
-	 * bug to me.<br/>
-	 *
-	 * @param project
-	 * @param Path
-	 * @throws CoreException
-	 *
-	 * @see addLibraryDependency {@link #addLibraryDependency(IProject, IProject)}
-	 */
+     * This method creates a link folder in the project descriptor and adds the
+     * folder as a source path to the projectdescriptor it also adds the path to the
+     * include folder if the include path parameter points to a path that contains a
+     * subfolder named "utility" this subfolder will be added to the include path as
+     * well <br/>
+     * <br/>
+     *
+     * note Arduino has these subfolders in the libraries that need to be
+     * include.<br/>
+     * <br/>
+     *
+     * note that in the current eclipse version, there is no need to add the
+     * subfolder as a code folder. This may change in the future as it looks like a
+     * bug to me.<br/>
+     *
+     * @param project
+     * @param Path
+     * @throws CoreException
+     *
+     * @see addLibraryDependency {@link #addLibraryDependency(IProject, IProject)}
+     */
 	public static void addCodeFolder(IProject project, Path Path, ICConfigurationDescription configurationDescription,
 			boolean forceRoot) throws CoreException {
-
-		String NiceName = Path.lastSegment();
+            String NiceName = Path.lastSegment();
 		addCodeFolder(project, Path, NiceName, configurationDescription, forceRoot);
 	}
 

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

@@ -45,7 +45,7 @@
 import io.sloeber.core.common.Const;
 import io.sloeber.core.common.InstancePreferences;
 import io.sloeber.core.managers.Library;
-@SuppressWarnings("unused") 
+
 public class Libraries {
 	public static final String WORKSPACE_LIB_FOLDER = "libraries/"; //$NON-NLS-1$
 	private static final String LIB = Messages.LIB;
@@ -241,7 +241,7 @@ public static void addLibrariesToProject(IProject project,
 	 *            the list of libraries to add
 	 * @return true if the configuration description has changed
 	 */
-	private static void addLibrariesToProject(IProject project,
+    public static void addLibrariesToProject(IProject project,
 			ICConfigurationDescription confdesc, Map<String, IPath> libraries) {
 		List<IPath> foldersToRemoveFromBuildPath = new LinkedList<>();
 		for (Entry<String, IPath> CurItem : libraries.entrySet()) {
@@ -593,4 +593,26 @@ public boolean accept(File dir, String name) {
 		return map;
 	}
 
+    /**
+     * based on a folder inside the library get the folder that starts the library
+     * if that path is not found will return path
+     * 
+     * @param path
+     *            path somewhere inside the library
+     * @return path to the source code
+     */
+    public static IPath getLibraryCodeFolder(IPath path) {
+        // is it a Sloeber managed Library
+        IPath libraryInstallPath = ConfigurationPreferences.getInstallationPathLibraries();
+        if (libraryInstallPath.matchingFirstSegments(path) == libraryInstallPath.segmentCount()) {
+            return path.uptoSegment(libraryInstallPath.segmentCount() + 2);
+        }
+        // is it a library of the hardware
+        IPath hardwareInstallPath = ConfigurationPreferences.getInstallationPathPackages();
+        if (hardwareInstallPath.matchingFirstSegments(path) == hardwareInstallPath.segmentCount()) {
+            return path.uptoSegment(hardwareInstallPath.segmentCount() + 6);
+        }
+        return path;
+    }
+
 }

io.sloeber.tests/src/io/sloeber/core/NightlyJenkins.java

@@ -10,8 +10,8 @@
 @RunWith(Suite.class)
 // removed NightlyBoardPatronTest due to issue #1204
 //this should be reenabled after #1204 is fixed
-//@SuiteClasses({ NightlyBoardPatronTest.class, RegressionTest.class,
-@SuiteClasses({  RegressionTest.class,
+@SuiteClasses({ NightlyBoardPatronTest.class, RegressionTest.class,
+        // @SuiteClasses({ RegressionTest.class,
         RegressionTestFailingOnTravis.class })
 public class NightlyJenkins {
     @BeforeClass