Split composed sketch and preprocessed sketch into different files

Author: cmaglie

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

@@ -289,7 +289,7 @@ func (l *SketchLibrariesDetector) findIncludes(
 	sourceFileQueue := &uniqueSourceFileQueue{}
 
 	if !l.useCachedLibrariesResolution {
-		mergedfile, err := makeSourceFile(sketchBuildPath, sketchBuildPath, paths.New(sketch.MainFile.Base()+".cpp"))
+		mergedfile, err := makeSourceFile(sketchBuildPath, sketchBuildPath, paths.New(sketch.MainFile.Base()+".cpp.merged"))
 		if err != nil {
 			return err
 		}

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

@@ -57,19 +57,17 @@ func PreprocessSketchWithCtags(
 
 	// Check if the preprocessed file is already up-to-date
 	unpreprocessedSourceFile := buildPath.Join("sketch", sketch.MainFile.Base()+".cpp.merged")
-	sourceFile := buildPath.Join("sketch", sketch.MainFile.Base()+".cpp")
+	preprocessedSourceFile := buildPath.Join("sketch", sketch.MainFile.Base()+".cpp")
 	if unpreprocessedStat, err := unpreprocessedSourceFile.Stat(); err != nil {
 		return nil, fmt.Errorf("%s: %w", i18n.Tr("unable to open unpreprocessed source file"), err)
-	} else if sourceStat, err := sourceFile.Stat(); err != nil {
-		return nil, fmt.Errorf("%s: %w", i18n.Tr("unable to open source file"), err)
-	} else if unpreprocessedStat.ModTime().Before(sourceStat.ModTime()) {
+	} else if sourceStat, err := preprocessedSourceFile.Stat(); err == nil && unpreprocessedStat.ModTime().Before(sourceStat.ModTime()) {
 		fmt.Fprintln(stdout, i18n.Tr("Sketch is unchanged, skipping preprocessing."))
 		res := &runner.Result{Stdout: stdout.Bytes(), Stderr: stderr.Bytes()}
 		return res, nil
 	}
 
 	// Run GCC preprocessor
-	result := GCC(sourceFile, ctagsTarget, includes, buildProperties).Run(ctx)
+	result := GCC(unpreprocessedSourceFile, ctagsTarget, includes, buildProperties).Run(ctx)
 	stdout.Write(result.Stdout)
 	stderr.Write(result.Stderr)
 	if err := result.Error; err != nil {
@@ -81,7 +79,7 @@ func PreprocessSketchWithCtags(
 		fmt.Fprintf(stderr, "%s: %s",
 			i18n.Tr("An error occurred adding prototypes"),
 			i18n.Tr("the compilation database may be incomplete or inaccurate"))
-		if err := sourceFile.CopyTo(ctagsTarget); err != nil {
+		if err := unpreprocessedSourceFile.CopyTo(ctagsTarget); err != nil {
 			return &runner.Result{Args: result.Args, Stdout: stdout.Bytes(), Stderr: stderr.Bytes()}, err
 		}
 	}
@@ -114,7 +112,7 @@ func PreprocessSketchWithCtags(
 
 	// Add prototypes to the original sketch source
 	var source string
-	if sourceData, err := sourceFile.ReadFile(); err == nil {
+	if sourceData, err := unpreprocessedSourceFile.ReadFile(); err == nil {
 		source = string(sourceData)
 	} else {
 		return &runner.Result{Args: result.Args, Stdout: stdout.Bytes(), Stderr: stderr.Bytes()}, err
@@ -148,7 +146,7 @@ func PreprocessSketchWithCtags(
 	}
 
 	// Write back arduino-preprocess output to the sourceFile
-	err = sourceFile.WriteFile([]byte(preprocessedSource))
+	err = preprocessedSourceFile.WriteFile([]byte(preprocessedSource))
 	return &runner.Result{Args: result.Args, Stdout: stdout.Bytes(), Stderr: stderr.Bytes()}, err
 }
 

internal/arduino/builder/sketch.go

@@ -62,12 +62,6 @@ func (b *Builder) prepareSketchBuildPath() error {
 		if err := destFileUnpreprocessed.WriteFile([]byte(mergedSource)); err != nil {
 			return err
 		}
-
-		b.logger.Warn(i18n.Tr("Generating sketch files in build path"))
-		destFile := b.sketchBuildPath.Join(b.sketch.MainFile.Base() + ".cpp")
-		if err := destFile.WriteFile([]byte(mergedSource)); err != nil {
-			return err
-		}
 	} else {
 		b.logger.Warn(fmt.Sprintf("%s %s", i18n.Tr("Generating sketch files in build path..."), i18n.Tr("(sketch unchanged)")))
 	}