Skip to content

Navigation Menu

Sign in
Appearance settings

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

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 1908634

Browse filesBrowse files
cmagliecmaglie
committed
Use Name field where appropriate instead of CanonicalName 
1 parent f1e5094 commit 1908634
Copy full SHA for 1908634
Expand file treeCollapse file tree

19 files changed

+219
-213
lines changed

‎arduino/libraries/libraries.go

Copy file name to clipboardExpand all lines: arduino/libraries/libraries.go
+3-3Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ type Library struct {
8585

8686
func (library *Library) String() string {
8787
if library.Version.String() == "" {
88-
return library.CanonicalName
88+
return library.Name
8989
}
90-
return library.CanonicalName + "@" + library.Version.String()
90+
return library.Name + "@" + 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.CanonicalName,
120+
Name: library.Name,
121121
Author: library.Author,
122122
Maintainer: library.Maintainer,
123123
Sentence: library.Sentence,

‎arduino/libraries/librarieslist.go

Copy file name to clipboardExpand all lines: arduino/libraries/librarieslist.go
+2-2Lines changed: 2 additions & 2 deletions
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.CanonicalName == name {
58+
if lib.Name == 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.CanonicalName < b.CanonicalName
85+
return a.Name < b.Name
8686
})
8787
}
8888

‎arduino/libraries/librariesresolver/cpp.go

Copy file name to clipboardExpand all lines: arduino/libraries/librariesresolver/cpp.go
+13-13Lines changed: 13 additions & 13 deletions
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.CanonicalName).
138+
WithField("lib", lib.Name).
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.CanonicalName).Info(" library with the best matching name")
152+
logrus.WithField("lib", best.Name).Info(" library with the best matching name")
153153
return best
154154
}
155155

156156
found.SortByName()
157-
logrus.WithField("lib", found[0].CanonicalName).Info(" first library in alphabetic order")
157+
logrus.WithField("lib", found[0].Name).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.CanonicalName)
171-
realName := simplify(lib.Name)
170+
name := simplify(lib.Name)
171+
canonicalName := simplify(lib.CanonicalName)
172172

173173
priority := 0
174174

@@ -185,17 +185,17 @@ func computePriority(lib *libraries.Library, header, arch string) int {
185185
priority += 0
186186
}
187187

188-
if realName == header && name == header {
188+
if name == header && canonicalName == header {
189189
priority += 600
190-
} else if realName == header || name == header {
190+
} else if name == header || canonicalName == header {
191191
priority += 500
192-
} else if realName == header+"-master" || name == header+"-master" {
192+
} else if name == header+"-master" || canonicalName == header+"-master" {
193193
priority += 400
194-
} else if strings.HasPrefix(realName, header) || strings.HasPrefix(name, header) {
194+
} else if strings.HasPrefix(name, header) || strings.HasPrefix(canonicalName, header) {
195195
priority += 300
196-
} else if strings.HasSuffix(realName, header) || strings.HasSuffix(name, header) {
196+
} else if strings.HasSuffix(name, header) || strings.HasSuffix(canonicalName, header) {
197197
priority += 200
198-
} else if strings.Contains(realName, header) || strings.Contains(name, header) {
198+
} else if strings.Contains(name, header) || strings.Contains(canonicalName, header) {
199199
priority += 100
200200
}
201201

@@ -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.CanonicalName))
223+
wordsToTest = append(wordsToTest, simplify(lib.Name))
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.CanonicalName) {
235+
if closestName == simplify(lib.Name) {
236236
winner = lib
237237
break
238238
}

‎arduino/libraries/librariesresolver/cpp_test.go

Copy file name to clipboardExpand all lines: arduino/libraries/librariesresolver/cpp_test.go
+15-15Lines changed: 15 additions & 15 deletions
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{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"}}
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"}}
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-
CanonicalName: "Servo",
44+
Name: "Servo",
4545
Location: libraries.User,
4646
Architectures: []string{"avr", "sam", "samd"}}
4747
userServoAllArch := &libraries.Library{
48-
CanonicalName: "Servo",
48+
Name: "Servo",
4949
Location: libraries.User,
5050
Architectures: []string{"*"}}
5151
userServoNonavr := &libraries.Library{
52-
CanonicalName: "Servo",
52+
Name: "Servo",
5353
Location: libraries.User,
5454
Architectures: []string{"sam", "samd"}}
5555
userAnotherServo := &libraries.Library{
56-
CanonicalName: "AnotherServo",
56+
Name: "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-
CanonicalName: "SD",
81+
Name: "SD",
8282
Location: libraries.User,
8383
Architectures: []string{"*"}}
8484
builtinSDesp := &libraries.Library{
85-
CanonicalName: "SD",
85+
Name: "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").CanonicalName
136+
return resolver.ResolveFor(header, "avr").Name
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))

‎arduino/libraries/loader.go

Copy file name to clipboardExpand all lines: arduino/libraries/loader.go
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ func makeLegacyLibrary(path *paths.Path, location LibraryLocation) (*Library, er
131131
Location: location,
132132
SourceDir: path,
133133
Layout: FlatLayout,
134+
Name: path.Base(),
134135
CanonicalName: path.Base(),
135136
Architectures: []string{"*"},
136137
IsLegacy: true,

‎commands/compile/compile.go

Copy file name to clipboardExpand all lines: commands/compile/compile.go
+1-1Lines changed: 1 addition & 1 deletion
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.CanonicalName) + ": " + err.Error() + "\n"
208+
msg := tr("Error getting information for library %s", lib.Name) + ": " + err.Error() + "\n"
209209
errStream.Write([]byte(msg))
210210
}
211211
importedLibs = append(importedLibs, rpcLib)

‎commands/lib/resolve_deps.go

Copy file name to clipboardExpand all lines: commands/lib/resolve_deps.go
+1-1Lines changed: 1 addition & 1 deletion
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.CanonicalName] = lib.Library
44+
installedLibs[lib.Library.Name] = lib.Library
4545
}
4646

4747
// Resolve all dependencies...

‎legacy/builder/container_find_includes.go

Copy file name to clipboardExpand all lines: legacy/builder/container_find_includes.go
+1-1Lines changed: 1 addition & 1 deletion
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.CanonicalName))
355+
ctx.Info(tr("Skipping dependencies detection for precompiled library %[1]s", library.Name))
356356
}
357357
return nil
358358
}

‎legacy/builder/phases/libraries_builder.go

Copy file name to clipboardExpand all lines: legacy/builder/phases/libraries_builder.go
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ func findExpectedPrecompiledLibFolder(ctx *types.Context, library *libraries.Lib
8686
}
8787
}
8888

89-
ctx.Info(tr("Library %[1]s has been declared precompiled:", library.CanonicalName))
89+
ctx.Info(tr("Library %[1]s has been declared precompiled:", library.Name))
9090

9191
// Try directory with full fpuSpecs first, if available
9292
if len(fpuSpecs) > 0 {
@@ -129,7 +129,7 @@ func compileLibraries(ctx *types.Context, libraries libraries.List, buildPath *p
129129

130130
func compileLibrary(ctx *types.Context, library *libraries.Library, buildPath *paths.Path, buildProperties *properties.Map, includes []string) (paths.PathList, error) {
131131
if ctx.Verbose {
132-
ctx.Info(tr(`Compiling library "%[1]s"`, library.CanonicalName))
132+
ctx.Info(tr(`Compiling library "%[1]s"`, library.Name))
133133
}
134134
libraryBuildPath := buildPath.Join(library.CanonicalName)
135135

‎legacy/builder/print_used_libraries_if_verbose.go

Copy file name to clipboardExpand all lines: legacy/builder/print_used_libraries_if_verbose.go
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ func (s *PrintUsedLibrariesIfVerbose) Run(ctx *types.Context) error {
3636
if library.Version.String() == "" {
3737
ctx.Info(
3838
tr("Using library %[1]s in folder: %[2]s %[3]s",
39-
library.CanonicalName,
39+
library.Name,
4040
library.InstallDir,
4141
legacy))
4242
} else {
4343
ctx.Info(
4444
tr("Using library %[1]s at version %[2]s in folder: %[3]s %[4]s",
45-
library.CanonicalName,
45+
library.Name,
4646
library.Version,
4747
library.InstallDir,
4848
legacy))

‎legacy/builder/resolve_library.go

Copy file name to clipboardExpand all lines: legacy/builder/resolve_library.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ func ResolveLibrary(ctx *types.Context, header string) *libraries.Library {
4545
}
4646

4747
selected := resolver.ResolveFor(header, ctx.TargetPlatform.Platform.Architecture)
48-
if alreadyImported := importedLibraries.FindByName(selected.CanonicalName); alreadyImported != nil {
48+
if alreadyImported := importedLibraries.FindByName(selected.Name); alreadyImported != nil {
4949
// Certain libraries might have the same name but be different.
5050
// This usually happens when the user includes two or more custom libraries that have
5151
// different header name but are stored in a parent folder with identical name, like

‎legacy/builder/test/helper.go

Copy file name to clipboardExpand all lines: legacy/builder/test/helper.go
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,5 +84,5 @@ func (s ByLibraryName) Swap(i, j int) {
8484
s[i], s[j] = s[j], s[i]
8585
}
8686
func (s ByLibraryName) Less(i, j int) bool {
87-
return s[i].CanonicalName < s[j].CanonicalName
87+
return s[i].Name < s[j].Name
8888
}

‎legacy/builder/test/includes_to_include_folders_test.go

Copy file name to clipboardExpand all lines: legacy/builder/test/includes_to_include_folders_test.go
+11-11Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ func TestIncludesToIncludeFolders(t *testing.T) {
5959

6060
importedLibraries := ctx.ImportedLibraries
6161
require.Equal(t, 1, len(importedLibraries))
62-
require.Equal(t, "Bridge", importedLibraries[0].CanonicalName)
62+
require.Equal(t, "Bridge", importedLibraries[0].Name)
6363
}
6464

6565
func TestIncludesToIncludeFoldersSketchWithIfDef(t *testing.T) {
@@ -131,8 +131,8 @@ func TestIncludesToIncludeFoldersIRremoteLibrary(t *testing.T) {
131131
importedLibraries := ctx.ImportedLibraries
132132
sort.Sort(ByLibraryName(importedLibraries))
133133
require.Equal(t, 2, len(importedLibraries))
134-
require.Equal(t, "Bridge", importedLibraries[0].CanonicalName)
135-
require.Equal(t, "IRremote", importedLibraries[1].CanonicalName)
134+
require.Equal(t, "Bridge", importedLibraries[0].Name)
135+
require.Equal(t, "IRremote", importedLibraries[1].Name)
136136
}
137137

138138
func TestIncludesToIncludeFoldersANewLibrary(t *testing.T) {
@@ -166,8 +166,8 @@ func TestIncludesToIncludeFoldersANewLibrary(t *testing.T) {
166166
importedLibraries := ctx.ImportedLibraries
167167
sort.Sort(ByLibraryName(importedLibraries))
168168
require.Equal(t, 2, len(importedLibraries))
169-
require.Equal(t, "ANewLibrary-master", importedLibraries[0].CanonicalName)
170-
require.Equal(t, "IRremote", importedLibraries[1].CanonicalName)
169+
require.Equal(t, "ANewLibrary-master", importedLibraries[0].Name)
170+
require.Equal(t, "IRremote", importedLibraries[1].Name)
171171
}
172172

173173
func TestIncludesToIncludeFoldersDuplicateLibs(t *testing.T) {
@@ -203,7 +203,7 @@ func TestIncludesToIncludeFoldersDuplicateLibs(t *testing.T) {
203203
importedLibraries := ctx.ImportedLibraries
204204
sort.Sort(ByLibraryName(importedLibraries))
205205
require.Equal(t, 1, len(importedLibraries))
206-
require.Equal(t, "SPI", importedLibraries[0].CanonicalName)
206+
require.Equal(t, "SPI", importedLibraries[0].Name)
207207
requireEquivalentPaths(t, importedLibraries[0].SourceDir.String(), filepath.Join("user_hardware", "my_avr_platform", "avr", "libraries", "SPI"))
208208
}
209209

@@ -241,7 +241,7 @@ func TestIncludesToIncludeFoldersDuplicateLibsWithConflictingLibsOutsideOfPlatfo
241241
importedLibraries := ctx.ImportedLibraries
242242
sort.Sort(ByLibraryName(importedLibraries))
243243
require.Equal(t, 1, len(importedLibraries))
244-
require.Equal(t, "SPI", importedLibraries[0].CanonicalName)
244+
require.Equal(t, "SPI", importedLibraries[0].Name)
245245
requireEquivalentPaths(t, importedLibraries[0].SourceDir.String(), filepath.Join("libraries", "SPI"))
246246
}
247247

@@ -279,7 +279,7 @@ func TestIncludesToIncludeFoldersDuplicateLibs2(t *testing.T) {
279279
importedLibraries := ctx.ImportedLibraries
280280
sort.Sort(ByLibraryName(importedLibraries))
281281
require.Equal(t, 1, len(importedLibraries))
282-
require.Equal(t, "USBHost", importedLibraries[0].CanonicalName)
282+
require.Equal(t, "USBHost", importedLibraries[0].Name)
283283
requireEquivalentPaths(t, importedLibraries[0].SourceDir.String(), filepath.Join("libraries", "USBHost", "src"))
284284
}
285285

@@ -317,7 +317,7 @@ func TestIncludesToIncludeFoldersSubfolders(t *testing.T) {
317317
importedLibraries := ctx.ImportedLibraries
318318
sort.Sort(ByLibraryName(importedLibraries))
319319
require.Equal(t, 3, len(importedLibraries))
320-
require.Equal(t, "testlib1", importedLibraries[0].CanonicalName)
321-
require.Equal(t, "testlib2", importedLibraries[1].CanonicalName)
322-
require.Equal(t, "testlib3", importedLibraries[2].CanonicalName)
320+
require.Equal(t, "testlib1", importedLibraries[0].Name)
321+
require.Equal(t, "testlib2", importedLibraries[1].Name)
322+
require.Equal(t, "testlib3", importedLibraries[2].Name)
323323
}

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.