2021-10-11 14:30:23 +00:00
|
|
|
|
package cli
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"encoding/json"
|
|
|
|
|
"flag"
|
|
|
|
|
"fmt"
|
|
|
|
|
"strconv"
|
|
|
|
|
"strings"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// IntSlice wraps []int to satisfy flag.Value
|
|
|
|
|
type IntSlice struct {
|
|
|
|
|
slice []int
|
2024-02-12 16:51:28 +00:00
|
|
|
|
separator separatorSpec
|
2021-10-11 14:30:23 +00:00
|
|
|
|
hasBeenSet bool
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// NewIntSlice makes an *IntSlice with default values
|
|
|
|
|
func NewIntSlice(defaults ...int) *IntSlice {
|
|
|
|
|
return &IntSlice{slice: append([]int{}, defaults...)}
|
|
|
|
|
}
|
|
|
|
|
|
2024-02-12 16:51:28 +00:00
|
|
|
|
// clone allocate a copy of self object
|
|
|
|
|
func (i *IntSlice) clone() *IntSlice {
|
|
|
|
|
n := &IntSlice{
|
|
|
|
|
slice: make([]int, len(i.slice)),
|
|
|
|
|
hasBeenSet: i.hasBeenSet,
|
|
|
|
|
}
|
|
|
|
|
copy(n.slice, i.slice)
|
|
|
|
|
return n
|
|
|
|
|
}
|
|
|
|
|
|
2021-10-11 14:30:23 +00:00
|
|
|
|
// TODO: Consistently have specific Set function for Int64 and Float64 ?
|
|
|
|
|
// SetInt directly adds an integer to the list of values
|
|
|
|
|
func (i *IntSlice) SetInt(value int) {
|
|
|
|
|
if !i.hasBeenSet {
|
|
|
|
|
i.slice = []int{}
|
|
|
|
|
i.hasBeenSet = true
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
i.slice = append(i.slice, value)
|
|
|
|
|
}
|
|
|
|
|
|
2024-02-12 16:51:28 +00:00
|
|
|
|
func (i *IntSlice) WithSeparatorSpec(spec separatorSpec) {
|
|
|
|
|
i.separator = spec
|
|
|
|
|
}
|
|
|
|
|
|
2021-10-11 14:30:23 +00:00
|
|
|
|
// Set parses the value into an integer and appends it to the list of values
|
|
|
|
|
func (i *IntSlice) Set(value string) error {
|
|
|
|
|
if !i.hasBeenSet {
|
|
|
|
|
i.slice = []int{}
|
|
|
|
|
i.hasBeenSet = true
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if strings.HasPrefix(value, slPfx) {
|
|
|
|
|
// Deserializing assumes overwrite
|
|
|
|
|
_ = json.Unmarshal([]byte(strings.Replace(value, slPfx, "", 1)), &i.slice)
|
|
|
|
|
i.hasBeenSet = true
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
2024-02-12 16:51:28 +00:00
|
|
|
|
for _, s := range i.separator.flagSplitMultiValues(value) {
|
|
|
|
|
tmp, err := strconv.ParseInt(strings.TrimSpace(s), 0, 64)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return err
|
|
|
|
|
}
|
2021-10-11 14:30:23 +00:00
|
|
|
|
|
2024-02-12 16:51:28 +00:00
|
|
|
|
i.slice = append(i.slice, int(tmp))
|
|
|
|
|
}
|
2021-10-11 14:30:23 +00:00
|
|
|
|
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// String returns a readable representation of this value (for usage defaults)
|
|
|
|
|
func (i *IntSlice) String() string {
|
2024-02-12 16:51:28 +00:00
|
|
|
|
v := i.slice
|
|
|
|
|
if v == nil {
|
|
|
|
|
// treat nil the same as zero length non-nil
|
|
|
|
|
v = make([]int, 0)
|
|
|
|
|
}
|
|
|
|
|
return fmt.Sprintf("%#v", v)
|
2021-10-11 14:30:23 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Serialize allows IntSlice to fulfill Serializer
|
|
|
|
|
func (i *IntSlice) Serialize() string {
|
|
|
|
|
jsonBytes, _ := json.Marshal(i.slice)
|
|
|
|
|
return fmt.Sprintf("%s%s", slPfx, string(jsonBytes))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Value returns the slice of ints set by this flag
|
|
|
|
|
func (i *IntSlice) Value() []int {
|
|
|
|
|
return i.slice
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Get returns the slice of ints set by this flag
|
|
|
|
|
func (i *IntSlice) Get() interface{} {
|
|
|
|
|
return *i
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// String returns a readable representation of this value
|
|
|
|
|
// (for usage defaults)
|
|
|
|
|
func (f *IntSliceFlag) String() string {
|
|
|
|
|
return FlagStringer(f)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// TakesValue returns true of the flag takes a value, otherwise false
|
|
|
|
|
func (f *IntSliceFlag) TakesValue() bool {
|
|
|
|
|
return true
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GetUsage returns the usage string for the flag
|
2024-02-12 16:51:28 +00:00
|
|
|
|
func (f *IntSliceFlag) GetUsage() string {
|
2021-10-11 14:30:23 +00:00
|
|
|
|
return f.Usage
|
|
|
|
|
}
|
|
|
|
|
|
2024-02-12 16:51:28 +00:00
|
|
|
|
// GetCategory returns the category for the flag
|
|
|
|
|
func (f *IntSliceFlag) GetCategory() string {
|
|
|
|
|
return f.Category
|
|
|
|
|
}
|
|
|
|
|
|
2021-10-11 14:30:23 +00:00
|
|
|
|
// GetValue returns the flags value as string representation and an empty
|
|
|
|
|
// string if the flag takes no value at all.
|
|
|
|
|
func (f *IntSliceFlag) GetValue() string {
|
2024-02-12 16:51:28 +00:00
|
|
|
|
var defaultVals []string
|
|
|
|
|
if f.Value != nil && len(f.Value.Value()) > 0 {
|
|
|
|
|
for _, i := range f.Value.Value() {
|
|
|
|
|
defaultVals = append(defaultVals, strconv.Itoa(i))
|
|
|
|
|
}
|
2021-10-11 14:30:23 +00:00
|
|
|
|
}
|
2024-02-12 16:51:28 +00:00
|
|
|
|
return strings.Join(defaultVals, ", ")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GetDefaultText returns the default text for this flag
|
|
|
|
|
func (f *IntSliceFlag) GetDefaultText() string {
|
|
|
|
|
if f.DefaultText != "" {
|
|
|
|
|
return f.DefaultText
|
|
|
|
|
}
|
|
|
|
|
return f.GetValue()
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GetEnvVars returns the env vars for this flag
|
|
|
|
|
func (f *IntSliceFlag) GetEnvVars() []string {
|
|
|
|
|
return f.EnvVars
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// IsSliceFlag implements DocGenerationSliceFlag.
|
|
|
|
|
func (f *IntSliceFlag) IsSliceFlag() bool {
|
|
|
|
|
return true
|
2021-10-11 14:30:23 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Apply populates the flag given the flag set and environment
|
|
|
|
|
func (f *IntSliceFlag) Apply(set *flag.FlagSet) error {
|
2024-02-12 16:51:28 +00:00
|
|
|
|
// apply any default
|
|
|
|
|
if f.Destination != nil && f.Value != nil {
|
|
|
|
|
f.Destination.slice = make([]int, len(f.Value.slice))
|
|
|
|
|
copy(f.Destination.slice, f.Value.slice)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// resolve setValue (what we will assign to the set)
|
|
|
|
|
var setValue *IntSlice
|
|
|
|
|
switch {
|
|
|
|
|
case f.Destination != nil:
|
|
|
|
|
setValue = f.Destination
|
|
|
|
|
case f.Value != nil:
|
|
|
|
|
setValue = f.Value.clone()
|
|
|
|
|
default:
|
|
|
|
|
setValue = new(IntSlice)
|
|
|
|
|
setValue.WithSeparatorSpec(f.separator)
|
|
|
|
|
}
|
2021-10-11 14:30:23 +00:00
|
|
|
|
|
2024-02-12 16:51:28 +00:00
|
|
|
|
if val, source, ok := flagFromEnvOrFile(f.EnvVars, f.FilePath); ok && val != "" {
|
|
|
|
|
for _, s := range f.separator.flagSplitMultiValues(val) {
|
|
|
|
|
if err := setValue.Set(strings.TrimSpace(s)); err != nil {
|
|
|
|
|
return fmt.Errorf("could not parse %q as int slice value from %s for flag %s: %s", val, source, f.Name, err)
|
2021-10-11 14:30:23 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2024-02-12 16:51:28 +00:00
|
|
|
|
// Set this to false so that we reset the slice if we then set values from
|
|
|
|
|
// flags that have already been set by the environment.
|
|
|
|
|
setValue.hasBeenSet = false
|
2021-10-11 14:30:23 +00:00
|
|
|
|
f.HasBeenSet = true
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for _, name := range f.Names() {
|
2024-02-12 16:51:28 +00:00
|
|
|
|
set.Var(setValue, name, f.Usage)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (f *IntSliceFlag) WithSeparatorSpec(spec separatorSpec) {
|
|
|
|
|
f.separator = spec
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Get returns the flag’s value in the given Context.
|
|
|
|
|
func (f *IntSliceFlag) Get(ctx *Context) []int {
|
|
|
|
|
return ctx.IntSlice(f.Name)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// RunAction executes flag action if set
|
|
|
|
|
func (f *IntSliceFlag) RunAction(c *Context) error {
|
|
|
|
|
if f.Action != nil {
|
|
|
|
|
return f.Action(c, c.IntSlice(f.Name))
|
2021-10-11 14:30:23 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// IntSlice looks up the value of a local IntSliceFlag, returns
|
|
|
|
|
// nil if not found
|
2024-02-12 16:51:28 +00:00
|
|
|
|
func (cCtx *Context) IntSlice(name string) []int {
|
|
|
|
|
if fs := cCtx.lookupFlagSet(name); fs != nil {
|
|
|
|
|
return lookupIntSlice(name, fs)
|
2021-10-11 14:30:23 +00:00
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func lookupIntSlice(name string, set *flag.FlagSet) []int {
|
|
|
|
|
f := set.Lookup(name)
|
|
|
|
|
if f != nil {
|
2024-02-12 16:51:28 +00:00
|
|
|
|
if slice, ok := unwrapFlagValue(f.Value).(*IntSlice); ok {
|
2021-10-11 14:30:23 +00:00
|
|
|
|
return slice.Value()
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
}
|