-
Notifications
You must be signed in to change notification settings - Fork 30
/
fileset_info.go
549 lines (500 loc) · 15 KB
/
fileset_info.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
package toolbox
import (
"fmt"
"go/ast"
"go/parser"
"go/token"
"go/types"
"io/ioutil"
"os"
"path"
"path/filepath"
"strings"
)
//FieldInfo represents a filed info
type FieldInfo struct {
Name string
TypeName string
ComponentType string
IsPointerComponent bool
KeyTypeName string
ValueTypeName string
TypePackage string
IsAnonymous bool
IsMap bool
IsChannel bool
IsSlice bool
IsPointer bool
Tag string
Comment string
IsVariant bool
}
//NewFunctionInfoFromField creates a new function info.
func NewFunctionInfoFromField(field *ast.Field, owner *FileInfo) *FunctionInfo {
result := &FunctionInfo{
Name: "",
ParameterFields: make([]*FieldInfo, 0),
ResultsFields: make([]*FieldInfo, 0),
}
if len(field.Names) > 0 {
result.Name = field.Names[0].Name
}
if funcType, ok := field.Type.(*ast.FuncType); ok {
if funcType.Params != nil && len(funcType.Params.List) > 0 {
result.ParameterFields = toFieldInfoSlice(funcType.Params)
}
if funcType.Results != nil && len(funcType.Results.List) > 0 {
result.ResultsFields = toFieldInfoSlice(funcType.Results)
}
var names = make(map[string]bool)
for _, param := range result.ParameterFields {
if strings.Contains(strings.ToLower(param.TypeName), strings.ToLower(param.Name)) {
name := matchLastNameSegment(param.TypeName)
if _, has := names[name]; has {
continue
}
names[name] = true
param.Name = name
}
}
}
return result
}
func matchLastNameSegment(name string) string {
var result = make([]byte, 0)
for i := len(name) - 1; i >= 0; i-- {
aChar := string(name[i : i+1])
if aChar != "." {
result = append(result, byte(aChar[0]))
}
if strings.ToUpper(aChar) == aChar || aChar == "." {
ReverseSlice(result)
return string(result)
}
}
return name
}
//NewFieldInfo creates a new field info.
func NewFieldInfo(field *ast.Field) *FieldInfo {
return NewFieldInfoByIndex(field, 0)
}
//NewFieldInfoByIndex creates a new field info.
func NewFieldInfoByIndex(field *ast.Field, index int) *FieldInfo {
result := &FieldInfo{
Name: "",
TypeName: types.ExprString(field.Type),
}
if len(field.Names) > 0 {
result.Name = field.Names[index].Name
} else {
result.Name = strings.Replace(strings.Replace(result.TypeName, "[]", "", len(result.TypeName)), "*", "", len(result.TypeName))
result.IsAnonymous = true
}
_, result.IsMap = field.Type.(*ast.MapType)
var arrayType *ast.ArrayType
if arrayType, result.IsSlice = field.Type.(*ast.ArrayType); result.IsSlice {
switch x := arrayType.Elt.(type) {
case *ast.Ident:
result.ComponentType = x.Name
case *ast.StarExpr:
switch y := x.X.(type) {
case *ast.Ident:
result.ComponentType = y.Name
case *ast.SelectorExpr:
result.ComponentType = y.X.(*ast.Ident).Name + "." + y.Sel.Name
}
result.IsPointerComponent = true
case *ast.SelectorExpr:
result.ComponentType = x.X.(*ast.Ident).Name + "." + x.Sel.Name
}
}
_, result.IsPointer = field.Type.(*ast.StarExpr)
_, result.IsChannel = field.Type.(*ast.ChanType)
if selector, ok := field.Type.(*ast.SelectorExpr); ok {
result.TypePackage = types.ExprString(selector.X)
}
if result.IsPointer {
if pointerExpr, casted := field.Type.(*ast.StarExpr); casted {
if identExpr, ok := pointerExpr.X.(*ast.Ident); ok {
result.TypeName = identExpr.Name
}
}
} else if identExpr, ok := field.Type.(*ast.Ident); ok {
result.TypeName = identExpr.Name
}
if field.Tag != nil {
result.Tag = field.Tag.Value
}
if mapType, ok := field.Type.(*ast.MapType); ok {
result.KeyTypeName = types.ExprString(mapType.Key)
result.ValueTypeName = types.ExprString(mapType.Value)
}
if strings.Contains(result.TypeName, "...") {
result.IsVariant = true
result.TypeName = strings.Replace(result.TypeName, "...", "[]", 1)
}
if index := strings.Index(result.TypeName, "."); index != -1 {
from := 0
if result.IsPointer {
from = 1
}
result.TypePackage = string(result.TypeName[from:index])
}
return result
}
//FunctionInfo represents a function info
type FunctionInfo struct {
Name string
ReceiverTypeName string
ParameterFields []*FieldInfo
ResultsFields []*FieldInfo
*FileInfo
}
//NewFunctionInfo create a new function
func NewFunctionInfo(funcDeclaration *ast.FuncDecl, owner *FileInfo) *FunctionInfo {
result := &FunctionInfo{
Name: "",
ParameterFields: make([]*FieldInfo, 0),
ResultsFields: make([]*FieldInfo, 0),
}
if funcDeclaration.Name != nil {
result.Name = funcDeclaration.Name.Name
}
if funcDeclaration.Recv != nil {
receiverType := funcDeclaration.Recv.List[0].Type
if ident, ok := receiverType.(*ast.Ident); ok {
result.ReceiverTypeName = ident.Name
} else if startExpr, ok := receiverType.(*ast.StarExpr); ok {
if ident, ok := startExpr.X.(*ast.Ident); ok {
result.ReceiverTypeName = ident.Name
}
}
}
return result
}
//TypeInfo represents a struct info
type TypeInfo struct {
Name string
Package string
FileName string
Comment string
IsSlice bool
IsMap bool
IsStruct bool
IsInterface bool
IsDerived bool
ComponentType string
IsPointerComponentType bool
Derived string
KeyTypeName string
ValueTypeName string
Settings map[string]string
fields []*FieldInfo
indexedField map[string]*FieldInfo
receivers []*FunctionInfo
indexedReceiver map[string]*FunctionInfo
rcv *FunctionInfo
}
//AddFields appends fileds to structinfo
func (s *TypeInfo) AddFields(fields ...*FieldInfo) {
s.fields = append(s.fields, fields...)
for _, field := range fields {
s.indexedField[field.Name] = field
}
}
//Field returns filedinfo for supplied file name
func (s *TypeInfo) Field(name string) *FieldInfo {
return s.indexedField[name]
}
//Fields returns all fields
func (s *TypeInfo) Fields() []*FieldInfo {
return s.fields
}
//HasField returns true if struct has passed in field.
func (s *TypeInfo) HasField(name string) bool {
_, found := s.indexedField[name]
return found
}
//Receivers returns struct functions
func (s *TypeInfo) Receivers() []*FunctionInfo {
return s.receivers
}
//Receiver returns receiver for passed in name
func (s *TypeInfo) Receiver(name string) *FunctionInfo {
return s.indexedReceiver[name]
}
//HasReceiver returns true if receiver is defined for struct
func (s *TypeInfo) HasReceiver(name string) bool {
_, found := s.indexedReceiver[name]
return found
}
//AddReceivers adds receiver for the struct
func (s *TypeInfo) AddReceivers(receivers ...*FunctionInfo) {
s.receivers = append(s.receivers, receivers...)
for _, receiver := range receivers {
s.indexedReceiver[receiver.Name] = receiver
}
}
//NewTypeInfo creates a new struct info
func NewTypeInfo(name string) *TypeInfo {
return &TypeInfo{Name: name,
fields: make([]*FieldInfo, 0),
receivers: make([]*FunctionInfo, 0),
indexedReceiver: make(map[string]*FunctionInfo),
indexedField: make(map[string]*FieldInfo),
Settings: make(map[string]string)}
}
//FileInfo represent hold definition about all defined types and its receivers in a file
type FileInfo struct {
basePath string
filename string
types map[string]*TypeInfo
functions map[string][]*FunctionInfo
packageName string
currentTypInfo *TypeInfo
fileSet *token.FileSet
currentFunctionInfo *FunctionInfo
Imports map[string]string
}
//Type returns a type info for passed in name
func (f *FileInfo) Type(name string) *TypeInfo {
return f.types[name]
}
//Type returns a struct info for passed in name
func (f *FileInfo) addFunction(funcion *FunctionInfo) {
functions, found := f.functions[funcion.ReceiverTypeName]
if !found {
functions = make([]*FunctionInfo, 0)
f.functions[funcion.ReceiverTypeName] = functions
}
f.functions[funcion.ReceiverTypeName] = append(f.functions[funcion.ReceiverTypeName], funcion)
}
//Types returns all struct info
func (f *FileInfo) Types() []*TypeInfo {
var result = make([]*TypeInfo, 0)
for _, v := range f.types {
result = append(result, v)
}
return result
}
//HasType returns truc if struct info is defined in a file
func (f *FileInfo) HasType(name string) bool {
_, found := f.types[name]
return found
}
//readComment reads comment from the position
func (f *FileInfo) readComment(pos token.Pos) string {
position := f.fileSet.Position(pos)
fileName := path.Join(f.basePath, f.filename)
content, err := ioutil.ReadFile(fileName)
if err != nil {
panic("Unable to open file " + fileName)
}
line := strings.Split(string(content), "\n")[position.Line-1]
commentPosition := strings.LastIndex(line, "//")
if commentPosition != -1 {
return line[commentPosition+2:]
}
return ""
}
//toFieldInfoSlice converts filedList to FiledInfo slice.
func toFieldInfoSlice(source *ast.FieldList) []*FieldInfo {
var result = make([]*FieldInfo, 0)
if source == nil || len(source.List) == 0 {
return result
}
for _, field := range source.List {
if len(field.Names) > 0 {
for i := range field.Names {
result = append(result, NewFieldInfoByIndex(field, i))
}
} else {
result = append(result, NewFieldInfoByIndex(field, 0))
}
}
return result
}
//toFunctionInfos convers filedList to function info slice.
func toFunctionInfos(source *ast.FieldList, owner *FileInfo) []*FunctionInfo {
var result = make([]*FunctionInfo, 0)
if source == nil || len(source.List) == 0 {
return result
}
for _, field := range source.List {
result = append(result, NewFunctionInfoFromField(field, owner))
}
return result
}
//Visit visits ast node to extract struct details from the passed file
func (f *FileInfo) Visit(node ast.Node) ast.Visitor {
if node != nil {
if os.Getenv("AST_DEBUG") == "1" {
fmt.Printf("%T %v\n",node,node)
}
//TODO refactor this mess !!!!
switch value := node.(type) {
case *ast.TypeSpec:
typeName := value.Name.Name
typeInfo := NewTypeInfo(typeName)
typeInfo.Package = f.packageName
typeInfo.FileName = f.filename
switch typeValue := value.Type.(type) {
case *ast.ArrayType:
typeInfo.IsSlice = true
if ident, ok := typeValue.Elt.(*ast.Ident); ok {
typeInfo.ComponentType = ident.Name
} else if startExpr, ok := typeValue.Elt.(*ast.StarExpr); ok {
if ident, ok := startExpr.X.(*ast.Ident); ok {
typeInfo.ComponentType = ident.Name
}
typeInfo.IsPointerComponentType = true
}
case *ast.StructType:
typeInfo.IsStruct = true
case *ast.InterfaceType:
typeInfo.IsInterface = true
case *ast.Ident:
typeInfo.Derived = typeValue.Name
typeInfo.IsDerived = true
}
f.currentTypInfo = typeInfo
f.types[typeName] = typeInfo
case *ast.StructType:
if f.currentTypInfo != nil { //TODO fixme - understand why current type would be nil
f.currentTypInfo.Comment = f.readComment(value.Pos())
f.currentTypInfo.AddFields(toFieldInfoSlice(value.Fields)...)
}
case *ast.FuncDecl:
functionInfo := NewFunctionInfo(value, f)
functionInfo.FileInfo = f
f.currentFunctionInfo = functionInfo
if len(functionInfo.ReceiverTypeName) > 0 {
f.addFunction(functionInfo)
}
case *ast.MapType:
if f.currentTypInfo == nil {
break
}
f.currentTypInfo.IsMap = true
if keyTypeID, ok := value.Key.(*ast.Ident); ok {
f.currentTypInfo.KeyTypeName = keyTypeID.Name
}
switch v := value.Value.(type) {
case *ast.Ident:
f.currentTypInfo.ValueTypeName = v.Name
case *ast.StarExpr:
componentTypeName := "*"
switch y :=v.X.(type) {
case *ast.Ident:
componentTypeName += y.Name
case *ast.SelectorExpr:
componentTypeName += y.X.(*ast.Ident).Name + "." + y.Sel.Name
}
f.currentTypInfo.ValueTypeName = componentTypeName
case *ast.ArrayType:
componentTypeName := ""
switch compType := v.Elt.(type) {
case *ast.StarExpr:
componentTypeName += "*"
switch y := compType.X.(type) {
case *ast.Ident:
componentTypeName += y.Name
case *ast.SelectorExpr:
componentTypeName += y.X.(*ast.Ident).Name + "." + y.Sel.Name
}
case *ast.Ident:
componentTypeName = compType.Name
}
f.currentTypInfo.ValueTypeName = "[]" + componentTypeName
}
case *ast.FuncType:
if f.currentFunctionInfo != nil {
if value.Params != nil {
f.currentFunctionInfo.ParameterFields = toFieldInfoSlice(value.Params)
}
if value.Results != nil {
f.currentFunctionInfo.ResultsFields = toFieldInfoSlice(value.Results)
}
f.currentFunctionInfo = nil
}
case *ast.FieldList:
if f.currentTypInfo != nil && f.currentTypInfo.IsInterface {
f.currentTypInfo.receivers = toFunctionInfos(value, f)
f.currentTypInfo = nil
}
case *ast.ImportSpec:
if value.Name != nil && value.Name.String() != "" {
f.Imports[value.Name.String()] = value.Path.Value
} else {
_, name := path.Split(value.Path.Value)
name = strings.Replace(name, `"`, "", 2)
f.Imports[name] = value.Path.Value
}
}
}
return f
}
//NewFileInfo creates a new file info.
func NewFileInfo(basePath, packageName, filename string, fileSet *token.FileSet) *FileInfo {
result := &FileInfo{
basePath: basePath,
filename: filename,
packageName: packageName,
types: make(map[string]*TypeInfo),
functions: make(map[string][]*FunctionInfo),
Imports: make(map[string]string),
fileSet: fileSet}
return result
}
//FileSetInfo represents a fileset info storing information about go file with their struct definition
type FileSetInfo struct {
files map[string]*FileInfo
}
//FileInfo returns fileinfo for supplied file name
func (f *FileSetInfo) FileInfo(name string) *FileInfo {
return f.files[name]
}
//FilesInfo returns all files info.
func (f *FileSetInfo) FilesInfo() map[string]*FileInfo {
return f.files
}
//Type returns type info for passed in type name.
func (f *FileSetInfo) Type(name string) *TypeInfo {
if pointerIndex := strings.LastIndex(name, "*"); pointerIndex != -1 {
name = name[pointerIndex+1:]
}
for _, v := range f.files {
if v.HasType(name) {
return v.Type(name)
}
}
return nil
}
//NewFileSetInfo creates a new fileset info
func NewFileSetInfo(baseDir string) (*FileSetInfo, error) {
fileSet := token.NewFileSet()
pkgs, err := parser.ParseDir(fileSet, baseDir, nil, parser.ParseComments)
if err != nil {
return nil, fmt.Errorf("failed to parse path %v: %v", baseDir, err)
}
var result = &FileSetInfo{
files: make(map[string]*FileInfo),
}
for packageName, pkg := range pkgs {
for filename, file := range pkg.Files {
filename := filepath.Base(filename)
fileInfo := NewFileInfo(baseDir, packageName, filename, fileSet)
ast.Walk(fileInfo, file)
result.files[filename] = fileInfo
}
}
for _, fileInfo := range result.files {
for k, functionsInfo := range fileInfo.functions {
typeInfo := result.Type(k)
if typeInfo != nil && typeInfo.IsStruct {
typeInfo.AddReceivers(functionsInfo...)
}
}
}
return result, nil
}