Renamed fields in Library structure: Name->CanonicalName; RealName->Name

arduino · cmaglie · Sep 21, 2022 · Sep 15, 2022 · Sep 15, 2022 · Sep 15, 2022
commit c3231a332d3d8d841d677fdb1d5d47e344334d3c
diff --git a/arduino/libraries/libraries.go b/arduino/libraries/libraries.go
@@ -63,12 +63,12 @@ type Library struct {
 	Types []string `json:"types,omitempty"`

 	InstallDir             *paths.Path
+	CanonicalName          string
 	SourceDir              *paths.Path
 	UtilityDir             *paths.Path
 	Location               LibraryLocation
 	ContainerPlatform      *cores.PlatformRelease `json:""`
 	Layout                 LibraryLayout
-	RealName               string
 	DotALinkage            bool
 	Precompiled            bool
 	PrecompiledWithSources bool
@@ -85,9 +85,9 @@ type Library struct {

 func (library *Library) String() string {
 	if library.Version.String() == "" {
-		return library.Name
+		return library.CanonicalName
 	}
-	return library.Name + "@" + library.Version.String()
+	return library.CanonicalName + "@" + library.Version.String()
 }

 // ToRPCLibrary converts this library into an rpc.Library
@@ -117,7 +117,7 @@ func (library *Library) ToRPCLibrary() (*rpc.Library, error) {
 	}

 	return &rpc.Library{
-		Name:              library.Name,
+		Name:              library.CanonicalName,
 		Author:            library.Author,
 		Maintainer:        library.Maintainer,
 		Sentence:          library.Sentence,
@@ -132,7 +132,7 @@ func (library *Library) ToRPCLibrary() (*rpc.Library, error) {
 		Location:          library.Location.ToRPCLibraryLocation(),
 		ContainerPlatform: platformOrEmpty(library.ContainerPlatform),
 		Layout:            library.Layout.ToRPCLibraryLayout(),
-		RealName:          library.RealName,
+		RealName:          library.Name,
 		DotALinkage:       library.DotALinkage,
 		Precompiled:       library.Precompiled,
 		LdFlags:           library.LDflags,

diff --git a/arduino/libraries/librariesindex/index.go b/arduino/libraries/librariesindex/index.go
@@ -125,7 +125,7 @@ func (idx *Index) FindRelease(ref *Reference) *Release {
 // FindIndexedLibrary search an indexed library that matches the provided
 // installed library or nil if not found
 func (idx *Index) FindIndexedLibrary(lib *libraries.Library) *Library {
-	return idx.Libraries[lib.RealName]
+	return idx.Libraries[lib.Name]
 }

 // FindLibraryUpdate check if an installed library may be updated using

diff --git a/arduino/libraries/librariesindex/index_test.go b/arduino/libraries/librariesindex/index_test.go
@@ -72,22 +72,22 @@ func TestIndexer(t *testing.T) {
 	})
 	require.Nil(t, rtcInexistent)

-	rtc := index.FindIndexedLibrary(&libraries.Library{RealName: "RTCZero"})
+	rtc := index.FindIndexedLibrary(&libraries.Library{Name: "RTCZero"})
 	require.NotNil(t, rtc)
 	require.Equal(t, "RTCZero", rtc.Name)

-	rtcUpdate := index.FindLibraryUpdate(&libraries.Library{RealName: "RTCZero", Version: semver.MustParse("1.0.0")})
+	rtcUpdate := index.FindLibraryUpdate(&libraries.Library{Name: "RTCZero", Version: semver.MustParse("1.0.0")})
 	require.NotNil(t, rtcUpdate)
 	require.Equal(t, "RTCZero@1.6.0", rtcUpdate.String())

-	rtcUpdateNoVersion := index.FindLibraryUpdate(&libraries.Library{RealName: "RTCZero", Version: nil})
+	rtcUpdateNoVersion := index.FindLibraryUpdate(&libraries.Library{Name: "RTCZero", Version: nil})
 	require.NotNil(t, rtcUpdateNoVersion)
 	require.Equal(t, "RTCZero@1.6.0", rtcUpdateNoVersion.String())

-	rtcNoUpdate := index.FindLibraryUpdate(&libraries.Library{RealName: "RTCZero", Version: semver.MustParse("3.0.0")})
+	rtcNoUpdate := index.FindLibraryUpdate(&libraries.Library{Name: "RTCZero", Version: semver.MustParse("3.0.0")})
 	require.Nil(t, rtcNoUpdate)

-	rtcInexistent2 := index.FindLibraryUpdate(&libraries.Library{RealName: "RTCZero-blah", Version: semver.MustParse("1.0.0")})
+	rtcInexistent2 := index.FindLibraryUpdate(&libraries.Library{Name: "RTCZero-blah", Version: semver.MustParse("1.0.0")})
 	require.Nil(t, rtcInexistent2)

 	resolve1 := index.ResolveDependencies(alp.Releases["1.2.1"])

diff --git a/arduino/libraries/librarieslist.go b/arduino/libraries/librarieslist.go
@@ -55,7 +55,7 @@ func (list *List) Remove(library *Library) {
 // the specified name or nil if not found
 func (list *List) FindByName(name string) *Library {
 	for _, lib := range *list {
-		if lib.Name == name {
+		if lib.CanonicalName == name {
 			return lib
 		}
 	}
@@ -82,7 +82,7 @@ func (list *List) FilterByVersionAndInstallLocation(version *semver.Version, ins
 func (list *List) SortByName() {
 	sort.Slice(*list, func(i, j int) bool {
 		a, b := (*list)[i], (*list)[j]
-		return a.Name < b.Name
+		return a.CanonicalName < b.CanonicalName
 	})
 }


diff --git a/arduino/libraries/librariesmanager/install.go b/arduino/libraries/librariesmanager/install.go
@@ -106,9 +106,9 @@ func (lm *LibrariesManager) Uninstall(lib *libraries.Library) error {
 		return fmt.Errorf(tr("removing lib directory: %s"), err)
 	}

-	alternatives := lm.Libraries[lib.RealName]
+	alternatives := lm.Libraries[lib.Name]
 	alternatives.Remove(lib)
-	lm.Libraries[lib.RealName] = alternatives
+	lm.Libraries[lib.Name] = alternatives
 	return nil
 }


diff --git a/arduino/libraries/librariesmanager/librariesmanager.go b/arduino/libraries/librariesmanager/librariesmanager.go
@@ -172,9 +172,9 @@ func (lm *LibrariesManager) LoadLibrariesFromDir(librariesDir *LibrariesDir) []*
 			continue
 		}
 		library.ContainerPlatform = librariesDir.PlatformRelease
-		alternatives := lm.Libraries[library.RealName]
+		alternatives := lm.Libraries[library.Name]
 		alternatives.Add(library)
-		lm.Libraries[library.RealName] = alternatives
+		lm.Libraries[library.Name] = alternatives
 	}

 	return statuses
@@ -193,9 +193,9 @@ func (lm *LibrariesManager) LoadLibraryFromDir(libRootDir *paths.Path, location
 		return fmt.Errorf(tr("loading library from %[1]s: %[2]s"), libRootDir, err)
 	}

-	alternatives := lm.Libraries[library.RealName]
+	alternatives := lm.Libraries[library.Name]
 	alternatives.Add(library)
-	lm.Libraries[library.RealName] = alternatives
+	lm.Libraries[library.Name] = alternatives
 	return nil
 }


diff --git a/arduino/libraries/librariesresolver/cpp.go b/arduino/libraries/librariesresolver/cpp.go
@@ -135,7 +135,7 @@ func (resolver *Cpp) ResolveFor(header, architecture string) *libraries.Library
 			msg = "  found another lib with same priority"
 		}
 		logrus.
-			WithField("lib", lib.Name).
+			WithField("lib", lib.CanonicalName).
 			WithField("prio", fmt.Sprintf("%03X", libPriority)).
 			Infof(msg)
 	}
@@ -149,12 +149,12 @@ func (resolver *Cpp) ResolveFor(header, architecture string) *libraries.Library
 	// If more than one library qualifies use the "closestmatch" algorithm to
 	// find the best matching one (instead of choosing it randomly)
 	if best := findLibraryWithNameBestDistance(header, found); best != nil {
-		logrus.WithField("lib", best.Name).Info("  library with the best matching name")
+		logrus.WithField("lib", best.CanonicalName).Info("  library with the best matching name")
 		return best
 	}

 	found.SortByName()
-	logrus.WithField("lib", found[0].Name).Info("  first library in alphabetic order")
+	logrus.WithField("lib", found[0].CanonicalName).Info("  first library in alphabetic order")
 	return found[0]
 }

@@ -167,8 +167,8 @@ func simplify(name string) string {
 func computePriority(lib *libraries.Library, header, arch string) int {
 	header = strings.TrimSuffix(header, filepath.Ext(header))
 	header = simplify(header)
-	name := simplify(lib.Name)
-	realName := simplify(lib.RealName)
+	name := simplify(lib.CanonicalName)
+	realName := simplify(lib.Name)

 	priority := 0

@@ -220,7 +220,7 @@ func findLibraryWithNameBestDistance(name string, libs libraries.List) *librarie
 	// Create closestmatch DB
 	wordsToTest := []string{}
 	for _, lib := range libs {
-		wordsToTest = append(wordsToTest, simplify(lib.Name))
+		wordsToTest = append(wordsToTest, simplify(lib.CanonicalName))
 	}
 	// Choose a set of bag sizes, more is more accurate but slower
 	bagSizes := []int{2}
@@ -232,7 +232,7 @@ func findLibraryWithNameBestDistance(name string, libs libraries.List) *librarie
 	// Return the closest-matching lib
 	var winner *libraries.Library
 	for _, lib := range libs {
-		if closestName == simplify(lib.Name) {
+		if closestName == simplify(lib.CanonicalName) {
 			winner = lib
 			break
 		}

diff --git a/arduino/libraries/librariesresolver/cpp_test.go b/arduino/libraries/librariesresolver/cpp_test.go
@@ -22,14 +22,14 @@ import (
 	"github.com/stretchr/testify/require"
 )

-var l1 = &libraries.Library{Name: "Calculus Lib", Location: libraries.User}
-var l2 = &libraries.Library{Name: "Calculus Lib-master", Location: libraries.User}
-var l3 = &libraries.Library{Name: "Calculus Lib Improved", Location: libraries.User}
-var l4 = &libraries.Library{Name: "Another Calculus Lib", Location: libraries.User}
-var l5 = &libraries.Library{Name: "Yet Another Calculus Lib Improved", Location: libraries.User}
-var l6 = &libraries.Library{Name: "Calculus Unified Lib", Location: libraries.User}
-var l7 = &libraries.Library{Name: "AnotherLib", Location: libraries.User}
-var bundleServo = &libraries.Library{Name: "Servo", Location: libraries.IDEBuiltIn, Architectures: []string{"avr", "sam", "samd"}}
+var l1 = &libraries.Library{CanonicalName: "Calculus Lib", Location: libraries.User}
+var l2 = &libraries.Library{CanonicalName: "Calculus Lib-master", Location: libraries.User}
+var l3 = &libraries.Library{CanonicalName: "Calculus Lib Improved", Location: libraries.User}
+var l4 = &libraries.Library{CanonicalName: "Another Calculus Lib", Location: libraries.User}
+var l5 = &libraries.Library{CanonicalName: "Yet Another Calculus Lib Improved", Location: libraries.User}
+var l6 = &libraries.Library{CanonicalName: "Calculus Unified Lib", Location: libraries.User}
+var l7 = &libraries.Library{CanonicalName: "AnotherLib", Location: libraries.User}
+var bundleServo = &libraries.Library{CanonicalName: "Servo", Location: libraries.IDEBuiltIn, Architectures: []string{"avr", "sam", "samd"}}

 func runResolver(include string, arch string, libs ...*libraries.Library) *libraries.Library {
 	libraryList := libraries.List{}
@@ -41,19 +41,19 @@ func runResolver(include string, arch string, libs ...*libraries.Library) *libra

 func TestArchitecturePriority(t *testing.T) {
 	userServo := &libraries.Library{
-		Name:          "Servo",
+		CanonicalName: "Servo",
 		Location:      libraries.User,
 		Architectures: []string{"avr", "sam", "samd"}}
 	userServoAllArch := &libraries.Library{
-		Name:          "Servo",
+		CanonicalName: "Servo",
 		Location:      libraries.User,
 		Architectures: []string{"*"}}
 	userServoNonavr := &libraries.Library{
-		Name:          "Servo",
+		CanonicalName: "Servo",
 		Location:      libraries.User,
 		Architectures: []string{"sam", "samd"}}
 	userAnotherServo := &libraries.Library{
-		Name:          "AnotherServo",
+		CanonicalName: "AnotherServo",
 		Location:      libraries.User,
 		Architectures: []string{"avr", "sam", "samd", "esp32"}}

@@ -78,11 +78,11 @@ func TestArchitecturePriority(t *testing.T) {
 	require.Equal(t, userServoAllArch, res, "selected library")

 	userSDAllArch := &libraries.Library{
-		Name:          "SD",
+		CanonicalName: "SD",
 		Location:      libraries.User,
 		Architectures: []string{"*"}}
 	builtinSDesp := &libraries.Library{
-		Name:          "SD",
+		CanonicalName: "SD",
 		Location:      libraries.PlatformBuiltIn,
 		Architectures: []string{"esp8266"}}
 	res = runResolver("SD.h", "esp8266", userSDAllArch, builtinSDesp)
@@ -133,7 +133,7 @@ func TestCppHeaderResolver(t *testing.T) {
 			librarylist.Add(lib)
 		}
 		resolver.headers[header] = librarylist
-		return resolver.ResolveFor(header, "avr").Name
+		return resolver.ResolveFor(header, "avr").CanonicalName
 	}
 	require.Equal(t, "Calculus Lib", resolve("calculus_lib.h", l1, l2, l3, l4, l5, l6, l7))
 	require.Equal(t, "Calculus Lib-master", resolve("calculus_lib.h", l2, l3, l4, l5, l6, l7))
@@ -147,14 +147,14 @@ func TestCppHeaderResolver(t *testing.T) {
 func TestCppHeaderResolverWithLibrariesInStrangeDirectoryNames(t *testing.T) {
 	resolver := NewCppResolver()
 	librarylist := libraries.List{}
-	librarylist.Add(&libraries.Library{Name: "onewire_2_3_4", RealName: "OneWire", Architectures: []string{"*"}})
-	librarylist.Add(&libraries.Library{Name: "onewireng_2_3_4", RealName: "OneWireNg", Architectures: []string{"avr"}})
+	librarylist.Add(&libraries.Library{CanonicalName: "onewire_2_3_4", Name: "OneWire", Architectures: []string{"*"}})
+	librarylist.Add(&libraries.Library{CanonicalName: "onewireng_2_3_4", Name: "OneWireNg", Architectures: []string{"avr"}})
 	resolver.headers["OneWire.h"] = librarylist
-	require.Equal(t, "onewire_2_3_4", resolver.ResolveFor("OneWire.h", "avr").Name)
+	require.Equal(t, "onewire_2_3_4", resolver.ResolveFor("OneWire.h", "avr").CanonicalName)

 	librarylist2 := libraries.List{}
-	librarylist2.Add(&libraries.Library{Name: "OneWire", RealName: "OneWire", Architectures: []string{"*"}})
-	librarylist2.Add(&libraries.Library{Name: "onewire_2_3_4", RealName: "OneWire", Architectures: []string{"avr"}})
+	librarylist2.Add(&libraries.Library{CanonicalName: "OneWire", Name: "OneWire", Architectures: []string{"*"}})
+	librarylist2.Add(&libraries.Library{CanonicalName: "onewire_2_3_4", Name: "OneWire", Architectures: []string{"avr"}})
 	resolver.headers["OneWire.h"] = librarylist2
-	require.Equal(t, "OneWire", resolver.ResolveFor("OneWire.h", "avr").Name)
+	require.Equal(t, "OneWire", resolver.ResolveFor("OneWire.h", "avr").CanonicalName)
 }
diff --git a/arduino/libraries/loader.go b/arduino/libraries/loader.go
@@ -108,8 +108,8 @@ func makeNewLibrary(libraryDir *paths.Path, location LibraryLocation) (*Library,
 	if err := addExamples(library); err != nil {
 		return nil, errors.Errorf(tr("scanning examples: %s"), err)
 	}
-	library.Name = libraryDir.Base()
-	library.RealName = strings.TrimSpace(libProperties.Get("name"))
+	library.CanonicalName = libraryDir.Base()
+	library.Name = strings.TrimSpace(libProperties.Get("name"))
 	library.Author = strings.TrimSpace(libProperties.Get("author"))
 	library.Maintainer = strings.TrimSpace(libProperties.Get("maintainer"))
 	library.Sentence = strings.TrimSpace(libProperties.Get("sentence"))
@@ -131,7 +131,7 @@ func makeLegacyLibrary(path *paths.Path, location LibraryLocation) (*Library, er
 		Location:      location,
 		SourceDir:     path,
 		Layout:        FlatLayout,
-		Name:          path.Base(),
+		CanonicalName: path.Base(),
 		Architectures: []string{"*"},
 		IsLegacy:      true,
 		Version:       semver.MustParse(""),

diff --git a/commands/compile/compile.go b/commands/compile/compile.go
@@ -205,7 +205,7 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 		for _, lib := range builderCtx.ImportedLibraries {
 			rpcLib, err := lib.ToRPCLibrary()
 			if err != nil {
-				msg := tr("Error getting information for library %s", lib.Name) + ": " + err.Error() + "\n"
+				msg := tr("Error getting information for library %s", lib.CanonicalName) + ": " + err.Error() + "\n"
 				errStream.Write([]byte(msg))
 			}
 			importedLibs = append(importedLibs, rpcLib)

diff --git a/commands/lib/list.go b/commands/lib/list.go
@@ -68,7 +68,7 @@ func LibraryList(ctx context.Context, req *rpc.LibraryListRequest) (*rpc.Library
 					continue
 				}
 			}
-			if latest, has := filteredRes[lib.Library.Name]; has {
+			if latest, has := filteredRes[lib.Library.CanonicalName]; has {
 				if latest.Library.LocationPriorityFor(boardPlatform, refBoardPlatform) >= lib.Library.LocationPriorityFor(boardPlatform, refBoardPlatform) {
 					continue
 				}
@@ -86,7 +86,7 @@ func LibraryList(ctx context.Context, req *rpc.LibraryListRequest) (*rpc.Library
 				f: compatible,
 			}

-			filteredRes[lib.Library.Name] = lib
+			filteredRes[lib.Library.CanonicalName] = lib
 		}

 		res = []*installedLib{}
@@ -96,7 +96,7 @@ func LibraryList(ctx context.Context, req *rpc.LibraryListRequest) (*rpc.Library
 	}

 	for _, lib := range res {
-		if nameFilter != "" && strings.ToLower(lib.Library.Name) != nameFilter {
+		if nameFilter != "" && strings.ToLower(lib.Library.CanonicalName) != nameFilter {
 			continue
 		}
 		var release *rpc.LibraryRelease
@@ -105,7 +105,7 @@ func LibraryList(ctx context.Context, req *rpc.LibraryListRequest) (*rpc.Library
 		}
 		rpcLib, err := lib.Library.ToRPCLibrary()
 		if err != nil {
-			return nil, &arduino.PermissionDeniedError{Message: tr("Error getting information for library %s", lib.Library.Name), Cause: err}
+			return nil, &arduino.PermissionDeniedError{Message: tr("Error getting information for library %s", lib.Library.CanonicalName), Cause: err}
 		}
 		installedLibs = append(installedLibs, &rpc.InstalledLibrary{
 			Library: rpcLib,

diff --git a/commands/lib/resolve_deps.go b/commands/lib/resolve_deps.go
@@ -41,7 +41,7 @@ func LibraryResolveDependencies(ctx context.Context, req *rpc.LibraryResolveDepe
 	// Extract all installed libraries
 	installedLibs := map[string]*libraries.Library{}
 	for _, lib := range listLibraries(lm, false, false) {
-		installedLibs[lib.Library.Name] = lib.Library
+		installedLibs[lib.Library.CanonicalName] = lib.Library
 	}

 	// Resolve all dependencies...

diff --git a/commands/lib/uninstall.go b/commands/lib/uninstall.go
@@ -52,7 +52,7 @@ func LibraryUninstall(ctx context.Context, req *rpc.LibraryUninstallRequest, tas
 		libsDir.Add(lib.InstallDir)
 	}
 	return &arduino.MultipleLibraryInstallDetected{
-		LibName: libs[0].RealName,
+		LibName: libs[0].Name,
 		LibsDir: libsDir,
 		Message: tr("Automatic library uninstall can't be performed in this case, please manually remove them."),
 	}

diff --git a/commands/lib/upgrade.go b/commands/lib/upgrade.go
@@ -86,7 +86,7 @@ func upgrade(lm *librariesmanager.LibrariesManager, libs []*installedLib, downlo

 func filterByName(libs []*installedLib, name string) *installedLib {
 	for _, lib := range libs {
-		if lib.Library.RealName == name {
+		if lib.Library.Name == name {
 			return lib
 		}
 	}

diff --git a/legacy/builder/container_find_includes.go b/legacy/builder/container_find_includes.go
@@ -352,7 +352,7 @@ func findIncludesUntilDone(ctx *types.Context, cache *includeCache, sourceFile t
 				// Fully precompiled libraries should have no dependencies
 				// to avoid ABI breakage
 				if ctx.Verbose {
-					ctx.Info(tr("Skipping dependencies detection for precompiled library %[1]s", library.Name))
+					ctx.Info(tr("Skipping dependencies detection for precompiled library %[1]s", library.CanonicalName))
 				}
 				return nil
 			}

diff --git a/legacy/builder/create_cmake_rule.go b/legacy/builder/create_cmake_rule.go
@@ -73,7 +73,7 @@ func (s *ExportProjectCMake) Run(ctx *types.Context) error {
 	dynamicLibsFromPkgConfig := map[string]bool{}
 	for _, library := range ctx.ImportedLibraries {
 		// Copy used libraries in the correct folder
-		libDir := libBaseFolder.Join(library.Name)
+		libDir := libBaseFolder.Join(library.CanonicalName)
 		mcu := ctx.BuildProperties.Get(constants.BUILD_PROPERTIES_BUILD_MCU)
 		utils.CopyDir(library.InstallDir.String(), libDir.String(), validExportExtensions)