forked from voxelbrain/goptions
/
flagset.go
248 lines (225 loc) · 6.16 KB
/
flagset.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
package goptions
import (
"errors"
"fmt"
"io"
"reflect"
"strings"
"sync"
)
// HelpFunc is the signature of a function responsible for printing the help.
type HelpFunc func(w io.Writer, fs *FlagSet)
// A FlagSet represents one set of flags which belong to one particular program.
// A FlagSet is also used to represent a subset of flags belonging to one verb.
type FlagSet struct {
// This HelpFunc will be called when PrintHelp() is called.
HelpFunc
// Name of the program. Might be used by HelpFunc.
Name string
helpFlag *Flag
remainderFlag *Flag
shortMap map[string]*Flag
longMap map[string]*Flag
// Global option flags
Flags []*Flag
// Verbs and corresponding FlagSets
Verbs map[string]*FlagSet
}
// NewFlagSet returns a new FlagSet containing all the flags which result from
// parsing the tags of the struct. Said struct as to be passed to the function
// as a pointer.
// If a tag line is erroneous, NewFlagSet() panics as this is considered a
// compile time error rather than a runtme error.
func NewFlagSet(name string, v interface{}) *FlagSet {
structValue := reflect.ValueOf(v)
if structValue.Kind() != reflect.Ptr {
panic("Value type is not a pointer to a struct")
}
structValue = structValue.Elem()
if structValue.Kind() != reflect.Struct {
panic("Value type is not a pointer to a struct")
}
return newFlagset(name, structValue, nil)
}
// Internal version which skips type checking and takes the "parent"'s
// remainder flag as a parameter.
func newFlagset(name string, structValue reflect.Value, remainder *Flag) *FlagSet {
var once sync.Once
r := &FlagSet{
Name: name,
Flags: make([]*Flag, 0),
HelpFunc: DefaultHelpFunc,
remainderFlag: remainder,
}
var i int
// Parse Option fields
for i = 0; i < structValue.Type().NumField(); i++ {
fieldValue := structValue.Field(i)
if fieldValue.Type().Name() == "Verbs" {
break
}
tag := structValue.Type().Field(i).Tag.Get("goptions")
flag, err := parseTag(tag)
if err != nil {
panic(fmt.Sprintf("Invalid tagline: %s", err))
}
flag.value = fieldValue
switch flag.value.Interface().(type) {
case Help:
r.helpFlag = flag
case Remainder:
if r.remainderFlag == nil {
r.remainderFlag = flag
}
}
if len(tag) != 0 {
r.Flags = append(r.Flags, flag)
}
}
r.shortMap, r.longMap = r.shortFlagMap(), r.longFlagMap()
// Parse verb fields
for i++; i < structValue.Type().NumField(); i++ {
once.Do(func() {
r.Verbs = make(map[string]*FlagSet)
})
fieldValue := structValue.Field(i)
tag := structValue.Type().Field(i).Tag.Get("goptions")
r.Verbs[tag] = newFlagset(tag, fieldValue, r.remainderFlag)
}
return r
}
func (fs *FlagSet) shortFlagMap() map[string]*Flag {
r := make(map[string]*Flag)
for _, flag := range fs.Flags {
for _, short := range flag.Short {
r[short] = flag
}
}
return r
}
func (fs *FlagSet) longFlagMap() map[string]*Flag {
r := make(map[string]*Flag)
for _, flag := range fs.Flags {
for _, long := range flag.Long {
r[long] = flag
}
}
return r
}
// MutexGroups returns a map of Flag lists which contain mutually
// exclusive flags.
func (fs *FlagSet) MutexGroups() map[string]MutexGroup {
r := make(map[string]MutexGroup)
for _, f := range fs.Flags {
mg := f.MutexGroup
if len(mg) == 0 {
continue
}
if _, ok := r[mg]; !ok {
r[mg] = make(MutexGroup, 0)
}
r[mg] = append(r[mg], f)
}
return r
}
var (
ErrHelpRequest = errors.New("Request for Help")
)
// Parse takes the command line arguments and sets the corresponding values
// in the FlagSet's struct.
func (fs *FlagSet) Parse(args []string) error {
for len(args) > 0 {
restArgs, err := fs.parseNextItem(args)
if err != nil {
return err
}
args = restArgs
}
if fs.helpFlag != nil && fs.helpFlag.WasSpecified {
return ErrHelpRequest
}
// Check for unset, obligatory, single Flags
for _, f := range fs.Flags {
if f.Obligatory && !f.WasSpecified && f.MutexGroup == "" {
return fmt.Errorf("%s must be specified", f.Name())
}
}
// Check for multiple set Flags in one mutex group
// Check also for unset, obligatory mutex groups
mgs := fs.MutexGroups()
for _, mg := range mgs {
if !mg.IsValid() {
return fmt.Errorf("ONE of %s must be specified", strings.Join(mg.Names(), ", "))
}
}
return nil
}
func (fs *FlagSet) parseNextItem(args []string) ([]string, error) {
if strings.HasPrefix(args[0], "--") {
return fs.parseLongFlag(args)
} else if strings.HasPrefix(args[0], "-") {
return fs.parseShortFlagCluster(args)
}
if fs.Verbs != nil {
verb, ok := fs.Verbs[args[0]]
if !ok {
return args, fmt.Errorf("Unknown verb: %s", args[0])
}
err := verb.Parse(args[1:])
if err != nil {
return args, err
}
return []string{}, nil
}
if fs.remainderFlag != nil {
remainder := reflect.MakeSlice(fs.remainderFlag.value.Type(), len(args), len(args))
reflect.Copy(remainder, reflect.ValueOf(args))
fs.remainderFlag.value.Set(remainder)
return []string{}, nil
}
return args, fmt.Errorf("Invalid trailing arguments: %v", args)
}
func (fs *FlagSet) parseLongFlag(args []string) ([]string, error) {
longflagname := args[0][2:]
f, ok := fs.longMap[longflagname]
if !ok {
return args, fmt.Errorf("Unknown flag --%s", longflagname)
}
args = args[1:]
f.set()
if f.NeedsExtraValue() {
err := f.setStringValue(args[0])
if err != nil {
return args, err
}
args = args[1:]
}
return args, nil
}
func (fs *FlagSet) parseShortFlagCluster(args []string) ([]string, error) {
shortflagnames := args[0][1:]
args = args[1:]
for idx, shortflagname := range shortflagnames {
flag, ok := fs.shortMap[string(shortflagname)]
if !ok {
return args, fmt.Errorf("Unknown flag -%s", string(shortflagname))
}
flag.set()
// If value-flag is given but is not the last in a short flag cluster,
// it's an error.
if flag.NeedsExtraValue() && idx != len(shortflagnames)-1 {
return args, fmt.Errorf("Flag %s needs a value", flag.Name())
} else if flag.NeedsExtraValue() {
err := flag.setStringValue(args[0])
if err != nil {
return args, err
}
args = args[1:]
}
}
return args, nil
}
// Prints the FlagSet's help to the given writer.
func (fs *FlagSet) PrintHelp(w io.Writer) {
fs.HelpFunc(w, fs)
}