-
Notifications
You must be signed in to change notification settings - Fork 4
/
messager.go
517 lines (479 loc) · 17.7 KB
/
messager.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
package main
import (
"fmt"
"path/filepath"
"strings"
"github.com/iancoleman/strcase"
"github.com/tableauio/loader/cmd/protoc-gen-go-tableau-loader/check"
"github.com/tableauio/loader/cmd/protoc-gen-go-tableau-loader/helper"
"github.com/tableauio/tableau/proto/tableaupb"
"golang.org/x/text/cases"
"golang.org/x/text/language"
"google.golang.org/protobuf/compiler/protogen"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/reflect/protoreflect"
"google.golang.org/protobuf/types/descriptorpb"
)
const (
formatPackage = protogen.GoImportPath("github.com/tableauio/tableau/format")
loadPackage = protogen.GoImportPath("github.com/tableauio/tableau/load")
storePackage = protogen.GoImportPath("github.com/tableauio/tableau/store")
errors = protogen.GoImportPath("github.com/pkg/errors")
treeMapPackage = protogen.GoImportPath("github.com/tableauio/loader/pkg/treemap")
pairPackage = protogen.GoImportPath("github.com/tableauio/loader/pkg/pair")
)
// golbal container for record all proto filenames and messager names
var messagers []string
var errorsPackage protogen.GoImportPath
var codePackage protogen.GoImportPath
var orderedMapTypeDefMap map[string]bool = make(map[string]bool)
// generateMessager generates a protoconf file corresponding to the protobuf file.
// Each wrapped struct type implement the Messager interface.
func generateMessager(gen *protogen.Plugin, file *protogen.File) {
errorsPackage = protogen.GoImportPath(string(file.GoImportPath) + "/" + *pkg + "/" + errPkg)
codePackage = protogen.GoImportPath(string(file.GoImportPath) + "/" + *pkg + "/" + codePkg)
filename := filepath.Join(file.GeneratedFilenamePrefix + "." + pcExt + ".go")
g := gen.NewGeneratedFile(filename, "")
generateFileHeader(gen, file, g)
g.P()
g.P("package ", *pkg)
g.P()
generateFileContent(gen, file, g)
}
// generateFileContent generates struct type definitions.
func generateFileContent(gen *protogen.Plugin, file *protogen.File, g *protogen.GeneratedFile) {
var fileMessagers []string
for _, message := range file.Messages {
opts := message.Desc.Options().(*descriptorpb.MessageOptions)
worksheet := proto.GetExtension(opts, tableaupb.E_Worksheet).(*tableaupb.WorksheetOptions)
if worksheet != nil {
genMessage(gen, file, g, message)
messagerName := string(message.Desc.Name())
fileMessagers = append(fileMessagers, messagerName)
}
}
messagers = append(messagers, fileMessagers...)
generateRegister(fileMessagers, g)
}
func generateRegister(messagers []string, g *protogen.GeneratedFile) {
// register messagers
g.P("func init() {")
for _, messager := range messagers {
g.P(`Register(func() Messager {`)
g.P("return new(", messager, ")")
g.P("})")
}
g.P("}")
}
// genMessage generates a message definition.
func genMessage(gen *protogen.Plugin, file *protogen.File, g *protogen.GeneratedFile, message *protogen.Message) {
messagerName := string(message.Desc.Name())
// type definitions
orderedMapTypeName := ""
if helper.NeedGenOrderedMap(message.Desc) {
orderedMapTypeName = genOrderedMapTypeDef(1, nil, messagerName, file, g, message)
}
g.P("// ", messagerName, " is a wrapper around protobuf message: ", file.GoImportPath.Ident(messagerName), ".")
g.P("//")
g.P("// It is designed for three goals:")
g.P("//")
g.P("// 1. Easy use: simple yet powerful accessers.")
g.P("// 2. Elegant API: concise and clean functions.")
g.P("// 3. Extensibility: Map, OrdererdMap, Index...")
// messager definition
g.P("type ", messagerName, " struct {")
g.P("UnimplementedMessager")
g.P("data ", file.GoImportPath.Ident(messagerName))
if helper.NeedGenOrderedMap(message.Desc) && orderedMapTypeName != "" {
g.P("orderedMap *", orderedMapTypeName)
}
g.P("}")
g.P()
// messager methods
g.P("// Name returns the ", messagerName, "'s message name.")
g.P("func (x *", messagerName, ") Name() string {")
g.P("if x != nil {")
g.P("return string((&x.data).ProtoReflect().Descriptor().Name())")
g.P("}")
g.P(`return ""`)
g.P("}")
g.P()
g.P("// Data returns the ", messagerName, "'s inner message data.")
g.P("func (x *", messagerName, ") Data() *", file.GoImportPath.Ident(messagerName), " {")
g.P("if x != nil {")
g.P("return &x.data")
g.P("}")
g.P(`return nil`)
g.P("}")
g.P()
g.P("// Load fills ", messagerName, "'s inner message from file in the specified directory and format.")
g.P("func (x *", messagerName, ") Load(dir string, format ", formatPackage.Ident("Format"), " , options ...", loadPackage.Ident("Option"), ") error {")
g.P("err := ", loadPackage.Ident("Load"), "(x.Data(), dir, format, options...)")
g.P("if err != nil {")
g.P("return err")
g.P("}")
g.P("return x.AfterLoad()")
g.P("}")
g.P()
g.P("// Store writes ", messagerName, "'s inner message to file in the specified directory and format.")
g.P("// Available formats: JSON, Bin, and Text.")
g.P("func (x *", messagerName, ") Store(dir string, format ", formatPackage.Ident("Format"), " , options ...", storePackage.Ident("Option"), ") error {")
g.P("return ", storePackage.Ident("Store"), "(x.Data(), dir, format, options...)")
g.P("}")
g.P()
g.P("// Messager is used to implement Checker interface.")
g.P("func (x *", messagerName, ") Messager() Messager {")
g.P("return x")
g.P("}")
g.P()
g.P("// AfterLoad runs after this messager is loaded.")
g.P("func (x *", messagerName, ") AfterLoad() error {")
if helper.NeedGenOrderedMap(message.Desc) {
genOrderedMapLoader(1, nil, messagerName, file, g, message, "")
}
g.P("return nil")
g.P("}")
g.P()
// syntactic sugar for accessing map items
genMapGetters(1, nil, messagerName, file, g, message)
if helper.NeedGenOrderedMap(message.Desc) {
g.P()
genOrderedMapGetters(1, nil, messagerName, file, g, message)
}
}
func genCheckRefer(depth int, levelInfos []*check.LevelInfo, g *protogen.GeneratedFile, messagerName string) {
if depth == 1 {
g.P(`// refer check`)
}
for _, levelInfo := range levelInfos {
accesser := levelInfo.Accesser
itemName := fmt.Sprintf("item%d", depth)
prevItemName := fmt.Sprintf("item%d", depth-1)
fieldName := fmt.Sprintf("%s.%s", prevItemName, strcase.ToCamel(levelInfo.GoFieldName))
if depth == 1 {
if accesser != nil {
fieldName = fmt.Sprintf("x.Data().Get%s()", strcase.ToCamel(levelInfo.GoFieldName))
} else {
g.P("for _, " + itemName + " := range x.Data().Get" + levelInfo.GoFieldName + "() {")
}
} else {
if levelInfo.FD == nil {
g.P("for _, " + itemName + " := range " + prevItemName + "." + levelInfo.GoFieldName + "{")
}
}
if accesser != nil {
g.P(`if conf := hub.Get` + accesser.MessagerName + `(); conf != nil {`)
g.P(" if _, ok := conf.Data()." + accesser.MapFieldName + "[" + accesser.MapKeyType + "(" + fieldName + ")]; !ok {")
g.P(` return `, errors.Ident("Errorf"), `("`, messagerName, ".", levelInfo.ColumnName, `(%v) not found in `, levelInfo.Refer, `", `, fieldName, `) `)
g.P(" }")
g.P("} else {")
g.P(` return `, errors.Ident("Errorf"), `("`+accesser.MessagerName+` not found")`)
g.P("}")
}
genCheckRefer(depth+1, levelInfo.NextLevels, g, messagerName)
if levelInfo.FD == nil {
g.P("}")
}
}
}
func genMapGetters(depth int, keys []helper.MapKey, messagerName string, file *protogen.File, g *protogen.GeneratedFile, message *protogen.Message) {
for _, field := range message.Fields {
fd := field.Desc
if field.Desc.IsMap() {
keys = helper.AddMapKey(file, fd, keys)
getter := fmt.Sprintf("Get%v", depth)
g.P("// ", getter, " finds value in the ", depth, "-level map. It will return nil if")
g.P("// the deepest key is not found, otherwise return an error.")
if fd.MapValue().Kind() == protoreflect.MessageKind {
g.P("func (x *", messagerName, ") ", getter, "(", helper.GenGetParams(keys), ") (*", getGoIdent(file, message, fd.MapValue()), ", error) {")
} else {
returnValType := helper.ParseGoType(file, fd.MapValue())
g.P("func (x *", messagerName, ") ", getter, "(", helper.GenGetParams(keys), ") (", returnValType, ", error) {")
}
returnEmptyValue := helper.GetTypeEmptyValue(fd.MapValue())
var container string
if depth == 1 {
container = "x.Data()"
} else {
container = "conf"
prevKeys := keys[:len(keys)-1]
prevGetter := fmt.Sprintf("Get%v", depth-1)
g.P("conf, err := x.", prevGetter, "(", helper.GenGetArguments(prevKeys), ")")
g.P("if err != nil {")
g.P(`return `, returnEmptyValue, `, err`)
g.P("}")
g.P()
}
g.P("d := ", container, ".Get", field.GoName, "()")
g.P("if d == nil {")
g.P(`return `, returnEmptyValue, `, `, errorsPackage.Ident("Errorf"), `(`, codePackage.Ident("Nil"), `, "`, field.GoName, ` is nil")`)
g.P("}")
lastKeyName := keys[len(keys)-1].Name
g.P("if val, ok := d[", lastKeyName, "]; !ok {")
g.P(`return `, returnEmptyValue, `, `, errorsPackage.Ident("Errorf"), `(`, codePackage.Ident("NotFound"), `, "`, lastKeyName, `(%v) not found", `, lastKeyName, `)`)
g.P("} else {")
g.P(`return val, nil`)
g.P("}")
g.P("}")
g.P()
if fd.MapValue().Kind() == protoreflect.MessageKind {
msg := getMessage(file.Messages, fd.MapValue().Message())
if msg != nil {
genMapGetters(depth+1, keys, messagerName, file, g, msg)
}
}
break
}
}
}
const orderedMapSuffix = "_OrderedMap"
const orderedMapValueSuffix = "_OrderedMapValue"
func genOrderedMapGetters(depth int, keys []helper.MapKey, messagerName string, file *protogen.File, g *protogen.GeneratedFile, message *protogen.Message) {
if *disableOrderedMap {
return
}
if depth == 1 && !helper.NeedGenOrderedMap(message.Desc) {
return
}
for _, field := range message.Fields {
fd := field.Desc
if fd.IsMap() {
getter := genGetterName(depth)
prefix := parseOrderedMapPrefix(fd, messagerName)
orderedMap := prefix + orderedMapSuffix
if depth == 1 {
g.P("// ", getter, " returns the 1-level ordered map.")
g.P("func (x *", messagerName, ") ", getter, "(", helper.GenGetParams(keys), ") *", orderedMap, "{")
g.P(" return x.orderedMap ")
} else {
g.P("// ", getter, " finds value in the ", depth-1, "-level ordered map. It will return nil if")
g.P("// the deepest key is not found, otherwise return an error.")
g.P("func (x *", messagerName, ") ", getter, "(", helper.GenGetParams(keys), ") (*", orderedMap, ", error) {")
if depth == 2 {
g.P("conf := x.orderedMap")
} else {
prevKeys := keys[:len(keys)-1]
prevGetter := genGetterName(depth - 1)
g.P("conf, err := x.", prevGetter, "(", helper.GenGetArguments(prevKeys), ")")
g.P("if err != nil {")
g.P(`return nil, err`)
g.P("}")
}
lastKeyName := keys[len(keys)-1].Name
lastKeyType := keys[len(keys)-1].Type
keyName := lastKeyName
if lastKeyType == "bool" {
keyName = fmt.Sprintf("BoolToInt(%s)", keyName)
}
g.P("if val, ok := conf.Get(", keyName, "); !ok {")
g.P(`return nil, `, errorsPackage.Ident("Errorf"), `(`, codePackage.Ident("NotFound"), `, "`, lastKeyName, `(%v) not found", `, lastKeyName, `)`)
g.P("} else {")
g.P(`return val.First, nil`)
g.P("}")
}
g.P("}")
g.P()
nextKeys := helper.AddMapKey(file, fd, keys)
if fd.MapValue().Kind() == protoreflect.MessageKind {
msg := getMessage(file.Messages, fd.MapValue().Message())
if msg != nil {
genOrderedMapGetters(depth+1, nextKeys, messagerName, file, g, msg)
}
}
break
}
}
}
func genGetterName(depth int) string {
getter := "GetOrderedMap"
if depth > 1 {
getter = fmt.Sprintf("GetOrderedMap%v", depth-1)
}
return getter
}
func genOrderedMapTypeDef(depth int, keys []helper.MapKey, messagerName string, file *protogen.File, g *protogen.GeneratedFile, message *protogen.Message) string {
if *disableOrderedMap {
return ""
}
if depth == 1 && !helper.NeedGenOrderedMap(message.Desc) {
return ""
}
for _, field := range message.Fields {
fd := field.Desc
if fd.IsMap() {
if depth == 1 {
g.P(" // OrderedMap types.")
}
nextKeys := helper.AddMapKey(file, fd, keys)
keyType := nextKeys[len(nextKeys)-1].Type
if keyType == "bool" {
keyType = "int"
}
if fd.MapValue().Kind() == protoreflect.MessageKind {
msg := getMessage(file.Messages, fd.MapValue().Message())
if msg != nil {
genOrderedMapTypeDef(depth+1, nextKeys, messagerName, file, g, msg)
}
}
prefix := parseOrderedMapPrefix(fd, messagerName)
orderedMap := prefix + orderedMapSuffix
orderedMapValue := prefix + orderedMapValueSuffix
_, ok := orderedMapTypeDefMap[orderedMap]
if !ok {
orderedMapTypeDefMap[orderedMap] = true
nextMapFD := getNextLevelMapFD(fd.MapValue())
if nextMapFD != nil {
currValueType := getGoIdent(file, message, fd.MapValue())
nextPrefix := parseOrderedMapPrefix(nextMapFD, messagerName)
nextOrderedMap := nextPrefix + orderedMapSuffix
g.P(" type ", orderedMapValue, "= ", pairPackage.Ident("Pair"), "[*", nextOrderedMap, ", *", currValueType, "];")
g.P(" type ", orderedMap, "= ", treeMapPackage.Ident("TreeMap"), "[", keyType, ", ", orderedMapValue, "]")
g.P()
} else {
orderedMapValue := helper.ParseGoType(file, fd.MapValue())
if fd.MapValue().Kind() == protoreflect.MessageKind {
g.P(" type ", orderedMap, "= ", treeMapPackage.Ident("TreeMap"), "[", keyType, ", *", getGoIdent(file, message, fd.MapValue()), "]")
} else {
g.P(" type ", orderedMap, "= ", treeMapPackage.Ident("TreeMap"), "[", keyType, ", ", orderedMapValue, "]")
}
g.P()
}
}
if depth == 1 {
return orderedMap
}
break
}
}
return ""
}
func genOrderedMapLoader(depth int, keys []helper.MapKey, messagerName string, file *protogen.File, g *protogen.GeneratedFile, message *protogen.Message, lastOrderedMapValue string) {
if *disableOrderedMap {
return
}
if depth == 1 {
g.P(" // OrderedMap init.")
}
for _, field := range message.Fields {
fd := field.Desc
if fd.IsMap() {
needConvertBool := false
if len(keys) > 0 && keys[len(keys)-1].Type == "bool" {
needConvertBool = true
}
nextKeys := helper.AddMapKey(file, fd, keys)
keyType := nextKeys[len(nextKeys)-1].Type
needConvertBoolNext := false
if keyType == "bool" {
keyType = "int"
needConvertBoolNext = true
}
prefix := parseOrderedMapPrefix(fd, messagerName)
orderedMapValue := prefix + orderedMapValueSuffix
mapName := fmt.Sprintf("x.Data().Get%s()", field.GoName)
nextMapFD := getNextLevelMapFD(fd.MapValue())
if depth == 1 {
if nextMapFD == nil {
if fd.MapValue().Kind() == protoreflect.MessageKind {
g.P("x.orderedMap = ", treeMapPackage.Ident("New"), "[", keyType, ", *", getGoIdent(file, message, fd.MapValue()), "]()")
} else {
g.P("x.orderedMap = ", treeMapPackage.Ident("New"), "[", keyType, ", ", helper.ParseGoType(file, fd.MapValue()), "]()")
}
} else {
g.P("x.orderedMap = ", treeMapPackage.Ident("New"), "[", keyType, ", ", orderedMapValue, "]()")
}
}
if depth != 1 {
mapName = fmt.Sprintf("v%d.Get%s()", depth-1, field.GoName)
keyName := fmt.Sprintf("k%d", depth-1)
if needConvertBool {
keyName = fmt.Sprintf("BoolToInt(%s)", keyName)
}
g.P("map", depth-1, ".Put(", keyName, ", ", lastOrderedMapValue, "{")
if nextMapFD == nil {
if fd.MapValue().Kind() == protoreflect.MessageKind {
g.P("First: ", treeMapPackage.Ident("New"), "[", keyType, ", *", getGoIdent(file, message, fd.MapValue()), "](),")
} else {
g.P("First: ", treeMapPackage.Ident("New"), "[", keyType, ", ", helper.ParseGoType(file, fd.MapValue()), "](),")
}
} else {
g.P("First: ", treeMapPackage.Ident("New"), "[", keyType, ", ", orderedMapValue, "](),")
}
g.P("Second: v", depth-1, ",")
g.P("})")
g.P(" k", depth-1, "v, _ := map", depth-1, ".Get(", keyName, ")")
}
g.P("for k", depth, ", v", depth, " := range ", mapName, "{")
if depth == 1 {
g.P("map", depth, " := x.orderedMap")
} else {
g.P("map", depth, " := k", depth-1, "v.First")
}
if nextMapFD != nil {
msg := getMessage(file.Messages, fd.MapValue().Message())
if msg != nil {
genOrderedMapLoader(depth+1, nextKeys, messagerName, file, g, msg, orderedMapValue)
}
} else {
keyName := fmt.Sprintf("k%d", depth)
if needConvertBoolNext {
keyName = fmt.Sprintf("BoolToInt(%s)", keyName)
}
g.P("map", depth, ".Put(", keyName, ", v", depth, ")")
}
g.P("}")
break
}
}
}
func parseOrderedMapPrefix(mapFd protoreflect.FieldDescriptor, messagerFullName string) string {
if mapFd.MapValue().Kind() == protoreflect.MessageKind {
fields := strings.Split(string(mapFd.MapValue().Message().FullName()), ".")
if len(fields) == 0 {
return messagerFullName
}
if len(fields) == 2 {
return fmt.Sprintf("%s_%s", cases.Title(language.Und).String(mapFd.MapKey().Kind().String()), fields[1])
}
return strings.Join(fields[1:], "_")
}
return fmt.Sprintf("%s_%s", messagerFullName, mapFd.MapValue().Kind())
}
func getNextLevelMapFD(fd protoreflect.FieldDescriptor) protoreflect.FieldDescriptor {
if fd.Kind() == protoreflect.MessageKind {
md := fd.Message()
for i := 0; i < md.Fields().Len(); i++ {
fd := md.Fields().Get(i)
if fd.IsMap() {
return fd
}
}
}
return nil
}
func getMessage(messages []*protogen.Message, md protoreflect.MessageDescriptor) *protogen.Message {
if len(messages) != 0 {
for _, msg := range messages {
if msg.Desc.FullName() == md.FullName() {
return msg
} else {
if m := getMessage(msg.Messages, md); m != nil {
return m
}
}
}
}
return nil
}
func getGoIdent(file *protogen.File, message *protogen.Message, fd protoreflect.FieldDescriptor) protogen.GoIdent {
// TODO: optimize
for _, field := range message.Fields {
if field.Desc.FullName() == fd.FullName() {
return field.GoIdent
}
}
return protogen.GoIdent{
GoImportPath: file.GoImportPath,
GoName: helper.ParseGoType(file, fd),
}
}