/
generator.go
378 lines (346 loc) · 10.6 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
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
package xmlstruct
import (
"encoding/xml"
"errors"
"fmt"
"go/format"
"io"
"io/fs"
"os"
"sort"
"strings"
"golang.org/x/exp/maps"
"golang.org/x/exp/slices"
"golang.org/x/net/html/charset"
)
var (
SkipDir = fs.SkipDir
//lint:ignore ST1012 SkipFile is not an error
SkipFile = errors.New("skip file") //nolint:errname,revive
)
// A Generator observes XML documents and generates Go structs into which the
// XML documents can be unmarshalled.
type Generator struct {
attrNameSuffix string
charDataFieldName string
elemNameSuffix string
exportNameFunc ExportNameFunc
exportRenames map[string]string
formatSource bool
header string
intType string
nameFunc NameFunc
namedTypes bool
order int
packageName string
preserveOrder bool
timeLayout string
topLevelAttributes bool
typeOrder map[xml.Name]int
usePointersForOptionalFields bool
useRawToken bool
typeElements map[xml.Name]*element
}
// A GeneratorOption sets an option on a Generator.
type GeneratorOption func(*Generator)
// WithAttrNameSuffix sets the attribute suffix.
func WithAttrNameSuffix(attrSuffix string) GeneratorOption {
return func(g *Generator) {
g.attrNameSuffix = attrSuffix
}
}
// WithCharDataFieldName sets the char data field name.
func WithCharDataFieldName(charDataFieldName string) GeneratorOption {
return func(g *Generator) {
g.charDataFieldName = charDataFieldName
}
}
// WithElemNameSuffix sets the attribute suffix.
func WithElemNameSuffix(elemSuffix string) GeneratorOption {
return func(g *Generator) {
g.elemNameSuffix = elemSuffix
}
}
// WithExportNameFunc sets the export name function for the generated Go source.
func WithExportNameFunc(exportNameFunc ExportNameFunc) GeneratorOption {
return func(g *Generator) {
g.exportNameFunc = exportNameFunc
}
}
// WithExportRenames sets the export renames.
func WithExportRenames(exportRenames map[string]string) GeneratorOption {
return func(g *Generator) {
g.exportRenames = exportRenames
}
}
// WithFormatSource sets whether to format the generated Go source.
func WithFormatSource(formatSource bool) GeneratorOption {
return func(g *Generator) {
g.formatSource = formatSource
}
}
// WithHeader sets the header of the generated Go source.
func WithHeader(header string) GeneratorOption {
return func(g *Generator) {
g.header = header
}
}
// WithIntType sets the int type in the generated Go source.
func WithIntType(intType string) GeneratorOption {
return func(g *Generator) {
g.intType = intType
}
}
// WithNameFunc sets the name function.
func WithNameFunc(nameFunc NameFunc) GeneratorOption {
return func(g *Generator) {
g.nameFunc = nameFunc
}
}
// WithNamedTypes sets whether all to generate named types for all elements.
func WithNamedTypes(namedTypes bool) GeneratorOption {
return func(o *Generator) {
o.namedTypes = namedTypes
}
}
// WithPackageName sets the package name of the generated Go source.
func WithPackageName(packageName string) GeneratorOption {
return func(g *Generator) {
g.packageName = packageName
}
}
// WithPreserveOrder sets whether to preserve the order of types and fields.
func WithPreserveOrder(preserveOrder bool) GeneratorOption {
return func(g *Generator) {
g.preserveOrder = preserveOrder
}
}
// WithTimeLayout sets the time layout used to identify times in the observed
// XML documents. Use an empty string to disable identifying times.
func WithTimeLayout(timeLayout string) GeneratorOption {
return func(g *Generator) {
g.timeLayout = timeLayout
}
}
// WithTopLevelAttributes sets whether to include top level attributes.
func WithTopLevelAttributes(topLevelAttributes bool) GeneratorOption {
return func(g *Generator) {
g.topLevelAttributes = topLevelAttributes
}
}
// WithUsePointersForOptionFields sets whether to use pointers for optional
// fields in the generated Go source.
func WithUsePointersForOptionalFields(usePointersForOptionalFields bool) GeneratorOption {
return func(g *Generator) {
g.usePointersForOptionalFields = usePointersForOptionalFields
}
}
// WithUseRawToken sets whether to use encoding/xml.Decoder.Token or
// encoding/xml.Decoder.RawToken.
func WithUseRawToken(useRawToken bool) GeneratorOption {
return func(g *Generator) {
g.useRawToken = useRawToken
}
}
// NewGenerator returns a new Generator with the given options.
func NewGenerator(options ...GeneratorOption) *Generator {
g := &Generator{
attrNameSuffix: DefaultAttrNameSuffix,
charDataFieldName: DefaultCharDataFieldName,
elemNameSuffix: DefaultElemNameSuffix,
formatSource: DefaultFormatSource,
header: DefaultHeader,
intType: DefaultIntType,
nameFunc: DefaultNameFunc,
namedTypes: DefaultNamedTypes,
packageName: DefaultPackageName,
preserveOrder: DefaultPreserveOrder,
timeLayout: DefaultTimeLayout,
topLevelAttributes: DefaultTopLevelAttributes,
typeOrder: make(map[xml.Name]int),
usePointersForOptionalFields: DefaultUsePointersForOptionalFields,
useRawToken: DefaultUseRawToken,
typeElements: make(map[xml.Name]*element),
}
g.exportNameFunc = func(name xml.Name) string {
if exportRename, ok := g.exportRenames[name.Local]; ok {
return exportRename
}
return DefaultExportNameFunc(name)
}
for _, option := range options {
option(g)
}
return g
}
// Generate returns the generated Go source for all the XML documents observed
// so far.
func (g *Generator) Generate() ([]byte, error) {
options := generateOptions{
attrNameSuffix: g.attrNameSuffix,
charDataFieldName: g.charDataFieldName,
elemNameSuffix: g.elemNameSuffix,
exportNameFunc: g.exportNameFunc,
header: g.header,
importPackageNames: make(map[string]struct{}),
intType: g.intType,
preserveOrder: g.preserveOrder,
usePointersForOptionalFields: g.usePointersForOptionalFields,
}
var typeElements []*element
if g.namedTypes {
options.namedTypes = maps.Clone(g.typeElements)
options.simpleTypes = make(map[xml.Name]struct{})
for name, element := range options.namedTypes {
if len(element.attrValues) != 0 || len(element.childElements) != 0 {
continue
}
options.simpleTypes[name] = struct{}{}
delete(options.namedTypes, name)
}
typeElements = maps.Values(options.namedTypes)
} else {
typeElements = maps.Values(g.typeElements)
}
if options.preserveOrder {
slices.SortFunc(typeElements, func(a, b *element) int {
return g.typeOrder[a.name] - g.typeOrder[b.name]
})
} else {
slices.SortFunc(typeElements, func(a, b *element) int {
aExportedName := options.exportNameFunc(a.name)
bExportedName := options.exportNameFunc(b.name)
switch {
case aExportedName < bExportedName:
return -1
case aExportedName == bExportedName:
return 0
default:
return 1
}
})
}
typesBuilder := &strings.Builder{}
typeNames := make(map[string]struct{})
for _, typeElement := range typeElements {
typeName := options.exportNameFunc(typeElement.name)
if _, ok := typeNames[typeName]; ok {
return nil, fmt.Errorf("%s: duplicate type name", typeName)
}
typeNames[typeName] = struct{}{}
fmt.Fprintf(typesBuilder, "\ntype %s ", typeName)
if err := typeElement.writeGoType(typesBuilder, &options, ""); err != nil {
return nil, err
}
typesBuilder.WriteByte('\n')
}
sourceBuilder := &strings.Builder{}
if options.header != "" {
fmt.Fprintf(sourceBuilder, "%s\n\n", options.header)
}
fmt.Fprintf(sourceBuilder, "package %s\n\n", g.packageName)
switch len(options.importPackageNames) {
case 0:
// Do nothing.
case 1:
for importPackageName := range options.importPackageNames {
fmt.Fprintf(sourceBuilder, "import %q\n", importPackageName)
}
default:
fmt.Fprintf(sourceBuilder, "import (\n")
importPackageNames := maps.Keys(options.importPackageNames)
sort.Strings(importPackageNames)
for _, importPackageName := range importPackageNames {
fmt.Fprintf(sourceBuilder, "\t%q\n", importPackageName)
}
fmt.Fprintf(sourceBuilder, ")\n")
}
sourceBuilder.WriteString(typesBuilder.String())
source := []byte(sourceBuilder.String())
if !g.formatSource {
return source, nil
}
return format.Source(source)
}
// ObserveFS observes all XML documents in fs.
func (g *Generator) ObserveFS(fsys fs.FS, root string, observeFunc func(string, fs.DirEntry, error) error) error {
return fs.WalkDir(fsys, root, func(path string, dirEntry fs.DirEntry, err error) error {
switch err := observeFunc(path, dirEntry, err); {
case errors.Is(err, fs.SkipDir):
return fs.SkipDir
case errors.Is(err, SkipFile):
return nil
case dirEntry.IsDir():
return nil
default:
file, err := fsys.Open(path)
if err != nil {
return err
}
defer file.Close()
return g.ObserveReader(file)
}
})
}
// ObserveFile observes an XML document in the given file.
func (g *Generator) ObserveFile(name string) error {
file, err := os.Open(name)
if err != nil {
return err
}
defer file.Close()
return g.ObserveReader(file)
}
// ObserveReader observes an XML document from r.
func (g *Generator) ObserveReader(r io.Reader) error {
options := observeOptions{
getOrder: func() int {
g.order++
return g.order
},
nameFunc: g.nameFunc,
timeLayout: g.timeLayout,
topLevelAttributes: g.topLevelAttributes,
typeOrder: g.typeOrder,
useRawToken: g.useRawToken,
}
if g.namedTypes {
options.topLevelElements = g.typeElements
}
decoder := xml.NewDecoder(r)
decoder.CharsetReader = charset.NewReaderLabel
FOR:
for {
var token xml.Token
var err error
if g.useRawToken {
token, err = decoder.RawToken()
} else {
token, err = decoder.Token()
}
switch {
case errors.Is(err, io.EOF):
return nil
case err != nil:
return err
default:
if startElement, ok := token.(xml.StartElement); ok {
name := g.nameFunc(startElement.Name)
if name == (xml.Name{}) {
continue FOR
}
typeElement, ok := g.typeElements[name]
if !ok {
typeElement = newElement(name)
g.typeElements[name] = typeElement
}
if _, ok := g.typeOrder[name]; !ok {
g.typeOrder[name] = options.getOrder()
}
if err := typeElement.observeChildElement(decoder, startElement, 0, &options); err != nil {
return err
}
}
}
}
}