Storing library resolution results for later print them. Fixes #25

Signed-off-by: Federico Fissore <[email protected]>

Author: Federico Fissore

src/arduino.cc/builder/add_additional_entries_to_context.go

@@ -85,5 +85,7 @@ func (s *AddAdditionalEntriesToContext) Run(context map[string]interface{}) erro
 	foldersWithSources := &types.UniqueStringQueue{}
 	context[constants.CTX_FOLDERS_WITH_SOURCES_QUEUE] = foldersWithSources
 
+	context[constants.CTX_LIBRARY_RESOLUTION_RESULTS] = make(map[string]types.LibraryResolutionResult)
+
 	return nil
 }

src/arduino.cc/builder/builder.go

@@ -83,7 +83,6 @@ func (s *Builder) Run(context map[string]interface{}) error {
 
 		&ContainerFindIncludes{},
 
-		&PrintUsedLibrariesIfVerbose{},
 		&WarnAboutArchIncompatibleLibraries{},
 
 		&ContainerAddPrototypes{},
@@ -111,6 +110,10 @@ func (s *Builder) Run(context map[string]interface{}) error {
 		&MergeSketchWithBootloader{},
 
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_POSTBUILD, Suffix: constants.HOOKS_PATTERN_SUFFIX},
+
+		&PrintUsedAndNotUsedLibraries{},
+
+		&PrintUsedLibrariesIfVerbose{},
 	}
 
 	return runCommands(context, commands)

src/arduino.cc/builder/constants/constants.go

@@ -102,6 +102,7 @@ const CTX_LIBRARIES_BUILD_PATH = "librariesBuildPath"
 const CTX_LIBRARIES_FOLDERS = "librariesFolders"
 const CTX_LIBRARIES = "libraries"
 const CTX_LIBRARY_DISCOVERY_RECURSION_DEPTH = "libraryDiscoveryRecursionDepth"
+const CTX_LIBRARY_RESOLUTION_RESULTS = "libraryResolutionResults"
 const CTX_LINE_OFFSET = "lineOffset"
 const CTX_LOGGER = "logger"
 const CTX_OBJECT_FILES_LIBRARIES = "objectFilesLibraries"

src/arduino.cc/builder/includes_to_include_folders.go

@@ -31,10 +31,8 @@ package builder
 
 import (
 	"arduino.cc/builder/constants"
-	"arduino.cc/builder/i18n"
 	"arduino.cc/builder/types"
 	"arduino.cc/builder/utils"
-	"os"
 	"path/filepath"
 	"strings"
 )
@@ -47,16 +45,15 @@ func (s *IncludesToIncludeFolders) Run(context map[string]interface{}) error {
 	}
 	includes := context[constants.CTX_INCLUDES].([]string)
 	headerToLibraries := context[constants.CTX_HEADER_TO_LIBRARIES].(map[string][]*types.Library)
-	debugLevel := utils.DebugLevel(context)
-	logger := context[constants.CTX_LOGGER].(i18n.Logger)
 	platform := context[constants.CTX_TARGET_PLATFORM].(*types.Platform)
 	actualPlatform := context[constants.CTX_ACTUAL_PLATFORM].(*types.Platform)
+	libraryResolutionResults := context[constants.CTX_LIBRARY_RESOLUTION_RESULTS].(map[string]types.LibraryResolutionResult)
 
-	var importedLibraries []*types.Library
+	importedLibraries := []*types.Library{}
 	if utils.MapHas(context, constants.CTX_IMPORTED_LIBRARIES) {
 		importedLibraries = context[constants.CTX_IMPORTED_LIBRARIES].([]*types.Library)
 	}
-	newlyImportedLibraries, err := resolveLibraries(includes, headerToLibraries, importedLibraries, []*types.Platform{platform, actualPlatform}, debugLevel, logger)
+	newlyImportedLibraries, err := resolveLibraries(includes, headerToLibraries, []*types.Platform{platform, actualPlatform}, libraryResolutionResults)
 	if err != nil {
 		return utils.WrapError(err)
 	}
@@ -95,10 +92,10 @@ func resolveIncludeFolders(importedLibraries []*types.Library, buildProperties m
 }
 
 //FIXME it's also resolving previously resolved libraries
-func resolveLibraries(includes []string, headerToLibraries map[string][]*types.Library, previousImportedLibraries []*types.Library, platforms []*types.Platform, debugLevel int, logger i18n.Logger) ([]*types.Library, error) {
+func resolveLibraries(includes []string, headerToLibraries map[string][]*types.Library, platforms []*types.Platform, libraryResolutionResults map[string]types.LibraryResolutionResult) ([]*types.Library, error) {
 	markImportedLibrary := make(map[*types.Library]bool)
 	for _, header := range includes {
-		resolveLibrary(header, headerToLibraries, markImportedLibrary, previousImportedLibraries, platforms, debugLevel, logger)
+		resolveLibrary(header, headerToLibraries, markImportedLibrary, platforms, libraryResolutionResults)
 	}
 
 	var importedLibraries []*types.Library
@@ -109,7 +106,7 @@ func resolveLibraries(includes []string, headerToLibraries map[string][]*types.L
 	return importedLibraries, nil
 }
 
-func resolveLibrary(header string, headerToLibraries map[string][]*types.Library, markImportedLibrary map[*types.Library]bool, previousImportedLibraries []*types.Library, platforms []*types.Platform, debugLevel int, logger i18n.Logger) {
+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 {
@@ -144,16 +141,19 @@ func resolveLibrary(header string, headerToLibraries map[string][]*types.Library
 		library = libraries[0]
 	}
 
-	if debugLevel > 0 && !sliceContainsLibrary(previousImportedLibraries, library) {
-		logger.Fprintln(os.Stderr, constants.MSG_LIBRARIES_MULTIPLE_LIBS_FOUND_FOR, header)
-		logger.Fprintln(os.Stderr, constants.MSG_LIBRARIES_USED, library.Folder)
-		for _, notUsedLibrary := range libraries {
-			if library != notUsedLibrary {
-				logger.Fprintln(os.Stderr, constants.MSG_LIBRARIES_NOT_USED, notUsedLibrary.Folder)
-			}
+	libraryResolutionResults[header] = types.LibraryResolutionResult{Library: library, NotUsedLibraries: filterOutLibraryFrom(libraries, library)}
+
+	markImportedLibrary[library] = true
+}
+
+func filterOutLibraryFrom(libraries []*types.Library, library *types.Library) []*types.Library {
+	filteredOutLibraries := []*types.Library{}
+	for _, lib := range libraries {
+		if lib != library {
+			filteredOutLibraries = append(filteredOutLibraries, lib)
 		}
 	}
-	markImportedLibrary[library] = true
+	return filteredOutLibraries
 }
 
 func libraryCompatibleWithPlatform(library *types.Library, platform *types.Platform) bool {

src/arduino.cc/builder/print_used_and_not_used_libraries.go

@@ -0,0 +1,59 @@
+/*
+ * This file is part of Arduino Builder.
+ *
+ * Arduino Builder is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2015 Arduino LLC (http://www.arduino.cc/)
+ */
+
+package builder
+
+import (
+	"arduino.cc/builder/constants"
+	"arduino.cc/builder/i18n"
+	"arduino.cc/builder/types"
+	"arduino.cc/builder/utils"
+	"os"
+)
+
+type PrintUsedAndNotUsedLibraries struct{}
+
+func (s *PrintUsedAndNotUsedLibraries) Run(context map[string]interface{}) error {
+	if utils.DebugLevel(context) <= 0 {
+		return nil
+	}
+
+	logger := context[constants.CTX_LOGGER].(i18n.Logger)
+	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)
+		}
+	}
+
+	return nil
+}

src/arduino.cc/builder/verbose_imported_libraries.go src/arduino.cc/builder/print_used_libraries_if_verbose.go

@@ -56,6 +56,8 @@ func TestAddAdditionalEntriesToContextNoBuildPath(t *testing.T) {
 
 	require.True(t, context[constants.CTX_COLLECTED_SOURCE_FILES_QUEUE].(*types.UniqueStringQueue).Empty())
 	require.True(t, context[constants.CTX_FOLDERS_WITH_SOURCES_QUEUE].(*types.UniqueStringQueue).Empty())
+
+	require.Equal(t, 0, len(context[constants.CTX_LIBRARY_RESOLUTION_RESULTS].(map[string]types.LibraryResolutionResult)))
 }
 
 func TestAddAdditionalEntriesToContextWithBuildPath(t *testing.T) {
@@ -78,4 +80,6 @@ func TestAddAdditionalEntriesToContextWithBuildPath(t *testing.T) {
 
 	require.True(t, context[constants.CTX_COLLECTED_SOURCE_FILES_QUEUE].(*types.UniqueStringQueue).Empty())
 	require.True(t, context[constants.CTX_FOLDERS_WITH_SOURCES_QUEUE].(*types.UniqueStringQueue).Empty())
+
+	require.Equal(t, 0, len(context[constants.CTX_LIBRARY_RESOLUTION_RESULTS].(map[string]types.LibraryResolutionResult)))
 }

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

@@ -165,7 +165,6 @@ func TestIncludesFinderWithGCCSketchWithDependendLibraries(t *testing.T) {
 	require.Equal(t, "library3.h", includes[5])
 	require.Equal(t, "library4.h", includes[6])
 
-	require.NotNil(t, context[constants.CTX_IMPORTED_LIBRARIES])
 	importedLibraries := context[constants.CTX_IMPORTED_LIBRARIES].([]*types.Library)
 	require.Equal(t, 4, len(importedLibraries))
 

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

@@ -71,7 +71,6 @@ func TestIncludesToIncludeFolders(t *testing.T) {
 		NoError(t, err)
 	}
 
-	require.NotNil(t, context[constants.CTX_IMPORTED_LIBRARIES])
 	importedLibraries := context[constants.CTX_IMPORTED_LIBRARIES].([]*types.Library)
 	require.Equal(t, 1, len(importedLibraries))
 	require.Equal(t, "Bridge", importedLibraries[0].Name)
@@ -108,7 +107,8 @@ func TestIncludesToIncludeFoldersSketchWithIfDef(t *testing.T) {
 		NoError(t, err)
 	}
 
-	require.Nil(t, context[constants.CTX_IMPORTED_LIBRARIES])
+	importedLibraries := context[constants.CTX_IMPORTED_LIBRARIES].([]*types.Library)
+	require.Equal(t, 0, len(importedLibraries))
 }
 
 func TestIncludesToIncludeFoldersIRremoteLibrary(t *testing.T) {
@@ -142,7 +142,6 @@ func TestIncludesToIncludeFoldersIRremoteLibrary(t *testing.T) {
 		NoError(t, err)
 	}
 
-	require.NotNil(t, context[constants.CTX_IMPORTED_LIBRARIES])
 	importedLibraries := context[constants.CTX_IMPORTED_LIBRARIES].([]*types.Library)
 	sort.Sort(ByLibraryName(importedLibraries))
 	require.Equal(t, 2, len(importedLibraries))
@@ -181,7 +180,6 @@ func TestIncludesToIncludeFoldersANewLibrary(t *testing.T) {
 		NoError(t, err)
 	}
 
-	require.NotNil(t, context[constants.CTX_IMPORTED_LIBRARIES])
 	importedLibraries := context[constants.CTX_IMPORTED_LIBRARIES].([]*types.Library)
 	sort.Sort(ByLibraryName(importedLibraries))
 	require.Equal(t, 2, len(importedLibraries))
@@ -220,7 +218,6 @@ func TestIncludesToIncludeFoldersDuplicateLibs(t *testing.T) {
 		NoError(t, err)
 	}
 
-	require.NotNil(t, context[constants.CTX_IMPORTED_LIBRARIES])
 	importedLibraries := context[constants.CTX_IMPORTED_LIBRARIES].([]*types.Library)
 	sort.Sort(ByLibraryName(importedLibraries))
 	require.Equal(t, 1, len(importedLibraries))

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

@@ -0,0 +1,68 @@
+/*
+ * This file is part of Arduino Builder.
+ *
+ * Arduino Builder is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2015 Arduino LLC (http://www.arduino.cc/)
+ */
+
+package types
+
+type UniqueStringQueue []string
+
+func (h UniqueStringQueue) Len() int           { return len(h) }
+func (h UniqueStringQueue) Less(i, j int) bool { return false }
+func (h UniqueStringQueue) Swap(i, j int)      { panic("Who called me?!?") }
+
+func (h *UniqueStringQueue) Push(x interface{}) {
+	if !sliceContains(*h, x.(string)) {
+		*h = append(*h, x.(string))
+	}
+}
+
+func (h *UniqueStringQueue) Pop() interface{} {
+	old := *h
+	x := old[0]
+	*h = old[1:]
+	return x
+}
+
+func (h *UniqueStringQueue) Empty() bool {
+	return h.Len() == 0
+}
+
+// duplication of utils.SliceContains! Thanks golang! Why? Because you can't have import cycles, so types cannot import from utils because utils already imports from types
+func sliceContains(slice []string, target string) bool {
+	for _, value := range slice {
+		if value == target {
+			return true
+		}
+	}
+	return false
+}
+
+type LibraryResolutionResult struct {
+	Library          *Library
+	NotUsedLibraries []*Library
+}

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

@@ -156,36 +156,3 @@ type KeyValuePair struct {
 type Command interface {
 	Run(context map[string]interface{}) error
 }
-
-type UniqueStringQueue []string
-
-func (h UniqueStringQueue) Len() int           { return len(h) }
-func (h UniqueStringQueue) Less(i, j int) bool { return false }
-func (h UniqueStringQueue) Swap(i, j int)      { panic("Who called me?!?") }
-
-func (h *UniqueStringQueue) Push(x interface{}) {
-	if !SliceContains(*h, x.(string)) {
-		*h = append(*h, x.(string))
-	}
-}
-
-func (h *UniqueStringQueue) Pop() interface{} {
-	old := *h
-	x := old[0]
-	*h = old[1:]
-	return x
-}
-
-func (h *UniqueStringQueue) Empty() bool {
-	return h.Len() == 0
-}
-
-// duplication of utils.SliceContains! Thanks golang! Why? Because you can't have import cycles, so types cannot import from utils because utils already imports from types
-func SliceContains(slice []string, target string) bool {
-	for _, value := range slice {
-		if value == target {
-			return true
-		}
-	}
-	return false
-}