Adding info in LibraryResolutionResult about whether selected library comes

from a platform or from outside. If the former and there are duplicates,
no warning is printed. Fixes #37

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

Author: Federico Fissore

src/arduino.cc/builder/includes_to_include_folders.go

@@ -144,7 +144,8 @@ func resolveLibrary(header string, headerToLibraries map[string][]*types.Library
 
 	library = useAlreadyImportedLibraryWithSameNameIfExists(library, markImportedLibrary)
 
-	libraryResolutionResults[header] = types.LibraryResolutionResult{Library: library, NotUsedLibraries: filterOutLibraryFrom(libraries, library)}
+	isLibraryFromPlatform := findLibraryIn(librariesInPlatforms, library) != nil
+	libraryResolutionResults[header] = types.LibraryResolutionResult{Library: library, IsLibraryFromPlatform: isLibraryFromPlatform, NotUsedLibraries: filterOutLibraryFrom(libraries, library)}
 
 	markImportedLibrary[library] = true
 }

src/arduino.cc/builder/print_used_and_not_used_libraries.go

@@ -48,10 +48,12 @@ func (s *PrintUsedAndNotUsedLibraries) Run(context map[string]interface{}) error
 	libraryResolutionResults := context[constants.CTX_LIBRARY_RESOLUTION_RESULTS].(map[string]types.LibraryResolutionResult)
 
 	for header, libResResult := range libraryResolutionResults {
-		logger.Fprintln(os.Stderr, constants.MSG_LIBRARIES_MULTIPLE_LIBS_FOUND_FOR, header)
-		logger.Fprintln(os.Stderr, constants.MSG_LIBRARIES_USED, libResResult.Library.Folder)
-		for _, notUsedLibrary := range libResResult.NotUsedLibraries {
-			logger.Fprintln(os.Stderr, constants.MSG_LIBRARIES_NOT_USED, notUsedLibrary.Folder)
+		if !libResResult.IsLibraryFromPlatform {
+			logger.Fprintln(os.Stderr, constants.MSG_LIBRARIES_MULTIPLE_LIBS_FOUND_FOR, header)
+			logger.Fprintln(os.Stderr, constants.MSG_LIBRARIES_USED, libResResult.Library.Folder)
+			for _, notUsedLibrary := range libResResult.NotUsedLibraries {
+				logger.Fprintln(os.Stderr, constants.MSG_LIBRARIES_NOT_USED, notUsedLibrary.Folder)
+			}
 		}
 	}
 

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

@@ -74,6 +74,10 @@ func TestIncludesToIncludeFolders(t *testing.T) {
 	importedLibraries := context[constants.CTX_IMPORTED_LIBRARIES].([]*types.Library)
 	require.Equal(t, 1, len(importedLibraries))
 	require.Equal(t, "Bridge", importedLibraries[0].Name)
+
+	libraryResolutionResults := context[constants.CTX_LIBRARY_RESOLUTION_RESULTS].(map[string]types.LibraryResolutionResult)
+	require.NotNil(t, libraryResolutionResults)
+	require.False(t, libraryResolutionResults["Bridge.h"].IsLibraryFromPlatform)
 }
 
 func TestIncludesToIncludeFoldersSketchWithIfDef(t *testing.T) {
@@ -109,6 +113,9 @@ func TestIncludesToIncludeFoldersSketchWithIfDef(t *testing.T) {
 
 	importedLibraries := context[constants.CTX_IMPORTED_LIBRARIES].([]*types.Library)
 	require.Equal(t, 0, len(importedLibraries))
+
+	libraryResolutionResults := context[constants.CTX_LIBRARY_RESOLUTION_RESULTS].(map[string]types.LibraryResolutionResult)
+	require.NotNil(t, libraryResolutionResults)
 }
 
 func TestIncludesToIncludeFoldersIRremoteLibrary(t *testing.T) {
@@ -147,6 +154,11 @@ func TestIncludesToIncludeFoldersIRremoteLibrary(t *testing.T) {
 	require.Equal(t, 2, len(importedLibraries))
 	require.Equal(t, "Bridge", importedLibraries[0].Name)
 	require.Equal(t, "IRremote", importedLibraries[1].Name)
+
+	libraryResolutionResults := context[constants.CTX_LIBRARY_RESOLUTION_RESULTS].(map[string]types.LibraryResolutionResult)
+	require.NotNil(t, libraryResolutionResults)
+	require.False(t, libraryResolutionResults["Bridge.h"].IsLibraryFromPlatform)
+	require.False(t, libraryResolutionResults["IRremote.h"].IsLibraryFromPlatform)
 }
 
 func TestIncludesToIncludeFoldersANewLibrary(t *testing.T) {
@@ -185,6 +197,11 @@ func TestIncludesToIncludeFoldersANewLibrary(t *testing.T) {
 	require.Equal(t, 2, len(importedLibraries))
 	require.Equal(t, "ANewLibrary-master", importedLibraries[0].Name)
 	require.Equal(t, "IRremote", importedLibraries[1].Name)
+
+	libraryResolutionResults := context[constants.CTX_LIBRARY_RESOLUTION_RESULTS].(map[string]types.LibraryResolutionResult)
+	require.NotNil(t, libraryResolutionResults)
+	require.False(t, libraryResolutionResults["anewlibrary.h"].IsLibraryFromPlatform)
+	require.False(t, libraryResolutionResults["IRremote.h"].IsLibraryFromPlatform)
 }
 
 func TestIncludesToIncludeFoldersDuplicateLibs(t *testing.T) {
@@ -223,6 +240,10 @@ func TestIncludesToIncludeFoldersDuplicateLibs(t *testing.T) {
 	require.Equal(t, 1, len(importedLibraries))
 	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)
+
+	libraryResolutionResults := context[constants.CTX_LIBRARY_RESOLUTION_RESULTS].(map[string]types.LibraryResolutionResult)
+	require.NotNil(t, libraryResolutionResults)
+	require.True(t, libraryResolutionResults["SPI.h"].IsLibraryFromPlatform)
 }
 
 func TestIncludesToIncludeFoldersDuplicateLibsWithConflictingLibsOutsideOfPlatform(t *testing.T) {
@@ -261,6 +282,10 @@ func TestIncludesToIncludeFoldersDuplicateLibsWithConflictingLibsOutsideOfPlatfo
 	require.Equal(t, 1, len(importedLibraries))
 	require.Equal(t, "SPI", importedLibraries[0].Name)
 	require.Equal(t, Abs(t, filepath.Join("libraries", "SPI")), importedLibraries[0].SrcFolder)
+
+	libraryResolutionResults := context[constants.CTX_LIBRARY_RESOLUTION_RESULTS].(map[string]types.LibraryResolutionResult)
+	require.NotNil(t, libraryResolutionResults)
+	require.False(t, libraryResolutionResults["SPI.h"].IsLibraryFromPlatform)
 }
 
 func TestIncludesToIncludeFoldersDuplicateLibs2(t *testing.T) {
@@ -298,4 +323,8 @@ func TestIncludesToIncludeFoldersDuplicateLibs2(t *testing.T) {
 	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)
+
+	libraryResolutionResults := context[constants.CTX_LIBRARY_RESOLUTION_RESULTS].(map[string]types.LibraryResolutionResult)
+	require.NotNil(t, libraryResolutionResults)
+	require.False(t, libraryResolutionResults["Usb.h"].IsLibraryFromPlatform)
 }

src/arduino.cc/builder/types/accessories.go

@@ -53,6 +53,7 @@ func (h *UniqueStringQueue) Empty() bool {
 }
 
 type LibraryResolutionResult struct {
-	Library          *Library
-	NotUsedLibraries []*Library
+	Library               *Library
+	IsLibraryFromPlatform bool
+	NotUsedLibraries      []*Library
 }