File: gen-accessors.go

package info (click to toggle)
golang-github-zorkian-go-datadog-api 2.30.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 1,612 kB
  • sloc: makefile: 28; sh: 13
file content (346 lines) | stat: -rw-r--r-- 9,448 bytes parent folder | download
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
//+build ignore

/*
 * Datadog API for Go
 *
 * Please see the included LICENSE file for licensing information.
 *
 * Copyright 2017 by authors and contributors.

 gen-accessors generates GetXx, GetXxOk, HasXx and SetXx methods for struct field types with pointers.

 It should be run by the go-datadog-api authors to ge-generate methods before pushing changes to GitHub.
*/

package main

import (
	"bytes"
	"flag"
	"fmt"
	"go/ast"
	"go/format"
	"go/parser"
	"go/token"
	"io/ioutil"
	"log"
	"os"
	"path/filepath"
	"sort"
	"strings"
	"text/template"
	"time"
)

const (
	fileSuffix = "-accessors.go"
)

var (
	verbose    = flag.Bool("v", false, "Print verbose log messages")
	sourceTmpl = template.Must(template.New("source").Parse(source))
)

func logf(fmt string, args ...interface{}) {
	if *verbose {
		log.Printf(fmt, args...)
	}
}

func main() {
	flag.Parse()
	fset := token.NewFileSet()

	pkgs, err := parser.ParseDir(fset, ".", sourceFilter, 0)
	if err != nil {
		log.Fatal(err)
		return
	}

	for pkgName, pkg := range pkgs {
		t := &templateData{
			Year:     time.Now().Year(),
			Filename: pkgName + fileSuffix,
			Package:  pkgName,
			Imports:  map[string]string{},
		}
		for filename, f := range pkg.Files {
			logf("Processing %v...", filename)
			t.sourceFile = filename
			if err := t.processAST(f); err != nil {
				log.Fatal(err)
			}
		}
		if err := t.dump(); err != nil {
			log.Fatal(err)
		}
	}
	logf("Done.")
}

// processAST walks source code files, looks for struct definitions, and calls appropriate helper functions
// to add generate accessors for type fields are star expressions -ie: pointers
func (t *templateData) processAST(f *ast.File) error {
	for _, decl := range f.Decls {
		gd, ok := decl.(*ast.GenDecl)
		if !ok {
			continue
		}
		for _, spec := range gd.Specs {
			// Types only
			ts, ok := spec.(*ast.TypeSpec)
			if !ok {
				continue
			}
			// Structs only
			st, ok := ts.Type.(*ast.StructType)
			if !ok {
				continue
			}

			for _, field := range st.Fields.List {
				// Pointers only
				se, ok := field.Type.(*ast.StarExpr)
				if len(field.Names) == 0 || !ok {
					continue
				}

				// TODO: handle more than one types, is that a thing?
				fieldName := field.Names[0]

				switch x := se.X.(type) {
				// An array or slice type
				case *ast.ArrayType:
					t.addArrayType(x, ts.Name.String(), fieldName.String())
				// An identifier. Most of our fields will match this
				case *ast.Ident:
					t.addIdent(x, ts.Name.String(), fieldName.String())
				// A map
				case *ast.MapType:
					t.addMapType(x, ts.Name.String(), fieldName.String())
				// A selector expression, ie json.Number
				case *ast.SelectorExpr:
					t.addSelectorExpr(x, ts.Name.String(), fieldName.String())
				default:
					logf("processAST: type %q, field %q, unknown %T: %+v", ts.Name, fieldName, x, x)
				}
			}
		}
	}
	return nil
}

// sourceFilter is a filter to ignore blacklisted file patterns
func sourceFilter(fi os.FileInfo) bool {
	return !strings.HasSuffix(fi.Name(), "_test.go") && !strings.HasSuffix(fi.Name(), fileSuffix)
}

// dump sorts the results, and writes the generated code to a file
func (t *templateData) dump() error {
	if len(t.Accessors) == 0 {
		logf("No accessors for %v; skipping.", t.Filename)
		return nil
	}

	// Sort accessors by ReceiverType.FieldName
	sort.Sort(byName(t.Accessors))

	var buf bytes.Buffer
	if err := sourceTmpl.Execute(&buf, t); err != nil {
		return err
	}
	clean, err := format.Source(buf.Bytes())
	if err != nil {
		return err
	}

	outFile := filepath.Join(filepath.Dir(t.sourceFile), t.Filename)
	logf("Writing %v...", outFile)
	return ioutil.WriteFile(outFile, clean, 0644)
}

// newAccessor returns a new accessor to be processed later
func newAccessor(receiverType, fieldName, fieldType, zeroValue string) *accessor {
	return &accessor{
		sortVal:      strings.ToLower(receiverType) + "." + strings.ToLower(fieldName),
		ReceiverVar:  strings.ToLower(receiverType[:1]),
		ReceiverType: receiverType,
		FieldName:    fieldName,
		FieldType:    fieldType,
		ZeroValue:    zeroValue,
	}
}

// addIdent adds an accessor for an identifier, for a given receiver and field
func (t *templateData) addIdent(x *ast.Ident, receiverType, fieldName string) {
	var zeroValue string
	switch x.String() {
	case "int", "int64":
		zeroValue = "0"
	case "string":
		zeroValue = `""`
	case "bool":
		zeroValue = "false"
	case "float64":
		zeroValue = "0"
	case "Status":
		zeroValue = "0"
	case "PrecisionT":
		zeroValue = `""`
	default:
		zeroValue = fmt.Sprintf("%s{}", x.String())
	}

	t.Accessors = append(t.Accessors, newAccessor(receiverType, fieldName, x.String(), zeroValue))
}

// addSelectorExpr adds an accessor for an identifier selector expression, for a given receiver and field
func (t *templateData) addSelectorExpr(x *ast.SelectorExpr, receiverType, fieldName string) {
	if strings.ToLower(fieldName[:1]) == fieldName[:1] { // non-exported field
		return
	}

	var xX string
	if xx, ok := x.X.(*ast.Ident); ok {
		xX = xx.String()
	}

	switch xX {
	case "time", "json":
		if xX == "json" {
			t.Imports["encoding/json"] = "encoding/json"
		} else {
			t.Imports[xX] = xX
		}
		fieldType := fmt.Sprintf("%v.%v", xX, x.Sel.Name)
		zeroValue := fmt.Sprintf("%v.%v{}", xX, x.Sel.Name)
		if xX == "json" && x.Sel.Name == "Number" {
			zeroValue = `""`
		}
		if xX == "time" && x.Sel.Name == "Duration" {
			zeroValue = "0"
		}
		t.Accessors = append(t.Accessors, newAccessor(receiverType, fieldName, fieldType, zeroValue))
	default:
		logf("addSelectorExpr: xX %q, type %q, field %q: unknown x=%+v; skipping.", xX, receiverType, fieldName, x)
	}
}

// addMypType adds an accessor for a map type, for a given receiver and field
func (t *templateData) addMapType(x *ast.MapType, receiverType, fieldName string) {
	// TODO: should we make this dynamic? Could handle more cases than string only
	var keyType string
	switch key := x.Key.(type) {
	case *ast.Ident:
		keyType = key.String()
	default:
		logf("addMapType: type %q, field %q: unknown key type: %T %+v; skipping.", receiverType, fieldName, key, key)
		return
	}

	var valueType string
	switch value := x.Value.(type) {
	case *ast.Ident:
		valueType = value.String()
	default:
		logf("addMapType: type %q, field %q: unknown value type: %T %+v; skipping.", receiverType, fieldName, value, value)
		return
	}

	fieldType := fmt.Sprintf("map[%v]%v", keyType, valueType)
	zeroValue := fmt.Sprintf("map[%v]%v{}", keyType, valueType)
	t.Accessors = append(t.Accessors, newAccessor(receiverType, fieldName, fieldType, zeroValue))
}

// addArrayType adds an accessor for a array type for a given receiver and field
func (t *templateData) addArrayType(x *ast.ArrayType, receiverType, fieldName string) {
	// TODO: should we make this dynamic? Could handle more cases than string only
	var eltType string
	switch elt := x.Elt.(type) {
	case *ast.Ident:
		eltType = elt.String()
	default:
		logf("addArrayType: type %q, field %q: unknown element type: %T %+v; skipping.", receiverType, fieldName, elt, elt)
		return
	}

	t.Accessors = append(t.Accessors, newAccessor(receiverType, fieldName, "[]"+eltType, "nil"))
}

// hold data used by our template
type templateData struct {
	sourceFile string
	Year       int
	Filename   string
	Package    string
	Imports    map[string]string
	Accessors  []*accessor
}

// our accessor used to render templates
type accessor struct {
	sortVal      string // lower-case version of "ReceiverType.FieldName"
	ReceiverVar  string // the one-letter variable name to match the ReceiverType
	ReceiverType string
	FieldName    string
	FieldType    string
	ZeroValue    string
}

// some helpers to sort
type byName []*accessor

func (b byName) Len() int           { return len(b) }
func (b byName) Less(i, j int) bool { return b[i].sortVal < b[j].sortVal }
func (b byName) Swap(i, j int)      { b[i], b[j] = b[j], b[i] }

const source = `/*
 THIS FILE IS AUTOMATICALLY GENERATED BY create-accessors; DO NOT EDIT.
 * Datadog API for Go
 *
 * Please see the included LICENSE file for licensing information.
 *
 * Copyright {{.Year}} by authors and contributors.
 */

package {{.Package}}
{{if .Imports}}
import (
  {{range .Imports}}
  "{{.}}"{{end}}
)
{{end}}
{{range .Accessors}}
// Get{{.FieldName}} returns the {{.FieldName}} field if non-nil, zero value otherwise.
func ({{.ReceiverVar}} *{{.ReceiverType}}) Get{{.FieldName}}() {{.FieldType}} {
  if {{.ReceiverVar}} == nil || {{.ReceiverVar}}.{{.FieldName}} == nil {
    return {{.ZeroValue}}
  }
  return *{{.ReceiverVar}}.{{.FieldName}}
}

// Get{{.FieldName}}Ok returns a tuple with the {{.FieldName}} field if it's non-nil, zero value otherwise
// and a boolean to check if the value has been set.
func ({{.ReceiverVar}} *{{.ReceiverType}}) Get{{.FieldName}}Ok() ({{.FieldType}}, bool){
  if {{.ReceiverVar}} == nil || {{.ReceiverVar}}.{{.FieldName}} == nil {
    return {{.ZeroValue}}, false
  }
  return *{{.ReceiverVar}}.{{.FieldName}}, true
}

// Has{{.FieldName}} returns a boolean if a field has been set.
func ({{.ReceiverVar}} *{{.ReceiverType}}) Has{{.FieldName}}() bool {
   if {{.ReceiverVar}} != nil && {{.ReceiverVar}}.{{.FieldName}} != nil {
    return true
   }

   return false
}

// Set{{.FieldName}} allocates a new {{.ReceiverVar}}.{{.FieldName}} and returns the pointer to it.
func ({{.ReceiverVar}} *{{.ReceiverType}}) Set{{.FieldName}}(v {{.FieldType}}) {
  {{.ReceiverVar}}.{{.FieldName}} = &v
}

{{end}}
`