Commit 63634c7

committed

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

1 parent 80e2c2e commit 63634c7Copy full SHA for 63634c7

File tree

6 files changed

+67

-27

lines changed

arduino/libraries
- libraries.go
- librariesresolver
  - cpp.go
- loader.go
commands/lib
- list.go
rpc/commands
- lib.pb.go
- lib.proto

6 files changed

+67

-27

lines changed

`‎arduino/libraries/libraries.go‎`

Lines changed: 20 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@`
`16`	`16`	`package libraries`
`17`	`17`
`18`	`18`	`import (`
	`19`	`+ "fmt"`
	`20`	`+`
`19`	`21`	`"github.com/arduino/arduino-cli/arduino/cores"`
`20`	`22`	`paths "github.com/arduino/go-paths-helper"`
`21`	`23`	`properties "github.com/arduino/go-properties-orderedmap"`
`@@ -71,6 +73,7 @@ type Library struct {`
`71`	`73`	`License string`
`72`	`74`	`Properties *properties.Map`
`73`	`75`	`Examples paths.PathList`
	`76`	`+ sourceHeaders []string`
`74`	`77`	`}`
`75`	`78`
`76`	`79`	`func (library *Library) String() string {`
`@@ -153,3 +156,20 @@ func (library *Library) LocationPriorityFor(platformRelease, refPlatformRelease`
`153`	`156`	`}`
`154`	`157`	`return 0`
`155`	`158`	`}`
	`159`	`+`
	`160`	`+// SourceHeaders returns the C++ headers in the library.`
	`161`	`+func (library *Library) SourceHeaders() ([]string, error) {`
	`162`	`+ if library.sourceHeaders == nil {`
	`163`	`+ cppHeaders, err := library.SourceDir.ReadDir()`
	`164`	`+ if err != nil {`
	`165`	`+ return nil, fmt.Errorf("reading lib src dir: %s", err)`
	`166`	`+ }`
	`167`	`+ cppHeaders.FilterSuffix(".h", ".hpp", ".hh")`
	`168`	`+ res := []string{}`
	`169`	`+ for _, cppHeader := range cppHeaders {`
	`170`	`+ res = append(res, cppHeader.Base())`
	`171`	`+ }`
	`172`	`+ library.sourceHeaders = res`
	`173`	`+ }`
	`174`	`+ return library.sourceHeaders, nil`
	`175`	`+}`

`‎arduino/libraries/librariesresolver/cpp.go‎`

Lines changed: 3 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -52,13 +52,11 @@ func (resolver Cpp) ScanFromLibrariesManager(lm librariesmanager.LibrariesMana`
`52`	`52`
`53`	`53`	`// ScanLibrary reads a library to find and cache C++ headers for later retrieval`
`54`	`54`	`func (resolver Cpp) ScanLibrary(lib libraries.Library) error {`
`55`		`- cppHeaders, err := lib.SourceDir.ReadDir()`
	`55`	`+ cppHeaders, err := lib.SourceHeaders()`
`56`	`56`	`if err != nil {`
`57`		`- return fmt.Errorf("reading lib src dir: %s", err)`
	`57`	`+ return fmt.Errorf("reading lib headers: %s", err)`
`58`	`58`	`}`
`59`		`- cppHeaders.FilterSuffix(".h", ".hpp", ".hh")`
`60`		`- for _, cppHeaderPath := range cppHeaders {`
`61`		`- cppHeader := cppHeaderPath.Base()`
	`59`	`+ for _, cppHeader := range cppHeaders {`
`62`	`60`	`l := resolver.headers[cppHeader]`
`63`	`61`	`l.Add(lib)`
`64`	`62`	`resolver.headers[cppHeader] = l`

`‎arduino/libraries/loader.go‎`

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,10 @@ func makeNewLibrary(libraryDir paths.Path, location LibraryLocation) (Library,`
`100`	`100`	`library.Version = v`
`101`	`101`	`}`
`102`	`102`
	`103`	`+ if includes := libProperties.Get("includes"); includes != "" {`
	`104`	`+ library.sourceHeaders = commaSeparatedToList(includes)`
	`105`	`+ }`
	`106`	`+`
`103`	`107`	`if err := addExamples(library); err != nil {`
`104`	`108`	`return nil, errors.Errorf("scanning examples: %s", err)`
`105`	`109`	`}`

`‎commands/lib/list.go‎`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -143,6 +143,7 @@ func GetOutputLibrary(lib libraries.Library) rpc.Library {`
`143`	`143`	`cntplat = lib.ContainerPlatform.String()`
`144`	`144`	`}`
`145`	`145`
	`146`	`+ libHeaders, _ := lib.SourceHeaders()`
`146`	`147`	`return &rpc.Library{`
`147`	`148`	`Name: lib.Name,`
`148`	`149`	`Author: lib.Author,`
`@@ -167,6 +168,7 @@ func GetOutputLibrary(lib libraries.Library) rpc.Library {`
`167`	`168`	`Version: lib.Version.String(),`
`168`	`169`	`License: lib.License,`
`169`	`170`	`Examples: lib.Examples.AsStrings(),`
	`171`	`+ ProvidesIncludes: libHeaders,`
`170`	`172`	`}`
`171`	`173`	`}`
`172`	`174`

`‎rpc/commands/lib.pb.go‎`

Lines changed: 35 additions & 22 deletions

Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

`‎rpc/commands/lib.proto‎`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -268,6 +268,9 @@ message Library {`
`268`	`268`	`LibraryLayout layout = 25;`
`269`	`269`	`// The example sketches provided by the library`
`270`	`270`	`repeated string examples = 26;`
	`271`	+ // Value of the `includes` field in library.properties or, if missing, the list of
	`272`	`+ // include files available on the library source root directory.`
	`273`	`+ repeated string provides_includes = 27;`
`271`	`274`	`}`
`272`	`275`
`273`	`276`	`enum LibraryLayout {`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit 63634c7

File tree

6 files changed

6 files changed

`‎arduino/libraries/libraries.go‎`

`‎arduino/libraries/librariesresolver/cpp.go‎`

`‎arduino/libraries/loader.go‎`

`‎commands/lib/list.go‎`

`‎rpc/commands/lib.pb.go‎`

`‎rpc/commands/lib.proto‎`

0 commit comments