-
-
Notifications
You must be signed in to change notification settings - Fork 308
/
pkg.go
241 lines (218 loc) · 5.91 KB
/
pkg.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
// Mgmt
// Copyright (C) 2013-2021+ James Shubin and the project contributors
// Written by James Shubin <james@shubin.ca> and the project contributors
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package main
import (
"bytes"
"errors"
"fmt"
"io/ioutil"
"log"
"os/exec"
"path/filepath"
"regexp"
"strings"
"github.com/iancoleman/strcase"
yaml "gopkg.in/yaml.v2"
)
var (
validSignature = regexp.MustCompile(`^func (?P<name>[A-Z][a-zA-Z0-9]+)\((?P<args>([a-zA-Z]+( (bool|string|int|int64|float64|\[\]byte))?(, )?){0,})\) (?P<return>(bool|string|int|int64|float64|\[\]byte|)|\((bool|string|int|int64|float64|\[\]byte), error\))$`)
errExcluded = errors.New("function is excluded")
)
type golangPackages []*golangPackage
type golangPackage struct {
// Name is the name of the golang package.
Name string `yaml:"name"`
// Alias is the alias of the package when imported in golang.
// e.g. import rand "os.rand"
Alias string `yaml:"alias,omitempty"`
// MgmtAlias is the name of the package inside mcl.
MgmtAlias string `yaml:"mgmtAlias,omitempty"`
// Exclude is a list of golang function names that we do not want.
Exclude []string `yaml:"exclude,omitempty"`
}
func parsePkg(path, filename, templates string) error {
var c config
filePath := filepath.Join(path, filename)
log.Printf("Data: %s", filePath)
cfgFile, err := ioutil.ReadFile(filePath)
if err != nil {
return err
}
err = yaml.UnmarshalStrict(cfgFile, &c)
if err != nil {
return err
}
functions, err := parsePackages(c)
if err != nil {
return err
}
err = parseFuncs(c, functions, path, templates)
if err != nil {
return err
}
return nil
}
func parsePackages(c config) (functions, error) {
var funcs []function
for _, golangPackage := range c.Packages {
fn, err := golangPackage.parsefuncs()
if err != nil {
return funcs, err
}
funcs = append(funcs, fn...)
}
return funcs, nil
}
func (obj *golangPackage) parsefuncs() (functions, error) {
var funcs []function
cmd := exec.Command("go", "doc", obj.Name)
var out bytes.Buffer
cmd.Stdout = &out
err := cmd.Run()
if err != nil {
return funcs, err
}
return obj.extractFuncs(out.String(), true)
}
func (obj *golangPackage) extractFuncs(doc string, getHelp bool) (functions, error) {
var funcs []function
for _, line := range strings.Split(doc, "\n") {
if validSignature.MatchString(line) {
f, err := obj.parseFunctionLine(line, getHelp)
if err != nil && err != errExcluded {
return funcs, err
}
if f != nil {
funcs = append(funcs, *f)
}
}
}
return funcs, nil
}
func (obj *golangPackage) parseFunctionLine(line string, getHelp bool) (*function, error) {
match := validSignature.FindStringSubmatch(line)
result := make(map[string]string)
for i, name := range validSignature.SubexpNames() {
if i != 0 && name != "" {
result[name] = match[i]
}
}
name := result["name"]
for _, e := range obj.Exclude {
if e == name {
return nil, errExcluded
}
}
errorFul, err := regexp.MatchString(`, error\)$`, result["return"])
if err != nil {
return nil, err
}
returns := parseReturn(result["return"])
if len(returns) == 0 {
return nil, errExcluded
}
mgmtPackage := obj.Name
if obj.MgmtAlias != "" {
mgmtPackage = obj.MgmtAlias
}
mgmtPackage = fmt.Sprintf("golang/%s", mgmtPackage)
internalName := fmt.Sprintf("%s%s", strcase.ToCamel(strings.Replace(obj.Name, "/", "", -1)), name)
internalName = strings.Replace(internalName, "Html", "HTML", -1)
var help string
if getHelp {
help, err = obj.getHelp(name, internalName)
if err != nil {
return nil, err
}
}
return &function{
MgmtPackage: mgmtPackage,
MclName: strcase.ToSnake(name),
InternalName: internalName,
Help: help,
GolangPackage: obj,
GolangFunc: name,
Errorful: errorFul,
Args: parseArgs(result["args"]),
Return: returns,
}, nil
}
func reverseArgs(s []arg) {
last := len(s) - 1
for i := 0; i < len(s)/2; i++ {
s[i], s[last-i] = s[last-i], s[i]
}
}
func reverse(s []string) {
last := len(s) - 1
for i := 0; i < len(s)/2; i++ {
s[i], s[last-i] = s[last-i], s[i]
}
}
func parseArgs(str string) []arg {
var args []arg
s := strings.Split(str, ",")
reverse(s)
var currentType string
for _, currentArg := range s {
if currentArg == "" {
continue
}
v := strings.Split(strings.TrimSpace(currentArg), " ")
if len(v) == 2 {
currentType = v[1]
}
args = append(args, arg{Name: v[0], Type: currentType})
}
reverseArgs(args)
return args
}
func parseReturn(str string) []arg {
var returns []arg
re := regexp.MustCompile(`(bool|string|int|int64|float64|\[\]byte)`)
t := string(re.Find([]byte(str)))
returns = append(returns, arg{Type: t})
return returns
}
func (obj *golangPackage) getHelp(function, internalName string) (string, error) {
cmd := exec.Command("go", "doc", fmt.Sprintf("%s.%s", obj.Name, function))
var out bytes.Buffer
cmd.Stdout = &out
err := cmd.Run()
if err != nil {
return "", err
}
var doc string
for i, line := range strings.Split(strings.TrimSpace(out.String()), "\n") {
if i > 0 {
s := strings.TrimSpace(line)
if i == 1 {
docs := strings.Split(s, " ")
docs[0] = internalName
s = strings.Join(docs, " ")
doc = doc + "// " + s + " is an autogenerated function.\n"
} else {
doc = doc + "//"
if s != "" {
doc = doc + " "
}
doc = doc + s + "\n"
}
}
}
return doc, nil
}