File: struct.go

package info (click to toggle)
golang-github-xlab-treeprint 0.0~git20181112.a009c39-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 88 kB
  • sloc: makefile: 2
file content (322 lines) | stat: -rw-r--r-- 7,624 bytes parent folder | download | duplicates (3)
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
package treeprint

import (
	"fmt"
	"reflect"
	"strings"
)

type StructTreeOption int

const (
	StructNameTree StructTreeOption = iota
	StructValueTree
	StructTagTree
	StructTypeTree
	StructTypeSizeTree
)

func FromStruct(v interface{}, opt ...StructTreeOption) (Tree, error) {
	var treeOpt StructTreeOption
	if len(opt) > 0 {
		treeOpt = opt[0]
	}
	switch treeOpt {
	case StructNameTree:
		tree := New()
		err := nameTree(tree, v)
		return tree, err
	case StructValueTree:
		tree := New()
		err := valueTree(tree, v)
		return tree, err
	case StructTagTree:
		tree := New()
		err := tagTree(tree, v)
		return tree, err
	case StructTypeTree:
		tree := New()
		err := typeTree(tree, v)
		return tree, err
	case StructTypeSizeTree:
		tree := New()
		err := typeSizeTree(tree, v)
		return tree, err
	default:
		err := fmt.Errorf("treeprint: invalid StructTreeOption %v", treeOpt)
		return nil, err
	}
}

type FmtFunc func(name string, v interface{}) (string, bool)

func FromStructWithMeta(v interface{}, fmtFunc FmtFunc) (Tree, error) {
	if fmtFunc == nil {
		tree := New()
		err := nameTree(tree, v)
		return tree, err
	}
	tree := New()
	err := metaTree(tree, v, fmtFunc)
	return tree, err
}

func Repr(v interface{}) string {
	tree := New()
	vType := reflect.TypeOf(v)
	vValue := reflect.ValueOf(v)
	_, val, isStruct := getValue(vType, &vValue)
	if !isStruct {
		return fmt.Sprintf("%+v", val.Interface())
	}
	err := valueTree(tree, val.Interface())
	if err != nil {
		return err.Error()
	}
	return tree.String()
}

func nameTree(tree Tree, v interface{}) error {
	typ, val, err := checkType(v)
	if err != nil {
		return err
	}
	fields := typ.NumField()
	for i := 0; i < fields; i++ {
		field := typ.Field(i)
		fieldValue := val.Field(i)
		name, skip, omit := getMeta(field.Name, field.Tag)
		if skip || omit && isEmpty(&fieldValue) {
			continue
		}
		typ, val, isStruct := getValue(field.Type, &fieldValue)
		if !isStruct {
			tree.AddNode(name)
			continue
		} else if subNum := typ.NumField(); subNum == 0 {
			tree.AddNode(name)
			continue
		}
		branch := tree.AddBranch(name)
		if err := nameTree(branch, val.Interface()); err != nil {
			err := fmt.Errorf("%v on struct branch %s", err, name)
			return err
		}
	}
	return nil
}

func getMeta(fieldName string, tag reflect.StructTag) (name string, skip, omit bool) {
	if tagStr := tag.Get("tree"); len(tagStr) > 0 {
		name, omit = tagSpec(tagStr)
	}
	if name == "-" {
		return fieldName, true, omit
	}
	if len(name) == 0 {
		name = fieldName
	} else if trimmed := strings.TrimSpace(name); len(trimmed) == 0 {
		name = fieldName
	}
	return
}

func valueTree(tree Tree, v interface{}) error {
	typ, val, err := checkType(v)
	if err != nil {
		return err
	}
	fields := typ.NumField()
	for i := 0; i < fields; i++ {
		field := typ.Field(i)
		fieldValue := val.Field(i)
		name, skip, omit := getMeta(field.Name, field.Tag)
		if skip || omit && isEmpty(&fieldValue) {
			continue
		}
		typ, val, isStruct := getValue(field.Type, &fieldValue)
		if !isStruct {
			tree.AddMetaNode(val.Interface(), name)
			continue
		} else if subNum := typ.NumField(); subNum == 0 {
			tree.AddMetaNode(val.Interface(), name)
			continue
		}
		branch := tree.AddBranch(name)
		if err := valueTree(branch, val.Interface()); err != nil {
			err := fmt.Errorf("%v on struct branch %s", err, name)
			return err
		}
	}
	return nil
}

func tagTree(tree Tree, v interface{}) error {
	typ, val, err := checkType(v)
	if err != nil {
		return err
	}
	fields := typ.NumField()
	for i := 0; i < fields; i++ {
		field := typ.Field(i)
		fieldValue := val.Field(i)
		name, skip, omit := getMeta(field.Name, field.Tag)
		if skip || omit && isEmpty(&fieldValue) {
			continue
		}
		filteredTag := filterTags(field.Tag)
		typ, val, isStruct := getValue(field.Type, &fieldValue)
		if !isStruct {
			tree.AddMetaNode(filteredTag, name)
			continue
		} else if subNum := typ.NumField(); subNum == 0 {
			tree.AddMetaNode(filteredTag, name)
			continue
		}
		branch := tree.AddMetaBranch(filteredTag, name)
		if err := tagTree(branch, val.Interface()); err != nil {
			err := fmt.Errorf("%v on struct branch %s", err, name)
			return err
		}
	}
	return nil
}

func typeTree(tree Tree, v interface{}) error {
	typ, val, err := checkType(v)
	if err != nil {
		return err
	}
	fields := typ.NumField()
	for i := 0; i < fields; i++ {
		field := typ.Field(i)
		fieldValue := val.Field(i)
		name, skip, omit := getMeta(field.Name, field.Tag)
		if skip || omit && isEmpty(&fieldValue) {
			continue
		}
		typ, val, isStruct := getValue(field.Type, &fieldValue)
		typename := fmt.Sprintf("%T", val.Interface())
		if !isStruct {
			tree.AddMetaNode(typename, name)
			continue
		} else if subNum := typ.NumField(); subNum == 0 {
			tree.AddMetaNode(typename, name)
			continue
		}
		branch := tree.AddMetaBranch(typename, name)
		if err := typeTree(branch, val.Interface()); err != nil {
			err := fmt.Errorf("%v on struct branch %s", err, name)
			return err
		}
	}
	return nil
}

func typeSizeTree(tree Tree, v interface{}) error {
	typ, val, err := checkType(v)
	if err != nil {
		return err
	}
	fields := typ.NumField()
	for i := 0; i < fields; i++ {
		field := typ.Field(i)
		fieldValue := val.Field(i)
		name, skip, omit := getMeta(field.Name, field.Tag)
		if skip || omit && isEmpty(&fieldValue) {
			continue
		}
		typ, val, isStruct := getValue(field.Type, &fieldValue)
		typesize := typ.Size()
		if !isStruct {
			tree.AddMetaNode(typesize, name)
			continue
		} else if subNum := typ.NumField(); subNum == 0 {
			tree.AddMetaNode(typesize, name)
			continue
		}
		branch := tree.AddMetaBranch(typesize, name)
		if err := typeSizeTree(branch, val.Interface()); err != nil {
			err := fmt.Errorf("%v on struct branch %s", err, name)
			return err
		}
	}
	return nil
}

func metaTree(tree Tree, v interface{}, fmtFunc FmtFunc) error {
	typ, val, err := checkType(v)
	if err != nil {
		return err
	}
	fields := typ.NumField()
	for i := 0; i < fields; i++ {
		field := typ.Field(i)
		fieldValue := val.Field(i)
		name, skip, omit := getMeta(field.Name, field.Tag)
		if skip || omit && isEmpty(&fieldValue) {
			continue
		}
		typ, val, isStruct := getValue(field.Type, &fieldValue)
		formatted, show := fmtFunc(name, val.Interface())
		if !isStruct {
			if show {
				tree.AddMetaNode(formatted, name)
				continue
			}
			tree.AddNode(name)
			continue
		} else if subNum := typ.NumField(); subNum == 0 {
			if show {
				tree.AddMetaNode(formatted, name)
				continue
			}
			tree.AddNode(name)
			continue
		}
		var branch Tree
		if show {
			branch = tree.AddMetaBranch(formatted, name)
		} else {
			branch = tree.AddBranch(name)
		}
		if err := metaTree(branch, val.Interface(), fmtFunc); err != nil {
			err := fmt.Errorf("%v on struct branch %s", err, name)
			return err
		}
	}
	return nil
}

func getValue(typ reflect.Type, val *reflect.Value) (reflect.Type, *reflect.Value, bool) {
	switch typ.Kind() {
	case reflect.Ptr:
		typ = typ.Elem()
		if typ.Kind() == reflect.Struct {
			elem := val.Elem()
			return typ, &elem, true
		}
	case reflect.Struct:
		return typ, val, true
	}
	return typ, val, false
}

func checkType(v interface{}) (reflect.Type, *reflect.Value, error) {
	typ := reflect.TypeOf(v)
	val := reflect.ValueOf(v)
	switch typ.Kind() {
	case reflect.Ptr:
		typ = typ.Elem()
		if typ.Kind() != reflect.Struct {
			err := fmt.Errorf("treeprint: %T is not a struct we could work with", v)
			return nil, nil, err
		}
		val = val.Elem()
	case reflect.Struct:
	default:
		err := fmt.Errorf("treeprint: %T is not a struct we could work with", v)
		return nil, nil, err
	}
	return typ, &val, nil
}