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
|
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
package exports
import (
"fmt"
"go/ast"
"strings"
)
// Content defines the set of exported constants, funcs, and structs.
type Content struct {
// the list of exported constants.
// key is the exported name, value is its type and value.
Consts map[string]Const `json:"consts,omitempty"`
// the list of exported functions and methods.
// key is the exported name, for methods it's prefixed with the receiver type (e.g. "Type.Method").
// value contains the list of params and return types.
Funcs map[string]Func `json:"funcs,omitempty"`
// the list of exported interfaces.
// key is the exported name, value contains the interface definition.
Interfaces map[string]Interface `json:"interfaces,omitempty"`
// the list of exported struct types.
// key is the exported name, value contains field information.
Structs map[string]Struct `json:"structs,omitempty"`
}
// Count returns the count of items
func (c Content) Count() int {
return len(c.Consts) + len(c.Funcs) + len(c.Interfaces) + len(c.Structs)
}
// Const is a const definition.
type Const struct {
// the type of the constant
Type string `json:"type"`
// the value of the constant
Value string `json:"value"`
}
// Func contains parameter and return types of a function/method.
type Func struct {
// a comma-delimited list of the param types
Params *string `json:"params,omitempty"`
// a comma-delimited list of the return types
Returns *string `json:"returns,omitempty"`
}
// Interface contains the list of methods for an interface.
type Interface struct {
// a list of embedded interfaces
AnonymousFields []string `json:"anon,omitempty"`
// key/value pairs of the methd names and their definitions
Methods map[string]Func
}
// Struct contains field info about a struct.
type Struct struct {
// a list of anonymous fields
AnonymousFields []string `json:"anon,omitempty"`
// key/value pairs of the field names and types respectively.
Fields map[string]string `json:"fields,omitempty"`
}
// NewContent returns an initialized Content object.
func NewContent() Content {
return Content{
Consts: make(map[string]Const),
Funcs: make(map[string]Func),
Interfaces: make(map[string]Interface),
Structs: make(map[string]Struct),
}
}
// IsEmpty returns true if there is no content in any of the fields.
func (c Content) IsEmpty() bool {
return len(c.Consts) == 0 && len(c.Funcs) == 0 && len(c.Interfaces) == 0 && len(c.Structs) == 0
}
// adds the specified const declaration to the exports list
func (c *Content) addConst(pkg Package, g *ast.GenDecl) {
for _, s := range g.Specs {
co := Const{}
vs := s.(*ast.ValueSpec)
v := ""
// Type is nil for untyped consts
if vs.Type != nil {
switch x := vs.Type.(type) {
case *ast.Ident:
co.Type = x.Name
v = vs.Values[0].(*ast.BasicLit).Value
case *ast.SelectorExpr:
co.Type = x.Sel.Name
v = vs.Values[0].(*ast.BasicLit).Value
default:
panic(fmt.Sprintf("wrong type %T", vs.Type))
}
} else {
// get the type from the token type
if bl, ok := vs.Values[0].(*ast.BasicLit); ok {
co.Type = strings.ToLower(bl.Kind.String())
v = bl.Value
} else if ce, ok := vs.Values[0].(*ast.CallExpr); ok {
// const FooConst = FooType("value")
co.Type = pkg.getText(ce.Fun.Pos(), ce.Fun.End())
v = pkg.getText(ce.Args[0].Pos(), ce.Args[0].End())
} else if ce, ok := vs.Values[0].(*ast.BinaryExpr); ok {
// const FooConst = "value" + Bar
co.Type = "*ast.BinaryExpr"
v = pkg.getText(ce.X.Pos(), ce.Y.End())
} else {
panic(fmt.Sprintf("unhandled case for adding constant: %s", pkg.getText(vs.Pos(), vs.End())))
}
}
// TODO should this also be removed?
// remove any surrounding quotes
if v[0] == '"' {
v = v[1 : len(v)-1]
}
co.Value = v
c.Consts[vs.Names[0].Name] = co
}
}
// adds the specified function declaration to the exports list
func (c *Content) addFunc(pkg Package, f *ast.FuncDecl) {
// create a method sig, for methods it's a combination of the receiver type
// with the function name e.g. "FooReceiver.Method", else just the function name.
sig := ""
if f.Recv != nil {
sig = pkg.getText(f.Recv.List[0].Type.Pos(), f.Recv.List[0].Type.End())
sig += "."
}
sig += f.Name.Name
c.Funcs[sig] = pkg.buildFunc(f.Type)
}
// adds the specified interface type to the exports list.
func (c *Content) addInterface(pkg Package, name string, i *ast.InterfaceType) {
in := Interface{Methods: map[string]Func{}}
if i.Methods != nil {
pkg.translateFieldList(i.Methods.List, func(n *string, t string, f *ast.Field) {
if n == nil {
in.AnonymousFields = append(in.AnonymousFields, t)
} else {
if in.Methods == nil {
in.Methods = map[string]Func{}
}
in.Methods[*n] = pkg.buildFunc(f.Type.(*ast.FuncType))
}
})
}
c.Interfaces[name] = in
}
// adds the specified struct type to the exports list.
func (c *Content) addStruct(pkg Package, name string, s *ast.StructType) {
sd := Struct{}
// assumes all struct types have fields
pkg.translateFieldList(s.Fields.List, func(n *string, t string, f *ast.Field) {
if n == nil {
sd.AnonymousFields = append(sd.AnonymousFields, t)
} else {
if sd.Fields == nil {
sd.Fields = map[string]string{}
}
sd.Fields[*n] = t
}
})
c.Structs[name] = sd
}
|