package flagutil import ( "flag" "fmt" "strconv" "strings" "time" ) // NewArrayString returns new ArrayString with the given name and description. func NewArrayString(name, description string) *ArrayString { description += "\nSupports an `array` of values separated by comma or specified via multiple flags." var a ArrayString flag.Var(&a, name, description) return &a } // NewArrayDuration returns new ArrayDuration with the given name and description. func NewArrayDuration(name, description string) *ArrayDuration { description += "\nSupports `array` of values separated by comma or specified via multiple flags." var a ArrayDuration flag.Var(&a, name, description) return &a } // NewArrayBool returns new ArrayBool with the given name and description. func NewArrayBool(name, description string) *ArrayBool { description += "\nSupports `array` of values separated by comma or specified via multiple flags." var a ArrayBool flag.Var(&a, name, description) return &a } // NewArrayInt returns new ArrayInt with the given name and description. func NewArrayInt(name, description string) *ArrayInt { description += "\nSupports `array` of values separated by comma or specified via multiple flags." var a ArrayInt flag.Var(&a, name, description) return &a } // NewArrayBytes returns new ArrayBytes with the given name and description. func NewArrayBytes(name, description string) *ArrayBytes { description += "\nSupports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB." description += "\nSupports `array` of values separated by comma or specified via multiple flags." var a ArrayBytes flag.Var(&a, name, description) return &a } // ArrayString is a flag that holds an array of strings. // // It may be set either by specifying multiple flags with the given name // passed to NewArray or by joining flag values by comma. // // The following example sets equivalent flag array with two items (value1, value2): // // -foo=value1 -foo=value2 // -foo=value1,value2 // // Flag values may be quoted. For instance, the following arg creates an array of ("a", "b, c") items: // // -foo='a,"b, c"' type ArrayString []string // String implements flag.Value interface func (a *ArrayString) String() string { aEscaped := make([]string, len(*a)) for i, v := range *a { if strings.ContainsAny(v, `", `+"\n") { v = fmt.Sprintf("%q", v) } aEscaped[i] = v } return strings.Join(aEscaped, ",") } // Set implements flag.Value interface func (a *ArrayString) Set(value string) error { values := parseArrayValues(value) *a = append(*a, values...) return nil } func parseArrayValues(s string) []string { if len(s) == 0 { return nil } var values []string for { v, tail := getNextArrayValue(s) values = append(values, v) if len(tail) == 0 { return values } if tail[0] == ',' { tail = tail[1:] } s = tail } } func getNextArrayValue(s string) (string, string) { if len(s) == 0 { return "", "" } if s[0] != '"' { // Fast path - unquoted string n := strings.IndexByte(s, ',') if n < 0 { // The last item return s, "" } return s[:n], s[n:] } // Find the end of quoted string end := 1 ss := s[1:] for { n := strings.IndexByte(ss, '"') if n < 0 { // Cannot find trailing quote. Return the whole string till the end. return s, "" } end += n + 1 // Verify whether the trailing quote is escaped with backslash. backslashes := 0 for n > backslashes && ss[n-backslashes-1] == '\\' { backslashes++ } if backslashes&1 == 0 { // The trailing quote isn't escaped. break } // The trailing quote is escaped. Continue searching for the next quote. ss = ss[n+1:] } v := s[:end] vUnquoted, err := strconv.Unquote(v) if err == nil { v = vUnquoted } return v, s[end:] } // GetOptionalArg returns optional arg under the given argIdx. func (a *ArrayString) GetOptionalArg(argIdx int) string { x := *a if argIdx >= len(x) { if len(x) == 1 { return x[0] } return "" } return x[argIdx] } // ArrayBool is a flag that holds an array of booleans values. // // Has the same api as ArrayString. type ArrayBool []bool // IsBoolFlag implements flag.IsBoolFlag interface func (a *ArrayBool) IsBoolFlag() bool { return true } // String implements flag.Value interface func (a *ArrayBool) String() string { formattedBools := make([]string, len(*a)) for i, v := range *a { formattedBools[i] = strconv.FormatBool(v) } return strings.Join(formattedBools, ",") } // Set implements flag.Value interface func (a *ArrayBool) Set(value string) error { values := parseArrayValues(value) for _, v := range values { b, err := strconv.ParseBool(v) if err != nil { return err } *a = append(*a, b) } return nil } // GetOptionalArg returns optional arg under the given argIdx. func (a *ArrayBool) GetOptionalArg(argIdx int) bool { x := *a if argIdx >= len(x) { if len(x) == 1 { return x[0] } return false } return x[argIdx] } // ArrayDuration is a flag that holds an array of time.Duration values. // // Has the same api as ArrayString. type ArrayDuration []time.Duration // String implements flag.Value interface func (a *ArrayDuration) String() string { formattedBools := make([]string, len(*a)) for i, v := range *a { formattedBools[i] = v.String() } return strings.Join(formattedBools, ",") } // Set implements flag.Value interface func (a *ArrayDuration) Set(value string) error { values := parseArrayValues(value) for _, v := range values { b, err := time.ParseDuration(v) if err != nil { return err } *a = append(*a, b) } return nil } // GetOptionalArgOrDefault returns optional arg under the given argIdx, // or default value, if argIdx not found. func (a *ArrayDuration) GetOptionalArgOrDefault(argIdx int, defaultValue time.Duration) time.Duration { x := *a if argIdx >= len(x) { if len(x) == 1 { return x[0] } return defaultValue } return x[argIdx] } // ArrayInt is flag that holds an array of ints. // // Has the same api as ArrayString. type ArrayInt []int // String implements flag.Value interface func (a *ArrayInt) String() string { x := *a formattedInts := make([]string, len(x)) for i, v := range x { formattedInts[i] = strconv.Itoa(v) } return strings.Join(formattedInts, ",") } // Set implements flag.Value interface func (a *ArrayInt) Set(value string) error { values := parseArrayValues(value) for _, v := range values { n, err := strconv.Atoi(v) if err != nil { return err } *a = append(*a, n) } return nil } // GetOptionalArgOrDefault returns optional arg under the given argIdx. func (a *ArrayInt) GetOptionalArgOrDefault(argIdx, defaultValue int) int { x := *a if argIdx < len(x) { return x[argIdx] } if len(x) == 1 { return x[0] } return defaultValue } // ArrayBytes is flag that holds an array of Bytes. // // Has the same api as ArrayString. type ArrayBytes []*Bytes // String implements flag.Value interface func (a *ArrayBytes) String() string { x := *a formattedBytes := make([]string, len(x)) for i, v := range x { formattedBytes[i] = v.String() } return strings.Join(formattedBytes, ",") } // Set implemented flag.Value interface func (a *ArrayBytes) Set(value string) error { values := parseArrayValues(value) for _, v := range values { var b Bytes if err := b.Set(v); err != nil { return err } *a = append(*a, &b) } return nil } // GetOptionalArgOrDefault returns optional arg under the given argIdx. func (a *ArrayBytes) GetOptionalArgOrDefault(argIdx int, defaultValue int64) int64 { x := *a if argIdx < len(x) { return x[argIdx].N } if len(x) == 1 { return x[0].N } return defaultValue }