Let IncludesFinderWithRegExp return at most 1 include

Originally, this code was written to find all include statements in a
source file, for further processing. However, since a while the
include finding was changed to run the preprocessor to see if any
includes are missing, and this class is used to find the missing
includes in the error message.

In practice, the preprocessor will bail out at the first missing
include, since there is no meaningful way for it to continue. This means
there will be at most one include in the error output. If there
would be multiple includes (either because the preprocessor decided to
continue, or there is some other output that accidentially matches the
regex), it would be harmful to actually process all of them, since the
absence of the first include might influence the presence of the second
(e.g. in the presence of #ifdefs).

This commit enforces that only one include is returned at a time,
slightly simplifying the code in the process. The filename and class
should be renamed to singular as well, but this will be left for a
future commit to reduce noise.

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

Author: matthijskooijman

src/arduino.cc/builder/container_find_includes.go

@@ -120,14 +120,13 @@ func findIncludesUntilDone(ctx *types.Context, sourceFilePath string) error {
 				return i18n.WrapError(err)
 			}
 		}
-		if len(ctx.IncludesJustFound) == 0 {
+		if ctx.IncludeJustFound == "" {
 			done = true
 		} else if len(ctx.ImportedLibraries) == len(importedLibraries) {
 			err := runCommand(ctx, &GCCPreprocRunner{TargetFileName: constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E})
 			return i18n.WrapError(err)
 		}
 		importedLibraries = ctx.ImportedLibraries
-		ctx.IncludesJustFound = []string{}
 	}
 	return nil
 }

src/arduino.cc/builder/includes_finder_with_regexp.go

@@ -45,24 +45,21 @@ type IncludesFinderWithRegExp struct {
 func (s *IncludesFinderWithRegExp) Run(ctx *types.Context) error {
 	source := *s.Source
 
-	matches := INCLUDE_REGEXP.FindAllStringSubmatch(source, -1)
-	includes := []string{}
-	for _, match := range matches {
-		includes = append(includes, strings.TrimSpace(match[1]))
+	match := INCLUDE_REGEXP.FindStringSubmatch(source)
+	if match != nil {
+		ctx.IncludeJustFound = strings.TrimSpace(match[1])
+	} else {
+		ctx.IncludeJustFound = findIncludeForOldCompilers(source)
 	}
-	if len(includes) == 0 {
-		include := findIncludesForOldCompilers(source)
-		if include != "" {
-			includes = append(includes, include)
-		}
+
+	if ctx.IncludeJustFound != "" {
+		ctx.Includes = utils.AppendIfNotPresent(ctx.Includes, ctx.IncludeJustFound)
 	}
 
-	ctx.IncludesJustFound = includes
-	ctx.Includes = utils.AppendIfNotPresent(ctx.Includes, includes...)
 	return nil
 }
 
-func findIncludesForOldCompilers(source string) string {
+func findIncludeForOldCompilers(source string) string {
 	lines := strings.Split(source, "\n")
 	for _, line := range lines {
 		splittedLine := strings.Split(line, ":")

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

@@ -61,7 +61,7 @@ type Context struct {
 	HeaderToLibraries          map[string][]*Library
 	ImportedLibraries          []*Library
 	LibrariesResolutionResults map[string]LibraryResolutionResult
-	IncludesJustFound          []string
+	IncludeJustFound           string
 	IncludeFolders             []string
 	OutputGccMinusM            string