Remove IncludesToIncludeFolders.Run

In previous commits, this method has been signficantly simplified,
reducing it to little more than a wrapper around the resolveLibrary
helper function.

This commit renames resolveLibrary to ResolveLibrary to make it public
and lets findIncludesUntilDone call it directly (instead of going
through IncludesToIncludeFolders). findIncludesUntilDone now also takes
care of processing the ResolveLibrary result, which was previously done
by IncludesToIncludeFolders.

The signature of ResolveLibrary is also changed to accept a Context, so
it can now extract the needed variables itself, instead of needing
IncludesToIncludeFolders to extract them.

Note that the filename that contains ResolveLibrary is no longer
entirely accurate, but this will be fixed in a later commit (to simplify
review of this commit).

Signed-off-by: Matthijs Kooijman <matthijs@stdin.nl>

Author: matthijskooijman

src/arduino.cc/builder/container_find_includes.go

@@ -84,12 +84,10 @@ func runCommand(ctx *types.Context, command types.Command) error {
 
 func findIncludesUntilDone(ctx *types.Context, sourceFilePath string) error {
 	targetFilePath := utils.NULLFile()
-	importedLibraries := ctx.ImportedLibraries
 	for {
 		commands := []types.Command{
 			&GCCPreprocRunnerForDiscoveringIncludes{SourceFilePath: sourceFilePath, TargetFilePath: targetFilePath},
 			&IncludesFinderWithRegExp{Source: &ctx.SourceGccMinusE},
-			&IncludesToIncludeFolders{},
 		}
 		for _, command := range commands {
 			err := runCommand(ctx, command)
@@ -102,10 +100,21 @@ func findIncludesUntilDone(ctx *types.Context, sourceFilePath string) error {
 			return nil
 		}
 
-		if len(ctx.ImportedLibraries) == len(importedLibraries) {
+		library := ResolveLibrary(ctx, ctx.IncludeJustFound)
+		if library == nil {
+			// Library could not be resolved, show error
 			err := runCommand(ctx, &GCCPreprocRunner{TargetFileName: constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E})
 			return i18n.WrapError(err)
 		}
-		importedLibraries = ctx.ImportedLibraries
+
+		// Add this library to the list of libraries, the
+		// include path and queue its source files for further
+		// include scanning
+		ctx.ImportedLibraries = append(ctx.ImportedLibraries, library)
+		ctx.IncludeFolders = append(ctx.IncludeFolders, library.SrcFolder)
+		sourceFolders := types.LibraryToSourceFolder(library)
+		for _, sourceFolder := range sourceFolders {
+			QueueSourceFilesFromFolder(ctx.CollectedSourceFiles, sourceFolder.Folder, sourceFolder.Recurse)
+		}
 	}
 }

src/arduino.cc/builder/includes_to_include_folders.go

@@ -38,41 +38,12 @@ import (
 	"arduino.cc/builder/utils"
 )
 
-type IncludesToIncludeFolders struct{}
-
-func (s *IncludesToIncludeFolders) Run(ctx *types.Context) error {
-	include := ctx.IncludeJustFound
-	includeFolders := ctx.IncludeFolders
+func ResolveLibrary(ctx *types.Context, header string) *types.Library {
 	headerToLibraries := ctx.HeaderToLibraries
-
-	platform := ctx.TargetPlatform
-	actualPlatform := ctx.ActualPlatform
+	platforms := []*types.Platform{ctx.ActualPlatform, ctx.TargetPlatform}
 	libraryResolutionResults := ctx.LibrariesResolutionResults
 	importedLibraries := ctx.ImportedLibraries
 
-	if include == "" {
-		return nil;
-	}
-
-	newlyImportedLibrary := resolveLibrary(include, headerToLibraries, importedLibraries, []*types.Platform{actualPlatform, platform}, libraryResolutionResults)
-	if newlyImportedLibrary == nil {
-		return nil;
-	}
-
-	importedLibraries = append(importedLibraries, newlyImportedLibrary)
-	sourceFolders := types.LibraryToSourceFolder(newlyImportedLibrary)
-	for _, sourceFolder := range sourceFolders {
-		QueueSourceFilesFromFolder(ctx.CollectedSourceFiles, sourceFolder.Folder, sourceFolder.Recurse)
-	}
-	includeFolders = append(includeFolders, newlyImportedLibrary.SrcFolder)
-
-	ctx.ImportedLibraries = importedLibraries
-	ctx.IncludeFolders = includeFolders
-
-	return nil
-}
-
-func resolveLibrary(header string, headerToLibraries map[string][]*types.Library, importedLibraries []*types.Library, platforms []*types.Platform, libraryResolutionResults map[string]types.LibraryResolutionResult) *types.Library {
 	markImportedLibrary := make(map[*types.Library]bool)
 	for _, library := range importedLibraries {
 		markImportedLibrary[library] = true