-
Notifications
You must be signed in to change notification settings - Fork 0
/
generate.go
525 lines (478 loc) · 12.1 KB
/
generate.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
package main
import (
"bytes"
_ "embed"
"fmt"
"strings"
"text/template"
"unicode"
)
var (
//go:embed tmpls/base-unexported.go.tmpl
baseUnexportedTmplText string
//go:embed tmpls/usagefunc.go.tmpl
usgFnTmplText string
//go:embed tmpls/parsefunc.go.tmpl
parseFnTmplText string
)
func generate(incVersion bool, pkgName string, usgTextWidth int, usgLayoutKind string, root *command) ([]byte, error) {
g, err := newGenerator(usgTextWidth, usgLayoutKind)
if err != nil {
return nil, fmt.Errorf("initializing generator: %w", err)
}
if err = g.writeBase(incVersion, pkgName, root); err != nil {
return nil, err
}
if err = g.genCommandCode(root); err != nil {
return nil, err
}
return g.buf.Bytes(), nil
}
type generator struct {
buf bytes.Buffer
usgTextWidth int
usgLayoutKind string
usgFnTmpl *template.Template
parseFnTmpl *template.Template
}
func newGenerator(usgTextWidth int, usgLayoutKind string) (generator, error) {
usgFnTmpl := template.Must(template.New("usagefunc").Parse(usgFnTmplText))
parseFuncs := template.FuncMap{
"add": func(a, b int) int { return a + b },
}
parseFnTmpl, err := template.New("parsefunc").Funcs(parseFuncs).Parse(parseFnTmplText)
if err != nil {
return generator{}, fmt.Errorf("parsing template: %w", err)
}
return generator{
usgTextWidth: usgTextWidth,
usgLayoutKind: usgLayoutKind,
usgFnTmpl: usgFnTmpl,
parseFnTmpl: parseFnTmpl,
}, nil
}
type headerData struct {
PkgName string
Version string
HasBool bool
HasFloat bool
HasInt bool
HasUint bool
HasNumber bool
HasSubcmds bool
Types typeSet
NeedsEnvCode bool
}
func (g *generator) writeBase(incVersion bool, pkgName string, root *command) error {
ts := typeSet{}
root.getTypes(ts)
hasFloat := ts.HasAny("float32", "float64")
hasInt := ts.HasAny("int", "int8", "int16", "int32", "int64")
hasUint := ts.HasAny("uint", "uint8", "uint16", "uint32", "uint64")
data := headerData{
PkgName: pkgName,
Types: ts,
HasBool: ts.HasAny("bool"),
HasFloat: hasFloat,
HasInt: hasInt,
HasUint: hasUint,
HasNumber: hasFloat || hasInt || hasUint,
HasSubcmds: root.HasSubcmds(),
NeedsEnvCode: root.HasEnvArgOrOptSomewhere(),
}
if incVersion {
data.Version = getBuildVersionInfo().String()
}
baseTmpl := template.Must(template.New("clapbase").Parse(baseUnexportedTmplText))
if err := baseTmpl.Execute(&g.buf, &data); err != nil {
return fmt.Errorf("executing base template: %w", err)
}
return nil
}
func (c *command) getTypes(ts typeSet) {
for _, o := range c.Opts {
if o.Name != "h" {
ts[o.FieldType] = struct{}{}
}
}
for _, a := range c.Args {
ts[a.FieldType] = struct{}{}
}
for _, sc := range c.Subcmds {
sc.getTypes(ts)
}
}
type typeSet map[basicType]struct{}
func (ts typeSet) HasAny(names ...basicType) bool {
for i := range names {
if _, ok := ts[names[i]]; ok {
return true
}
}
return false
}
func (t basicType) ClapValueType() string {
switch t {
case "bool":
return "Bool"
case "string":
return "String"
case "float32", "float64":
return "Float"
case "int", "int8", "int16", "int32", "int64", "rune":
return "Int"
case "uint", "uint8", "uint16", "uint32", "uint64", "byte":
return "Uint"
default:
panic("unknown basic type: " + t)
}
}
func (g *generator) genCommandCode(c *command) error {
for i := range c.Subcmds {
if err := g.genCommandCode(&c.Subcmds[i]); err != nil {
return err
}
}
if err := g.genCmdUsageFunc(c); err != nil {
return fmt.Errorf("generating '%s' usage help: %w", c.TypeName, err)
}
if err := g.genCmdParseFunc(c); err != nil {
return fmt.Errorf("generating '%s' parse func: %w", c.TypeName, err)
}
return nil
}
type usgTmplData struct {
OptUsgs []string
ArgUsgs []string
SubcmdUsgs []string
*command
}
func (g *generator) genCmdUsageFunc(c *command) error {
optUsgs := make([]string, len(c.Opts))
{
var optNameColWidth int
for _, o := range c.Opts {
if l := len(o.usgNameAndArg()); l > optNameColWidth {
optNameColWidth = l
}
}
for i, o := range c.Opts {
switch g.usgLayoutKind {
case "roomy":
var extra string
{
if v, ok := o.data.getConfig("default"); ok {
extra += "\n [default: " + v + "]"
}
if v, ok := o.data.getConfig("env"); ok {
extra += "\n [env: " + v + "]"
}
}
content := " " + o.usgNameAndArg() + "\n"
content += " " + wrapBlurb(o.data.Blurb, 6, g.usgTextWidth)
if extra != "" {
content += "\n" + extra
}
if i < len(c.Opts)-1 {
content += "\n"
}
optUsgs[i] = content
default:
paddedNameAndArg := fmt.Sprintf(" %-*s ", optNameColWidth, o.usgNameAndArg())
desc := o.data.Blurb
if v, ok := o.data.getConfig("default"); ok {
desc += " (default: " + v + ")"
}
if v, ok := o.data.getConfig("env"); ok {
desc += " [$" + v + "]"
}
optUsgs[i] = paddedNameAndArg + wrapBlurb(desc, len(paddedNameAndArg), g.usgTextWidth)
}
}
}
argUsgs := make([]string, len(c.Args))
{
var argNameColWidth int
for _, a := range c.Args {
if l := len(a.UsgName()); l > argNameColWidth {
argNameColWidth = l
}
}
for i, a := range c.Args {
switch g.usgLayoutKind {
case "roomy":
var extra string
{
if v, ok := a.data.getConfig("default"); ok {
extra += "\n [default: " + v + "]"
}
if v, ok := a.data.getConfig("env"); ok {
extra += "\n [env: " + v + "]"
}
}
content := " " + a.UsgName() + "\n"
content += " " + wrapBlurb(a.data.Blurb, 6, g.usgTextWidth)
if extra != "" {
content += "\n" + extra
}
if i < len(c.Args)-1 {
content += "\n"
}
argUsgs[i] = content
default:
paddedName := fmt.Sprintf(" %-*s ", argNameColWidth, a.UsgName())
desc := a.data.Blurb
if v, ok := a.data.getConfig("default"); ok {
desc += " (default: " + v + ")"
}
if v, ok := a.data.getConfig("env"); ok {
desc += " [$" + v + "]"
}
argUsgs[i] = paddedName + wrapBlurb(desc, len(paddedName), g.usgTextWidth)
}
}
}
subcmdUsgs := make([]string, len(c.Subcmds))
{
var subcmdNameColWidth int
for _, sc := range c.Subcmds {
if l := len(sc.UsgName()); l > subcmdNameColWidth {
subcmdNameColWidth = l
}
}
for i, sc := range c.Subcmds {
switch g.usgLayoutKind {
case "roomy":
content := " " + sc.UsgName() + "\n"
content += " " + wrapBlurb(sc.Data.Blurb, 6, g.usgTextWidth)
if i < len(c.Subcmds)-1 {
content += "\n"
}
subcmdUsgs[i] = content
default:
paddedName := fmt.Sprintf(" %-*s ", subcmdNameColWidth, sc.UsgName())
subcmdUsgs[i] = paddedName + wrapBlurb(sc.Data.Blurb, len(paddedName), g.usgTextWidth)
}
}
}
err := g.usgFnTmpl.Execute(&g.buf, usgTmplData{
OptUsgs: optUsgs,
ArgUsgs: argUsgs,
SubcmdUsgs: subcmdUsgs,
command: c,
})
if err != nil {
return err
}
return nil
}
func (g *generator) genCmdParseFunc(c *command) error {
err := g.parseFnTmpl.Execute(&g.buf, c)
if err != nil {
return err
}
return nil
}
func (c *command) Defaults() string {
var s string
for _, o := range c.Opts {
if defVal, ok := o.data.getConfig("default"); ok {
s += fmt.Sprintf("\tc.%s = %s\n", o.FieldName, defVal)
}
}
for _, a := range c.Args {
if defVal, ok := a.data.getConfig("default"); ok {
s += fmt.Sprintf("\tc.%s = %s\n", a.FieldName, defVal)
}
}
return s
}
func (c *command) Parents() string {
s := ""
for i := range c.parentNames {
s += c.parentNames[i] + " "
}
return s
}
func (c *command) UsageLines() []string {
var us []string
for _, cfg := range c.Data.configs {
if cfg.key == "cmd_usage" {
us = append(us, c.UsgName()+" "+cfg.val)
}
}
if len(us) > 0 {
return us
}
optionsSlot := " [options]" // Every command has at least the help options for now.
commandSlot := ""
if c.HasSubcmds() {
commandSlot = " <command>"
}
argsSlot := ""
for i := range c.Args {
argsSlot += " " + c.Args[i].UsgName()
}
return []string{
c.UsgName() + optionsSlot + commandSlot + argsSlot,
}
}
// QuotedNames returns a comma separated list of this command's name, plus any aliases,
// each in double quotes.
func (c *command) QuotedNames() string {
s := "\"" + c.UsgName() + "\""
if csv, ok := c.Data.getConfig("cmd_aliases"); ok {
for _, alias := range strings.Split(csv, ",") {
s += ", \"" + strings.TrimSpace(alias) + "\""
}
}
return s
}
func (c *command) Overview() string {
paras := c.Data.overview
var s strings.Builder
for i := range paras {
s.WriteString(" ")
// Drop any trailing new lines from the last paragraph so that there won't be any
// extra space separating it from the options section that follows.
if i == len(paras)-1 {
s.WriteString(strings.TrimRight(paras[i], "\n"))
} else {
s.WriteString(paras[i])
}
// Separate the over paragraphs with a blank line by ensuring each paragraph
// except the last one ends with two new lines.
if i != len(paras)-1 && !strings.HasSuffix(paras[i], "\n\n") {
s.WriteString("\n")
}
}
return s.String()
}
func (o *option) EnvVar() string {
name, _ := o.data.getConfig("env")
return name
}
func (a *argument) EnvVar() string {
name, _ := a.data.getConfig("env")
return name
}
func (a *argument) UsgName() string {
name := a.name
if v, ok := a.data.getConfig("arg_name"); ok {
name = v
}
if a.IsRequired() {
return "<" + name + ">"
}
return "[" + name + "]"
}
func (a *argument) IsRequired() bool {
_, ok := a.data.getConfig("arg_required")
return ok
}
func (o *option) usgNameAndArg() string {
s := "-" + o.Name
if an := o.usgArgName(); an != "" {
s += " " + an
}
return s
}
// usgArgName returns the usage text of an option argument for non-boolean options. For
// example, if there's a string option named `file`, the usage might look something like
// `--file <arg>` where "<arg>" is the usage argument name text.
func (o *option) usgArgName() string {
if o.FieldType.IsBool() {
return ""
}
if name, ok := o.data.getConfig("opt_arg_name"); ok {
return "<" + name + ">"
}
return "<arg>"
}
// HasEnvArgOrOptSomewhere returns true if this command or one of its subcommands contains
// an option or an argument that uses an environment variable config.
func (c *command) HasEnvArgOrOptSomewhere() bool {
for i := range c.Opts {
if _, ok := c.Opts[i].data.getConfig("env"); ok {
return true
}
}
for i := range c.Args {
if _, ok := c.Args[i].data.getConfig("env"); ok {
return true
}
}
for i := range c.Subcmds {
if c.Subcmds[i].HasEnvArgOrOptSomewhere() {
return true
}
}
return false
}
func (c *command) HasNonHelpOpts() bool {
for i := range c.Opts {
if c.Opts[i].Name != "h" {
return true
}
}
return false
}
func (c *command) HasSubcmds() bool { return len(c.Subcmds) > 0 }
func wrapBlurb(v string, indentLen, lineLen int) string {
s := wrapText(v, indentLen, lineLen)
return s[indentLen:]
}
type wordWrapper struct {
indent string
word strings.Builder
line strings.Builder
result strings.Builder
}
func wrapText(v string, indentLen, lineLen int) string {
var ww wordWrapper
ww.indent = strings.Repeat(" ", indentLen)
ww.word.Grow(lineLen)
ww.line.Grow(lineLen)
ww.line.WriteString(ww.indent)
ww.result.Grow(len(v))
for _, c := range strings.TrimSpace(v) {
if !unicode.IsSpace(c) {
ww.word.WriteRune(c)
continue
}
if c == '\n' {
ww.takeWordAndReset()
ww.takeLineAndReset()
continue
}
if ww.line.Len()+ww.word.Len() > lineLen {
ww.takeLineAndReset()
}
ww.takeWordAndReset()
ww.line.WriteRune(c)
}
if ww.word.Len() > 0 {
if ww.line.Len()+ww.word.Len() > lineLen {
ww.takeLineAndReset()
}
ww.takeWordAndReset()
}
if ww.line.Len() > 0 {
ww.result.WriteString(ww.line.String())
ww.line.Reset()
}
res := ww.result.String()
ww.result.Reset()
return res
}
func (ww *wordWrapper) takeWordAndReset() {
ww.line.WriteString(ww.word.String())
ww.word.Reset()
}
func (ww *wordWrapper) takeLineAndReset() {
ln := strings.TrimRightFunc(ww.line.String(), unicode.IsSpace) // remove trailing whitespace
ww.result.WriteString(ln)
ww.result.WriteRune('\n')
ww.line.Reset()
ww.line.WriteString(ww.indent)
}