Use runner.Task in GCC preprocessor

It slightly simplifies code, but also provide the basis for the next
commits.

Author: cmaglie

internal/arduino/builder/internal/detector/detector.go

@@ -284,6 +284,19 @@ func (l *SketchLibrariesDetector) findIncludes(
 	return nil
 }
 
+func (l *SketchLibrariesDetector) gccPreprocessTask(sourceFile *sourceFile, buildProperties *properties.Map) *runner.Task {
+	// Libraries may require the "utility" directory to be added to the include
+	// search path, but only for the source code of the library, so we temporary
+	// copy the current search path list and add the library' utility directory
+	// if needed.
+	includeFolders := l.includeFolders
+	if extraInclude := sourceFile.ExtraIncludePath; extraInclude != nil {
+		includeFolders = append(includeFolders, extraInclude)
+	}
+
+	return preprocessor.GCC(sourceFile.SourcePath, paths.NullPath(), includeFolders, buildProperties)
+}
+
 func (l *SketchLibrariesDetector) findMissingIncludesInCompilationUnit(
 	ctx context.Context,
 	sourceFileQueue *uniqueSourceFileQueue,
@@ -315,15 +328,7 @@ func (l *SketchLibrariesDetector) findMissingIncludesInCompilationUnit(
 	for {
 		l.cache.Expect(&detectorCacheEntry{Compile: sourceFile})
 
-		// Libraries may require the "utility" directory to be added to the include
-		// search path, but only for the source code of the library, so we temporary
-		// copy the current search path list and add the library' utility directory
-		// if needed.
-		includeFolders := l.includeFolders
-		if extraInclude := sourceFile.ExtraIncludePath; extraInclude != nil {
-			includeFolders = append(includeFolders, extraInclude)
-		}
-
+		preprocTask := l.gccPreprocessTask(sourceFile, buildProperties)
 		var preprocErr error
 		var preprocResult *runner.Result
 
@@ -335,7 +340,8 @@ func (l *SketchLibrariesDetector) findMissingIncludesInCompilationUnit(
 			}
 			first = false
 		} else {
-			preprocResult, preprocErr = preprocessor.GCC(ctx, sourcePath, paths.NullPath(), includeFolders, buildProperties)
+			preprocResult = preprocTask.Run(ctx)
+			preprocErr = preprocResult.Error
 			if l.logger.Verbose() {
 				l.logger.WriteStdout(preprocResult.Stdout)
 			}
@@ -368,7 +374,8 @@ func (l *SketchLibrariesDetector) findMissingIncludesInCompilationUnit(
 
 			// If preprocess result came from cache, run the preprocessor to obtain the actual error to show
 			if preprocErr == nil || len(preprocResult.Stderr) == 0 {
-				preprocResult, preprocErr = preprocessor.GCC(ctx, sourcePath, paths.NullPath(), includeFolders, buildProperties)
+				preprocResult = preprocTask.Run(ctx)
+				preprocErr = preprocResult.Error
 				if l.logger.Verbose() {
 					l.logger.WriteStdout(preprocResult.Stdout)
 				}

internal/arduino/builder/internal/preprocessor/arduino_preprocessor.go

@@ -45,11 +45,11 @@ func PreprocessSketchWithArduinoPreprocessor(
 
 	sourceFile := buildPath.Join("sketch", sk.MainFile.Base()+".cpp")
 	targetFile := buildPath.Join("preproc", "sketch_merged.cpp")
-	gccResult, err := GCC(ctx, sourceFile, targetFile, includeFolders, buildProperties)
+	gccResult := GCC(sourceFile, targetFile, includeFolders, buildProperties).Run(ctx)
 	verboseOut.Write(gccResult.Stdout)
 	verboseOut.Write(gccResult.Stderr)
-	if err != nil {
-		return nil, err
+	if gccResult.Error != nil {
+		return nil, gccResult.Error
 	}
 
 	arduinoPreprocessorProperties := properties.NewMap()

internal/arduino/builder/internal/preprocessor/ctags.go

@@ -57,10 +57,10 @@ func PreprocessSketchWithCtags(
 
 	// Run GCC preprocessor
 	sourceFile := buildPath.Join("sketch", sketch.MainFile.Base()+".cpp")
-	result, err := GCC(ctx, sourceFile, ctagsTarget, includes, buildProperties)
+	result := GCC(sourceFile, ctagsTarget, includes, buildProperties).Run(ctx)
 	stdout.Write(result.Stdout)
 	stderr.Write(result.Stderr)
-	if err != nil {
+	if err := result.Error; err != nil {
 		if !onlyUpdateCompilationDatabase {
 			return &runner.Result{Args: result.Args, Stdout: stdout.Bytes(), Stderr: stderr.Bytes()}, err
 		}

internal/arduino/builder/internal/preprocessor/gcc.go

@@ -16,26 +16,21 @@
 package preprocessor
 
 import (
-	"context"
-	"errors"
-	"fmt"
 	"strings"
 
 	f "github.com/arduino/arduino-cli/internal/algorithms"
 	"github.com/arduino/arduino-cli/internal/arduino/builder/cpp"
 	"github.com/arduino/arduino-cli/internal/arduino/builder/internal/runner"
-	"github.com/arduino/arduino-cli/internal/i18n"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
 )
 
 // GCC performs a run of the gcc preprocess (macro/includes expansion). The function outputs the result
 // to targetFilePath. Returns the stdout/stderr of gcc if any.
 func GCC(
-	ctx context.Context,
 	sourceFilePath, targetFilePath *paths.Path,
 	includes paths.PathList, buildProperties *properties.Map,
-) (*runner.Result, error) {
+) *runner.Task {
 	gccBuildProperties := properties.NewMap()
 	gccBuildProperties.Set("preproc.macros.flags", "-w -x c++ -E -CC")
 	gccBuildProperties.Merge(buildProperties)
@@ -59,26 +54,12 @@ func GCC(
 	}
 
 	pattern := gccBuildProperties.Get(gccPreprocRecipeProperty)
-	if pattern == "" {
-		return nil, errors.New(i18n.Tr("%s pattern is missing", gccPreprocRecipeProperty))
-	}
-
 	commandLine := gccBuildProperties.ExpandPropsInString(pattern)
 	commandLine = properties.DeleteUnexpandedPropsFromString(commandLine)
 	args, _ := properties.SplitQuotedString(commandLine, `"'`, false)
 
 	// Remove -MMD argument if present. Leaving it will make gcc try
 	// to create a /dev/null.d dependency file, which won't work.
 	args = f.Filter(args, f.NotEquals("-MMD"))
-
-	proc, err := paths.NewProcess(nil, args...)
-	if err != nil {
-		return nil, err
-	}
-	stdout, stderr, err := proc.RunAndCaptureOutput(ctx)
-
-	// Append gcc arguments to stdout
-	stdout = append([]byte(fmt.Sprintln(strings.Join(args, " "))), stdout...)
-
-	return &runner.Result{Args: proc.GetArgs(), Stdout: stdout, Stderr: stderr}, err
+	return runner.NewTask(args...)
 }