When an included header is part of an already included library, use that

library
The order in which -libraries parameters are specified matters: second one is
more important than first one

Signed-off-by: Federico Fissore <f.fissore@arduino.cc>

Author: Federico Fissore

src/arduino.cc/builder/includes_to_include_folders.go

@@ -53,7 +53,7 @@ func (s *IncludesToIncludeFolders) Run(context map[string]interface{}) error {
 	if utils.MapHas(context, constants.CTX_IMPORTED_LIBRARIES) {
 		importedLibraries = context[constants.CTX_IMPORTED_LIBRARIES].([]*types.Library)
 	}
-	newlyImportedLibraries, err := resolveLibraries(includes, headerToLibraries, []*types.Platform{platform, actualPlatform}, libraryResolutionResults)
+	newlyImportedLibraries, err := resolveLibraries(includes, headerToLibraries, importedLibraries, []*types.Platform{platform, actualPlatform}, libraryResolutionResults)
 	if err != nil {
 		return utils.WrapError(err)
 	}
@@ -92,24 +92,27 @@ func resolveIncludeFolders(importedLibraries []*types.Library, buildProperties m
 }
 
 //FIXME it's also resolving previously resolved libraries
-func resolveLibraries(includes []string, headerToLibraries map[string][]*types.Library, platforms []*types.Platform, libraryResolutionResults map[string]types.LibraryResolutionResult) ([]*types.Library, error) {
+func resolveLibraries(includes []string, headerToLibraries map[string][]*types.Library, importedLibraries []*types.Library, platforms []*types.Platform, libraryResolutionResults map[string]types.LibraryResolutionResult) ([]*types.Library, error) {
 	markImportedLibrary := make(map[*types.Library]bool)
+	for _, library := range importedLibraries {
+		markImportedLibrary[library] = true
+	}
 	for _, header := range includes {
 		resolveLibrary(header, headerToLibraries, markImportedLibrary, platforms, libraryResolutionResults)
 	}
 
-	var importedLibraries []*types.Library
+	var newlyImportedLibraries []*types.Library
 	for library, _ := range markImportedLibrary {
-		importedLibraries = append(importedLibraries, library)
+		newlyImportedLibraries = append(newlyImportedLibraries, library)
 	}
 
-	return importedLibraries, nil
+	return newlyImportedLibraries, nil
 }
 
 func resolveLibrary(header string, headerToLibraries map[string][]*types.Library, markImportedLibrary map[*types.Library]bool, platforms []*types.Platform, libraryResolutionResults map[string]types.LibraryResolutionResult) {
 	libraries := headerToLibraries[header]
 
-	if libraries == nil {
+	if libraries == nil || len(libraries) == 0 {
 		return
 	}
 
@@ -118,6 +121,10 @@ func resolveLibrary(header string, headerToLibraries map[string][]*types.Library
 		return
 	}
 
+	if markedLibrariesContainOneOfCandidate(markImportedLibrary, libraries) {
+		return
+	}
+
 	var library *types.Library
 
 	for _, platform := range platforms {
@@ -138,14 +145,36 @@ func resolveLibrary(header string, headerToLibraries map[string][]*types.Library
 	}
 
 	if library == nil {
-		library = libraries[0]
+		library = libraries[len(libraries)-1]
 	}
 
+	library = useAlreadyImportedLibraryWithSameNameIfExists(library, markImportedLibrary)
+
 	libraryResolutionResults[header] = types.LibraryResolutionResult{Library: library, NotUsedLibraries: filterOutLibraryFrom(libraries, library)}
 
 	markImportedLibrary[library] = true
 }
 
+func markedLibrariesContainOneOfCandidate(markImportedLibrary map[*types.Library]bool, libraries []*types.Library) bool {
+	for markedLibrary, _ := range markImportedLibrary {
+		for _, library := range libraries {
+			if markedLibrary == library {
+				return true
+			}
+		}
+	}
+	return false
+}
+
+func useAlreadyImportedLibraryWithSameNameIfExists(library *types.Library, markImportedLibrary map[*types.Library]bool) *types.Library {
+	for lib, _ := range markImportedLibrary {
+		if lib.Name == library.Name {
+			return lib
+		}
+	}
+	return library
+}
+
 func filterOutLibraryFrom(libraries []*types.Library, library *types.Library) []*types.Library {
 	filteredOutLibraries := []*types.Library{}
 	for _, lib := range libraries {

src/arduino.cc/builder/libraries_loader.go

@@ -43,11 +43,11 @@ import (
 type LibrariesLoader struct{}
 
 func (s *LibrariesLoader) Run(context map[string]interface{}) error {
-	if !utils.MapHas(context, constants.CTX_LIBRARIES_FOLDERS) {
-		return nil
+	librariesFolders := []string{}
+	if utils.MapHas(context, constants.CTX_LIBRARIES_FOLDERS) {
+		librariesFolders = context[constants.CTX_LIBRARIES_FOLDERS].([]string)
 	}
 
-	librariesFolders := context[constants.CTX_LIBRARIES_FOLDERS].([]string)
 	platform := context[constants.CTX_TARGET_PLATFORM].(*types.Platform)
 	debugLevel := utils.DebugLevel(context)
 	logger := context[constants.CTX_LOGGER].(i18n.Logger)
@@ -57,11 +57,11 @@ func (s *LibrariesLoader) Run(context map[string]interface{}) error {
 		return utils.WrapError(err)
 	}
 
-	librariesFolders = appendPathToLibrariesFolders(librariesFolders, filepath.Join(platform.Folder, constants.FOLDER_LIBRARIES))
+	librariesFolders = prependPathToLibrariesFolders(librariesFolders, filepath.Join(platform.Folder, constants.FOLDER_LIBRARIES))
 
 	actualPlatform := context[constants.CTX_ACTUAL_PLATFORM].(*types.Platform)
 	if actualPlatform != platform {
-		librariesFolders = appendPathToLibrariesFolders(librariesFolders, filepath.Join(actualPlatform.Folder, constants.FOLDER_LIBRARIES))
+		librariesFolders = prependPathToLibrariesFolders(librariesFolders, filepath.Join(actualPlatform.Folder, constants.FOLDER_LIBRARIES))
 	}
 
 	librariesFolders, err = utils.AbsolutizePaths(librariesFolders)
@@ -208,7 +208,7 @@ func makeLegacyLibrary(libraryFolder string) (*types.Library, error) {
 	return library, nil
 }
 
-func appendPathToLibrariesFolders(librariesFolders []string, newLibrariesFolder string) []string {
+func prependPathToLibrariesFolders(librariesFolders []string, newLibrariesFolder string) []string {
 	if stat, err := os.Stat(newLibrariesFolder); os.IsNotExist(err) || !stat.IsDir() {
 		return librariesFolders
 	}
@@ -217,5 +217,5 @@ func appendPathToLibrariesFolders(librariesFolders []string, newLibrariesFolder
 		return librariesFolders
 	}
 
-	return append(librariesFolders, newLibrariesFolder)
+	return append([]string{newLibrariesFolder}, librariesFolders...)
 }

src/arduino.cc/builder/test/includes_to_include_folders_test.go

@@ -162,7 +162,7 @@ func TestIncludesToIncludeFoldersANewLibrary(t *testing.T) {
 	context[constants.CTX_FQBN] = "arduino:avr:leonardo"
 	context[constants.CTX_SKETCH_LOCATION] = filepath.Join("sketch10", "sketch.ino")
 	context[constants.CTX_BUILD_PROPERTIES_RUNTIME_IDE_VERSION] = "10600"
-	context[constants.CTX_LIBRARIES_FOLDERS] = []string{"libraries", "downloaded_libraries"}
+	context[constants.CTX_LIBRARIES_FOLDERS] = []string{"downloaded_libraries", "libraries"}
 	context[constants.CTX_VERBOSE] = false
 
 	commands := []types.Command{
@@ -224,3 +224,40 @@ func TestIncludesToIncludeFoldersDuplicateLibs(t *testing.T) {
 	require.Equal(t, "SPI", importedLibraries[0].Name)
 	require.Equal(t, Abs(t, filepath.Join("user_hardware", "my_avr_platform", "avr", "libraries", "SPI")), importedLibraries[0].SrcFolder)
 }
+
+func TestIncludesToIncludeFoldersDuplicateLibs2(t *testing.T) {
+	DownloadCoresAndToolsAndLibraries(t)
+
+	context := make(map[string]interface{})
+
+	buildPath := SetupBuildPath(t, context)
+	defer os.RemoveAll(buildPath)
+
+	context[constants.CTX_HARDWARE_FOLDERS] = []string{filepath.Join("..", "hardware"), "hardware", "downloaded_hardware", "downloaded_board_manager_stuff"}
+	context[constants.CTX_TOOLS_FOLDERS] = []string{"downloaded_tools", "downloaded_board_manager_stuff"}
+	context[constants.CTX_FQBN] = "arduino:samd:arduino_zero_native"
+	context[constants.CTX_SKETCH_LOCATION] = filepath.Join("sketch_usbhost", "sketch_usbhost.ino")
+	context[constants.CTX_BUILD_PROPERTIES_RUNTIME_IDE_VERSION] = "10600"
+	context[constants.CTX_LIBRARIES_FOLDERS] = []string{"libraries", "downloaded_libraries"}
+
+	commands := []types.Command{
+		&builder.SetupHumanLoggerIfMissing{},
+
+		&builder.ContainerSetupHardwareToolsLibsSketchAndProps{},
+
+		&builder.ContainerMergeCopySketchFiles{},
+
+		&builder.ContainerFindIncludes{},
+	}
+
+	for _, command := range commands {
+		err := command.Run(context)
+		NoError(t, err)
+	}
+
+	importedLibraries := context[constants.CTX_IMPORTED_LIBRARIES].([]*types.Library)
+	sort.Sort(ByLibraryName(importedLibraries))
+	require.Equal(t, 1, len(importedLibraries))
+	require.Equal(t, "USBHost", importedLibraries[0].Name)
+	require.Equal(t, Abs(t, filepath.Join("libraries", "USBHost", "src")), importedLibraries[0].SrcFolder)
+}

src/arduino.cc/builder/test/libraries/USBHost/keywords.txt

@@ -0,0 +1,35 @@
+#######################################
+# Syntax Coloring Map For USBHost
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+MouseController	KEYWORD1
+USBHost	KEYWORD1
+KeyboardController	KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+Task	KEYWORD2
+mouseMoved	KEYWORD2
+mouseDragged	KEYWORD2
+mousePressed	KEYWORD2
+mouseReleased	KEYWORD2
+getXChange	KEYWORD2
+getYChange	KEYWORD2
+getButton	KEYWORD2
+keyPressed	KEYWORD2
+keyReleased	KEYWORD2
+getModifiers	KEYWORD2
+getKey	KEYWORD2
+getOemKey	KEYWORD2
+
+
+#######################################
+# Constants (LITERAL1)
+#######################################
+

src/arduino.cc/builder/test/libraries/USBHost/library.properties

@@ -0,0 +1,8 @@
+name=USBHost
+version=1.0
+author=Arduino
+maintainer=Arduino <info@arduino.cc>
+sentence=Allows the communication with USB peripherals like mice, keyboards, and thumbdrives. For Arduino Due and Zero.
+paragraph=The USBHost library allows the board to appear as a USB host, enabling it to communicate with peripherals like USB mice and keyboards. USBHost does not support devices that are connected through USB hubs. This includes some keyboards that have an internal hub.
+url=http://arduino.cc/en/Reference/USBHost
+architectures=samd

src/arduino.cc/builder/test/libraries/USBHost/src/KeyboardController.cpp

@@ -0,0 +1,40 @@
+/*
+ Copyright (c) 2012 Arduino.  All right reserved.
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library 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 Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+#include <KeyboardController.h>
+
+extern "C" {
+void __keyboardControllerEmptyCallback() { }
+}
+
+void keyPressed()  __attribute__ ((weak, alias("__keyboardControllerEmptyCallback")));
+void keyReleased() __attribute__ ((weak, alias("__keyboardControllerEmptyCallback")));
+
+void KeyboardController::OnKeyDown(uint8_t _mod, uint8_t _oemKey) {
+	modifiers = _mod;
+	keyOem = _oemKey;
+	key = OemToAscii(_mod, _oemKey);
+	keyPressed();
+}
+
+void KeyboardController::OnKeyUp(uint8_t _mod, uint8_t _oemKey) {
+	modifiers = _mod;
+	keyOem = _oemKey;
+	key = OemToAscii(_mod, _oemKey);
+	keyReleased();
+}

src/arduino.cc/builder/test/libraries/USBHost/src/KeyboardController.h

@@ -0,0 +1,54 @@
+/*
+ Copyright (c) 2012 Arduino.  All right reserved.
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library 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 Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+#ifndef KEYBOARD_CONTROLLER_H
+#define KEYBOARD_CONTROLLER_H
+
+#include <hidboot.h>
+
+enum KeyboardModifiers {
+	LeftCtrl = 1,
+	LeftShift = 2,
+	Alt = 4,
+	LeftCmd = 8,
+	RightCtrl = 16,
+	RightShift = 32,
+	AltGr = 64,
+	RightCmd = 128
+};
+
+class KeyboardController : public KeyboardReportParser {
+public:
+  KeyboardController(USBHost &usb) : hostKeyboard(&usb), key(0), keyOem(0), modifiers(0) {
+    hostKeyboard.SetReportParser(0, this);
+  };
+
+  uint8_t getKey()       { return key; };
+  uint8_t getModifiers() { return modifiers; };
+  uint8_t getOemKey()    { return keyOem; };
+
+protected:
+  virtual void OnKeyDown(uint8_t mod, uint8_t key);
+  virtual void OnKeyUp(uint8_t mod, uint8_t key);
+
+private:
+  HIDBoot<HID_PROTOCOL_KEYBOARD> hostKeyboard;
+  uint8_t key, keyOem, modifiers;
+};
+
+#endif