-
Notifications
You must be signed in to change notification settings - Fork 0
/
codegen.go
1458 lines (1289 loc) · 39.3 KB
/
codegen.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
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package main
import (
"bytes"
"fmt"
"go/token"
"go/types"
"sort"
"strconv"
"strings"
"text/tabwriter"
"github.com/rsms/go-bits"
"github.com/rsms/go-log"
)
type codecDir int
const (
codecEncode = codecDir(iota)
codecDecode
)
// "Automatically generated" header, used for improved safety when deleting unused files.
// Note that this should contain the regexp "go generate" expects, which is as follows:
// ^// Code generated .* DO NOT EDIT\.$
// See `go help generate` for more information.
var generatedByHeaderPrefix = "// +build !entgen\n\n// Code generated by entgen. DO NOT EDIT."
type PkgImport struct {
Path string
Name string // optional local name
}
type Codegen struct {
pkg *Package
srcdir string
entpkgPath string // path of the ent package
generatedFunctions map[string]bool
pos token.Pos // best source pos for whater is currently being generated
posstack []token.Pos
// main write stream
wbuf bytes.Buffer
w *tabwriter.Writer // conforms to io.Writer
// helpers
helperbuf bytes.Buffer
helperw *tabwriter.Writer // conforms to io.Writer
helperm map[string]error
// imported packages (does not include the ent package)
imports []PkgImport
// options
PrivateFieldSetters bool // generate "setField" methods instead of "SetField" methods
}
func NewCodegen(pkg *Package, srcdir, entpkgPath string) *Codegen {
g := &Codegen{
pkg: pkg,
srcdir: srcdir,
entpkgPath: entpkgPath,
posstack: make([]token.Pos, 0, 8),
generatedFunctions: map[string]bool{},
}
g.w = tabwriter.NewWriter(&g.wbuf, 0, 1, 1, ' ', tabwriter.TabIndent)
g.helperw = tabwriter.NewWriter(&g.helperbuf, 0, 1, 1, ' ', tabwriter.TabIndent)
return g
}
func (g *Codegen) goTypeName(t types.Type) string {
// note: if things ever gets slow, this could be a place to start trying adding caching
// which shouldn't have an effect for basic types but might have an impact for complex types.
return goTypeName(t, g.pkg.Types)
}
func (g *Codegen) f(format string, args ...interface{}) {
fmt.Fprintf(g.w, format, args...)
}
func (g *Codegen) s(s string) {
g.w.Write([]byte(s))
}
func (g *Codegen) flush() {
g.w.Flush()
g.helperw.Flush()
}
func (g *Codegen) Finalize() []byte {
g.flush()
b := g.wbuf.Bytes()
// helpers
helpers := g.helperbuf.Bytes()
if len(helpers) > 0 {
b = append(b, "\n// ---- helpers ----\n"...)
b = append(b, helpers...)
}
// header
header := &bytes.Buffer{}
wf := func(format string, args ...interface{}) {
fmt.Fprintf(header, format, args...)
}
wf("%s\n", generatedByHeaderPrefix)
wf("package %s\n", g.pkg.Name)
if len(g.imports) == 0 {
wf("import %#v\n", g.entpkgPath)
} else {
wf("import (\n %#v\n", g.entpkgPath)
for _, im := range g.imports {
if im.Name != "" {
wf(" %s %#v\n", im.Name, im.Path)
} else {
wf(" %#v\n", im.Path)
}
}
header.WriteString(")\n")
}
header.WriteByte('\n')
b = append(header.Bytes(), b...)
return b
}
func (g *Codegen) logErrUnsupportedType(f *EntField) {
f.ent.logSrcErr(f.pos, "unsupported type %s of field %s.%s", f.t.Type, f.ent.sname, f.sname)
}
func (g *Codegen) logSrcErr(format string, args ...interface{}) {
logSrcErr(g.srcdir, g.pkg, g.pos, format, args...)
}
func (g *Codegen) logSrcWarn(format string, args ...interface{}) {
logSrcWarn(g.srcdir, g.pkg, g.pos, format, args...)
}
func (g *Codegen) pushPos(pos token.Pos) {
g.posstack = append(g.posstack, g.pos)
g.pos = pos
}
func (g *Codegen) popPos() {
g.pos = g.posstack[len(g.posstack)-1]
g.posstack = g.posstack[:len(g.posstack)-1]
}
// isMutableRefType returns true if t is a type which underlying value may be changed without
// assignment. For example a slice.
func isMutableRefType(typ types.Type) bool {
for {
switch t := typ.(type) {
case *types.Array, *types.Slice, *types.Map, *types.Pointer, *types.Struct:
return true
case *types.Named:
typ = t.Underlying()
default:
return false
}
}
return false
}
// —————————————————————————————————————————————————————————————————————————————————————————
// encode
func (g *Codegen) codegenEncodeField(f *EntField) error {
cvar := "c"
expr, err := g.genFieldEncoder(f, cvar, "e."+f.sname)
if err != nil {
return err
}
g.f(" %s.Key(%#v)\n", cvar, f.name)
g.f(" %s\n", expr)
return nil
}
func (g *Codegen) genFieldEncoder(f *EntField, cvar, valexpr string) (string, error) {
g.pushPos(f.t.pos)
defer g.popPos()
expr, err := g.encoderExpr(f.t.Type, cvar, valexpr)
if err == ErrUnsupportedType {
g.logErrUnsupportedType(f)
}
return expr, err
}
func (g *Codegen) encoderExpr(typ types.Type, cvar, valexpr string) (expr string, err error) {
typ, cast := g.unwrapNamedType(typ)
if cast != "" {
// flip cast
cast = g.goTypeName(typ)
}
switch t := typ.(type) {
case *types.Basic:
m, cast, advice := g.basicCodecCall(t, codecEncode, cast != "")
if advice != "" {
advice = ", " + advice
}
expr = fmt.Sprintf("%s.%s(%s%s)", cvar, m, wrapstr(valexpr, cast), advice)
return
case *types.Slice, *types.Array:
if cast != "" {
cast = ""
}
var elemt types.Type
if st, ok := t.(*types.Slice); ok {
elemt = st.Elem()
} else {
elemt = t.(*types.Array).Elem()
// use slice of all arrays (even those that are not [N]byte)
valexpr += "[:]"
// convert to slice so that genComplexEncoder uses slice encoders instead of generating
// array encoders.
typ = types.NewSlice(elemt)
}
// special case for []byte
if bt, ok := elemt.(*types.Basic); ok && bt.Kind() == types.Uint8 {
expr = fmt.Sprintf("%s.Blob(%s)", cvar, wrapstr(valexpr, cast))
return
}
}
expr, err = g.getOrBuildTypeHelper(typ, cvar, "ent_encode_", g.genComplexEncoder)
expr += "(" + cvar + ", " + wrapstr(valexpr, cast) + ")"
return
}
func (g *Codegen) genComplexEncoder(typ types.Type, cvar string, buf *bytes.Buffer) error {
wf := func(format string, args ...interface{}) {
fmt.Fprintf(buf, format, args...)
}
goType := g.goTypeName(typ)
wf("(%s ent.Encoder, v %s) {\n", cvar, goType)
switch t := typ.(type) {
case *types.Slice:
expr, err := g.encoderExpr(t.Elem(), cvar, "val")
if err != nil {
return err
}
wf(" %s.BeginList(len(v))\n", cvar)
wf(" for _, val := range v {\n")
wf(" %s\n", expr)
wf(" }\n")
wf(" %s.EndList()\n", cvar)
case *types.Map:
expr, err := g.encoderExpr(t.Elem(), cvar, "val")
if err != nil {
return err
}
if kt, ok := t.Key().(*types.Basic); !ok || kt.Kind() != types.String {
g.logSrcErr("unsupported map key type %s; only string map keys are supported", t.Key())
return ErrUnsupportedType
}
wf(" %s.BeginDict(len(v))\n", cvar)
wf(" for k, val := range v {\n")
wf(" %s.Key(k)\n", cvar)
wf(" %s\n", expr)
wf(" }\n")
wf(" %s.EndDict()\n", cvar)
default:
return ErrUnsupportedType
} // switch typ
wf("}\n")
return nil
}
// —————————————————————————————————————————————————————————————————————————————————————————
// decode
func (g *Codegen) codegenDecodeField(f *EntField) error {
g.pushPos(f.t.pos)
defer g.popPos()
expr, cast, err := g.decoderExpr(f.t.Type, "c")
if err != nil {
if err == ErrUnsupportedType {
g.logErrUnsupportedType(f)
}
return err
}
g.f(" e.%s = %s\n", f.sname, wrapstr(expr, cast))
return nil
}
// decoderExpr generates & returns a "decode" expression like "c.Int(64)"
func (g *Codegen) decoderExpr(typ types.Type, cvar string) (expr, cast string, err error) {
typ, cast = g.unwrapNamedType(typ)
switch t := typ.(type) {
case *types.Basic:
m, basicCast, advice := g.basicCodecCall(t, codecDecode, false)
if cast == "" {
cast = basicCast
}
expr = fmt.Sprintf("%s.%s(%s)", cvar, m, advice)
return
case *types.Slice:
// special case for []byte
if bt, ok := t.Elem().(*types.Basic); ok && bt.Kind() == types.Uint8 {
expr = cvar + ".Blob()"
return
}
case *types.Array:
// arrays are decoded as slices then copied into arrays via a ent_slice_to_AN_T helper
expr, err = g.getOrBuildTypeHelper(typ, cvar, "ent_slice_to_", g.genCopyHelper)
if bt, ok := t.Elem().(*types.Basic); ok && bt.Kind() == types.Uint8 {
// special case for [N]byte
expr += "(" + cvar + ".Blob())"
} else {
slicet := types.NewSlice(t.Elem())
expr2, err2 := g.getOrBuildTypeHelper(slicet, cvar, "ent_decode_", g.genComplexDecoder)
err = err2
expr += "(" + expr2 + "(" + cvar + "))"
}
return
} // switch t:=typ.(type)
expr, err = g.getOrBuildTypeHelper(typ, cvar, "ent_decode_", g.genComplexDecoder)
expr += "(" + cvar + ")"
return
}
// genCopyHelper assumes typ is *types.Array
func (g *Codegen) genCopyHelper(typ types.Type, cvar string, buf *bytes.Buffer) error {
wf := func(format string, args ...interface{}) {
fmt.Fprintf(buf, format, args...)
}
elemt := typ.(*types.Array).Elem()
goType := g.goTypeName(typ)
elemGoType := g.goTypeName(elemt)
wf("(s []%s) (r %s) {\n", elemGoType, goType)
wf(" copy(r[:], s)\n")
wf(" return\n" +
"}\n")
return nil
}
func (g *Codegen) genComplexDecoder(typ types.Type, cvar string, buf *bytes.Buffer) error {
wf := func(format string, args ...interface{}) {
fmt.Fprintf(buf, format, args...)
}
goType := g.goTypeName(typ)
wf("(%s ent.Decoder) (r %s) {\n", cvar, goType)
switch t := typ.(type) {
case *types.Slice:
expr, cast, err := g.decoderExpr(t.Elem(), cvar)
if err != nil {
return err
}
wf(" n := %s.ListHeader()\n", cvar)
wf(" if n > -1 {\n")
wf(" r = make(%s, 0, n)\n", goType)
wf(" for i := 0; i < n; i++ {\n")
wf(" r = append(r, %s)\n", wrapstr(expr, cast))
wf(" }\n")
wf(" } else {\n")
wf(" for %s.More() {\n", cvar)
wf(" r = append(r, %s)\n", wrapstr(expr, cast))
wf(" }\n")
wf(" }\n")
case *types.Map:
expr, cast, err := g.decoderExpr(t.Elem(), cvar)
if err != nil {
return err
}
// note: we don't check that key type is string since we already check for that in
// genComplexEncoder
valueGoType := g.goTypeName(t.Elem())
wf(" n := %s.DictHeader()\n", cvar)
wf(" r = make(map[string]%s, n)\n", valueGoType)
wf(" if n > -1 {\n")
wf(" for i := 0; i < n; i++ {\n")
wf(" k := %s.Key()\n", cvar)
wf(" r[k] = %s\n", wrapstr(expr, cast))
wf(" }\n")
wf(" } else {\n")
wf(" for %s.More() {\n", cvar)
wf(" k := %s.Key()\n", cvar)
wf(" r[k] = %s\n", wrapstr(expr, cast))
wf(" }\n")
wf(" }\n")
// case *types.Array:
// expr, cast, err := g.decoderExpr(t.Elem())
// if err != nil {
// return err
// }
// wf(" n := c.ListHeader()\n")
// wf(" if n < 0 {\n")
// wf(" for i := 0; c.More(); i++ {\n")
// wf(" if i < %d {\n", t.Len())
// wf(" r[i] = %s\n", wrapstr(expr, cast))
// wf(" } else {\n")
// wf(" c.Discard()\n")
// wf(" }\n")
// wf(" }\n")
// wf(" } else {\n")
// wf(" if n > %d { n = %d }\n", t.Len(), t.Len())
// wf(" for i := 0; i < n; i++ {\n")
// wf(" r[i] = %s\n", wrapstr(expr, cast))
// wf(" }\n")
// wf(" }\n")
default:
return ErrUnsupportedType
} // switch typ
wf(" return\n}\n") // end of `func {fname}(cvar ent.Decoder) ...`
return nil
}
// —————————————————————————————————————————————————————————————————————————————————————————
// both encoding & decoding
type HelperBuilder = func(t types.Type, cvar string, b *bytes.Buffer) error
func (g *Codegen) getOrBuildTypeHelper(
typ types.Type,
cvar, fnamePrefix string,
builder HelperBuilder,
) (string, error) {
fname, err := Typemangle(g.pkg.Types, typ)
if err != nil {
return "", err
}
fname = fnamePrefix + fname
err = g.getOrBuildHelper(fname, cvar, typ, builder)
return fname, err
}
func (g *Codegen) getOrBuildHelper(fname, cvar string, t types.Type, builder HelperBuilder) error {
if g.helperm == nil {
g.helperm = map[string]error{}
} else {
err, ok := g.helperm[fname]
if ok {
return err
}
}
log.Debug("codegen helper %s", fname)
var buf bytes.Buffer
buf.WriteString("\nfunc ")
buf.WriteString(fname)
err := builder(t, cvar, &buf)
g.helperm[fname] = err
if err == nil {
g.helperw.Write(buf.Bytes())
}
return err
}
func (g *Codegen) unwrapNamedType(typ types.Type) (canonical types.Type, cast string) {
// unwrap named type (does not include aliases, which do not need casting)
canonical = typ
for {
t, ok := canonical.(*types.Named)
if !ok {
break
}
canonical = t.Underlying()
if canonical == typ {
break
}
if cast == "" {
cast = g.goTypeName(typ)
}
}
return
}
func (g *Codegen) basicCodecCall(
t *types.Basic, cdir codecDir, mustcast bool,
) (m, cast, advice string) {
kind := t.Kind()
var wantadvice bool
setcast := func(enccast string) {
if cdir == codecDecode {
cast = g.goTypeName(t)
} else {
cast = enccast
}
}
switch kind {
case types.Bool, types.UntypedBool:
m = "Bool"
case types.Int, types.UntypedInt, types.Int8, types.Int16, types.Int32, types.Int64,
types.UntypedRune:
if mustcast || kind != types.Int64 {
setcast("int64")
}
m = "Int"
wantadvice = true
case types.Uint, types.Uint8, types.Uint16, types.Uint32, types.Uint64,
types.Uintptr, types.UnsafePointer:
if mustcast || kind != types.Uint64 {
setcast("uint64")
}
m = "Uint"
wantadvice = true
case types.UntypedFloat, types.Float32, types.Float64:
if mustcast || kind != types.Float64 {
setcast("float64")
}
m = "Float"
wantadvice = true
case types.UntypedComplex, types.Complex64, types.Complex128:
if mustcast || kind != types.Complex128 {
setcast("complex128")
}
m = "Complex"
wantadvice = true
case types.String, types.UntypedString:
m = "Str"
}
if wantadvice {
advice = basicKindSizeAdvice(t.Kind())
}
return
}
// —————————————————————————————————————————————————————————————————————————————————————————
// ent
func (g *Codegen) codegenEnt(e *EntInfo) error {
w := g.w
g.pushPos(e.pos)
defer g.popPos()
log.Info("codegen ent %q (%s.%s)", e.name, e.pkg.Name, e.sname)
linefeed := []byte{'\n'}
wstr := func(s string) { w.Write([]byte(s)) }
wline := func() { w.Write(linefeed) }
// wbyte := func(b byte) { w.Write([]byte{b}) }
userMethods := e.getUserMethods()
generatedMethods := map[string]bool{}
var err error
// methodIsUndefined checks if user has defined "name" method
methodIsUndefined := func(name string) bool {
return userMethods[name] == nil && !generatedMethods[name]
}
// methodMustBeUndefined checks if user has defined "name" method. If not, returns true.
// If there is a definition, logs an error and returns false.
methodMustBeUndefined := func(name, help string) bool {
m := userMethods[name]
if m == nil {
if generatedMethods[name] {
panic("trying to generate method " + name + " twice")
}
return true
}
if help != "" {
help = " " + help
}
e.logSrcErr(m.pos, "ent method %s already defined for %s.%s", name, e.sname, help)
if err == nil {
err = fmt.Errorf("method definition conflict")
}
// TODO error
return false
}
methodWarnIfDefinedAlt := func(name, help string) string {
if m := userMethods[name]; m != nil {
lname := inverseCapitalize(name)
if lname != name {
if help != "" {
help = " " + help
}
e.logSrcWarn(m.pos,
"ent method %s is already defined for %s. Naming the generated method %s instead.%s",
name, e.sname, lname, help)
help = "" // so we don't print it twice in case there's an error next
}
name = lname
methodMustBeUndefined(name, help)
} else if generatedMethods[name] {
panic("trying to generate method " + name + " twice")
}
return name
}
funcIsUndefined := func(name string) bool {
// TODO user functions
return !g.generatedFunctions[name]
}
// compile indexes
fieldIndexes := g.collectFieldIndexes(e.fields)
g.f(
"// ----------------------------------------------------------------------------\n// %s\n\n",
e.sname)
// // replicate original struct documentation
// if len(e.doc) > 0 {
// wstr("// ")
// wstr(strings.Join(e.doc, "\n// "))
// wline()
// }
// variables & constants
// // ent.Register
// wline()
// g.f("var _ = ent.Register(&%s{})\n", e.sname)
// wline()
// LoadTYPEById(s ent.Storage, id uint64) (*TYPE, error)
fname := "Load" + e.sname + "ById"
if funcIsUndefined(fname) {
g.generatedFunctions[fname] = true
g.f("// %s loads %s with id from storage\n"+
"func %s(storage ent.Storage, id uint64) (*%s, error)\t{\n"+
" e := &%s{}\n"+
" return e, ent.LoadEntById(e, storage, id)\n"+
"}\n\n",
fname, e.sname,
fname, e.sname,
e.sname)
}
// FindTYPEByINDEX
// LoadTYPEByINDEX
for _, fx := range fieldIndexes {
if err := g.genFindTYPEByINDEX(e, fx); err != nil {
return err
}
}
mname := "EntTypeName"
if methodMustBeUndefined(mname, "Use tag on EntBase field instead (e.g. `typename`)") {
generatedMethods[mname] = true
g.f("// %s returns the ent's storage name (%q)\n"+
"func (e %s) %s() string\t{ return %#v }\n\n",
mname, e.name,
e.sname, mname, e.name)
}
mname = "EntStorage"
if methodIsUndefined(mname) {
generatedMethods[mname] = true
g.f("// %s returns the storage this ent belongs to or nil if it doesn't belong anywhere.\n"+
"func (e *%s) %s() ent.Storage\t{ return ent.GetStorage(e) }\n\n",
mname,
e.sname, mname)
}
mname = "EntNew"
if methodIsUndefined(mname) {
generatedMethods[mname] = true
g.f("// %s returns a new empty %s. Used by the ent package for loading ents.\n"+
"func (e %s) %s() ent.Ent\t{ return &%s{} }\n\n",
mname, e.sname,
e.sname, mname, e.sname)
}
mname = "MarshalJSON"
if methodIsUndefined(mname) {
generatedMethods[mname] = true
g.f("// %s returns a JSON representation of e. Conforms to json.Marshaler.\n"+
"func (e *%s) %s() ([]byte, error) { return ent.JsonEncode(e, \"\") }\n\n",
mname,
e.sname, mname)
}
mname = "UnmarshalJSON"
if methodIsUndefined(mname) {
generatedMethods[mname] = true
g.f("// %s populates the ent from JSON data. Conforms to json.Unmarshaler.\n"+
"func (e *%s) %s(b []byte) error { return ent.JsonDecode(e, b) }\n\n",
mname,
e.sname, mname)
}
mname = "String"
if methodIsUndefined(mname) {
generatedMethods[mname] = true
g.f("// %s returns a JSON representation of e.\n"+
"func (e %s) %s() string { return ent.EntString(&e) }\n\n",
mname,
e.sname, mname)
}
mname = "Create"
if methodIsUndefined(mname) {
generatedMethods[mname] = true
g.f("// %s a new %s ent in storage\n"+
"func (e *%s) %s(storage ent.Storage) error\t{ return ent.CreateEnt(e, storage) }\n",
mname, e.name,
e.sname, mname)
}
mname = "Save"
if methodIsUndefined(mname) {
generatedMethods[mname] = true
g.f("// %s pending changes to whatever storage this ent was created or loaded from\n"+
"func (e *%s) %s() error\t{ return ent.SaveEnt(e) }\n",
mname,
e.sname, mname)
}
mname = "Reload"
if methodIsUndefined(mname) {
generatedMethods[mname] = true
g.f("// %s fields to latest values from storage, discarding any unsaved changes\n"+
"func (e *%s) %s() error\t{ return ent.ReloadEnt(e) }\n",
mname,
e.sname, mname)
}
mname = "PermanentlyDelete"
if methodIsUndefined(mname) {
generatedMethods[mname] = true
g.f("// %s deletes this ent from storage. This can usually not be undone.\n"+
"func (e *%s) %s() error\t{ return ent.DeleteEnt(e) }\n",
mname,
e.sname, mname)
}
mname = "Iterator"
if methodIsUndefined(mname) {
generatedMethods[mname] = true
g.f("// %s returns an iterator over all %s ents. Order is undefined.\n"+
"func (e %s) %s(s ent.Storage) ent.EntIterator\t{ return s.IterateEnts(&e) }\n",
mname, e.sname,
e.sname, mname)
}
wline()
// begin field accessor methods
if len(e.fields) > 0 {
wstr("// ---- field accessor methods ----\n\n")
fieldsWithTags := []*EntField{}
// field getters
// func (e *ENTTYPE) Field() { return e.field }
didGenerateGetters := false
for _, field := range e.fields {
if len(field.tags) > 0 {
fieldsWithTags = append(fieldsWithTags, field)
}
// skip gettter if the field has a public name
if field.uname == field.sname {
continue
}
// skip if user has defined a method with the same name
if !methodIsUndefined(field.uname) {
continue
}
// sname is lower case; generate getter function
// if the field has documentation, add it to the getter for nice godoc
if len(field.doc) > 0 {
wstr("// ")
wstr(strings.Join(field.doc, "\n// "))
wline()
}
g.f("func (e *%s) %s() %s\t{ return e.%s }\n",
e.sname,
field.uname,
g.goTypeName(field.t.Type),
field.sname,
)
generatedMethods[field.uname] = true
didGenerateGetters = true
}
if didGenerateGetters {
wline()
}
// field setters
// func (e *Type) SetField() { e.field }
fieldSetterPrefix := "Set"
if g.PrivateFieldSetters {
fieldSetterPrefix = "set"
}
var genChangedSetters []*EntField
for _, field := range e.fields {
mname := fieldSetterPrefix + field.uname
if !methodIsUndefined(mname) {
if g.PrivateFieldSetters {
continue
}
// If the user has defined a method with the same name, define a private lower-case version
//
// This can be useful for the author to use in composition, e.g.
// // user-defined
// func (e *Foo) SetThing(v int) {
// if someCondition() {
// e.setThing() // call entgen-generated method
// }
// }
//
mname = "set" + field.uname
if !methodIsUndefined(mname) {
// user has defined that one too; they don't want it to be generated.
continue
}
}
g.f("func (e *%s) %s(v %s)\t{"+
" e.%s = v;"+
" ent.SetFieldChanged(&e.EntBase, %d)"+
"}\n",
e.sname, mname, g.goTypeName(field.t.Type),
field.sname,
field.index,
)
generatedMethods[mname] = true
if isMutableRefType(field.t.Type) {
genChangedSetters = append(genChangedSetters, field)
}
}
// SetFIELDChanged(bool)
if len(genChangedSetters) > 0 {
wline()
for _, field := range genChangedSetters {
mname := fieldSetterPrefix + field.uname + "Changed"
if methodIsUndefined(mname) {
g.f("func (e *%s) %s()\t{ ent.SetFieldChanged(&e.EntBase, %d) }\n",
e.sname, mname, field.index)
generatedMethods[mname] = true
}
}
}
// EntEncode & EntDecode
wstr("// ---- encode & decode methods ----\n\n")
// -- EntEncode --
mname := methodWarnIfDefinedAlt(
"EntEncode",
"Make sure to call entEncode from your EntEncode method",
)
generatedMethods[mname] = true
g.f("\nfunc (e *%s) %s(c ent.Encoder, fields ent.FieldSet) {", e.sname, mname)
// g.f("\n\teb := &e.EntBase\n")
for _, field := range e.fields {
g.pushPos(field.pos)
// Note: Rather than precomputing (1<<field.index), let the compiler apply constant
// evaluation instead. This makes the generated code more readable.
g.f("\tif fields.Has(%d)\t{", field.index)
err := g.codegenEncodeField(field)
wstr(" }\n")
g.popPos()
if err != nil {
return err
}
}
wstr("}\n")
// -- EntDecode --
mname = methodWarnIfDefinedAlt(
"EntDecode",
"Make sure to call entDecode from your EntDecode method",
)
generatedMethods[mname] = true
if err := g.genEntDecode(e, mname); err != nil {
return err
}
}
// -- EntDecodePartial --
mname = methodWarnIfDefinedAlt(
"EntDecodePartial",
"Make sure to call entDecodeIndexed from your EntDecodePartial method",
)
generatedMethods[mname] = true
if err := g.genEntDecodePartial(e, mname); err != nil {
return err
}
// EntFields
if methodMustBeUndefined("EntFields", "") {
g.genEntFields(e)
}
// data & methods for ents with indexes
if len(fieldIndexes) > 0 {
// -- EntIndexes --
if methodIsUndefined("EntIndexes") {
generatedMethods["EntIndexes"] = true
g.f("\n// Indexes (Name, Fields, Flags)\n")
g.f("var ent_%s_idx = []ent.EntIndex{\n", e.sname)
for _, x := range fieldIndexes {
var flags []string
if (x.flags & fieldIndexUnique) != 0 {
flags = append(flags, "ent.EntIndexUnique")
}
if len(flags) == 0 {
flags = append(flags, "0")
}
fieldIndices := genFieldmap(e, x.fields)
g.f("{ %#v, %s, %s },\n", x.name, fieldIndices, strings.Join(flags, "|"))
}
g.f("}\n\n")
g.f("// EntIndexes returns information about secondary indexes\n")
g.f("func (e *%s) EntIndexes() []ent.EntIndex { return ent_%s_idx }\n",
e.sname, e.sname)
}
} // if len(fieldIndexes) > 0
if log.RootLogger.Level <= log.LevelDebug {
log.Debug("methods generated for %s:%s", e.sname, fmtMappedNames(generatedMethods))
}
g.scanImportsNeededForEnt(e)
return err
}
// typePkgName returns the package name for a type that is from an external package.
// E.g:
// package foo
// "int" => ""
// "foo.Thing" => ""
// "bar.Thing" => "bar"
// "[]bar.Thing" => "bar"
//
func (g *Codegen) typePkgName(t types.Type) string {
if t, ok := t.(*types.Named); ok {
if o := t.Obj(); o != nil {
if pkg := o.Pkg(); pkg != nil && pkg != g.pkg.Types && pkg.Path() != g.pkg.Types.Path() {
return pkg.Name()
}
}
}
return ""
}
func (g *Codegen) scanImportsNeededForEnt(e *EntInfo) {
// collect all unique named types which has package information
uniqueNamedTypes := make(map[*types.Named]*types.TypeName)
for _, field := range e.fields {
if t, ok := field.t.Type.(*types.Named); ok {
if o := t.Obj(); o != nil {
if o.Pkg() != nil {
uniqueNamedTypes[t] = o
}
}
}
}
// for each unique named type...
ePkgPath := g.pkg.Types.Path()
for _, o := range uniqueNamedTypes {
pkg := o.Pkg() // note: never nil
// log.Debug("%v\n o.id=%v, o.name=%v, pkg.name=%s, pkg.path=%q", t,
// o.Id(), o.Name(), pkg.Name(), pkg.Path())
pkgPath := pkg.Path()
if pkgPath != ePkgPath && pkgPath != g.entpkgPath {
g.imports = append(g.imports, PkgImport{Path: pkgPath})
}
}
}
func (g *Codegen) genEntFields(e *EntInfo) {
// entField* constants for symbolic field indices
var fieldmap uint64