Skip to content

Commit ccef5a1

Browse files
cmagliecmaglie
committed
Made FQBN parsing package public
Because it may turn out useful for other projects.
1 parent a9597d6 commit ccef5a1

17 files changed

+162
-154
lines changed

‎commands/service_board_details.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ import (
2020

2121
"github.com/arduino/arduino-cli/commands/cmderrors"
2222
"github.com/arduino/arduino-cli/commands/internal/instances"
23-
"github.com/arduino/arduino-cli/internal/arduino/cores"
2423
"github.com/arduino/arduino-cli/internal/arduino/utils"
24+
"github.com/arduino/arduino-cli/pkg/fqbn"
2525
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
2626
)
2727

@@ -34,7 +34,7 @@ func (s *arduinoCoreServerImpl) BoardDetails(ctx context.Context, req *rpc.Board
3434
}
3535
defer release()
3636

37-
fqbn, err := cores.ParseFQBN(req.GetFqbn())
37+
fqbn, err := fqbn.Parse(req.GetFqbn())
3838
if err != nil {
3939
return nil, &cmderrors.InvalidFQBNError{Cause: err}
4040
}
@@ -48,7 +48,7 @@ func (s *arduinoCoreServerImpl) BoardDetails(ctx context.Context, req *rpc.Board
4848
details.Name = board.Name()
4949
details.Fqbn = board.FQBN()
5050
details.PropertiesId = board.BoardID
51-
details.Official = fqbn.Package == "arduino"
51+
details.Official = fqbn.Packager == "arduino"
5252
details.Version = board.PlatformRelease.Version.String()
5353
details.IdentificationProperties = []*rpc.BoardIdentificationProperties{}
5454
for _, p := range board.GetIdentificationProperties() {

‎commands/service_board_list.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ import (
3030
"github.com/arduino/arduino-cli/commands/cmderrors"
3131
"github.com/arduino/arduino-cli/commands/internal/instances"
3232
f "github.com/arduino/arduino-cli/internal/algorithms"
33-
"github.com/arduino/arduino-cli/internal/arduino/cores"
3433
"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
3534
"github.com/arduino/arduino-cli/internal/cli/configuration"
3635
"github.com/arduino/arduino-cli/internal/i18n"
3736
"github.com/arduino/arduino-cli/internal/inventory"
37+
"github.com/arduino/arduino-cli/pkg/fqbn"
3838
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
3939
"github.com/arduino/go-properties-orderedmap"
4040
discovery "github.com/arduino/pluggable-discovery-protocol-handler/v2"
@@ -148,7 +148,7 @@ func identify(pme *packagemanager.Explorer, port *discovery.Port, settings *conf
148148
// first query installed cores through the Package Manager
149149
logrus.Debug("Querying installed cores for board identification...")
150150
for _, board := range pme.IdentifyBoard(port.Properties) {
151-
fqbn, err := cores.ParseFQBN(board.FQBN())
151+
fqbn, err := fqbn.Parse(board.FQBN())
152152
if err != nil {
153153
return nil, &cmderrors.InvalidFQBNError{Cause: err}
154154
}
@@ -210,10 +210,10 @@ func (s *arduinoCoreServerImpl) BoardList(ctx context.Context, req *rpc.BoardLis
210210
}
211211
defer release()
212212

213-
var fqbnFilter *cores.FQBN
213+
var fqbnFilter *fqbn.FQBN
214214
if f := req.GetFqbn(); f != "" {
215215
var err error
216-
fqbnFilter, err = cores.ParseFQBN(f)
216+
fqbnFilter, err = fqbn.Parse(f)
217217
if err != nil {
218218
return nil, &cmderrors.InvalidFQBNError{Cause: err}
219219
}
@@ -247,9 +247,9 @@ func (s *arduinoCoreServerImpl) BoardList(ctx context.Context, req *rpc.BoardLis
247247
}, nil
248248
}
249249

250-
func hasMatchingBoard(b *rpc.DetectedPort, fqbnFilter *cores.FQBN) bool {
250+
func hasMatchingBoard(b *rpc.DetectedPort, fqbnFilter *fqbn.FQBN) bool {
251251
for _, detectedBoard := range b.GetMatchingBoards() {
252-
detectedFqbn, err := cores.ParseFQBN(detectedBoard.GetFqbn())
252+
detectedFqbn, err := fqbn.Parse(detectedBoard.GetFqbn())
253253
if err != nil {
254254
continue
255255
}

‎commands/service_compile.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ import (
2828
"github.com/arduino/arduino-cli/commands/cmderrors"
2929
"github.com/arduino/arduino-cli/commands/internal/instances"
3030
"github.com/arduino/arduino-cli/internal/arduino/builder"
31-
"github.com/arduino/arduino-cli/internal/arduino/cores"
3231
"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesmanager"
3332
"github.com/arduino/arduino-cli/internal/arduino/sketch"
3433
"github.com/arduino/arduino-cli/internal/arduino/utils"
3534
"github.com/arduino/arduino-cli/internal/buildcache"
3635
"github.com/arduino/arduino-cli/internal/i18n"
3736
"github.com/arduino/arduino-cli/internal/inventory"
37+
"github.com/arduino/arduino-cli/pkg/fqbn"
3838
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
3939
paths "github.com/arduino/go-paths-helper"
4040
"github.com/sirupsen/logrus"
@@ -116,15 +116,15 @@ func (s *arduinoCoreServerImpl) Compile(req *rpc.CompileRequest, stream rpc.Ardu
116116
return &cmderrors.MissingFQBNError{}
117117
}
118118

119-
fqbn, err := cores.ParseFQBN(fqbnIn)
119+
fqbn, err := fqbn.Parse(fqbnIn)
120120
if err != nil {
121121
return &cmderrors.InvalidFQBNError{Cause: err}
122122
}
123123
_, targetPlatform, targetBoard, boardBuildProperties, buildPlatform, err := pme.ResolveFQBN(fqbn)
124124
if err != nil {
125125
if targetPlatform == nil {
126126
return &cmderrors.PlatformNotFoundError{
127-
Platform: fmt.Sprintf("%s:%s", fqbn.Package, fqbn.PlatformArch),
127+
Platform: fmt.Sprintf("%s:%s", fqbn.Packager, fqbn.Architecture),
128128
Cause: errors.New(i18n.Tr("platform not installed")),
129129
}
130130
}

‎commands/service_debug_config.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ import (
2727

2828
"github.com/arduino/arduino-cli/commands/cmderrors"
2929
"github.com/arduino/arduino-cli/commands/internal/instances"
30-
"github.com/arduino/arduino-cli/internal/arduino/cores"
3130
"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
3231
"github.com/arduino/arduino-cli/internal/arduino/sketch"
3332
"github.com/arduino/arduino-cli/internal/i18n"
33+
"github.com/arduino/arduino-cli/pkg/fqbn"
3434
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
3535
"github.com/arduino/go-paths-helper"
3636
"github.com/arduino/go-properties-orderedmap"
@@ -76,7 +76,7 @@ func (s *arduinoCoreServerImpl) IsDebugSupported(ctx context.Context, req *rpc.I
7676

7777
// Compute the minimum FQBN required to get the same debug configuration.
7878
// (i.e. the FQBN cleaned up of the options that do not affect the debugger configuration)
79-
minimumFQBN := cores.MustParseFQBN(req.GetFqbn())
79+
minimumFQBN := fqbn.MustParse(req.GetFqbn())
8080
for _, config := range minimumFQBN.Configs.Keys() {
8181
checkFQBN := minimumFQBN.Clone()
8282
checkFQBN.Configs.Remove(config)
@@ -127,7 +127,7 @@ func (s *arduinoCoreServerImpl) getDebugProperties(req *rpc.GetDebugConfigReques
127127
if fqbnIn == "" {
128128
return nil, &cmderrors.MissingFQBNError{}
129129
}
130-
fqbn, err := cores.ParseFQBN(fqbnIn)
130+
fqbn, err := fqbn.Parse(fqbnIn)
131131
if err != nil {
132132
return nil, &cmderrors.InvalidFQBNError{Cause: err}
133133
}

‎commands/service_library_list.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ import (
2121

2222
"github.com/arduino/arduino-cli/commands/cmderrors"
2323
"github.com/arduino/arduino-cli/commands/internal/instances"
24-
"github.com/arduino/arduino-cli/internal/arduino/cores"
2524
"github.com/arduino/arduino-cli/internal/arduino/libraries"
2625
"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesindex"
2726
"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesmanager"
2827
"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesresolver"
2928
"github.com/arduino/arduino-cli/internal/i18n"
29+
"github.com/arduino/arduino-cli/pkg/fqbn"
3030
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
3131
)
3232

@@ -59,7 +59,7 @@ func (s *arduinoCoreServerImpl) LibraryList(ctx context.Context, req *rpc.Librar
5959
var allLibs []*installedLib
6060
if fqbnString := req.GetFqbn(); fqbnString != "" {
6161
allLibs = listLibraries(lme, li, req.GetUpdatable(), true)
62-
fqbn, err := cores.ParseFQBN(req.GetFqbn())
62+
fqbn, err := fqbn.Parse(req.GetFqbn())
6363
if err != nil {
6464
return nil, &cmderrors.InvalidFQBNError{Cause: err}
6565
}
@@ -77,8 +77,8 @@ func (s *arduinoCoreServerImpl) LibraryList(ctx context.Context, req *rpc.Librar
7777
}
7878
}
7979
if latest, has := filteredRes[lib.Library.Name]; has {
80-
latestPriority := librariesresolver.ComputePriority(latest.Library, "", fqbn.PlatformArch)
81-
libPriority := librariesresolver.ComputePriority(lib.Library, "", fqbn.PlatformArch)
80+
latestPriority := librariesresolver.ComputePriority(latest.Library, "", fqbn.Architecture)
81+
libPriority := librariesresolver.ComputePriority(lib.Library, "", fqbn.Architecture)
8282
if latestPriority >= libPriority {
8383
// Pick library with the best priority
8484
continue
@@ -87,7 +87,7 @@ func (s *arduinoCoreServerImpl) LibraryList(ctx context.Context, req *rpc.Librar
8787

8888
// Check if library is compatible with board specified by FBQN
8989
lib.Library.CompatibleWith = map[string]bool{
90-
fqbnString: lib.Library.IsCompatibleWith(fqbn.PlatformArch),
90+
fqbnString: lib.Library.IsCompatibleWith(fqbn.Architecture),
9191
}
9292

9393
filteredRes[lib.Library.Name] = lib

‎commands/service_monitor.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import (
2828
"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
2929
pluggableMonitor "github.com/arduino/arduino-cli/internal/arduino/monitor"
3030
"github.com/arduino/arduino-cli/internal/i18n"
31+
"github.com/arduino/arduino-cli/pkg/fqbn"
3132
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
3233
"github.com/arduino/go-properties-orderedmap"
3334
"github.com/djherbis/buffer"
@@ -237,7 +238,7 @@ func (s *arduinoCoreServerImpl) Monitor(stream rpc.ArduinoCoreService_MonitorSer
237238
return nil
238239
}
239240

240-
func findMonitorAndSettingsForProtocolAndBoard(pme *packagemanager.Explorer, protocol, fqbn string) (*pluggableMonitor.PluggableMonitor, *properties.Map, error) {
241+
func findMonitorAndSettingsForProtocolAndBoard(pme *packagemanager.Explorer, protocol, fqbnIn string) (*pluggableMonitor.PluggableMonitor, *properties.Map, error) {
241242
if protocol == "" {
242243
return nil, nil, &cmderrors.MissingPortProtocolError{}
243244
}
@@ -246,8 +247,8 @@ func findMonitorAndSettingsForProtocolAndBoard(pme *packagemanager.Explorer, pro
246247
boardSettings := properties.NewMap()
247248

248249
// If a board is specified search the monitor in the board package first
249-
if fqbn != "" {
250-
fqbn, err := cores.ParseFQBN(fqbn)
250+
if fqbnIn != "" {
251+
fqbn, err := fqbn.Parse(fqbnIn)
251252
if err != nil {
252253
return nil, nil, &cmderrors.InvalidFQBNError{Cause: err}
253254
}

‎commands/service_upload.go

+5-4
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import (
3232
"github.com/arduino/arduino-cli/internal/arduino/globals"
3333
"github.com/arduino/arduino-cli/internal/arduino/sketch"
3434
"github.com/arduino/arduino-cli/internal/i18n"
35+
"github.com/arduino/arduino-cli/pkg/fqbn"
3536
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
3637
paths "github.com/arduino/go-paths-helper"
3738
properties "github.com/arduino/go-properties-orderedmap"
@@ -53,15 +54,15 @@ func (s *arduinoCoreServerImpl) SupportedUserFields(ctx context.Context, req *rp
5354
}
5455
defer release()
5556

56-
fqbn, err := cores.ParseFQBN(req.GetFqbn())
57+
fqbn, err := fqbn.Parse(req.GetFqbn())
5758
if err != nil {
5859
return nil, &cmderrors.InvalidFQBNError{Cause: err}
5960
}
6061

6162
_, platformRelease, _, boardProperties, _, err := pme.ResolveFQBN(fqbn)
6263
if platformRelease == nil {
6364
return nil, &cmderrors.PlatformNotFoundError{
64-
Platform: fmt.Sprintf("%s:%s", fqbn.Package, fqbn.PlatformArch),
65+
Platform: fmt.Sprintf("%s:%s", fqbn.Packager, fqbn.Architecture),
6566
Cause: err,
6667
}
6768
} else if err != nil {
@@ -282,7 +283,7 @@ func (s *arduinoCoreServerImpl) runProgramAction(ctx context.Context, pme *packa
282283
return nil, &cmderrors.MissingProgrammerError{}
283284
}
284285

285-
fqbn, err := cores.ParseFQBN(fqbnIn)
286+
fqbn, err := fqbn.Parse(fqbnIn)
286287
if err != nil {
287288
return nil, &cmderrors.InvalidFQBNError{Cause: err}
288289
}
@@ -292,7 +293,7 @@ func (s *arduinoCoreServerImpl) runProgramAction(ctx context.Context, pme *packa
292293
_, boardPlatform, board, boardProperties, buildPlatform, err := pme.ResolveFQBN(fqbn)
293294
if boardPlatform == nil {
294295
return nil, &cmderrors.PlatformNotFoundError{
295-
Platform: fmt.Sprintf("%s:%s", fqbn.Package, fqbn.PlatformArch),
296+
Platform: fmt.Sprintf("%s:%s", fqbn.Packager, fqbn.Architecture),
296297
Cause: err,
297298
}
298299
} else if err != nil {

‎commands/service_upload_list_programmers.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import (
2121
"github.com/arduino/arduino-cli/commands/cmderrors"
2222
"github.com/arduino/arduino-cli/commands/internal/instances"
2323
"github.com/arduino/arduino-cli/internal/arduino/cores"
24+
"github.com/arduino/arduino-cli/pkg/fqbn"
2425
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
2526
)
2627

@@ -36,7 +37,7 @@ func (s *arduinoCoreServerImpl) ListProgrammersAvailableForUpload(ctx context.Co
3637
if fqbnIn == "" {
3738
return nil, &cmderrors.MissingFQBNError{}
3839
}
39-
fqbn, err := cores.ParseFQBN(fqbnIn)
40+
fqbn, err := fqbn.Parse(fqbnIn)
4041
if err != nil {
4142
return nil, &cmderrors.InvalidFQBNError{Cause: err}
4243
}

‎commands/service_upload_test.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ import (
2525
"github.com/arduino/arduino-cli/internal/arduino/cores"
2626
"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
2727
"github.com/arduino/arduino-cli/internal/arduino/sketch"
28+
"github.com/arduino/arduino-cli/pkg/fqbn"
2829
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
2930
paths "github.com/arduino/go-paths-helper"
3031
properties "github.com/arduino/go-properties-orderedmap"
@@ -60,15 +61,15 @@ func TestDetermineBuildPathAndSketchName(t *testing.T) {
6061
importFile string
6162
importDir string
6263
sketch *sketch.Sketch
63-
fqbn *cores.FQBN
64+
fqbn *fqbn.FQBN
6465
resBuildPath string
6566
resSketchName string
6667
}
6768

6869
blonk, err := sketch.New(paths.New("testdata/upload/Blonk"))
6970
require.NoError(t, err)
7071

71-
fqbn, err := cores.ParseFQBN("arduino:samd:mkr1000")
72+
fqbn, err := fqbn.Parse("arduino:samd:mkr1000")
7273
require.NoError(t, err)
7374

7475
srv := NewArduinoCoreServer().(*arduinoCoreServerImpl)

‎internal/arduino/builder/build_options_manager.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ import (
2222
"strings"
2323

2424
"github.com/arduino/arduino-cli/internal/arduino/builder/internal/utils"
25-
"github.com/arduino/arduino-cli/internal/arduino/cores"
2625
"github.com/arduino/arduino-cli/internal/arduino/sketch"
2726
"github.com/arduino/arduino-cli/internal/i18n"
27+
"github.com/arduino/arduino-cli/pkg/fqbn"
2828
"github.com/arduino/go-paths-helper"
2929
properties "github.com/arduino/go-properties-orderedmap"
3030
)
@@ -51,7 +51,7 @@ func newBuildOptions(
5151
builtInLibrariesDirs, buildPath *paths.Path,
5252
sketch *sketch.Sketch,
5353
customBuildProperties []string,
54-
fqbn *cores.FQBN,
54+
fqbn *fqbn.FQBN,
5555
clean bool,
5656
compilerOptimizationFlags string,
5757
runtimePlatformPath, buildCorePath *paths.Path,

‎internal/arduino/builder/builder.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ import (
3535
"github.com/arduino/arduino-cli/internal/arduino/libraries/librariesmanager"
3636
"github.com/arduino/arduino-cli/internal/arduino/sketch"
3737
"github.com/arduino/arduino-cli/internal/i18n"
38+
"github.com/arduino/arduino-cli/pkg/fqbn"
3839
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
3940
"github.com/arduino/go-paths-helper"
4041
"github.com/arduino/go-properties-orderedmap"
@@ -127,7 +128,7 @@ func NewBuilder(
127128
requestBuildProperties []string,
128129
hardwareDirs, otherLibrariesDirs paths.PathList,
129130
builtInLibrariesDirs *paths.Path,
130-
fqbn *cores.FQBN,
131+
fqbn *fqbn.FQBN,
131132
clean bool,
132133
sourceOverrides map[string]string,
133134
onlyUpdateCompilationDatabase bool,

‎internal/arduino/cores/board.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import (
2121
"sync"
2222

2323
"github.com/arduino/arduino-cli/internal/i18n"
24+
"github.com/arduino/arduino-cli/pkg/fqbn"
2425
"github.com/arduino/go-properties-orderedmap"
2526
)
2627

@@ -124,7 +125,7 @@ func (b *Board) GetConfigOptionValues(option string) *properties.Map {
124125

125126
// GetBuildProperties returns the build properties and the build
126127
// platform for the Board with the configuration passed as parameter.
127-
func (b *Board) GetBuildProperties(fqbn *FQBN) (*properties.Map, error) {
128+
func (b *Board) GetBuildProperties(fqbn *fqbn.FQBN) (*properties.Map, error) {
128129
b.buildConfigOptionsStructures()
129130

130131
// Override default configs with user configs
@@ -161,7 +162,7 @@ func (b *Board) GetBuildProperties(fqbn *FQBN) (*properties.Map, error) {
161162
// "cpu=atmega2560".
162163
// FIXME: deprecated, use GetBuildProperties instead
163164
func (b *Board) GeneratePropertiesForConfiguration(config string) (*properties.Map, error) {
164-
fqbn, err := ParseFQBN(b.String() + ":" + config)
165+
fqbn, err := fqbn.Parse(b.String() + ":" + config)
165166
if err != nil {
166167
return nil, errors.New(i18n.Tr("parsing fqbn: %s", err))
167168
}

0 commit comments

Comments
 (0)