Removed LibraryAlternatives object in favor of libraries.List

Author: cmaglie

arduino/libraries/librarieslist.go

@@ -17,6 +17,8 @@ package libraries
 
 import (
 	"sort"
+
+	semver "go.bug.st/relaxed-semver"
 )
 
 // List is a list of Libraries
@@ -39,6 +41,16 @@ func (list *List) Add(libs ...*Library) {
 	}
 }
 
+// Remove removes the library from the list
+func (alts *List) Remove(library *Library) {
+	for i, lib := range *alts {
+		if lib == library {
+			*alts = append((*alts)[:i], (*alts)[i+1:]...)
+			return
+		}
+	}
+}
+
 // FindByName returns the first library in the list that match
 // the specified name or nil if not found
 func (list *List) FindByName(name string) *Library {
@@ -50,6 +62,22 @@ func (list *List) FindByName(name string) *Library {
 	return nil
 }
 
+// FilterByVersionAndInstallLocation returns the libraries mathching the provided version and install location. If version
+// is nil all version are matched.
+func (list *List) FilterByVersionAndInstallLocation(version *semver.Version, installLocation LibraryLocation) List {
+	var found List
+	for _, lib := range *list {
+		if lib.Location != installLocation {
+			continue
+		}
+		if version != nil && !lib.Version.Equal(version) {
+			continue
+		}
+		found.Add(lib)
+	}
+	return found
+}
+
 // SortByName sorts the libraries by name
 func (list *List) SortByName() {
 	sort.Slice(*list, func(i, j int) bool {

arduino/libraries/librariesmanager/install.go

@@ -53,7 +53,7 @@ func (lm *LibrariesManager) InstallPrerequisiteCheck(indexLibrary *librariesinde
 
 	var replaced *libraries.Library
 	if installedLibs, have := lm.Libraries[saneName]; have {
-		for _, installedLib := range installedLibs.Alternatives {
+		for _, installedLib := range installedLibs {
 			if installedLib.Location != installLocation {
 				continue
 			}
@@ -99,7 +99,9 @@ func (lm *LibrariesManager) Uninstall(lib *libraries.Library) error {
 		return fmt.Errorf(tr("removing lib directory: %s"), err)
 	}
 
-	lm.Libraries[lib.Name].Remove(lib)
+	alternatives := lm.Libraries[lib.Name]
+	alternatives.Remove(lib)
+	lm.Libraries[lib.Name] = alternatives
 	return nil
 }
 

arduino/libraries/librariesmanager/librariesmanager.go

@@ -27,7 +27,6 @@ import (
 	paths "github.com/arduino/go-paths-helper"
 	"github.com/pmylund/sortutil"
 	"github.com/sirupsen/logrus"
-	semver "go.bug.st/relaxed-semver"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 )
@@ -36,7 +35,7 @@ import (
 // (the list of libraries, revisions, installed paths, etc.)
 type LibrariesManager struct {
 	LibrariesDir []*LibrariesDir
-	Libraries    map[string]*LibraryAlternatives `json:"libraries"`
+	Libraries    map[string]libraries.List `json:"libraries"`
 
 	Index              *librariesindex.Index
 	IndexFile          *paths.Path
@@ -54,39 +53,11 @@ type LibrariesDir struct {
 // LibraryAlternatives is a list of different versions of the same library
 // installed in the system
 type LibraryAlternatives struct {
-	Alternatives libraries.List
+	libraries.List
 }
 
 var tr = i18n.Tr
 
-// Add adds a library to the alternatives
-func (alts *LibraryAlternatives) Add(library *libraries.Library) {
-	if len(alts.Alternatives) > 0 && alts.Alternatives[0].Name != library.Name {
-		panic(fmt.Sprintf("the library name is different from the set (%[1]s != %[2]s)", alts.Alternatives[0].Name, library.Name))
-	}
-	alts.Alternatives = append(alts.Alternatives, library)
-}
-
-// Remove removes the library from the alternatives
-func (alts *LibraryAlternatives) Remove(library *libraries.Library) {
-	for i, lib := range alts.Alternatives {
-		if lib == library {
-			alts.Alternatives = append(alts.Alternatives[:i], alts.Alternatives[i+1:]...)
-			return
-		}
-	}
-}
-
-// FindVersion returns the library mathching the provided version or nil if not found
-func (alts *LibraryAlternatives) FindVersion(version *semver.Version, installLocation libraries.LibraryLocation) *libraries.Library {
-	for _, lib := range alts.Alternatives {
-		if lib.Version.Equal(version) && lib.Location == installLocation {
-			return lib
-		}
-	}
-	return nil
-}
-
 // Names returns an array with all the names of the installed libraries.
 func (lm LibrariesManager) Names() []string {
 	res := make([]string, len(lm.Libraries))
@@ -107,7 +78,7 @@ func NewLibraryManager(indexDir *paths.Path, downloadsDir *paths.Path) *Librarie
 		indexFileSignature = indexDir.Join("library_index.json.sig")
 	}
 	return &LibrariesManager{
-		Libraries:          map[string]*LibraryAlternatives{},
+		Libraries:          map[string]libraries.List{},
 		IndexFile:          indexFile,
 		IndexFileSignature: indexFileSignature,
 		DownloadsDir:       downloadsDir,
@@ -208,12 +179,9 @@ func (lm *LibrariesManager) LoadLibrariesFromDir(librariesDir *LibrariesDir) []*
 			continue
 		}
 		library.ContainerPlatform = librariesDir.PlatformRelease
-		alternatives, ok := lm.Libraries[library.Name]
-		if !ok {
-			alternatives = &LibraryAlternatives{}
-			lm.Libraries[library.Name] = alternatives
-		}
+		alternatives := lm.Libraries[library.Name]
 		alternatives.Add(library)
+		lm.Libraries[library.Name] = alternatives
 	}
 
 	return statuses
@@ -232,13 +200,9 @@ func (lm *LibrariesManager) LoadLibraryFromDir(libRootDir *paths.Path, location
 		return fmt.Errorf(tr("loading library from %[1]s: %[2]s"), libRootDir, err)
 	}
 
-	alternatives, ok := lm.Libraries[library.Name]
-	if !ok {
-		alternatives = &LibraryAlternatives{}
-		lm.Libraries[library.Name] = alternatives
-	}
+	alternatives := lm.Libraries[library.Name]
 	alternatives.Add(library)
-
+	lm.Libraries[library.Name] = alternatives
 	return nil
 }
 
@@ -253,12 +217,16 @@ func (lm *LibrariesManager) FindByReference(libRef *librariesindex.Reference, in
 	}
 	// TODO: Move "search into user" into another method...
 	if libRef.Version == nil {
-		for _, candidate := range alternatives.Alternatives {
+		for _, candidate := range alternatives {
 			if candidate.Location == installLocation {
 				return candidate
 			}
 		}
 		return nil
 	}
-	return alternatives.FindVersion(libRef.Version, installLocation)
+	res := alternatives.FilterByVersionAndInstallLocation(libRef.Version, installLocation)
+	if len(res) > 0 {
+		return res[0]
+	}
+	return nil
 }

arduino/libraries/librariesresolver/cpp.go

@@ -47,7 +47,7 @@ func NewCppResolver() *Cpp {
 // and cache all C++ headers for later retrieval
 func (resolver *Cpp) ScanFromLibrariesManager(lm *librariesmanager.LibrariesManager) error {
 	for _, libAlternatives := range lm.Libraries {
-		for _, lib := range libAlternatives.Alternatives {
+		for _, lib := range libAlternatives {
 			resolver.ScanLibrary(lib)
 		}
 	}
@@ -58,7 +58,7 @@ func (resolver *Cpp) ScanFromLibrariesManager(lm *librariesmanager.LibrariesMana
 // and cache all C++ headers for later retrieval.
 func (resolver *Cpp) ScanIDEBuiltinLibraries(lm *librariesmanager.LibrariesManager) error {
 	for _, libAlternatives := range lm.Libraries {
-		for _, lib := range libAlternatives.Alternatives {
+		for _, lib := range libAlternatives {
 			if lib.Location == libraries.IDEBuiltIn {
 				resolver.ScanLibrary(lib)
 			}
@@ -71,7 +71,7 @@ func (resolver *Cpp) ScanIDEBuiltinLibraries(lm *librariesmanager.LibrariesManag
 // and cache all C++ headers for later retrieval.
 func (resolver *Cpp) ScanUserAndUnmanagedLibraries(lm *librariesmanager.LibrariesManager) error {
 	for _, libAlternatives := range lm.Libraries {
-		for _, lib := range libAlternatives.Alternatives {
+		for _, lib := range libAlternatives {
 			if lib.Location == libraries.User || lib.Location == libraries.Unmanaged {
 				resolver.ScanLibrary(lib)
 			}
@@ -84,7 +84,7 @@ func (resolver *Cpp) ScanUserAndUnmanagedLibraries(lm *librariesmanager.Librarie
 // to find and cache all C++ headers for later retrieval.
 func (resolver *Cpp) ScanPlatformLibraries(lm *librariesmanager.LibrariesManager, platform *cores.PlatformRelease) error {
 	for _, libAlternatives := range lm.Libraries {
-		for _, lib := range libAlternatives.Alternatives {
+		for _, lib := range libAlternatives {
 			if lib.Location != libraries.PlatformBuiltIn && lib.Location != libraries.ReferencedPlatformBuiltIn {
 				continue
 			}

commands/lib/list.go

@@ -121,7 +121,7 @@ func LibraryList(ctx context.Context, req *rpc.LibraryListRequest) (*rpc.Library
 func listLibraries(lm *librariesmanager.LibrariesManager, updatable bool, all bool) []*installedLib {
 	res := []*installedLib{}
 	for _, libAlternatives := range lm.Libraries {
-		for _, lib := range libAlternatives.Alternatives {
+		for _, lib := range libAlternatives {
 			if !all {
 				if lib.Location != libraries.User {
 					continue

legacy/builder/test/libraries_loader_test.go

@@ -31,7 +31,7 @@ import (
 func extractLibraries(ctx *types.Context) []*libraries.Library {
 	res := []*libraries.Library{}
 	for _, lib := range ctx.LibrariesManager.Libraries {
-		for _, libAlternative := range lib.Alternatives {
+		for _, libAlternative := range lib {
 			res = append(res, libAlternative)
 		}
 	}