/
messages_set.go
680 lines (610 loc) · 35.3 KB
/
messages_set.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
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
// Copyright © 2021 The Things Industries B.V.
// SPDX-License-Identifier: Apache-2.0
package gen
import (
"fmt"
"github.com/TheThingsIndustries/protoc-gen-go-flags/annotations"
"google.golang.org/protobuf/compiler/protogen"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/reflect/protoreflect"
"google.golang.org/protobuf/types/descriptorpb"
)
func (g *generator) messageHasSetFlags(message *protogen.Message, visited ...*protogen.Message) bool {
// No code is generated for map entries, so we also don't need to generate set flags.
if message.Desc.IsMapEntry() {
return false
}
var generateSetFlags bool
for _, field := range message.Fields {
// If the field has the (thethings.flags.field) option, and set is set, we need to generate set flags for the message.
fieldOpts := field.Desc.Options().(*descriptorpb.FieldOptions)
if !proto.HasExtension(fieldOpts, annotations.E_Field) {
continue
}
if fieldExt, ok := proto.GetExtension(fieldOpts, annotations.E_Field).(*annotations.FieldOptions); ok {
if fieldExt.Set == nil || fieldExt.GetSet() {
generateSetFlags = true
}
}
}
// Finally, the set field can still override to true or false if explicitly set.
messageOpts := message.Desc.Options().(*descriptorpb.MessageOptions)
if proto.HasExtension(messageOpts, annotations.E_Message) {
if messageExt, ok := proto.GetExtension(messageOpts, annotations.E_Message).(*annotations.MessageOptions); ok && messageExt.Set != nil {
generateSetFlags = *messageExt.Set
}
}
return generateSetFlags
}
func (g *generator) hasSemanticalFlag(message *protogen.Message, field *protogen.Field) bool {
var generateSemanticalFlags bool
// Semantical flags are only defined for messages.
if field.Desc.Kind() != protoreflect.MessageKind {
return false
}
// The `semantical` flag can be set by the message and/or the field itself.
// The field overrides the message flags.
messageOpts := message.Desc.Options().(*descriptorpb.MessageOptions)
if proto.HasExtension(messageOpts, annotations.E_Message) {
if messageExt, ok := proto.GetExtension(messageOpts, annotations.E_Message).(*annotations.MessageOptions); ok && messageExt.Semantical != nil {
generateSemanticalFlags = *messageExt.Semantical
}
}
fieldOpts := field.Desc.Options().(*descriptorpb.FieldOptions)
if proto.HasExtension(fieldOpts, annotations.E_Field) {
if fieldExt, ok := proto.GetExtension(fieldOpts, annotations.E_Field).(*annotations.FieldOptions); ok && fieldExt.Semantical != nil {
generateSemanticalFlags = *fieldExt.Semantical
}
}
return generateSemanticalFlags
}
func (g *generator) genMessageSetFlags(message *protogen.Message) {
g.P("// AddSetFlagsFor", message.GoIdent, " adds flags to select fields in ", message.GoIdent, ".")
g.P("func AddSetFlagsFor", message.GoIdent, "(flags *", pflagPackage.Ident("FlagSet"), ", prefix string, hidden bool) ", " {")
nextField:
for _, field := range message.Fields {
_, setFlag, hidden := g.getFieldFlagBoolOptions(field)
if setFlag != nil && !*setFlag {
continue nextField
}
semantical := g.hasSemanticalFlag(message, field)
var customFlagType *protogen.GoIdent
fieldOpts := field.Desc.Options()
if proto.HasExtension(fieldOpts, annotations.E_Field) {
customFlagType = parseGoIdent(proto.GetExtension(field.Desc.Options(), annotations.E_Field).(*annotations.FieldOptions).GetSetFlagNewFunc())
}
var enumAliasMap *protogen.GoIdent
// If field is enum, check if there is an alias map defined for it.
if field.Desc.Kind() == protoreflect.EnumKind {
enumOpts := field.Enum.Desc.Options()
if proto.HasExtension(enumOpts, annotations.E_Enum) {
enumAliasMap = parseGoIdent(proto.GetExtension(enumOpts, annotations.E_Enum).(*annotations.EnumOptions).GetAliasMap())
}
}
// If field is a wrapped enum, check if there is an alias map defined for it.
if field.Desc.Kind() == protoreflect.MessageKind && messageIsWrapper(field.Message) && field.Message.Fields[0].Desc.Kind() == protoreflect.EnumKind {
enumOpts := field.Message.Fields[0].Enum.Desc.Options()
if proto.HasExtension(enumOpts, annotations.E_Enum) {
enumAliasMap = parseGoIdent(proto.GetExtension(enumOpts, annotations.E_Enum).(*annotations.EnumOptions).GetAliasMap())
}
}
// Convert field name to flag name (underscore to dash).
flagName := flagNameReplacer.Replace(string(field.Desc.Name()))
// If field is oneof, add oneof field name to flag name.
if field.Oneof != nil {
flagName = flagNameReplacer.Replace(string(field.Oneof.Desc.Name())) + "." + flagName
}
if field.Desc.IsMap() {
// If the field is a map, the field type is a MapEntry message.
// In the MapEntry message, the first field is the key, and the second field is the value.
key := field.Message.Fields[0]
value := field.Message.Fields[1]
if key.Desc.Kind() != protoreflect.StringKind {
g.P("// FIXME: Skipping ", field.GoName, " because maps with ", key.Desc.Kind(), " key types are currently not supported.")
continue nextField
}
switch value.Desc.Kind() {
default:
g.P("flags.AddFlag(", flagspluginPackage.Ident("NewString"+g.libNameForField(value)+"MapFlag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), "", `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
case protoreflect.EnumKind:
g.P("// FIXME: Skipping ", field.GoName, " because maps with enum value types are currently not supported.")
case protoreflect.MessageKind:
switch {
case messageIsWrapper(value.Message):
wrappedField := value.Message.Fields[0]
if wrappedField.Desc.Kind() == protoreflect.EnumKind {
g.P("// FIXME: Skipping ", field.GoName, " because maps with enum value types are currently not supported.")
} else {
g.P("flags.AddFlag(", flagspluginPackage.Ident("NewString"+g.libNameForField(wrappedField)+"MapFlag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), "", `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
}
// Add only flags for supported WKTs.
case isSupportedWKTSliceOrMap(value.Message):
g.P("flags.AddFlag(", flagspluginPackage.Ident("NewString"+g.libNameForWKT(value.Message)+"MapFlag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), "", `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
default:
g.P("// FIXME: Skipping ", field.GoName, " because maps with message value types are currently not supported.")
}
}
continue nextField
}
if field.Desc.IsList() {
if customFlagType != nil {
// If flag has a custom new flag definition, add this and continue with next field.
g.P("flags.AddFlag(", *customFlagType, "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), "", `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
continue nextField
}
switch field.Desc.Kind() {
default:
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForField(field)+"SliceFlag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), "", `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
case protoreflect.EnumKind:
if enumAliasMap != nil {
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForField(field)+"SliceFlag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix),`, flagspluginPackage.Ident("EnumValueDesc("), field.Enum.GoIdent, "_value, ", *enumAliasMap, "), ", flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
continue nextField
}
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForField(field)+"SliceFlag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix),`, flagspluginPackage.Ident("EnumValueDesc("), field.Enum.GoIdent, "_value", "", "), ", flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
case protoreflect.MessageKind:
switch {
case messageIsWrapper(field.Message):
wrappedField := field.Message.Fields[0]
if wrappedField.Desc.Kind() == protoreflect.EnumKind {
if enumAliasMap != nil {
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForField(wrappedField)+"SliceFlag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix),`, flagspluginPackage.Ident("EnumValueDesc("), wrappedField.Enum.GoIdent, "_value, ", *enumAliasMap, "), ", flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
continue nextField
}
// If a wrapped field is enum, include enum value description.
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForField(wrappedField)+"SliceFlag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), `, flagspluginPackage.Ident("EnumValueDesc("), wrappedField.Enum.GoIdent, "_value), ", flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
} else {
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForField(wrappedField)+"SliceFlag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), "", `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
}
case messageIsWKT(field.Message):
if !isSupportedWKTSliceOrMap(field.Message) {
g.P("// FIXME: Skipping ", field.GoName, " because this repeated WKT is currently not supported.")
continue nextField
}
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForWKT(field.Message)+"SliceFlag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), "", `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
default:
g.P("// FIXME: Skipping ", field.GoName, " because repeated messages are currently not supported.")
}
}
continue nextField
}
if customFlagType != nil {
// If flag has a custom new flag definition, add this and continue with next field.
g.P("flags.AddFlag(", *customFlagType, "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), "", `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
continue nextField
}
switch field.Desc.Kind() {
default:
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForField(field)+"Flag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), "", `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
case protoreflect.EnumKind:
if enumAliasMap != nil {
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForField(field)+"Flag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix),`, flagspluginPackage.Ident("EnumValueDesc("), field.Enum.GoIdent, "_value, ", *enumAliasMap, "), ", flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
continue nextField
}
// If a field is enum, include enum value description.
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForField(field)+"Flag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), `, flagspluginPackage.Ident("EnumValueDesc("), field.Enum.GoIdent, "_value), ", flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
case protoreflect.MessageKind:
switch {
case g.messageHasSetFlags(field.Message):
// If the field is of type message, and the message has set flags, add those.
g.P(field.Message.GoIdent.GoImportPath.Ident("AddSetFlagsFor"+field.Message.GoIdent.GoName), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), `, ifThenElse((hidden || messageIsWrapper(field.Message)), "true", "hidden"), ")")
// If the field has a semantical meaning add a boolean flag for the flagName itself.
if semantical {
g.genSemanticalSetFlags(flagName, hidden)
}
if messageIsWrapper(field.Message) {
// If the message is a wrapper, include the parent flag as an alias that points to the wrapped flag value.
g.P(flagspluginPackage.Ident("AddAlias"), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `.value", prefix), `, flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), ")")
}
case messageIsWrapper(field.Message):
wrappedField := field.Message.Fields[0]
if wrappedField.Desc.Kind() == protoreflect.EnumKind {
if enumAliasMap != nil {
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForField(wrappedField)+"Flag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix),`, flagspluginPackage.Ident("EnumValueDesc("), wrappedField.Enum.GoIdent, "_value, ", *enumAliasMap, "), ", flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
g.P(flagspluginPackage.Ident("AddAlias"), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `.value", prefix), `, flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), ")")
continue nextField
}
// If a wrapped field is enum, include enum value description.
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForField(wrappedField)+"Flag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `.value", prefix), `, flagspluginPackage.Ident("EnumValueDesc("), field.Enum.GoIdent, "_value), ", flagspluginPackage.Ident("WithHidden"), "(true)", "))")
// If the message is a wrapper, include the parent flag as an alias that points to the wrapped flag value.
g.P(flagspluginPackage.Ident("AddAlias"), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `.value", prefix), `, flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), ")")
continue nextField
} else if messageIsWKT(field.Message) {
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForField(wrappedField)+"Flag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), "", `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
continue nextField
}
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForField(wrappedField)+"Flag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `.value", prefix), "", `, flagspluginPackage.Ident("WithHidden"), "(true)", "))")
// If the message is a wrapper, include the parent flag as an alias that points to the wrapped flag value.
g.P(flagspluginPackage.Ident("AddAlias"), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `.value", prefix), `, flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), ")")
case messageIsWKT(field.Message):
if !isSupportedWKT(field.Message) {
g.P("// FIXME: Skipping ", field.GoName, " because this WKT is currently not supported.")
continue nextField
}
g.P("flags.AddFlag(", flagspluginPackage.Ident("New"+g.libNameForWKT(field.Message)+"Flag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), "", `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
default:
// If the field is not of any known type but does have a semantical tag, generate a flag for it.
if semantical {
g.genSemanticalSetFlags(flagName, hidden)
} else {
g.P("// FIXME: Skipping ", field.GoName, " because it does not seem to implement AddSetFlags.")
}
}
}
}
g.P("}")
g.P()
}
func (g *generator) genMessageSetterFromFlags(message *protogen.Message) {
g.P("// SetFromFlags sets the ", message.GoIdent, " message from flags.")
g.P("func (m *", message.GoIdent, ") SetFromFlags(flags *", pflagPackage.Ident("FlagSet"), ", prefix string) (paths []string, err error) {")
nextField:
for _, field := range message.Fields {
_, setFlag, _ := g.getFieldFlagBoolOptions(field)
if setFlag != nil && !*setFlag {
continue nextField
}
semantical := g.hasSemanticalFlag(message, field)
var (
fieldGoName interface{} = fieldGoName(field)
customtype = fieldCustomType(field)
nullable = fieldIsNullable(field)
customGetter *protogen.GoIdent
)
fieldOpts := field.Desc.Options()
// If customtype annotation is set, the getter must be of format Get{CustomFlag} (with Slice appended if list).
if customtype != nil {
customGetter = flagFromCustomType(field)
} else if proto.HasExtension(fieldOpts, annotations.E_Field) {
// Otherwise if custom getter set, use the custom getter instead of underlying proto field type.
customGetter = parseGoIdent(proto.GetExtension(field.Desc.Options(), annotations.E_Field).(*annotations.FieldOptions).GetSetFlagGetterFunc())
}
var enumAliasMap *protogen.GoIdent
// If field is enum, check if there is an alias map defined for it.
if field.Desc.Kind() == protoreflect.EnumKind {
enumOpts := field.Enum.Desc.Options()
if proto.HasExtension(enumOpts, annotations.E_Enum) {
enumAliasMap = parseGoIdent(proto.GetExtension(enumOpts, annotations.E_Enum).(*annotations.EnumOptions).GetAliasMap())
}
}
// If field is a wrapped enum, check if there is an alias map defined for it.
if field.Desc.Kind() == protoreflect.MessageKind && messageIsWrapper(field.Message) && field.Message.Fields[0].Desc.Kind() == protoreflect.EnumKind {
enumOpts := field.Message.Fields[0].Enum.Desc.Options()
if proto.HasExtension(enumOpts, annotations.E_Enum) {
enumAliasMap = parseGoIdent(proto.GetExtension(enumOpts, annotations.E_Enum).(*annotations.EnumOptions).GetAliasMap())
}
}
flagName := field.Desc.Name()
if field.Oneof != nil {
// If field is oneof, add oneof field name to flag name.
flagName = field.Oneof.Desc.Name() + "." + flagName
}
if field.Desc.IsMap() {
// If custom getter is set for the field, use it to retrieve the flag value.
if customGetter != nil {
g.P("if val, changed, err := ", *customGetter, "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
g.P("return nil, err")
g.P("} else if ", "changed", "{")
g.P("m", ".", fieldGoName, " = val")
// If flag is set, append the path to the paths to be returned.
g.P("paths = append(paths, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix))`)
g.P("}")
continue nextField
}
// If customtype is set for the field, and there is no custom getter, fail immediately.
// This shouldn't happen because the getters are always generated for custom types whether they are there or not.
if customtype != nil {
g.gen.Error(fmt.Errorf("field with customtype %q doesn't have custom_flag_type set", message.Desc.FullName()))
return
}
// If the field is a map, the field type is a MapEntry message.
// In the MapEntry message, the first field is the key, and the second field is the value.
key := field.Message.Fields[0]
value := field.Message.Fields[1]
if key.Desc.Kind() != protoreflect.StringKind {
g.P("// FIXME: Skipping ", field.GoName, " because maps with ", key.Desc.Kind(), " key types are currently not supported.")
continue nextField
}
switch value.Desc.Kind() {
default:
g.P("if val, changed, err := ", flagspluginPackage.Ident("GetString"+g.libNameForField(value)+"Map"), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
g.P("return nil, err")
g.P("} else if ", "changed", "{")
g.P("m", ".", fieldGoName, " = val")
g.P("paths = append(paths, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix))`)
g.P("}")
case protoreflect.MessageKind:
switch {
case messageIsWrapper(value.Message):
// If value is a wrapped message, consider wrapped value type.
wrappedField := value.Message.Fields[0]
if wrappedField.Desc.Kind() == protoreflect.EnumKind {
g.P("// FIXME: Skipping ", field.GoName, " because maps with enum value types are currently not supported.")
continue nextField
}
g.P("if val, changed, err := ", flagspluginPackage.Ident("GetString"+g.libNameForField(wrappedField)+"Map"), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
g.P("return nil, err")
g.P("} else if changed", "{")
// If nullable is false, create a map without a pointer value.
g.P("m.", fieldGoName, " = make(map[", g.goTypeForField(key), "]", ifThenElse(fieldIsNullable(value), "*", ""), g.goTypeForField(value), ")")
g.P("for key, value := range val {")
// If field is a wrapper, every value needs to be converted to the go type for field and assigned to the map.
g.P("m", ".", fieldGoName, "[key] = ", ifThenElse(fieldIsNullable(value), "&", ""), g.goTypeForField(value), "{Value: value}")
g.P("}")
g.P("paths = append(paths, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix))`)
g.P("}")
case isSupportedWKTSliceOrMap(value.Message):
g.P("if val, changed, err := ", flagspluginPackage.Ident("GetString"+g.libNameForWKT(value.Message)+"Map"), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
g.P("return nil, err")
g.P("} else if changed", "{")
g.P("m.", fieldGoName, " = make(map[", g.goTypeForField(key), "]", ifThenElse(fieldIsNullable(value), "*", ""), g.goTypeForField(value), ")")
g.P("for key, value := range val {")
// If value is not a wrapper, but a supported WKT, convert the value to the proto type.
g.P("m", ".", fieldGoName, "[key] = ", g.readWKTValue(value, value.Message, "value"))
g.P("}")
g.P("paths = append(paths, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix))`)
g.P("}")
default:
g.P("// FIXME: Skipping ", field.GoName, " because maps with message value types are currently not supported.")
}
case protoreflect.EnumKind:
g.P("// FIXME: Skipping ", field.GoName, " because maps with enum value types are currently not supported.")
}
continue nextField
}
if field.Desc.IsList() {
// If custom getter is set for the field, use it to retrieve the flag value.
if customGetter != nil {
g.P("if val, changed, err := ", *customGetter, "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
g.P("return nil, err")
g.P("} else if changed", "{")
g.P("m", ".", fieldGoName, " = val")
g.P("paths = append(paths, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix))`)
g.P("}")
continue nextField
}
// If customtype is set for the field, and there is no custom getter, fail immediately.
// This shouldn't happen because the getters are always generated for custom types whether they are there or not.
if customtype != nil {
g.gen.Error(fmt.Errorf("field with customtype %q doesn't have custom_flag_type set", message.Desc.FullName()))
return
}
switch field.Desc.Kind() {
default:
// When getting slice flags, append `Slice` to the go flag getter.
g.P("if val, changed, err := ", flagspluginPackage.Ident("Get"+g.libNameForField(field)+"Slice"), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
g.P("return nil, err")
g.P("} else if changed", "{")
if field.Desc.Kind() == protoreflect.EnumKind {
g.P("m", ".", fieldGoName, " = make([]", field.Enum.GoIdent, ", len(val))")
g.P("for i, v := range val {")
// If field is enum slice, we first obtain the string representation for every value,
// then use `SetEnumString` and pass value map to return the int32 identifier for the enum.
if enumAliasMap != nil {
g.P("enumValue, err :=", flagspluginPackage.Ident("SetEnumString"), "(v, ", field.Enum.GoIdent, "_value, ", *enumAliasMap, ")")
} else {
g.P("enumValue, err :=", flagspluginPackage.Ident("SetEnumString"), "(v, ", field.Enum.GoIdent, "_value)")
}
g.ifErrNotNil()
// Pass the int32 identifier to proto generated function to get the enum value.
g.P("m", ".", fieldGoName, "[i] = ", field.Enum.GoIdent, "(enumValue)")
g.P("}")
} else {
// Otherwise just assign the slice value to the struct field.
g.P("m", ".", fieldGoName, " = val")
}
g.P("paths = append(paths, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix))`)
g.P("}")
case protoreflect.MessageKind:
switch {
case messageIsWrapper(field.Message):
// If message is a wrapper, we consider the underlying wrapped field type.
wrappedField := field.Message.Fields[0]
g.P("if val, changed, err := ", flagspluginPackage.Ident("Get"+g.libNameForField(wrappedField)+"Slice"), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
g.P("return nil, err")
g.P("} else if changed", "{")
g.P("m", ".", fieldGoName, " = make([]", ifThenElse(fieldIsNullable(field), "*", ""), field.Message.GoIdent, ", len(val))")
g.P("for i, value := range val {")
if wrappedField.Desc.Kind() == protoreflect.EnumKind {
// If field is enum slice, we first obtain the string representation for every value,
// then use `SetEnumString` and pass value map to return the int32 identifier for the enum.
if enumAliasMap != nil {
g.P("enumValue, err :=", flagspluginPackage.Ident("SetEnumString"), "(value, ", wrappedField.Enum.GoIdent, "_value, ", *enumAliasMap, ")")
} else {
g.P("enumValue, err :=", flagspluginPackage.Ident("SetEnumString"), "(value, ", wrappedField.Enum.GoIdent, "_value)")
}
g.ifErrNotNil()
// For wrapped message we need to assign the value to the wrapped struct field `Value`.
g.P("m.", fieldGoName, "[i] = &", field.Message.GoIdent, "{Value: ", wrappedField.Enum.GoIdent, "(enumValue)}")
} else {
// For wrapped message we need to assign the value to the wrapped struct field `Value`.
g.P("m.", fieldGoName, "[i] = &", field.Message.GoIdent, "{Value: value}")
}
g.P("}")
g.P("paths = append(paths, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix))`)
g.P("}")
case messageIsWKT(field.Message):
// Currently we support only FieldMask, Timestamp, and Duration WKTs (other than the wrapped WKTs).
if !isSupportedWKTSliceOrMap(field.Message) {
g.P("// FIXME: Skipping ", field.GoName, " because this repeated WKT is not supported")
continue nextField
}
g.P("if val, changed, err := ", flagspluginPackage.Ident("Get"+g.libNameForWKT(field.Message)+"Slice"), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
g.P("return nil, err")
g.P("} else if changed", "{")
g.P("m", ".", fieldGoName, " = make([]", ifThenElse(fieldIsNullable(field), "*", ""), field.Message.GoIdent, ", len(val))")
g.P("for i, value := range val {")
// For every WKT value in WKT slice we convert it to the timestamp proto type.
g.P("m.", fieldGoName, "[i] = ", g.readWKTValue(field, field.Message, "value"))
g.P("}")
g.P("paths = append(paths, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix))`)
g.P("}")
default:
g.P("// FIXME: Skipping ", field.GoName, " because it does not seem to implement AddSetFlags.")
}
}
continue nextField
}
// The identifier of the message is m, but in case of a oneof, we'll be operating on ov.
messageOrOneofIdent := "m"
// If this field is in a oneof, allocate a new oneof value wrapper.
if field.Oneof != nil {
messageOrOneofIdent = "ov"
}
// If custom getter is set for the field, use it to retrieve the flag value.
if customGetter != nil {
g.P("if val, changed, err := ", *customGetter, "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
g.P("return nil, err")
g.P("} else if changed", "{")
if field.Oneof != nil {
// If field is in a oneof, initialize an appropriate proto oneof type.
g.P(messageOrOneofIdent, " := &", field.GoIdent, "{}")
}
// Assign value to the underlying field of the proto oneof type.
if nullable {
g.P(messageOrOneofIdent, ".", fieldGoName, " = &val")
} else {
g.P(messageOrOneofIdent, ".", fieldGoName, " = val")
}
// Append set paths.
g.P("paths = append(paths, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix))`)
} else if customtype != nil {
g.gen.Error(fmt.Errorf("field with customtype %q doesn't have custom_flag_type set", message.Desc.FullName()))
return
} else {
switch field.Desc.Kind() {
default:
g.P("if val, changed, err := ", flagspluginPackage.Ident("Get"+g.libNameForField(field)), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
g.P("return nil, err")
g.P("} else if changed", "{")
// If field is in a oneof, initialize an appropriate proto oneof type.
if field.Oneof != nil {
g.P(messageOrOneofIdent, " := &", field.GoIdent, "{}")
}
// If field is enum , we first obtain the string representation for the value,
// then use `SetEnumString` and pass value map to return the int32 identifier for the enum.
if field.Desc.Kind() == protoreflect.EnumKind {
if enumAliasMap != nil {
g.P("enumValue, err :=", flagspluginPackage.Ident("SetEnumString"), "(val, ", field.Enum.GoIdent, "_value, ", *enumAliasMap, ")")
} else {
g.P("enumValue, err :=", flagspluginPackage.Ident("SetEnumString"), "(val, ", field.Enum.GoIdent, "_value)")
}
g.ifErrNotNil()
g.P(messageOrOneofIdent, ".", fieldGoName, " = ", field.Enum.GoIdent, "(enumValue)")
} else {
g.P(messageOrOneofIdent, ".", fieldGoName, " = val")
}
g.P("paths = append(paths, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix))`)
case protoreflect.MessageKind:
// If message is a wrapper, we consider wrapped field type.
fieldName := field
if messageIsWrapper(field.Message) {
fieldName = field.Message.Fields[0]
}
switch {
case g.messageHasSetFlags(field.Message):
// If field message has flag setter, we first check if any flags for the message are set.
g.P("if changed := ", flagspluginPackage.Ident("IsAnyPrefixSet(flags, "), flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); changed {`)
if field.Oneof != nil {
g.P(messageOrOneofIdent, " := &", field.GoIdent, "{}")
}
if nullable {
g.P("if ", messageOrOneofIdent, ".", fieldGoName, " == nil {")
g.P(messageOrOneofIdent, ".", fieldGoName, " =&", field.Message.GoIdent, "{}")
g.P("}")
}
// If any flags are set, we use the message setter to set the field, and obtain the set paths to return.
g.P("if setPaths, err := ", messageOrOneofIdent, ".", fieldGoName, ".SetFromFlags(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
g.P("return nil, err")
// If the flag is semantical there will be no paths returned, in this case append the flagName.
if semantical {
g.P("} else if len(setPaths) == 0 {")
g.P("paths = append(paths, ", `"`, flagName, `")`)
}
g.P("} else {")
g.P("paths = append(paths, setPaths...)")
g.P("}")
case messageIsWrapper(field.Message):
if messageIsWKT(field.Message) {
g.P("if val, changed, err := ", flagspluginPackage.Ident("Get"+g.libNameForField(fieldName)), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
} else {
// If the message is wrapper we get value directly from the {fieldName}.value flag.
g.P("if val, changed, err := ", flagspluginPackage.Ident("Get"+g.libNameForField(fieldName)), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `.value", prefix)); err != nil {`)
}
g.P("return nil, err")
g.P("} else if changed", "{")
if field.Oneof != nil {
g.P(messageOrOneofIdent, " := &", field.GoIdent, "{}")
}
g.P(messageOrOneofIdent, ".", fieldGoName, " = &", field.Message.GoIdent, "{Value: val}")
g.P("paths = append(paths, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix))`)
case messageIsWKT(field.Message):
// Currently we only support FieldMask, Duration and Timestamp WKT's, apart from wrapper types.
if !isSupportedWKT(field.Message) {
g.P("// FIXME: Skipping ", field.GoName, " because this WKT is not supported.")
continue nextField
}
g.P("if val, changed, err := ", flagspluginPackage.Ident("Get"+g.libNameForWKT(fieldName.Message)), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
g.P("return nil, err")
g.P("} else if changed", "{")
if field.Oneof != nil {
g.P(messageOrOneofIdent, " := &", field.GoIdent, "{}")
}
g.P(messageOrOneofIdent, ".", fieldGoName, " = ", g.readWKTValue(field, field.Message, "val"))
g.P("paths = append(paths, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix))`)
default:
// If the message is not of a known kind or has no set tag, generate a semantical handler.
if semantical {
g.P("if _, changed, err := ", flagspluginPackage.Ident("GetBool"), "(flags, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix)); err != nil {`)
g.P("return nil, err")
g.P("} else if changed {")
// If field is in a oneof, initialize an appropriate proto oneof type.
if field.Oneof != nil {
g.P(messageOrOneofIdent, " := &", field.GoIdent, "{}")
if nullable {
g.P("if ", messageOrOneofIdent, ".", fieldGoName, " == nil {")
g.P(messageOrOneofIdent, ".", fieldGoName, " =&", field.Message.GoIdent, "{}")
g.P("}")
}
} else {
g.P("m.", fieldGoName, " = &", field.Message.GoIdent, "{}")
}
g.P("paths = append(paths, ", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix))`)
} else {
g.P("// FIXME: Skipping ", field.GoName, " because it does not seem to implement AddSetFlags.")
continue nextField
}
}
}
}
if field.Oneof != nil {
// Set the message field to the oneof wrapper.
g.P("m.", field.Oneof.GoName, " = ov")
} // end field if statement
g.P("}")
}
g.P("return paths, nil")
g.P("}")
}
// readWKTValue assigns a different proto field type to a WKT value based on the plugin used.
func (g *generator) readWKTValue(field *protogen.Field, message *protogen.Message, fieldName string) string {
pluginPackage := golangPluginPackage
switch message.Desc.FullName() {
case "google.protobuf.FieldMask":
return g.QualifiedGoIdent(pluginPackage.Ident("SetFieldMask(" + fieldName + ")"))
case "google.protobuf.Timestamp":
return g.QualifiedGoIdent(pluginPackage.Ident("SetTimestamp(" + fieldName + ")"))
case "google.protobuf.Duration":
return g.QualifiedGoIdent(pluginPackage.Ident("SetDuration(" + fieldName + ")"))
default:
g.gen.Error(fmt.Errorf("unsupported WKT %q", message.Desc.FullName()))
return ""
}
}
func (g *generator) ifErrNotNil() {
g.P("if err != nil {")
g.P("return nil, err")
g.P("}")
}
func (g *generator) genSemanticalSetFlags(flagName string, hidden bool) {
g.P("flags.AddFlag(", flagspluginPackage.Ident("NewBoolFlag"), "(", flagspluginPackage.Ident("Prefix"), `("`, flagName, `", prefix), "", `, flagspluginPackage.Ident("WithHidden"), ifThenElse(hidden, "(true)", "(hidden)"), "))")
}