-
Notifications
You must be signed in to change notification settings - Fork 327
/
flags.go
255 lines (238 loc) · 5.77 KB
/
flags.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
// Copyright (C) 2017 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package flags
import (
"flag"
"fmt"
"reflect"
"strconv"
"strings"
"time"
)
type (
Set struct {
// Raw is the underlying flag set
// TODO: hide this once we stop things relying on it
Raw flag.FlagSet
}
)
type U64Slice []uint64
func (i *U64Slice) String() string {
return fmt.Sprintf("%d", *i)
}
func (i *U64Slice) Set(v string) error {
*i = make(U64Slice, 0)
if v[0] != '[' || v[len(v)-1] != ']' {
tmp, err := strconv.ParseInt(v, 10, 64)
if err != nil {
return fmt.Errorf("Expected '[n, ...]' or 'n', could not parse %s", v)
}
*i = append(*i, uint64(tmp))
return nil
}
x := strings.Split(v[1:len(v)-1], ",")
for _, val := range x {
tmp, err := strconv.ParseInt(strings.TrimSpace(val), 10, 64)
if err != nil {
return fmt.Errorf("Could not parse slice %s", val)
}
*i = append(*i, uint64(tmp))
}
return nil
}
func bindName(prefix string, name string, partial string, full string) string {
if partial != "" {
name = partial
}
if full != "" {
return full
}
if prefix == "" {
return name
}
if name == "" {
return prefix
}
return prefix + "-" + name
}
// Bind uses reflection to bind flag values to the verb.
// It will recurse into nested structures adding all leaf fields.
func (s *Set) Bind(name string, value interface{}, help string) {
switch val := value.(type) {
case *bool:
s.Raw.BoolVar(val, name, *val, help)
return
case *int:
s.Raw.IntVar(val, name, *val, help)
return
case *int64:
s.Raw.Int64Var(val, name, *val, help)
return
case *uint:
s.Raw.UintVar(val, name, *val, help)
return
case *uint64:
s.Raw.Uint64Var(val, name, *val, help)
return
case *float64:
s.Raw.Float64Var(val, name, *val, help)
return
case *string:
s.Raw.StringVar(val, name, *val, help)
return
case *time.Duration:
s.Raw.DurationVar(val, name, *val, help)
return
case Choosable:
chooser := val.Chooser()
s.Raw.Var(chooser, name, fmt.Sprintf("%s [one of: %s]", help, chooser.Choices))
return
case Enum:
chooser := ForEnum(val)
s.Raw.Var(chooser, name, fmt.Sprintf("%s [one of: %s]", help, chooser.Choices))
return
case flag.Value:
s.Raw.Var(val, name, help)
return
}
rv := reflect.ValueOf(value)
if rv.Kind() != reflect.Ptr || rv.Elem().Kind() != reflect.Struct {
panic(fmt.Sprintf("Unhandled flag type : %v", rv.Type()))
}
e := rv.Elem()
t := e.Type()
for i := 0; i < e.NumField(); i++ {
tf := t.Field(i)
if tf.PkgPath != "" {
continue // Unexported.
}
field := e.Field(i)
if !field.CanSet() {
panic(fmt.Sprintf("Unsettable field %q : %v", tf.Name, field.Type()))
}
tags := tf.Tag
fname := strings.ToLower(tf.Name)
fullname := tags.Get("fullname")
partialname := tags.Get("name")
usage := tags.Get("help")
if tf.Anonymous {
fname = ""
}
if partialname != "" {
fname = partialname
}
switch {
case fullname != "":
// all done
case fname == "":
fullname = name
case name == "":
fullname = fname
default:
fullname = name + "-" + fname
}
s.Bind(fullname, field.Addr().Interface(), usage)
}
}
// HasFlags returns true if the set has bound flags.
func (s *Set) HasFlags() bool {
result := false
s.Raw.VisitAll(func(*flag.Flag) {
result = true
})
return result
}
// HasVisibleFlags returns true if the set has bound flags for the specified verbosity.
func (s *Set) HasVisibleFlags(verbose bool) bool {
result := false
s.Raw.VisitAll(func(f *flag.Flag) {
if _, _, hidden := getFlagUsage(f, verbose); !hidden {
result = true
}
})
return result
}
func getFlagUsage(f *flag.Flag, verbose bool) (string, string, bool) {
name, usage := flag.UnquoteUsage(f)
if !strings.HasPrefix(usage, "_") {
return name, usage, false
}
return name, usage[1:], !verbose
}
func dumpDefault(fl *flag.Flag) string {
typ := reflect.TypeOf(fl.Value)
var z reflect.Value
if typ.Kind() == reflect.Ptr {
z = reflect.New(typ.Elem())
} else {
z = reflect.Zero(typ)
}
value := z.Interface().(flag.Value)
isString := false
if getter, isGetter := value.(flag.Getter); isGetter {
_, isString = getter.Get().(string)
}
if fl.DefValue == value.String() {
return ""
}
switch fl.DefValue {
case "false":
return ""
case "":
return ""
case "0":
return ""
}
if isString {
return fmt.Sprintf(" (default %q)", fl.DefValue)
}
return fmt.Sprintf(" (default %v)", fl.DefValue)
}
// Returns the usage string for the flags
func (s *Set) Usage(verbose bool) string {
result := ""
s.Raw.VisitAll(func(fl *flag.Flag) {
if result != "" {
result += "\n"
}
result += fmt.Sprintf(" -%s", fl.Name)
name, usage, hidden := getFlagUsage(fl, verbose)
if hidden {
return
}
result += " " + name
if len(result) > 4 {
result += "\n "
}
result += "\t"
result += usage
result += dumpDefault(fl)
})
return result
}
// Parse processes the args to fill in the flags.
// see flag.Parse for more details.
func (s *Set) Parse(args ...string) {
s.Raw.Usage = flag.CommandLine.Usage
s.Raw.Parse(args)
}
// Args returns the unprocessed part of the command line passed to Parse.
func (s *Set) Args() []string {
return s.Raw.Args()
}
// ForceCommandLine is an ugly hack for things that try to directly use the flag package
//TODO: remove this
func (s *Set) ForceCommandLine() {
flag.CommandLine = &s.Raw
}