Put utility folders in the include path during include detection

When compiling source files from a library, the utility folder of the
library itself is in the include path. When doing include detection,
this did not happen, which could lead to compilation errors. Because of
the broken (but recently fixed) errorhandling in include detection, this
error was not visible to the user. It would only have a visible effect
if a library included another library *after* including a file from its
utility folder through the include path, and that other library was not
otherwise pulled in.

In practice, this would almost never occur, but with the new caching the
cache would be invalidated and this problem became visible.

This is fixed by simply including the utility folder in the include path
during include detection. This required explicitly passing the include
path through the GCCPreprocRunnerForDiscoveringIncludes and
GCCPreprocRunner.

Signed-off-by: Matthijs Kooijman <[email protected]>

Author: matthijskooijman

src/arduino.cc/builder/container_add_prototypes.go

@@ -43,7 +43,7 @@ type ContainerAddPrototypes struct{}
 func (s *ContainerAddPrototypes) Run(ctx *types.Context) error {
 	sourceFile := filepath.Join(ctx.SketchBuildPath, filepath.Base(ctx.Sketch.MainFile.Name)+".cpp")
 	commands := []types.Command{
-		&GCCPreprocRunner{SourceFilePath: sourceFile, TargetFileName: constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E},
+		&GCCPreprocRunner{SourceFilePath: sourceFile, TargetFileName: constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E, Includes: ctx.IncludeFolders},
 		&ReadFileAndStoreInContext{Target: &ctx.SourceGccMinusE},
 		&FilterSketchSource{Source: &ctx.SourceGccMinusE},
 		&CTagsTargetFileSaver{Source: &ctx.SourceGccMinusE, TargetFileName: constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E},

src/arduino.cc/builder/container_find_includes.go

@@ -312,14 +312,19 @@ func findIncludesUntilDone(ctx *types.Context, cache *includeCache, sourceFile t
 	for {
 		var include string
 		cache.ExpectFile(sourcePath)
+
+		includes := ctx.IncludeFolders
+		if library, ok := sourceFile.Origin.(*types.Library); ok && library.UtilityFolder != "" {
+			includes = append(includes, library.UtilityFolder)
+		}
 		if unchanged && cache.valid {
 			include = cache.Next().Include
 			if first && ctx.Verbose {
 				ctx.GetLogger().Println(constants.LOG_LEVEL_INFO, constants.MSG_USING_CACHED_INCLUDES, sourcePath)
 			}
 		} else {
 			commands := []types.Command{
-				&GCCPreprocRunnerForDiscoveringIncludes{SourceFilePath: sourcePath, TargetFilePath: targetFilePath},
+				&GCCPreprocRunnerForDiscoveringIncludes{SourceFilePath: sourcePath, TargetFilePath: targetFilePath, Includes: includes},
 				&IncludesFinderWithRegExp{Source: &ctx.SourceGccMinusE},
 			}
 			for _, command := range commands {
@@ -340,7 +345,7 @@ func findIncludesUntilDone(ctx *types.Context, cache *includeCache, sourceFile t
 		library := ResolveLibrary(ctx, include)
 		if library == nil {
 			// Library could not be resolved, show error
-			err := runCommand(ctx, &GCCPreprocRunner{SourceFilePath: sourcePath, TargetFileName: constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E})
+			err := runCommand(ctx, &GCCPreprocRunner{SourceFilePath: sourcePath, TargetFileName: constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E, Includes: includes})
 			return i18n.WrapError(err)
 		}
 

src/arduino.cc/builder/gcc_preproc_runner.go

@@ -44,10 +44,11 @@ import (
 type GCCPreprocRunner struct {
 	SourceFilePath string
 	TargetFileName string
+	Includes []string
 }
 
 func (s *GCCPreprocRunner) Run(ctx *types.Context) error {
-	properties, targetFilePath, err := prepareGCCPreprocRecipeProperties(ctx, s.SourceFilePath, s.TargetFileName)
+	properties, targetFilePath, err := prepareGCCPreprocRecipeProperties(ctx, s.SourceFilePath, s.TargetFileName, s.Includes)
 	if err != nil {
 		return i18n.WrapError(err)
 	}
@@ -72,10 +73,11 @@ func (s *GCCPreprocRunner) Run(ctx *types.Context) error {
 type GCCPreprocRunnerForDiscoveringIncludes struct {
 	SourceFilePath string
 	TargetFilePath string
+	Includes []string
 }
 
 func (s *GCCPreprocRunnerForDiscoveringIncludes) Run(ctx *types.Context) error {
-	properties, _, err := prepareGCCPreprocRecipeProperties(ctx, s.SourceFilePath, s.TargetFilePath)
+	properties, _, err := prepareGCCPreprocRecipeProperties(ctx, s.SourceFilePath, s.TargetFilePath, s.Includes)
 	if err != nil {
 		return i18n.WrapError(err)
 	}
@@ -98,7 +100,7 @@ func (s *GCCPreprocRunnerForDiscoveringIncludes) Run(ctx *types.Context) error {
 	return nil
 }
 
-func prepareGCCPreprocRecipeProperties(ctx *types.Context, sourceFilePath string, targetFilePath string) (properties.Map, string, error) {
+func prepareGCCPreprocRecipeProperties(ctx *types.Context, sourceFilePath string, targetFilePath string, includes []string) (properties.Map, string, error) {
 	if targetFilePath != utils.NULLFile() {
 		preprocPath := ctx.PreprocPath
 		err := utils.EnsureFolderExists(preprocPath)
@@ -112,7 +114,6 @@ func prepareGCCPreprocRecipeProperties(ctx *types.Context, sourceFilePath string
 	properties[constants.BUILD_PROPERTIES_SOURCE_FILE] = sourceFilePath
 	properties[constants.BUILD_PROPERTIES_PREPROCESSED_FILE_PATH] = targetFilePath
 
-	includes := ctx.IncludeFolders
 	includes = utils.Map(includes, utils.WrapWithHyphenI)
 	properties[constants.BUILD_PROPERTIES_INCLUDES] = strings.Join(includes, constants.SPACE)
 	builder_utils.RemoveHyphenMDDFlagFromGCCCommandLine(properties)