remove CompilationDatabase from Context

arduino · Sep 12, 2023 · 0c19451 · 0c19451
1 parent fdd9ec6
commit 0c19451
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 56 deletions.
diff --git a/arduino/builder/builder.go b/arduino/builder/builder.go
@@ -19,6 +19,7 @@ import (
 	"errors"
 	"fmt"
 
+	"github.com/arduino/arduino-cli/arduino/builder/compilation"
 	"github.com/arduino/arduino-cli/arduino/builder/logger"
 	"github.com/arduino/arduino-cli/arduino/builder/progress"
 	"github.com/arduino/arduino-cli/arduino/cores"
@@ -59,6 +60,8 @@ type Builder struct {
 
 	// Set to true to skip build and produce only Compilation Database
 	onlyUpdateCompilationDatabase bool
+	// Compilation Database to build/update
+	compilationDatabase *compilation.Database
 
 	// Progress of all various steps
 	Progress *progress.Struct
@@ -152,6 +155,7 @@ func NewBuilder(
 		clean:                         clean,
 		sourceOverrides:               sourceOverrides,
 		onlyUpdateCompilationDatabase: onlyUpdateCompilationDatabase,
+		compilationDatabase:           compilation.NewDatabase(sketchBuildPath.Join("compile_commands.json")),
 		Progress:                      progressStats,
 		BuildOptionsManager: NewBuildOptionsManager(
 			hardwareDirs, builtInToolsDirs, otherLibrariesDirs,
@@ -192,3 +196,10 @@ func (b *Builder) GetLibrariesBuildPath() *paths.Path {
 func (b *Builder) ExecutableSectionsSize() ExecutablesFileSections {
 	return b.executableSectionsSize
 }
+
+// SaveCompilationDatabase fixdoc
+func (b *Builder) SaveCompilationDatabase() {
+	if b.compilationDatabase != nil {
+		b.compilationDatabase.SaveToFile()
+	}
+}
diff --git a/arduino/builder/core.go b/arduino/builder/core.go
@@ -22,7 +22,6 @@ import (
 	"os"
 	"strings"
 
-	"github.com/arduino/arduino-cli/arduino/builder/compilation"
 	"github.com/arduino/arduino-cli/arduino/builder/cpp"
 	"github.com/arduino/arduino-cli/arduino/builder/utils"
 	"github.com/arduino/arduino-cli/arduino/cores"
@@ -33,10 +32,7 @@ import (
 )
 
 // BuildCore fixdoc
-func (b *Builder) BuildCore(
-	actualPlatform *cores.PlatformRelease,
-	compilationDatabase *compilation.Database,
-) (paths.PathList, *paths.Path, error) {
+func (b *Builder) BuildCore(actualPlatform *cores.PlatformRelease) (paths.PathList, *paths.Path, error) {
 	if err := b.coreBuildPath.MkdirAll(); err != nil {
 		return nil, nil, errors.WithStack(err)
 	}
@@ -53,18 +49,15 @@ func (b *Builder) BuildCore(
 		}
 	}
 
-	archiveFile, objectFiles, err := b.compileCore(actualPlatform, compilationDatabase)
+	archiveFile, objectFiles, err := b.compileCore(actualPlatform)
 	if err != nil {
 		return nil, nil, errors.WithStack(err)
 	}
 
 	return objectFiles, archiveFile, nil
 }
 
-func (b *Builder) compileCore(
-	actualPlatform *cores.PlatformRelease,
-	compilationDatabase *compilation.Database,
-) (*paths.Path, paths.PathList, error) {
+func (b *Builder) compileCore(actualPlatform *cores.PlatformRelease) (*paths.Path, paths.PathList, error) {
 	coreFolder := b.buildProperties.GetPath("build.core.path")
 	variantFolder := b.buildProperties.GetPath("build.variant.path")
 	targetCoreFolder := b.buildProperties.GetPath("runtime.platform.path")
@@ -81,7 +74,7 @@ func (b *Builder) compileCore(
 		variantObjectFiles, err = utils.CompileFilesRecursive(
 			variantFolder, b.coreBuildPath, b.buildProperties, includes,
 			b.onlyUpdateCompilationDatabase,
-			compilationDatabase,
+			b.compilationDatabase,
 			b.jobs,
 			b.logger,
 			b.Progress,
@@ -132,7 +125,7 @@ func (b *Builder) compileCore(
 	coreObjectFiles, err := utils.CompileFilesRecursive(
 		coreFolder, b.coreBuildPath, b.buildProperties, includes,
 		b.onlyUpdateCompilationDatabase,
-		compilationDatabase,
+		b.compilationDatabase,
 		b.jobs,
 		b.logger,
 		b.Progress,

diff --git a/arduino/builder/libraries.go b/arduino/builder/libraries.go
@@ -19,7 +19,6 @@ import (
 	"strings"
 	"time"
 
-	"github.com/arduino/arduino-cli/arduino/builder/compilation"
 	"github.com/arduino/arduino-cli/arduino/builder/cpp"
 	"github.com/arduino/arduino-cli/arduino/builder/utils"
 	"github.com/arduino/arduino-cli/arduino/cores"
@@ -38,19 +37,15 @@ var (
 )
 
 // BuildLibraries fixdoc
-func (b *Builder) BuildLibraries(
-	includesFolders paths.PathList,
-	importedLibraries libraries.List,
-	compilationDatabase *compilation.Database,
-) (paths.PathList, error) {
+func (b *Builder) BuildLibraries(includesFolders paths.PathList, importedLibraries libraries.List) (paths.PathList, error) {
 	includes := f.Map(includesFolders.AsStrings(), cpp.WrapWithHyphenI)
 	libs := importedLibraries
 
 	if err := b.librariesBuildPath.MkdirAll(); err != nil {
 		return nil, errors.WithStack(err)
 	}
 
-	librariesObjectFiles, err := b.compileLibraries(libs, includes, compilationDatabase)
+	librariesObjectFiles, err := b.compileLibraries(libs, includes)
 	if err != nil {
 		return nil, errors.WithStack(err)
 	}
@@ -117,16 +112,13 @@ func (b *Builder) findExpectedPrecompiledLibFolder(
 	return nil
 }
 
-func (b *Builder) compileLibraries(libraries libraries.List, includes []string, compilationDatabase *compilation.Database) (paths.PathList, error) {
+func (b *Builder) compileLibraries(libraries libraries.List, includes []string) (paths.PathList, error) {
 	b.Progress.AddSubSteps(len(libraries))
 	defer b.Progress.RemoveSubSteps()
 
 	objectFiles := paths.NewPathList()
 	for _, library := range libraries {
-		libraryObjectFiles, err := b.compileLibrary(
-			library, includes,
-			compilationDatabase,
-		)
+		libraryObjectFiles, err := b.compileLibrary(library, includes)
 		if err != nil {
 			return nil, errors.WithStack(err)
 		}
@@ -139,10 +131,7 @@ func (b *Builder) compileLibraries(libraries libraries.List, includes []string,
 	return objectFiles, nil
 }
 
-func (b *Builder) compileLibrary(
-	library *libraries.Library, includes []string,
-	compilationDatabase *compilation.Database,
-) (paths.PathList, error) {
+func (b *Builder) compileLibrary(library *libraries.Library, includes []string) (paths.PathList, error) {
 	if b.logger.Verbose() {
 		b.logger.Info(tr(`Compiling library "%[1]s"`, library.Name))
 	}
@@ -205,7 +194,7 @@ func (b *Builder) compileLibrary(
 		libObjectFiles, err := utils.CompileFilesRecursive(
 			library.SourceDir, libraryBuildPath, b.buildProperties, includes,
 			b.onlyUpdateCompilationDatabase,
-			compilationDatabase,
+			b.compilationDatabase,
 			b.jobs,
 			b.logger,
 			b.Progress,
@@ -236,7 +225,7 @@ func (b *Builder) compileLibrary(
 		libObjectFiles, err := utils.CompileFiles(
 			library.SourceDir, libraryBuildPath, b.buildProperties, includes,
 			b.onlyUpdateCompilationDatabase,
-			compilationDatabase,
+			b.compilationDatabase,
 			b.jobs,
 			b.logger,
 			b.Progress,
@@ -251,7 +240,7 @@ func (b *Builder) compileLibrary(
 			utilityObjectFiles, err := utils.CompileFiles(
 				library.UtilityDir, utilityBuildPath, b.buildProperties, includes,
 				b.onlyUpdateCompilationDatabase,
-				compilationDatabase,
+				b.compilationDatabase,
 				b.jobs,
 				b.logger,
 				b.Progress,

diff --git a/arduino/builder/sketch.go b/arduino/builder/sketch.go
@@ -23,7 +23,6 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/arduino/arduino-cli/arduino/builder/compilation"
 	"github.com/arduino/arduino-cli/arduino/builder/cpp"
 	"github.com/arduino/arduino-cli/arduino/builder/utils"
 	"github.com/arduino/arduino-cli/arduino/sketch"
@@ -180,10 +179,7 @@ func writeIfDifferent(source []byte, destPath *paths.Path) error {
 }
 
 // BuildSketch fixdoc
-func (b *Builder) BuildSketch(
-	includesFolders paths.PathList,
-	compilationDatabase *compilation.Database,
-) (paths.PathList, error) {
+func (b *Builder) BuildSketch(includesFolders paths.PathList) (paths.PathList, error) {
 	includes := f.Map(includesFolders.AsStrings(), cpp.WrapWithHyphenI)
 
 	if err := b.sketchBuildPath.MkdirAll(); err != nil {
@@ -193,7 +189,7 @@ func (b *Builder) BuildSketch(
 	sketchObjectFiles, err := utils.CompileFiles(
 		b.sketchBuildPath, b.sketchBuildPath, b.buildProperties, includes,
 		b.onlyUpdateCompilationDatabase,
-		compilationDatabase,
+		b.compilationDatabase,
 		b.jobs,
 		b.builderLogger,
 		b.Progress,
@@ -208,7 +204,7 @@ func (b *Builder) BuildSketch(
 		srcObjectFiles, err := utils.CompileFilesRecursive(
 			sketchSrcPath, sketchSrcPath, b.buildProperties, includes,
 			b.onlyUpdateCompilationDatabase,
-			compilationDatabase,
+			b.compilationDatabase,
 			b.jobs,
 			b.builderLogger,
 			b.Progress,

diff --git a/commands/compile/compile.go b/commands/compile/compile.go
@@ -25,7 +25,6 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino"
 	bldr "github.com/arduino/arduino-cli/arduino/builder"
-	"github.com/arduino/arduino-cli/arduino/builder/compilation"
 	"github.com/arduino/arduino-cli/arduino/builder/detector"
 	"github.com/arduino/arduino-cli/arduino/builder/logger"
 	"github.com/arduino/arduino-cli/arduino/builder/progress"
@@ -223,10 +222,6 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 	}
 	builderCtx.Builder = sketchBuilder
 
-	builderCtx.CompilationDatabase = compilation.NewDatabase(
-		sketchBuilder.GetBuildPath().Join("compile_commands.json"),
-	)
-
 	var libsManager *librariesmanager.LibrariesManager
 	if pme.GetProfile() != nil {
 		libsManager = lm

diff --git a/legacy/builder/builder.go b/legacy/builder/builder.go
@@ -64,10 +64,7 @@ func (s *Builder) Run(ctx *types.Context) error {
 		}),
 
 		types.BareCommand(func(ctx *types.Context) error {
-			sketchObjectFiles, err := ctx.Builder.BuildSketch(
-				ctx.SketchLibrariesDetector.IncludeFolders(),
-				ctx.CompilationDatabase,
-			)
+			sketchObjectFiles, err := ctx.Builder.BuildSketch(ctx.SketchLibrariesDetector.IncludeFolders())
 			if err != nil {
 				return err
 			}
@@ -94,7 +91,6 @@ func (s *Builder) Run(ctx *types.Context) error {
 			librariesObjectFiles, err := ctx.Builder.BuildLibraries(
 				ctx.SketchLibrariesDetector.IncludeFolders(),
 				ctx.SketchLibrariesDetector.ImportedLibraries(),
-				ctx.CompilationDatabase,
 			)
 			if err != nil {
 				return err
@@ -113,7 +109,7 @@ func (s *Builder) Run(ctx *types.Context) error {
 		}),
 
 		types.BareCommand(func(ctx *types.Context) error {
-			objectFiles, archiveFile, err := ctx.Builder.BuildCore(ctx.ActualPlatform, ctx.CompilationDatabase)
+			objectFiles, archiveFile, err := ctx.Builder.BuildCore(ctx.ActualPlatform)
 
 			ctx.CoreObjectsFiles = objectFiles
 			ctx.CoreArchiveFilePath = archiveFile
@@ -176,9 +172,7 @@ func (s *Builder) Run(ctx *types.Context) error {
 		ctx.Builder.Progress.PushProgress()
 	}
 
-	if ctx.CompilationDatabase != nil {
-		ctx.CompilationDatabase.SaveToFile()
-	}
+	ctx.Builder.SaveCompilationDatabase()
 
 	var otherErr error
 	commands = []types.Command{

diff --git a/legacy/builder/types/context.go b/legacy/builder/types/context.go
@@ -17,7 +17,6 @@ package types
 
 import (
 	"github.com/arduino/arduino-cli/arduino/builder"
-	"github.com/arduino/arduino-cli/arduino/builder/compilation"
 	"github.com/arduino/arduino-cli/arduino/builder/detector"
 	"github.com/arduino/arduino-cli/arduino/builder/logger"
 	"github.com/arduino/arduino-cli/arduino/cores"
@@ -48,7 +47,4 @@ type Context struct {
 
 	// C++ Parsing
 	LineOffset int
-
-	// Compilation Database to build/update
-	CompilationDatabase *compilation.Database
 }