Structure sourceFile is now copied instead of passed-by-pointer

Author: cmaglie

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

@@ -30,7 +30,7 @@ type detectorCache struct {
 
 type detectorCacheEntry struct {
 	AddedIncludePath *paths.Path  `json:"added_include_path,omitempty"`
-	Compile          *sourceFile  `json:"compile,omitempty"`
+	Compile          sourceFile   `json:"compile,omitempty"`
 	CompileTask      *runner.Task `json:"compile_task,omitempty"`
 	MissingIncludeH  *string      `json:"missing_include_h,omitempty"`
 }
@@ -39,7 +39,7 @@ func (e *detectorCacheEntry) String() string {
 	if e.AddedIncludePath != nil {
 		return "Added include path: " + e.AddedIncludePath.String()
 	}
-	if e.Compile != nil && e.CompileTask != nil {
+	if e.CompileTask != nil {
 		return "Compiling: " + e.Compile.String() + " / " + e.CompileTask.String()
 	}
 	if e.MissingIncludeH != nil {

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

@@ -272,7 +272,7 @@ func (l *SketchLibrariesDetector) findIncludes(
 	// Pre-run cache entries
 	l.preRunner = runner.New(ctx, jobs)
 	for _, entry := range l.cache.EntriesAhead() {
-		if entry.Compile != nil && entry.CompileTask != nil {
+		if entry.CompileTask != nil {
 			upToDate, _ := entry.Compile.ObjFileIsUpToDate()
 			if !upToDate {
 				_ = entry.Compile.PrepareBuildPath()
@@ -351,7 +351,7 @@ func (l *SketchLibrariesDetector) findIncludes(
 	return nil
 }
 
-func (l *SketchLibrariesDetector) gccPreprocessTask(sourceFile *sourceFile, buildProperties *properties.Map) *runner.Task {
+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
@@ -517,7 +517,7 @@ func (l *SketchLibrariesDetector) queueSourceFilesFromFolder(
 
 // makeSourceFile create a sourceFile object for the given source file path.
 // The given sourceFilePath can be absolute, or relative within the sourceRoot root folder.
-func (l *SketchLibrariesDetector) makeSourceFile(sourceRoot, buildRoot, sourceFilePath *paths.Path, extraIncludePaths ...*paths.Path) (*sourceFile, error) {
+func (l *SketchLibrariesDetector) makeSourceFile(sourceRoot, buildRoot, sourceFilePath *paths.Path, extraIncludePaths ...*paths.Path) (sourceFile, error) {
 	if len(extraIncludePaths) > 1 {
 		panic("only one extra include path allowed")
 	}
@@ -530,15 +530,14 @@ func (l *SketchLibrariesDetector) makeSourceFile(sourceRoot, buildRoot, sourceFi
 		var err error
 		sourceFilePath, err = sourceRoot.RelTo(sourceFilePath)
 		if err != nil {
-			return nil, err
+			return sourceFile{}, err
 		}
 	}
-	res := &sourceFile{
+	return sourceFile{
 		SourcePath:       sourceRoot.JoinPath(sourceFilePath),
 		DepfilePath:      buildRoot.Join(fmt.Sprintf("%s.libsdetect.d", sourceFilePath)),
 		ExtraIncludePath: extraIncludePath,
-	}
-	return res, nil
+	}, nil
 }
 
 func (l *SketchLibrariesDetector) failIfImportedLibraryIsWrong() error {

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

@@ -46,7 +46,7 @@ func (f *sourceFile) String() string {
 }
 
 // Equals checks if a sourceFile is equal to another.
-func (f *sourceFile) Equals(g *sourceFile) bool {
+func (f *sourceFile) Equals(g sourceFile) bool {
 	return f.SourcePath.EqualsTo(g.SourcePath) &&
 		f.DepfilePath.EqualsTo(g.DepfilePath) &&
 		((f.ExtraIncludePath == nil && g.ExtraIncludePath == nil) ||
@@ -120,22 +120,22 @@ func (f *sourceFile) ObjFileIsUpToDate() (unchanged bool, err error) {
 }
 
 // uniqueSourceFileQueue is a queue of source files that does not allow duplicates.
-type uniqueSourceFileQueue []*sourceFile
+type uniqueSourceFileQueue []sourceFile
 
 // Push adds a source file to the queue if it is not already present.
-func (queue *uniqueSourceFileQueue) Push(value *sourceFile) {
+func (queue *uniqueSourceFileQueue) Push(value sourceFile) {
 	if !queue.Contains(value) {
 		*queue = append(*queue, value)
 	}
 }
 
 // Contains checks if the queue Contains a source file.
-func (queue uniqueSourceFileQueue) Contains(target *sourceFile) bool {
+func (queue uniqueSourceFileQueue) Contains(target sourceFile) bool {
 	return slices.ContainsFunc(queue, target.Equals)
 }
 
 // Pop removes and returns the first element of the queue.
-func (queue *uniqueSourceFileQueue) Pop() *sourceFile {
+func (queue *uniqueSourceFileQueue) Pop() sourceFile {
 	old := *queue
 	x := old[0]
 	*queue = old[1:]