Skip to content

Commit c3231a3

Browse files
cmagliecmaglie
committed
Renamed fields in Library structure: Name->CanonicalName; RealName->Name
1 parent ac8bc63 commit c3231a3

26 files changed

+129
-129
lines changed

Diff for: ‎arduino/libraries/libraries.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,12 @@ type Library struct {
6363
Types []string `json:"types,omitempty"`
6464

6565
InstallDir *paths.Path
66+
CanonicalName string
6667
SourceDir *paths.Path
6768
UtilityDir *paths.Path
6869
Location LibraryLocation
6970
ContainerPlatform *cores.PlatformRelease `json:""`
7071
Layout LibraryLayout
71-
RealName string
7272
DotALinkage bool
7373
Precompiled bool
7474
PrecompiledWithSources bool
@@ -85,9 +85,9 @@ type Library struct {
8585

8686
func (library *Library) String() string {
8787
if library.Version.String() == "" {
88-
return library.Name
88+
return library.CanonicalName
8989
}
90-
return library.Name + "@" + library.Version.String()
90+
return library.CanonicalName + "@" + library.Version.String()
9191
}
9292

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

119119
return &rpc.Library{
120-
Name: library.Name,
120+
Name: library.CanonicalName,
121121
Author: library.Author,
122122
Maintainer: library.Maintainer,
123123
Sentence: library.Sentence,
@@ -132,7 +132,7 @@ func (library *Library) ToRPCLibrary() (*rpc.Library, error) {
132132
Location: library.Location.ToRPCLibraryLocation(),
133133
ContainerPlatform: platformOrEmpty(library.ContainerPlatform),
134134
Layout: library.Layout.ToRPCLibraryLayout(),
135-
RealName: library.RealName,
135+
RealName: library.Name,
136136
DotALinkage: library.DotALinkage,
137137
Precompiled: library.Precompiled,
138138
LdFlags: library.LDflags,

Diff for: ‎arduino/libraries/librariesindex/index.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ func (idx *Index) FindRelease(ref *Reference) *Release {
125125
// FindIndexedLibrary search an indexed library that matches the provided
126126
// installed library or nil if not found
127127
func (idx *Index) FindIndexedLibrary(lib *libraries.Library) *Library {
128-
return idx.Libraries[lib.RealName]
128+
return idx.Libraries[lib.Name]
129129
}
130130

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

Diff for: ‎arduino/libraries/librariesindex/index_test.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -72,22 +72,22 @@ func TestIndexer(t *testing.T) {
7272
})
7373
require.Nil(t, rtcInexistent)
7474

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

79-
rtcUpdate := index.FindLibraryUpdate(&libraries.Library{RealName: "RTCZero", Version: semver.MustParse("1.0.0")})
79+
rtcUpdate := index.FindLibraryUpdate(&libraries.Library{Name: "RTCZero", Version: semver.MustParse("1.0.0")})
8080
require.NotNil(t, rtcUpdate)
8181
require.Equal(t, "[email protected]", rtcUpdate.String())
8282

83-
rtcUpdateNoVersion := index.FindLibraryUpdate(&libraries.Library{RealName: "RTCZero", Version: nil})
83+
rtcUpdateNoVersion := index.FindLibraryUpdate(&libraries.Library{Name: "RTCZero", Version: nil})
8484
require.NotNil(t, rtcUpdateNoVersion)
8585
require.Equal(t, "[email protected]", rtcUpdateNoVersion.String())
8686

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

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

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

Diff for: ‎arduino/libraries/librarieslist.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ func (list *List) Remove(library *Library) {
5555
// the specified name or nil if not found
5656
func (list *List) FindByName(name string) *Library {
5757
for _, lib := range *list {
58-
if lib.Name == name {
58+
if lib.CanonicalName == name {
5959
return lib
6060
}
6161
}
@@ -82,7 +82,7 @@ func (list *List) FilterByVersionAndInstallLocation(version *semver.Version, ins
8282
func (list *List) SortByName() {
8383
sort.Slice(*list, func(i, j int) bool {
8484
a, b := (*list)[i], (*list)[j]
85-
return a.Name < b.Name
85+
return a.CanonicalName < b.CanonicalName
8686
})
8787
}
8888

Diff for: ‎arduino/libraries/librariesmanager/install.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,9 @@ func (lm *LibrariesManager) Uninstall(lib *libraries.Library) error {
106106
return fmt.Errorf(tr("removing lib directory: %s"), err)
107107
}
108108

109-
alternatives := lm.Libraries[lib.RealName]
109+
alternatives := lm.Libraries[lib.Name]
110110
alternatives.Remove(lib)
111-
lm.Libraries[lib.RealName] = alternatives
111+
lm.Libraries[lib.Name] = alternatives
112112
return nil
113113
}
114114

Diff for: ‎arduino/libraries/librariesmanager/librariesmanager.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,9 @@ func (lm *LibrariesManager) LoadLibrariesFromDir(librariesDir *LibrariesDir) []*
172172
continue
173173
}
174174
library.ContainerPlatform = librariesDir.PlatformRelease
175-
alternatives := lm.Libraries[library.RealName]
175+
alternatives := lm.Libraries[library.Name]
176176
alternatives.Add(library)
177-
lm.Libraries[library.RealName] = alternatives
177+
lm.Libraries[library.Name] = alternatives
178178
}
179179

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

196-
alternatives := lm.Libraries[library.RealName]
196+
alternatives := lm.Libraries[library.Name]
197197
alternatives.Add(library)
198-
lm.Libraries[library.RealName] = alternatives
198+
lm.Libraries[library.Name] = alternatives
199199
return nil
200200
}
201201

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ func (resolver *Cpp) ResolveFor(header, architecture string) *libraries.Library
135135
msg = " found another lib with same priority"
136136
}
137137
logrus.
138-
WithField("lib", lib.Name).
138+
WithField("lib", lib.CanonicalName).
139139
WithField("prio", fmt.Sprintf("%03X", libPriority)).
140140
Infof(msg)
141141
}
@@ -149,12 +149,12 @@ func (resolver *Cpp) ResolveFor(header, architecture string) *libraries.Library
149149
// If more than one library qualifies use the "closestmatch" algorithm to
150150
// find the best matching one (instead of choosing it randomly)
151151
if best := findLibraryWithNameBestDistance(header, found); best != nil {
152-
logrus.WithField("lib", best.Name).Info(" library with the best matching name")
152+
logrus.WithField("lib", best.CanonicalName).Info(" library with the best matching name")
153153
return best
154154
}
155155

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

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

173173
priority := 0
174174

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

Diff for: ‎arduino/libraries/librariesresolver/cpp_test.go

+21-21
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ import (
2222
"github.com/stretchr/testify/require"
2323
)
2424

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

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

4242
func TestArchitecturePriority(t *testing.T) {
4343
userServo := &libraries.Library{
44-
Name: "Servo",
44+
CanonicalName: "Servo",
4545
Location: libraries.User,
4646
Architectures: []string{"avr", "sam", "samd"}}
4747
userServoAllArch := &libraries.Library{
48-
Name: "Servo",
48+
CanonicalName: "Servo",
4949
Location: libraries.User,
5050
Architectures: []string{"*"}}
5151
userServoNonavr := &libraries.Library{
52-
Name: "Servo",
52+
CanonicalName: "Servo",
5353
Location: libraries.User,
5454
Architectures: []string{"sam", "samd"}}
5555
userAnotherServo := &libraries.Library{
56-
Name: "AnotherServo",
56+
CanonicalName: "AnotherServo",
5757
Location: libraries.User,
5858
Architectures: []string{"avr", "sam", "samd", "esp32"}}
5959

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

8080
userSDAllArch := &libraries.Library{
81-
Name: "SD",
81+
CanonicalName: "SD",
8282
Location: libraries.User,
8383
Architectures: []string{"*"}}
8484
builtinSDesp := &libraries.Library{
85-
Name: "SD",
85+
CanonicalName: "SD",
8686
Location: libraries.PlatformBuiltIn,
8787
Architectures: []string{"esp8266"}}
8888
res = runResolver("SD.h", "esp8266", userSDAllArch, builtinSDesp)
@@ -133,7 +133,7 @@ func TestCppHeaderResolver(t *testing.T) {
133133
librarylist.Add(lib)
134134
}
135135
resolver.headers[header] = librarylist
136-
return resolver.ResolveFor(header, "avr").Name
136+
return resolver.ResolveFor(header, "avr").CanonicalName
137137
}
138138
require.Equal(t, "Calculus Lib", resolve("calculus_lib.h", l1, l2, l3, l4, l5, l6, l7))
139139
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) {
147147
func TestCppHeaderResolverWithLibrariesInStrangeDirectoryNames(t *testing.T) {
148148
resolver := NewCppResolver()
149149
librarylist := libraries.List{}
150-
librarylist.Add(&libraries.Library{Name: "onewire_2_3_4", RealName: "OneWire", Architectures: []string{"*"}})
151-
librarylist.Add(&libraries.Library{Name: "onewireng_2_3_4", RealName: "OneWireNg", Architectures: []string{"avr"}})
150+
librarylist.Add(&libraries.Library{CanonicalName: "onewire_2_3_4", Name: "OneWire", Architectures: []string{"*"}})
151+
librarylist.Add(&libraries.Library{CanonicalName: "onewireng_2_3_4", Name: "OneWireNg", Architectures: []string{"avr"}})
152152
resolver.headers["OneWire.h"] = librarylist
153-
require.Equal(t, "onewire_2_3_4", resolver.ResolveFor("OneWire.h", "avr").Name)
153+
require.Equal(t, "onewire_2_3_4", resolver.ResolveFor("OneWire.h", "avr").CanonicalName)
154154

155155
librarylist2 := libraries.List{}
156-
librarylist2.Add(&libraries.Library{Name: "OneWire", RealName: "OneWire", Architectures: []string{"*"}})
157-
librarylist2.Add(&libraries.Library{Name: "onewire_2_3_4", RealName: "OneWire", Architectures: []string{"avr"}})
156+
librarylist2.Add(&libraries.Library{CanonicalName: "OneWire", Name: "OneWire", Architectures: []string{"*"}})
157+
librarylist2.Add(&libraries.Library{CanonicalName: "onewire_2_3_4", Name: "OneWire", Architectures: []string{"avr"}})
158158
resolver.headers["OneWire.h"] = librarylist2
159-
require.Equal(t, "OneWire", resolver.ResolveFor("OneWire.h", "avr").Name)
159+
require.Equal(t, "OneWire", resolver.ResolveFor("OneWire.h", "avr").CanonicalName)
160160
}

Diff for: ‎arduino/libraries/loader.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ func makeNewLibrary(libraryDir *paths.Path, location LibraryLocation) (*Library,
108108
if err := addExamples(library); err != nil {
109109
return nil, errors.Errorf(tr("scanning examples: %s"), err)
110110
}
111-
library.Name = libraryDir.Base()
112-
library.RealName = strings.TrimSpace(libProperties.Get("name"))
111+
library.CanonicalName = libraryDir.Base()
112+
library.Name = strings.TrimSpace(libProperties.Get("name"))
113113
library.Author = strings.TrimSpace(libProperties.Get("author"))
114114
library.Maintainer = strings.TrimSpace(libProperties.Get("maintainer"))
115115
library.Sentence = strings.TrimSpace(libProperties.Get("sentence"))
@@ -131,7 +131,7 @@ func makeLegacyLibrary(path *paths.Path, location LibraryLocation) (*Library, er
131131
Location: location,
132132
SourceDir: path,
133133
Layout: FlatLayout,
134-
Name: path.Base(),
134+
CanonicalName: path.Base(),
135135
Architectures: []string{"*"},
136136
IsLegacy: true,
137137
Version: semver.MustParse(""),

Diff for: ‎commands/compile/compile.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
205205
for _, lib := range builderCtx.ImportedLibraries {
206206
rpcLib, err := lib.ToRPCLibrary()
207207
if err != nil {
208-
msg := tr("Error getting information for library %s", lib.Name) + ": " + err.Error() + "\n"
208+
msg := tr("Error getting information for library %s", lib.CanonicalName) + ": " + err.Error() + "\n"
209209
errStream.Write([]byte(msg))
210210
}
211211
importedLibs = append(importedLibs, rpcLib)

Diff for: ‎commands/lib/list.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ func LibraryList(ctx context.Context, req *rpc.LibraryListRequest) (*rpc.Library
6868
continue
6969
}
7070
}
71-
if latest, has := filteredRes[lib.Library.Name]; has {
71+
if latest, has := filteredRes[lib.Library.CanonicalName]; has {
7272
if latest.Library.LocationPriorityFor(boardPlatform, refBoardPlatform) >= lib.Library.LocationPriorityFor(boardPlatform, refBoardPlatform) {
7373
continue
7474
}
@@ -86,7 +86,7 @@ func LibraryList(ctx context.Context, req *rpc.LibraryListRequest) (*rpc.Library
8686
f: compatible,
8787
}
8888

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

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

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

Diff for: ‎commands/lib/resolve_deps.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ func LibraryResolveDependencies(ctx context.Context, req *rpc.LibraryResolveDepe
4141
// Extract all installed libraries
4242
installedLibs := map[string]*libraries.Library{}
4343
for _, lib := range listLibraries(lm, false, false) {
44-
installedLibs[lib.Library.Name] = lib.Library
44+
installedLibs[lib.Library.CanonicalName] = lib.Library
4545
}
4646

4747
// Resolve all dependencies...

Diff for: ‎commands/lib/uninstall.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ func LibraryUninstall(ctx context.Context, req *rpc.LibraryUninstallRequest, tas
5252
libsDir.Add(lib.InstallDir)
5353
}
5454
return &arduino.MultipleLibraryInstallDetected{
55-
LibName: libs[0].RealName,
55+
LibName: libs[0].Name,
5656
LibsDir: libsDir,
5757
Message: tr("Automatic library uninstall can't be performed in this case, please manually remove them."),
5858
}

Diff for: ‎commands/lib/upgrade.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ func upgrade(lm *librariesmanager.LibrariesManager, libs []*installedLib, downlo
8686

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

Diff for: ‎legacy/builder/container_find_includes.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ func findIncludesUntilDone(ctx *types.Context, cache *includeCache, sourceFile t
352352
// Fully precompiled libraries should have no dependencies
353353
// to avoid ABI breakage
354354
if ctx.Verbose {
355-
ctx.Info(tr("Skipping dependencies detection for precompiled library %[1]s", library.Name))
355+
ctx.Info(tr("Skipping dependencies detection for precompiled library %[1]s", library.CanonicalName))
356356
}
357357
return nil
358358
}

Diff for: ‎legacy/builder/create_cmake_rule.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ func (s *ExportProjectCMake) Run(ctx *types.Context) error {
7373
dynamicLibsFromPkgConfig := map[string]bool{}
7474
for _, library := range ctx.ImportedLibraries {
7575
// Copy used libraries in the correct folder
76-
libDir := libBaseFolder.Join(library.Name)
76+
libDir := libBaseFolder.Join(library.CanonicalName)
7777
mcu := ctx.BuildProperties.Get(constants.BUILD_PROPERTIES_BUILD_MCU)
7878
utils.CopyDir(library.InstallDir.String(), libDir.String(), validExportExtensions)
7979

0 commit comments

Comments
 (0)