/
generator.go
169 lines (139 loc) · 3.82 KB
/
generator.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
/*
Copyright 2023 The KubeVela Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package cuegen
import (
"fmt"
goast "go/ast"
gotypes "go/types"
"io"
"strings"
cueast "cuelang.org/go/cue/ast"
"cuelang.org/go/cue/ast/astutil"
cueformat "cuelang.org/go/cue/format"
"golang.org/x/tools/go/packages"
)
// Generator generates CUE schema from Go struct.
type Generator struct {
// immutable
pkg *packages.Package
types typeInfo
opts *options
}
// NewGenerator creates a new generator with given file or package path.
func NewGenerator(f string) (*Generator, error) {
pkg, err := loadPackage(f)
if err != nil {
return nil, err
}
types := getTypeInfo(pkg)
g := &Generator{
pkg: pkg,
types: types,
opts: newDefaultOptions(),
}
return g, nil
}
// Package returns internal package struct, which should be read-only.
func (g *Generator) Package() *packages.Package {
return g.pkg
}
// Generate generates CUE schema from Go struct and writes to w.
// And it can be called multiple times with different options.
//
// NB: it's not thread-safe.
func (g *Generator) Generate(opts ...Option) (decls []Decl, _ error) {
g.opts = newDefaultOptions() // reset options for each call
for _, opt := range opts {
if opt != nil {
opt(g.opts)
}
}
for _, syntax := range g.pkg.Syntax {
for _, decl := range syntax.Decls {
if d, ok := decl.(*goast.GenDecl); ok {
t, err := g.convertDecls(d)
if err != nil {
return nil, err
}
decls = append(decls, t...)
}
}
}
return decls, nil
}
// Format formats CUE ast decls with package header and writes to w.
func (g *Generator) Format(w io.Writer, decls []Decl) error {
if w == nil {
return fmt.Errorf("nil writer")
}
if len(decls) == 0 {
return fmt.Errorf("invalid decls")
}
pkg := &cueast.Package{Name: Ident(g.pkg.Name, false)}
f := &cueast.File{Decls: []cueast.Decl{pkg}}
for _, decl := range decls {
if decl == nil {
continue
}
f.Decls = append(f.Decls, decl.Build())
}
if err := astutil.Sanitize(f); err != nil {
return err
}
b, err := cueformat.Node(f, cueformat.Simplify())
if err != nil {
return err
}
_, err = w.Write(b)
return err
}
// loadPackage loads a package from given path.
func loadPackage(p string) (*packages.Package, error) {
cfg := &packages.Config{
Mode: packages.NeedName | packages.NeedFiles | packages.NeedCompiledGoFiles |
packages.NeedImports | packages.NeedTypes | packages.NeedTypesSizes |
packages.NeedSyntax | packages.NeedTypesInfo | packages.NeedDeps |
packages.NeedModule,
}
pkgs, err := packages.Load(cfg, []string{p}...)
if err != nil {
return nil, err
}
if len(pkgs) != 1 {
return nil, fmt.Errorf("expected one package, got %d", len(pkgs))
}
// only need to check the first package
pkg := pkgs[0]
if pkg.Errors != nil {
errs := make([]string, 0, len(pkg.Errors))
for _, e := range pkg.Errors {
errs = append(errs, fmt.Sprintf("\t%s: %v", pkg.PkgPath, e))
}
return nil, fmt.Errorf("could not load Go packages:\n%s", strings.Join(errs, "\n"))
}
return pkg, nil
}
type typeInfo map[gotypes.Type]*goast.StructType
func getTypeInfo(p *packages.Package) typeInfo {
m := make(typeInfo)
for _, f := range p.Syntax {
goast.Inspect(f, func(n goast.Node) bool {
// record all struct types
if t, ok := n.(*goast.StructType); ok {
m[p.TypesInfo.TypeOf(t)] = t
}
return true
})
}
return m
}