Automatically include libraries in profile without discovery.

Author: cmaglie

commands/instances.go

@@ -381,7 +381,7 @@ func (s *arduinoCoreServerImpl) Init(req *rpc.InitRequest, stream rpc.ArduinoCor
 				}
 				lmb.AddLibrariesDir(librariesmanager.LibrariesDir{
 					Path:            libDir,
-					Location:        libraries.Unmanaged,
+					Location:        libraries.User,
 					IsSingleLibrary: true,
 				})
 				continue

commands/service_compile.go

@@ -100,10 +100,11 @@ func (s *arduinoCoreServerImpl) Compile(req *rpc.CompileRequest, stream rpc.Ardu
 		return &cmderrors.CantOpenSketchError{Cause: err}
 	}
 
+	profile := pme.GetProfile()
 	fqbnIn := req.GetFqbn()
 	if fqbnIn == "" && sk != nil {
-		if pme.GetProfile() != nil {
-			fqbnIn = pme.GetProfile().FQBN
+		if profile != nil {
+			fqbnIn = profile.FQBN
 		} else {
 			fqbnIn = sk.GetDefaultFQBN()
 		}
@@ -217,7 +218,7 @@ func (s *arduinoCoreServerImpl) Compile(req *rpc.CompileRequest, stream rpc.Ardu
 	var libsManager *librariesmanager.LibrariesManager
 	if lm, err := instances.GetLibraryManager(req.GetInstance()); err != nil {
 		return err
-	} else if pme.GetProfile() != nil {
+	} else if profile != nil {
 		libsManager = lm
 	}
 
@@ -250,6 +251,7 @@ func (s *arduinoCoreServerImpl) Compile(req *rpc.CompileRequest, stream rpc.Ardu
 	librariesDirs.Add(s.settings.LibrariesDir())
 	libraryDirs := paths.NewPathList(req.GetLibrary()...) // Array of single-library directories
 
+	alwaysBuildProfileLibs := profile != nil
 	sketchBuilder, err := builder.NewBuilder(
 		ctx,
 		sk,
@@ -273,6 +275,7 @@ func (s *arduinoCoreServerImpl) Compile(req *rpc.CompileRequest, stream rpc.Ardu
 		libraryDirs,
 		outStream, errStream, verbosity, req.GetWarnings(),
 		progressCB,
+		alwaysBuildProfileLibs,
 		pme.GetEnvVarsForSpawnedProcess(),
 	)
 	if err != nil {

internal/arduino/builder/builder.go

@@ -136,6 +136,7 @@ func NewBuilder(
 	customLibraryDirs paths.PathList,
 	stdout, stderr io.Writer, verbosity logger.Verbosity, warningsLevel string,
 	progressCB rpc.TaskProgressCB,
+	alwaysBuildProfileLibs bool,
 	toolEnv []string,
 ) (*Builder, error) {
 	buildProperties := properties.NewMap()
@@ -185,7 +186,7 @@ func NewBuilder(
 	}
 
 	log := logger.New(stdout, stderr, verbosity, warningsLevel)
-	libsResolver, libsLoadingWarnings, err := detector.LibrariesLoader(
+	libsManager, libsResolver, libsLoadingWarnings, err := detector.LibrariesLoader(
 		useCachedLibrariesResolution,
 		librariesManager,
 		builtInLibrariesDirs,
@@ -239,9 +240,10 @@ func NewBuilder(
 		),
 		diagnosticStore: diagnosticStore,
 		libsDetector: detector.NewSketchLibrariesDetector(
-			libsResolver,
+			libsManager, libsResolver,
 			useCachedLibrariesResolution,
 			onlyUpdateCompilationDatabase,
+			alwaysBuildProfileLibs,
 			log,
 			diagnosticStore,
 		),

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

@@ -50,10 +50,12 @@ type libraryResolutionResult struct {
 
 // SketchLibrariesDetector todo
 type SketchLibrariesDetector struct {
+	librariesManager              *librariesmanager.LibrariesManager
 	librariesResolver             *librariesresolver.Cpp
 	useCachedLibrariesResolution  bool
 	cache                         *detectorCache
 	onlyUpdateCompilationDatabase bool
+	alwaysBuildProfileLibs        bool
 	importedLibraries             libraries.List
 	librariesResolutionResults    map[string]libraryResolutionResult
 	includeFolders                paths.PathList
@@ -65,20 +67,24 @@ type SketchLibrariesDetector struct {
 
 // NewSketchLibrariesDetector todo
 func NewSketchLibrariesDetector(
+	lm *librariesmanager.LibrariesManager,
 	libsResolver *librariesresolver.Cpp,
 	useCachedLibrariesResolution bool,
 	onlyUpdateCompilationDatabase bool,
+	alwaysBuildProfileLibs bool,
 	logger *logger.BuilderLogger,
 	diagnosticStore *diagnostics.Store,
 ) *SketchLibrariesDetector {
 	return &SketchLibrariesDetector{
+		librariesManager:              lm,
 		librariesResolver:             libsResolver,
 		useCachedLibrariesResolution:  useCachedLibrariesResolution,
 		cache:                         newDetectorCache(),
 		librariesResolutionResults:    map[string]libraryResolutionResult{},
 		importedLibraries:             libraries.List{},
 		includeFolders:                paths.PathList{},
 		onlyUpdateCompilationDatabase: onlyUpdateCompilationDatabase,
+		alwaysBuildProfileLibs:        alwaysBuildProfileLibs,
 		logger:                        logger,
 		diagnosticStore:               diagnosticStore,
 	}
@@ -134,10 +140,25 @@ func (l *SketchLibrariesDetector) ImportedLibraries() libraries.List {
 	return l.importedLibraries
 }
 
-// AppendImportedLibraries todo should rename this, probably after refactoring the
-// container_find_includes command.
-func (l *SketchLibrariesDetector) AppendImportedLibraries(library *libraries.Library) {
+// addAndBuildLibrary adds the given library to the imported libraries list and queues its source files
+// for further processing.
+func (l *SketchLibrariesDetector) addAndBuildLibrary(sourceFileQueue *uniqueSourceFileQueue, librariesBuildPath *paths.Path, library *libraries.Library) {
 	l.importedLibraries = append(l.importedLibraries, library)
+	if library.Precompiled && library.PrecompiledWithSources {
+		// Fully precompiled libraries should have no dependencies to avoid ABI breakage
+		if l.logger.VerbosityLevel() == logger.VerbosityVerbose {
+			l.logger.Info(i18n.Tr("Skipping dependencies detection for precompiled library %[1]s", library.Name))
+		}
+	} else {
+		for _, sourceDir := range library.SourceDirs() {
+			l.queueSourceFilesFromFolder(
+				sourceFileQueue,
+				sourceDir.Dir, sourceDir.Recurse,
+				library.SourceDir,
+				librariesBuildPath.Join(library.DirName),
+				library.UtilityDir)
+		}
+	}
 }
 
 // PrintUsedAndNotUsedLibraries todo
@@ -284,6 +305,16 @@ func (l *SketchLibrariesDetector) findIncludes(
 			l.queueSourceFilesFromFolder(sourceFileQueue, srcSubfolderPath, true /* recurse */, sketchBuildPath, sketchBuildPath)
 		}
 
+		if l.alwaysBuildProfileLibs {
+			for _, library := range l.librariesManager.FindAllInstalled() {
+				if library.Location == libraries.User {
+					l.logger.Info(i18n.Tr("The library %[1]s has been automatically added from sketch project.", library.Name))
+					l.addAndBuildLibrary(sourceFileQueue, librariesBuildPath, library)
+					l.addIncludeFolder(library.SourceDir)
+				}
+			}
+		}
+
 		for !sourceFileQueue.Empty() {
 			err := l.findMissingIncludesInCompilationUnit(ctx, sourceFileQueue, buildProperties, librariesBuildPath, platformArch)
 			if err != nil {
@@ -452,7 +483,7 @@ func (l *SketchLibrariesDetector) findMissingIncludesInCompilationUnit(
 		// Add this library to the list of libraries, the
 		// include path and queue its source files for further
 		// include scanning
-		l.AppendImportedLibraries(library)
+		l.addAndBuildLibrary(sourceFileQueue, librariesBuildPath, library)
 		l.addIncludeFolder(library.SourceDir)
 
 		if library.Precompiled && library.PrecompiledWithSources {
@@ -556,7 +587,7 @@ func LibrariesLoader(
 	librariesDirs paths.PathList,
 	buildPlatform *cores.PlatformRelease,
 	targetPlatform *cores.PlatformRelease,
-) (*librariesresolver.Cpp, []byte, error) {
+) (*librariesmanager.LibrariesManager, *librariesresolver.Cpp, []byte, error) {
 	verboseOut := &bytes.Buffer{}
 	lm := librariesManager
 	if useCachedLibrariesResolution {
@@ -569,7 +600,7 @@ func LibrariesLoader(
 
 		if builtInLibrariesDir != nil {
 			if err := builtInLibrariesDir.ToAbs(); err != nil {
-				return nil, nil, err
+				return nil, nil, nil, err
 			}
 			lmb.AddLibrariesDir(librariesmanager.LibrariesDir{
 				Path:     builtInLibrariesDir,
@@ -592,7 +623,7 @@ func LibrariesLoader(
 
 		librariesFolders := librariesDirs
 		if err := librariesFolders.ToAbs(); err != nil {
-			return nil, nil, err
+			return nil, nil, nil, err
 		}
 		for _, folder := range librariesFolders {
 			lmb.AddLibrariesDir(librariesmanager.LibrariesDir{
@@ -618,5 +649,5 @@ func LibrariesLoader(
 
 	allLibs := lm.FindAllInstalled()
 	resolver := librariesresolver.NewCppResolver(allLibs, targetPlatform, buildPlatform)
-	return resolver, verboseOut.Bytes(), nil
+	return lm, resolver, verboseOut.Bytes(), nil
 }