Remove Context.FoldersWithSourceFiles

This field was used during include detection, to collect the source
folders whose source files should be processed for includes. This field
was handled by the CollectAllSourceFilesFromFoldersWithSources pass,
which finds all source files in these folders and adds them to the
Context.CollectedSourceFiles queue instead.

This commit changes all code that used to add directories to the
FoldersWithSourceFiles queue to instead add all contained source files
to the CollectedSourceFiles queue. For this, the
CollectAllSourceFilesFromFoldersWithSources pass is transformed into
regular function and renamed to QueueSourceFilesInFolder, so it can be
directly called without needing any particular context entries.

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

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

Author: matthijskooijman

src/arduino.cc/builder/add_additional_entries_to_context.go

@@ -69,7 +69,6 @@ func (s *AddAdditionalEntriesToContext) Run(ctx *types.Context) error {
 	}
 
 	ctx.CollectedSourceFiles = &types.UniqueStringQueue{}
-	ctx.FoldersWithSourceFiles = &types.UniqueSourceFolderQueue{}
 
 	ctx.LibrariesResolutionResults = make(map[string]types.LibraryResolutionResult)
 	ctx.HardwareRewriteResults = make(map[*types.Platform][]types.PlatforKeyRewrite)

src/arduino.cc/builder/collect_all_source_files_from_folders_with_sources.go

@@ -35,24 +35,17 @@ import (
 	"arduino.cc/builder/utils"
 )
 
-type CollectAllSourceFilesFromFoldersWithSources struct{}
-
-func (s *CollectAllSourceFilesFromFoldersWithSources) Run(ctx *types.Context) error {
-	foldersWithSources := ctx.FoldersWithSourceFiles
-	sourceFiles := ctx.CollectedSourceFiles
+func QueueSourceFilesFromFolder(queue *types.UniqueStringQueue, folder string, recurse bool) error {
 	extensions := func(ext string) bool { return ADDITIONAL_FILE_VALID_EXTENSIONS_NO_HEADERS[ext] }
 
 	filePaths := []string{}
-	for !foldersWithSources.Empty() {
-		sourceFolder := foldersWithSources.Pop().(types.SourceFolder)
-		err := utils.FindFilesInFolder(&filePaths, sourceFolder.Folder, extensions, sourceFolder.Recurse)
-		if err != nil {
-			return i18n.WrapError(err)
-		}
+	err := utils.FindFilesInFolder(&filePaths, folder, extensions, recurse)
+	if err != nil {
+		return i18n.WrapError(err)
 	}
 
 	for _, filePath := range filePaths {
-		sourceFiles.Push(filePath)
+		queue.Push(filePath)
 	}
 
 	return nil

src/arduino.cc/builder/container_find_includes.go

@@ -51,32 +51,21 @@ func (s *ContainerFindIncludes) Run(ctx *types.Context) error {
 	sketch := ctx.Sketch
 	ctx.CollectedSourceFiles.Push(filepath.Join(sketchBuildPath, filepath.Base(sketch.MainFile.Name)+".cpp"))
 
-	foldersWithSources := ctx.FoldersWithSourceFiles
-	foldersWithSources.Push(types.SourceFolder{Folder: ctx.SketchBuildPath, Recurse: false})
+	sourceFilePaths := ctx.CollectedSourceFiles
+	QueueSourceFilesFromFolder(sourceFilePaths, ctx.SketchBuildPath, /* recurse */ false)
 	srcSubfolderPath := filepath.Join(ctx.SketchBuildPath, constants.SKETCH_FOLDER_SRC)
 	if info, err := os.Stat(srcSubfolderPath); err == nil && info.IsDir() {
-		foldersWithSources.Push(types.SourceFolder{Folder: srcSubfolderPath, Recurse: true})
-	}
-
-	err := runCommand(ctx, &CollectAllSourceFilesFromFoldersWithSources{})
-	if err != nil {
-		return i18n.WrapError(err)
+		QueueSourceFilesFromFolder(sourceFilePaths, srcSubfolderPath, /* recurse */ true)
 	}
 
-	sourceFilePaths := ctx.CollectedSourceFiles
-
 	for !sourceFilePaths.Empty() {
-		err = findIncludesUntilDone(ctx, sourceFilePaths.Pop().(string))
-		if err != nil {
-			return i18n.WrapError(err)
-		}
-		err := runCommand(ctx, &CollectAllSourceFilesFromFoldersWithSources{})
+		err := findIncludesUntilDone(ctx, sourceFilePaths.Pop().(string))
 		if err != nil {
 			return i18n.WrapError(err)
 		}
 	}
 
-	err = runCommand(ctx, &FailIfImportedLibraryIsWrong{})
+	err := runCommand(ctx, &FailIfImportedLibraryIsWrong{})
 	if err != nil {
 		return i18n.WrapError(err)
 	}

src/arduino.cc/builder/includes_to_include_folders.go

@@ -59,12 +59,10 @@ func (s *IncludesToIncludeFolders) Run(ctx *types.Context) error {
 		return nil;
 	}
 
-	foldersWithSources := ctx.FoldersWithSourceFiles
-
 	importedLibraries = append(importedLibraries, newlyImportedLibrary)
 	sourceFolders := types.LibraryToSourceFolder(newlyImportedLibrary)
 	for _, sourceFolder := range sourceFolders {
-		foldersWithSources.Push(sourceFolder)
+		QueueSourceFilesFromFolder(ctx.CollectedSourceFiles, sourceFolder.Folder, sourceFolder.Recurse)
 	}
 	includeFolders = append(includeFolders, newlyImportedLibrary.SrcFolder)
 

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

@@ -52,7 +52,6 @@ func TestAddAdditionalEntriesToContextNoBuildPath(t *testing.T) {
 	require.NotNil(t, ctx.WarningsLevel)
 
 	require.True(t, ctx.CollectedSourceFiles.Empty())
-	require.True(t, ctx.FoldersWithSourceFiles.Empty())
 
 	require.Equal(t, 0, len(ctx.LibrariesResolutionResults))
 }
@@ -72,7 +71,6 @@ func TestAddAdditionalEntriesToContextWithBuildPath(t *testing.T) {
 	require.NotNil(t, ctx.WarningsLevel)
 
 	require.True(t, ctx.CollectedSourceFiles.Empty())
-	require.True(t, ctx.FoldersWithSourceFiles.Empty())
 
 	require.Equal(t, 0, len(ctx.LibrariesResolutionResults))
 }

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

@@ -51,26 +51,3 @@ func (queue *UniqueStringQueue) Pop() interface{} {
 func (queue *UniqueStringQueue) Empty() bool {
 	return queue.Len() == 0
 }
-
-type UniqueSourceFolderQueue []SourceFolder
-
-func (queue UniqueSourceFolderQueue) Len() int           { return len(queue) }
-func (queue UniqueSourceFolderQueue) Less(i, j int) bool { return false }
-func (queue UniqueSourceFolderQueue) Swap(i, j int)      { panic("Who called me?!?") }
-
-func (queue *UniqueSourceFolderQueue) Push(value SourceFolder) {
-	if !sliceContainsSourceFolder(*queue, value) {
-		*queue = append(*queue, value)
-	}
-}
-
-func (queue *UniqueSourceFolderQueue) Pop() interface{} {
-	old := *queue
-	x := old[0]
-	*queue = old[1:]
-	return x
-}
-
-func (queue *UniqueSourceFolderQueue) Empty() bool {
-	return queue.Len() == 0
-}

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

@@ -47,7 +47,6 @@ type Context struct {
 	SketchObjectFiles    []string
 
 	CollectedSourceFiles   *UniqueStringQueue
-	FoldersWithSourceFiles *UniqueSourceFolderQueue
 
 	Sketch          *Sketch
 	Source          string

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

@@ -38,12 +38,3 @@ func sliceContains(slice []string, target string) bool {
 	}
 	return false
 }
-
-func sliceContainsSourceFolder(slice []SourceFolder, target SourceFolder) bool {
-	for _, elem := range slice {
-		if elem.Folder == target.Folder {
-			return true
-		}
-	}
-	return false
-}