urfave-cli/flag.go

243 lines
4.4 KiB
Go
Raw Normal View History

2013-07-15 02:16:30 +00:00
package cli
2013-12-07 15:10:04 +00:00
import (
"flag"
"fmt"
"strconv"
"strings"
)
2013-07-15 02:16:30 +00:00
2013-11-01 14:31:37 +00:00
// Flag is a common interface related to parsing flags in cli.
// For more advanced flag parsing techniques, it is recomended that
// this interface be implemented.
2013-07-15 02:16:30 +00:00
type Flag interface {
2013-07-19 00:39:42 +00:00
fmt.Stringer
2013-11-01 14:31:37 +00:00
// Apply Flag settings to the given flag set
2013-07-19 00:39:42 +00:00
Apply(*flag.FlagSet)
getName() string
2013-07-19 00:39:42 +00:00
}
2013-07-20 15:21:20 +00:00
func flagSet(name string, flags []Flag) *flag.FlagSet {
2013-07-24 14:35:45 +00:00
set := flag.NewFlagSet(name, flag.ContinueOnError)
2013-09-24 01:41:31 +00:00
2013-07-19 00:39:42 +00:00
for _, f := range flags {
f.Apply(set)
}
return set
2013-07-15 02:16:30 +00:00
}
2013-11-20 08:05:18 +00:00
func eachName(longName string, fn func(string)) {
parts := strings.Split(longName, ",")
for _, name := range parts {
name = strings.Trim(name, " ")
fn(name)
}
}
2013-09-24 01:41:31 +00:00
type StringSlice []string
func (f *StringSlice) Set(value string) error {
*f = append(*f, value)
2013-09-24 01:41:31 +00:00
return nil
}
func (f *StringSlice) String() string {
return fmt.Sprintf("%s", *f)
2013-09-24 01:41:31 +00:00
}
func (f *StringSlice) Value() []string {
return *f
2013-09-24 01:41:31 +00:00
}
type StringSliceFlag struct {
Name string
Value *StringSlice
Usage string
}
func (f StringSliceFlag) String() string {
return fmt.Sprintf("%s%s %v\t`%v` %s", prefixFor(f.Name), f.Name, f.Value, "-"+f.Name+" option -"+f.Name+" option", f.Usage)
2013-09-24 01:41:31 +00:00
}
func (f StringSliceFlag) Apply(set *flag.FlagSet) {
2013-11-20 08:05:18 +00:00
eachName(f.Name, func(name string) {
2013-11-18 23:35:23 +00:00
set.Var(f.Value, name, f.Usage)
2013-11-20 08:05:18 +00:00
})
2013-11-18 23:35:23 +00:00
}
func (f StringSliceFlag) getName() string {
2013-11-18 23:35:23 +00:00
return f.Name
2013-09-24 01:41:31 +00:00
}
type IntSlice []int
func (f *IntSlice) Set(value string) error {
tmp, err := strconv.Atoi(value)
if err != nil {
return err
} else {
*f = append(*f, tmp)
}
return nil
}
func (f *IntSlice) String() string {
return fmt.Sprintf("%d", *f)
}
func (f *IntSlice) Value() []int {
return *f
}
type IntSliceFlag struct {
Name string
Value *IntSlice
Usage string
}
func (f IntSliceFlag) String() string {
2013-11-20 08:05:18 +00:00
firstName := strings.Trim(strings.Split(f.Name, ",")[0], " ")
pref := prefixFor(firstName)
return fmt.Sprintf("%s '%v'\t%v", prefixedNames(f.Name), pref+firstName+" option "+pref+firstName+" option", f.Usage)
}
func (f IntSliceFlag) Apply(set *flag.FlagSet) {
2013-11-20 08:05:18 +00:00
eachName(f.Name, func(name string) {
2013-11-18 23:35:23 +00:00
set.Var(f.Value, name, f.Usage)
2013-11-20 08:05:18 +00:00
})
2013-11-18 23:35:23 +00:00
}
func (f IntSliceFlag) getName() string {
2013-11-18 23:35:23 +00:00
return f.Name
}
2013-07-15 02:16:30 +00:00
type BoolFlag struct {
2013-07-19 00:39:42 +00:00
Name string
Usage string
}
func (f BoolFlag) String() string {
2013-11-20 08:05:18 +00:00
return fmt.Sprintf("%s\t%v", prefixedNames(f.Name), f.Usage)
2013-07-19 00:39:42 +00:00
}
func (f BoolFlag) Apply(set *flag.FlagSet) {
2013-11-20 08:05:18 +00:00
eachName(f.Name, func(name string) {
2013-11-18 23:35:23 +00:00
set.Bool(name, false, f.Usage)
2013-11-20 08:05:18 +00:00
})
2013-11-18 23:35:23 +00:00
}
func (f BoolFlag) getName() string {
2013-11-18 23:35:23 +00:00
return f.Name
2013-07-15 02:16:30 +00:00
}
type BoolTFlag struct {
Name string
Usage string
}
func (f BoolTFlag) String() string {
return fmt.Sprintf("%s\t%v", prefixedNames(f.Name), f.Usage)
}
func (f BoolTFlag) Apply(set *flag.FlagSet) {
eachName(f.Name, func(name string) {
set.Bool(name, true, f.Usage)
})
}
func (f BoolTFlag) getName() string {
return f.Name
}
2013-07-15 02:16:30 +00:00
type StringFlag struct {
2013-07-19 00:39:42 +00:00
Name string
Value string
Usage string
2013-07-15 02:16:30 +00:00
}
func (f StringFlag) String() string {
2014-04-11 19:09:59 +00:00
var fmtString string
fmtString = "%s %v\t%v"
if len(f.Value) > 0 {
fmtString = "%s '%v'\t%v"
} else {
fmtString = "%s %v\t%v"
}
return fmt.Sprintf(fmtString, prefixedNames(f.Name), f.Value, f.Usage)
2013-07-15 02:16:30 +00:00
}
2013-07-17 02:59:04 +00:00
func (f StringFlag) Apply(set *flag.FlagSet) {
2013-11-20 08:05:18 +00:00
eachName(f.Name, func(name string) {
2013-11-18 23:35:23 +00:00
set.String(name, f.Value, f.Usage)
2013-11-20 08:05:18 +00:00
})
2013-11-18 23:35:23 +00:00
}
func (f StringFlag) getName() string {
2013-11-18 23:35:23 +00:00
return f.Name
2013-07-17 02:59:04 +00:00
}
2013-07-19 00:39:42 +00:00
type IntFlag struct {
Name string
Value int
Usage string
2013-07-15 02:16:30 +00:00
}
2013-07-17 02:59:04 +00:00
2013-07-19 00:39:42 +00:00
func (f IntFlag) String() string {
2013-11-20 08:05:18 +00:00
return fmt.Sprintf("%s '%v'\t%v", prefixedNames(f.Name), f.Value, f.Usage)
2013-07-17 02:59:04 +00:00
}
2013-07-19 00:39:42 +00:00
func (f IntFlag) Apply(set *flag.FlagSet) {
2013-11-20 08:05:18 +00:00
eachName(f.Name, func(name string) {
2013-11-18 23:35:23 +00:00
set.Int(name, f.Value, f.Usage)
2013-11-20 08:05:18 +00:00
})
2013-11-18 23:35:23 +00:00
}
func (f IntFlag) getName() string {
2013-11-18 23:35:23 +00:00
return f.Name
2013-07-17 02:59:04 +00:00
}
2013-07-24 14:35:45 +00:00
2013-12-03 13:42:09 +00:00
type Float64Flag struct {
Name string
Value float64
Usage string
}
func (f Float64Flag) String() string {
return fmt.Sprintf("%s '%v'\t%v", prefixedNames(f.Name), f.Value, f.Usage)
}
func (f Float64Flag) Apply(set *flag.FlagSet) {
eachName(f.Name, func(name string) {
set.Float64(name, f.Value, f.Usage)
})
}
func (f Float64Flag) getName() string {
return f.Name
}
2013-09-09 18:51:46 +00:00
func prefixFor(name string) (prefix string) {
if len(name) == 1 {
prefix = "-"
} else {
prefix = "--"
}
return
}
2013-11-20 08:05:18 +00:00
func prefixedNames(fullName string) (prefixed string) {
parts := strings.Split(fullName, ",")
for i, name := range parts {
name = strings.Trim(name, " ")
prefixed += prefixFor(name) + name
2013-11-21 01:25:13 +00:00
if i < len(parts)-1 {
2013-11-20 08:05:18 +00:00
prefixed += ", "
}
}
return
}