/
gogen.go
539 lines (489 loc) · 13.8 KB
/
gogen.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
/*
This file is part of rclgo
Copyright © 2021 Technology Innovation Institute, United Arab Emirates
Licensed under the Apache License, Version 2.0 (the "License");
http://www.apache.org/licenses/LICENSE-2.0
*/
package gogen
import (
"errors"
"fmt"
"io"
"io/fs"
"os"
"path"
"path/filepath"
"regexp"
"runtime"
"strings"
"text/template"
"github.com/alessio/shellescape"
"github.com/kivilahtio/go-re/v0"
)
type Rule struct {
Pattern *regexp.Regexp
}
func NewRule(pattern string) (*Rule, error) {
re, err := regexp.Compile("^" + pattern + "$")
if err != nil {
return nil, err
}
return &Rule{Pattern: re}, nil
}
type RuleSet []*Rule
func (s RuleSet) Includes(str string) bool {
for _, r := range s {
if r.Pattern.MatchString(str) {
return true
}
}
return false
}
type Config struct {
RclgoImportPath string
MessageModulePrefix string
RootPaths []string
DestPath string
CGOFlagsPath string
RegexIncludes RuleSet
ROSPkgIncludes []string
GoPkgIncludes []string
LicenseHeader string
}
var DefaultConfig = Config{
RclgoImportPath: "github.com/tiiuae/rclgo",
MessageModulePrefix: "github.com/tiiuae/rclgo-msgs",
}
// RclgoRepoRootPath returns the path to the root of the rclgo repository.
// Panics if the path can't be determined.
func RclgoRepoRootPath() string {
_, file, _, ok := runtime.Caller(0)
if !ok {
panic("could not determine rclgo repo root path")
}
return filepath.Join(file, "../../..")
}
type Generator struct {
config *Config
cImportsByPkgAndType map[string]stringSet
allPkgs map[string]*rosPkgRef
actionMsgsNeeded bool
}
func New(config *Config) *Generator {
return &Generator{
config: config,
cImportsByPkgAndType: make(map[string]stringSet),
}
}
func (g *Generator) GeneratePrimitives() error {
return g.generateRclgoFile(
"primitive types",
filepath.Join(g.config.DestPath, "pkg/rclgo/primitives/primitives.gen.go"),
primitiveTypes,
templateData{"PMap": &primitiveTypeMappings},
)
}
func (g *Generator) GenerateRclgoFlags() error {
return g.generateRclgoFile(
"rclgo flags",
filepath.Join(g.config.DestPath, "pkg/rclgo/flags.gen.go"),
rclgoFlags,
templateData{"ROSIncludes": rclgoROSIncludes},
)
}
func (g *Generator) GenerateTestGogenFlags() error {
return g.generateRclgoFile(
"gogen flags",
filepath.Join(g.config.DestPath, "test/gogen/flags.gen.go"),
gogenTestFlags,
nil,
)
}
func (g *Generator) generateRclgoFile(fileType, destFilePath string, tmpl *template.Template, data templateData) error {
PrintErrf("Generating %s: %s\n", fileType, destFilePath)
return g.generateGoFile(destFilePath, tmpl, data)
}
func (g *Generator) GenerateROS2AllMessagesImporter() error {
pkgs := map[string]struct{}{}
for _, glob := range []string{"*/msg", "*/srv", "*/action"} {
dirs, err := filepath.Glob(filepath.Join(g.config.DestPath, glob))
if err != nil {
return err
}
for _, d := range dirs {
pkgs[path.Join(
filepath.Base(filepath.Dir(d)),
filepath.Base(d),
)] = struct{}{}
}
}
return g.generateGoFile(
filepath.Join(g.config.DestPath, "msgs.gen.go"),
ros2MsgImportAllPackage,
templateData{"Packages": pkgs},
)
}
var rclgoROSIncludes = []string{
"rcl",
"rmw",
"rosidl_runtime_c",
"rosidl_typesupport_interface",
"rcutils",
"rcl_action",
"action_msgs",
"unique_identifier_msgs",
"builtin_interfaces",
"rcl_yaml_param_parser",
}
func includeDirFlag(rootPath, rosPkg string) string {
return fmt.Sprintf("-I%s", filepath.Join(rootPath, "include", rosPkg))
}
func libDirFlag(rootPath string) string {
return fmt.Sprintf("-L%[1]s -Wl,-rpath=%[1]s", filepath.Join(rootPath, "lib"))
}
func prependFlagEnv(envVar string, flags []string) string {
return strings.Join(flags, " ") + " " + os.Getenv(envVar)
}
func writeFlagEnv(w io.Writer, envVar string, flags stringSet) error {
_, err := fmt.Fprintf(w, "export CGO_%s=%s\n", envVar, shellescape.Quote(prependFlagEnv(envVar, flags.ToSortedSlice())))
return err
}
func (g *Generator) GenerateCGOFlags() error {
if g.config.CGOFlagsPath == "" {
return nil
}
PrintErrln("Generating CGO flags:", g.config.CGOFlagsPath)
libDirs := stringSet{}
includes := stringSet{}
for _, rootPath := range g.config.RootPaths {
libDirs.Add(libDirFlag(rootPath))
for _, dep := range rclgoROSIncludes {
includes.Add(includeDirFlag(rootPath, dep))
}
for pkgAndType, imports := range g.cImportsByPkgAndType {
pkg, _, err := parsePkgAndType(pkgAndType)
if err != nil {
PrintErrf("Failed to parse package and type from %s: %v\n", pkgAndType, err)
continue
}
includes.Add(includeDirFlag(rootPath, pkg))
for imp := range imports {
includes.Add(includeDirFlag(rootPath, imp))
}
}
}
var err error
out := os.Stdout
if g.config.CGOFlagsPath != "-" {
out, err = mkdir_p(g.config.CGOFlagsPath)
if err != nil {
return err
}
defer out.Close()
}
if err := writeFlagEnv(out, "CFLAGS", includes); err != nil {
return err
}
return writeFlagEnv(out, "LDFLAGS", libDirs)
}
type rosPkgRef struct {
Interfaces map[Metadata]string
Generated bool
}
func (g *Generator) GenerateGolangMessageTypes() error {
g.findPackages()
if len(g.config.RegexIncludes) == 0 && len(g.config.ROSPkgIncludes) == 0 && len(g.config.GoPkgIncludes) == 0 {
for pkg := range g.allPkgs {
g.generatePkg(pkg, false)
}
} else {
for _, pkg := range g.config.ROSPkgIncludes {
g.generatePkg(pkg, true)
}
goDeps, err := loadGoPkgDeps(g.config.GoPkgIncludes...)
if err != nil {
return fmt.Errorf("failed to load Go deps: %w", err)
}
prefix := g.config.MessageModulePrefix + "/"
for goDep := range goDeps {
pkgWithType := strings.TrimPrefix(goDep, prefix)
if pkgWithType != goDep {
g.generatePkg(path.Dir(pkgWithType), true)
}
}
if g.actionMsgsNeeded {
g.generatePkg("action_msgs", true)
}
for pkg := range g.allPkgs {
if g.config.RegexIncludes.Includes(pkg) {
g.generatePkg(pkg, false)
}
}
}
for pkgAndType, imports := range g.cImportsByPkgAndType {
err := g.generateCommonPackageGoFile(pkgAndType, imports)
if err != nil {
PrintErrf("Failed to generate common package file for package %s: %v\n", pkgAndType, err)
}
}
return nil
}
func (g *Generator) generatePkg(pkg string, genDeps bool) {
ref := g.allPkgs[pkg]
if ref == nil {
PrintErrf("Failed to generate package %s: package not found\n", pkg)
} else if !ref.Generated {
ref.Generated = true
for meta, path := range ref.Interfaces {
g.generateInterface(meta, path)
}
if genDeps {
for imp := range g.cImportsByPkgAndType[pkg+"_msg"] {
g.generatePkg(imp, genDeps)
}
for imp := range g.cImportsByPkgAndType[pkg+"_srv"] {
g.generatePkg(imp, genDeps)
}
for imp := range g.cImportsByPkgAndType[pkg+"_action"] {
g.generatePkg(imp, genDeps)
}
}
}
}
func (g *Generator) getCImportsForPkgAndType(pkgAndType string) stringSet {
set := g.cImportsByPkgAndType[pkgAndType]
if set == nil {
set = stringSet{}
g.cImportsByPkgAndType[pkgAndType] = set
}
return set
}
func (g *Generator) generateInterface(meta Metadata, ifacePath string) {
PrintErrf("Generating: %s\n", ifacePath)
switch meta.Type {
case "msg":
result, err := g.generateMessage(&meta, ifacePath)
if err != nil {
PrintErrf("Error converting ROS2 Message '%s' to '%s', error: %v\n", ifacePath, g.config.DestPath, err)
}
set := g.getCImportsForPkgAndType(result.GoPackage())
set.AddFrom(result.CImports)
case "srv":
result, err := g.generateService(&meta, ifacePath)
if err != nil {
PrintErrf("Error converting ROS2 Service '%s' to '%s', error: %v\n", ifacePath, g.config.DestPath, err)
}
set := g.getCImportsForPkgAndType(result.GoPackage())
set.AddFrom(result.Request.CImports)
set.AddFrom(result.Response.CImports)
case "action":
result, err := g.generateAction(ifacePath)
if err != nil {
PrintErrf("Error converting ROS2 Action '%s' to '%s', error: %v\n", ifacePath, g.config.DestPath, err)
}
g.actionMsgsNeeded = true
set := g.getCImportsForPkgAndType(result.GoPackage())
set.AddFrom(result.Goal.CImports)
set.AddFrom(result.SendGoal.Request.CImports)
set.AddFrom(result.SendGoal.Response.CImports)
set.AddFrom(result.Result.CImports)
set.AddFrom(result.GetResult.Request.CImports)
set.AddFrom(result.GetResult.Response.CImports)
set.AddFrom(result.Feedback.CImports)
set.AddFrom(result.FeedbackMessage.CImports)
default:
PrintErrf("Interface file %s has an invalid type: %s\n", ifacePath, meta.Type)
}
}
func (g *Generator) findPackages() {
g.allPkgs = map[string]*rosPkgRef{}
for i := len(g.config.RootPaths) - 1; i >= 0; i-- {
filepath.Walk(g.config.RootPaths[i], func(path string, info fs.FileInfo, err error) error { //nolint:errcheck
skip, blacklistEntry := blacklisted(path)
if skip {
PrintErrf("Blacklisted: %s, matched regex '%s'\n", path, blacklistEntry)
return nil
}
if re.M(filepath.ToSlash(path), `m!/(msg/.+\.msg)|(srv/.+\.srv)|(action/.+\.action)$!`) {
meta, err := parseMetadataFromPath(path)
if err != nil {
PrintErrf("Failed to parse metadata from path %s: %v\n", path, err)
} else {
ref := g.allPkgs[meta.Package]
if ref == nil {
ref = &rosPkgRef{Interfaces: map[Metadata]string{}}
g.allPkgs[meta.Package] = ref
}
ref.Interfaces[*meta] = path
}
}
return nil
})
}
}
func (g *Generator) generateMessage(md *Metadata, sourcePath string) (*ROS2Message, error) {
msg := ROS2MessageNew("", "")
var err error
msg.Metadata = md
content, err := os.ReadFile(sourcePath)
if err != nil {
return nil, err
}
parser := parser{config: g.config}
err = parser.ParseROS2Message(msg, string(content))
if err != nil {
return nil, err
}
err = g.generateMessageGoFile(&parser, msg)
if err != nil {
return nil, err
}
return msg, nil
}
func parseMetadataFromPath(p string) (*Metadata, error) {
base := filepath.Base(p)
ext := filepath.Ext(base)
m := &Metadata{
Name: strings.TrimSuffix(base, ext),
Type: ext[1:],
}
dirs := strings.Split(p, string(filepath.Separator))
if len(dirs) >= 2 {
m.Package = dirs[len(dirs)-3]
} else {
return nil, fmt.Errorf("Path '%s' cannot be parsed for ROS2 package name!", p)
}
return m, nil
}
func ifaceFilePath(destPathPkgRoot string, m *Metadata) string {
return filepath.Join(destPathPkgRoot, m.ImportPath(), m.Name+".gen.go")
}
func (g *Generator) generateService(m *Metadata, srcPath string) (*ROS2Service, error) {
service := NewROS2Service(m.Package, m.Name)
srcFile, err := os.ReadFile(filepath.Clean(srcPath))
if err != nil {
return nil, err
}
parser := parser{config: g.config}
if err = parser.ParseService(service, string(srcFile)); err != nil {
return nil, err
}
err = g.generateServiceGoFiles(&parser, service)
if err != nil {
return nil, err
}
return service, nil
}
func (g *Generator) generateAction(srcPath string) (*ROS2Action, error) {
m, err := parseMetadataFromPath(srcPath)
if err != nil {
return nil, err
}
action := NewROS2Action(m.Package, m.Name)
srcFile, err := os.ReadFile(srcPath)
if err != nil {
return nil, err
}
parser := parser{config: g.config}
if err = parser.ParseAction(action, string(srcFile)); err != nil {
return nil, err
}
err = g.generateIfaceGoFile(
action.Metadata,
ros2ActionToGolangTypeTemplate,
templateData{"Action": action},
)
if err != nil {
return nil, err
}
err = g.generateMessageGoFile(&parser, action.Goal)
if err != nil {
return nil, err
}
err = g.generateMessageGoFile(&parser, action.Result)
if err != nil {
return nil, err
}
err = g.generateMessageGoFile(&parser, action.Feedback)
if err != nil {
return nil, err
}
err = g.generateServiceGoFiles(&parser, action.SendGoal)
if err != nil {
return nil, err
}
err = g.generateServiceGoFiles(&parser, action.GetResult)
if err != nil {
return nil, err
}
err = g.generateMessageGoFile(&parser, action.FeedbackMessage)
if err != nil {
return nil, err
}
return action, nil
}
type templateData = map[string]interface{}
func (g *Generator) generateGoFile(destPath string, tmpl *template.Template, data templateData) error {
f, err := mkdir_p(destPath)
if err != nil {
return err
}
defer f.Close()
if data == nil {
data = templateData{"Config": g.config}
} else if _, ok := data["Config"]; !ok {
data["Config"] = g.config
}
return tmpl.Execute(f, data)
}
func (g *Generator) generateIfaceGoFile(meta *Metadata, tmpl *template.Template, data templateData) error {
return g.generateGoFile(ifaceFilePath(g.config.DestPath, meta), tmpl, data)
}
func (g *Generator) generateMessageGoFile(parser *parser, msg *ROS2Message) error {
return g.generateIfaceGoFile(
msg.Metadata,
ros2MsgToGolangTypeTemplate,
templateData{
"Message": msg,
"cSerializationCode": parser.cSerializationCode,
"goSerializationCode": parser.goSerializationCode,
},
)
}
func (g *Generator) generateServiceGoFiles(parser *parser, srv *ROS2Service) error {
err := g.generateIfaceGoFile(
srv.Metadata,
ros2ServiceToGolangTypeTemplate,
templateData{"Service": srv},
)
if err != nil {
return err
}
err = g.generateMessageGoFile(parser, srv.Request)
if err != nil {
return err
}
return g.generateMessageGoFile(parser, srv.Response)
}
func (g *Generator) generateCommonPackageGoFile(pkgAndType string, cImports stringSet) error {
cPkg, pkgType, err := parsePkgAndType(pkgAndType)
if err != nil {
return err
}
return g.generateGoFile(
filepath.Join(g.config.DestPath, cPkg, pkgType, "common.gen.go"),
ros2PackageCommonTemplate,
templateData{
"GoPackage": pkgAndType,
"CPackage": cPkg,
"CImports": cImports,
},
)
}
func parsePkgAndType(pkgAndType string) (pkg string, typ string, err error) {
i := strings.LastIndex(pkgAndType, "_")
if i < 0 || i > len(pkgAndType)-1 {
return "", "", errors.New("package type suffix is missing or incorrect")
}
return pkgAndType[:i], pkgAndType[i+1:], nil
}