Refactor path generation for ctags_target_for_gcc_minus_e.cpp

Previously, the relative filename passed to GCCPreprocRunner() was made
absolute by prepareGCCPreprocRecipeProperties() and then returned, so it
could be used later on. There was an exception to this when /dev/null
was passed.

Now, the only place that passed something other than /dev/null simply
does this processing up front instead. This prepares the way for
removing Context::FileToRead in the next commit.

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

Author: matthijskooijman

container_add_prototypes.go

@@ -35,15 +35,23 @@ import (
 	"github.com/arduino/arduino-builder/constants"
 	"github.com/arduino/arduino-builder/i18n"
 	"github.com/arduino/arduino-builder/types"
+	"github.com/arduino/arduino-builder/utils"
 )
 
 type ContainerAddPrototypes struct{}
 
 func (s *ContainerAddPrototypes) Run(ctx *types.Context) error {
 	sourceFile := filepath.Join(ctx.SketchBuildPath, filepath.Base(ctx.Sketch.MainFile.Name)+".cpp")
 
+	// Generate the full pathname for the preproc output file
+	err := utils.EnsureFolderExists(ctx.PreprocPath)
+	if err != nil {
+		return i18n.WrapError(err)
+	}
+	targetFilePath := filepath.Join(ctx.PreprocPath, constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E)
+
 	// Run preprocessor
-	err := GCCPreprocRunner(ctx, sourceFile, constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E, ctx.IncludeFolders)
+	err = GCCPreprocRunner(ctx, sourceFile, targetFilePath, ctx.IncludeFolders)
 	if err != nil {
 		return i18n.WrapError(err)
 	}

gcc_preproc_runner.go

@@ -30,7 +30,6 @@
 package builder
 
 import (
-	"path/filepath"
 	"strings"
 
 	"github.com/arduino/arduino-builder/builder_utils"
@@ -42,7 +41,7 @@ import (
 )
 
 func GCCPreprocRunner(ctx *types.Context, sourceFilePath string, targetFilePath string, includes []string) error {
-	properties, targetFilePath, err := prepareGCCPreprocRecipeProperties(ctx, sourceFilePath, targetFilePath, includes)
+	properties, err := prepareGCCPreprocRecipeProperties(ctx, sourceFilePath, targetFilePath, includes)
 	if err != nil {
 		return i18n.WrapError(err)
 	}
@@ -65,7 +64,7 @@ func GCCPreprocRunner(ctx *types.Context, sourceFilePath string, targetFilePath
 }
 
 func GCCPreprocRunnerForDiscoveringIncludes(ctx *types.Context, sourceFilePath string, targetFilePath string, includes []string) (string, error) {
-	properties, _, err := prepareGCCPreprocRecipeProperties(ctx, sourceFilePath, targetFilePath, includes)
+	properties, err := prepareGCCPreprocRecipeProperties(ctx, sourceFilePath, targetFilePath, includes)
 	if err != nil {
 		return "", i18n.WrapError(err)
 	}
@@ -86,16 +85,7 @@ func GCCPreprocRunnerForDiscoveringIncludes(ctx *types.Context, sourceFilePath s
 	return string(stderr), nil
 }
 
-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)
-		if err != nil {
-			return nil, "", i18n.WrapError(err)
-		}
-		targetFilePath = filepath.Join(preprocPath, targetFilePath)
-	}
-
+func prepareGCCPreprocRecipeProperties(ctx *types.Context, sourceFilePath string, targetFilePath string, includes []string) (properties.Map, error) {
 	properties := ctx.BuildProperties.Clone()
 	properties[constants.BUILD_PROPERTIES_SOURCE_FILE] = sourceFilePath
 	properties[constants.BUILD_PROPERTIES_PREPROCESSED_FILE_PATH] = targetFilePath
@@ -104,7 +94,7 @@ func prepareGCCPreprocRecipeProperties(ctx *types.Context, sourceFilePath string
 	properties[constants.BUILD_PROPERTIES_INCLUDES] = strings.Join(includes, constants.SPACE)
 	builder_utils.RemoveHyphenMDDFlagFromGCCCommandLine(properties)
 
-	return properties, targetFilePath, nil
+	return properties, nil
 }
 
 func GeneratePreprocPatternFromCompile(compilePattern string) string {