Added 'provides_includes' field in 'lib list' output structures

Author: cmaglie

Diff for: arduino/libraries/libraries.go

@@ -16,6 +16,8 @@
 package libraries
 
 import (
+	"fmt"
+
 	"github.com/arduino/arduino-cli/arduino/cores"
 	paths "github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"
@@ -71,6 +73,7 @@ type Library struct {
 	License                string
 	Properties             *properties.Map
 	Examples               paths.PathList
+	sourceHeaders          []string
 }
 
 func (library *Library) String() string {
@@ -153,3 +156,20 @@ func (library *Library) LocationPriorityFor(platformRelease, refPlatformRelease
 	}
 	return 0
 }
+
+// SourceHeaders returns the C++ headers in the library.
+func (library *Library) SourceHeaders() ([]string, error) {
+	if library.sourceHeaders == nil {
+		cppHeaders, err := library.SourceDir.ReadDir()
+		if err != nil {
+			return nil, fmt.Errorf("reading lib src dir: %s", err)
+		}
+		cppHeaders.FilterSuffix(".h", ".hpp", ".hh")
+		res := []string{}
+		for _, cppHeader := range cppHeaders {
+			res = append(res, cppHeader.Base())
+		}
+		library.sourceHeaders = res
+	}
+	return library.sourceHeaders, nil
+}

Diff for: arduino/libraries/librariesresolver/cpp.go

@@ -52,13 +52,11 @@ func (resolver *Cpp) ScanFromLibrariesManager(lm *librariesmanager.LibrariesMana
 
 // ScanLibrary reads a library to find and cache C++ headers for later retrieval
 func (resolver *Cpp) ScanLibrary(lib *libraries.Library) error {
-	cppHeaders, err := lib.SourceDir.ReadDir()
+	cppHeaders, err := lib.SourceHeaders()
 	if err != nil {
-		return fmt.Errorf("reading lib src dir: %s", err)
+		return fmt.Errorf("reading lib headers: %s", err)
 	}
-	cppHeaders.FilterSuffix(".h", ".hpp", ".hh")
-	for _, cppHeaderPath := range cppHeaders {
-		cppHeader := cppHeaderPath.Base()
+	for _, cppHeader := range cppHeaders {
 		l := resolver.headers[cppHeader]
 		l.Add(lib)
 		resolver.headers[cppHeader] = l

Diff for: arduino/libraries/loader.go

@@ -100,6 +100,10 @@ func makeNewLibrary(libraryDir *paths.Path, location LibraryLocation) (*Library,
 		library.Version = v
 	}
 
+	if includes := libProperties.Get("includes"); includes != "" {
+		library.sourceHeaders = commaSeparatedToList(includes)
+	}
+
 	if err := addExamples(library); err != nil {
 		return nil, errors.Errorf("scanning examples: %s", err)
 	}

Diff for: commands/lib/list.go

@@ -143,6 +143,7 @@ func GetOutputLibrary(lib *libraries.Library) *rpc.Library {
 		cntplat = lib.ContainerPlatform.String()
 	}
 
+	libHeaders, _ := lib.SourceHeaders()
 	return &rpc.Library{
 		Name:              lib.Name,
 		Author:            lib.Author,
@@ -167,6 +168,7 @@ func GetOutputLibrary(lib *libraries.Library) *rpc.Library {
 		Version:           lib.Version.String(),
 		License:           lib.License,
 		Examples:          lib.Examples.AsStrings(),
+		ProvidesIncludes:  libHeaders,
 	}
 }
 

Diff for: rpc/commands/lib.pb.go

@@ -268,6 +268,9 @@ message Library {
     LibraryLayout layout = 25;
     // The example sketches provided by the library
     repeated string examples = 26;
+    // Value of the `includes` field in library.properties or, if missing, the list of
+    // include files available on the library source root directory.
+    repeated string provides_includes = 27;
 }
 
 enum LibraryLayout {