2021-02-01 00:10:16 +01:00
|
|
|
|
package cli
|
|
|
|
|
|
|
|
|
|
import (
|
2022-09-13 15:44:44 +02:00
|
|
|
|
"errors"
|
2021-02-01 00:10:16 +01:00
|
|
|
|
"flag"
|
|
|
|
|
"fmt"
|
|
|
|
|
"strconv"
|
|
|
|
|
)
|
|
|
|
|
|
2022-09-13 15:44:44 +02:00
|
|
|
|
// boolValue needs to implement the boolFlag internal interface in flag
|
|
|
|
|
// to be able to capture bool fields and values
|
|
|
|
|
//
|
|
|
|
|
// type boolFlag interface {
|
|
|
|
|
// Value
|
|
|
|
|
// IsBoolFlag() bool
|
|
|
|
|
// }
|
|
|
|
|
type boolValue struct {
|
|
|
|
|
destination *bool
|
|
|
|
|
count *int
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func newBoolValue(val bool, p *bool, count *int) *boolValue {
|
|
|
|
|
*p = val
|
|
|
|
|
return &boolValue{
|
|
|
|
|
destination: p,
|
|
|
|
|
count: count,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (b *boolValue) Set(s string) error {
|
|
|
|
|
v, err := strconv.ParseBool(s)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = errors.New("parse error")
|
|
|
|
|
return err
|
|
|
|
|
}
|
|
|
|
|
*b.destination = v
|
|
|
|
|
if b.count != nil {
|
|
|
|
|
*b.count = *b.count + 1
|
|
|
|
|
}
|
|
|
|
|
return err
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (b *boolValue) Get() interface{} { return *b.destination }
|
|
|
|
|
|
|
|
|
|
func (b *boolValue) String() string {
|
|
|
|
|
if b.destination != nil {
|
|
|
|
|
return strconv.FormatBool(*b.destination)
|
|
|
|
|
}
|
|
|
|
|
return strconv.FormatBool(false)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (b *boolValue) IsBoolFlag() bool { return true }
|
|
|
|
|
|
|
|
|
|
func (b *boolValue) Count() int {
|
2023-07-07 09:05:50 +02:00
|
|
|
|
if b.count != nil && *b.count > 0 {
|
2022-09-13 15:44:44 +02:00
|
|
|
|
return *b.count
|
|
|
|
|
}
|
|
|
|
|
return 0
|
|
|
|
|
}
|
|
|
|
|
|
2021-02-01 00:10:16 +01:00
|
|
|
|
// TakesValue returns true of the flag takes a value, otherwise false
|
|
|
|
|
func (f *BoolFlag) TakesValue() bool {
|
|
|
|
|
return false
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GetUsage returns the usage string for the flag
|
|
|
|
|
func (f *BoolFlag) GetUsage() string {
|
|
|
|
|
return f.Usage
|
|
|
|
|
}
|
|
|
|
|
|
2022-05-25 20:49:12 +02:00
|
|
|
|
// GetCategory returns the category for the flag
|
|
|
|
|
func (f *BoolFlag) GetCategory() string {
|
|
|
|
|
return f.Category
|
|
|
|
|
}
|
|
|
|
|
|
2021-02-01 00:10:16 +01:00
|
|
|
|
// GetValue returns the flags value as string representation and an empty
|
|
|
|
|
// string if the flag takes no value at all.
|
|
|
|
|
func (f *BoolFlag) GetValue() string {
|
|
|
|
|
return ""
|
|
|
|
|
}
|
|
|
|
|
|
2022-04-26 14:24:23 +02:00
|
|
|
|
// GetDefaultText returns the default text for this flag
|
|
|
|
|
func (f *BoolFlag) GetDefaultText() string {
|
|
|
|
|
if f.DefaultText != "" {
|
|
|
|
|
return f.DefaultText
|
|
|
|
|
}
|
2023-12-11 09:48:36 +01:00
|
|
|
|
if f.defaultValueSet {
|
|
|
|
|
return fmt.Sprintf("%v", f.defaultValue)
|
|
|
|
|
}
|
|
|
|
|
return fmt.Sprintf("%v", f.Value)
|
2022-04-26 14:24:23 +02:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GetEnvVars returns the env vars for this flag
|
|
|
|
|
func (f *BoolFlag) GetEnvVars() []string {
|
|
|
|
|
return f.EnvVars
|
|
|
|
|
}
|
|
|
|
|
|
2022-10-01 16:18:50 +02:00
|
|
|
|
// RunAction executes flag action if set
|
|
|
|
|
func (f *BoolFlag) RunAction(c *Context) error {
|
|
|
|
|
if f.Action != nil {
|
|
|
|
|
return f.Action(c, c.Bool(f.Name))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
2021-02-01 00:10:16 +01:00
|
|
|
|
// Apply populates the flag given the flag set and environment
|
|
|
|
|
func (f *BoolFlag) Apply(set *flag.FlagSet) error {
|
2022-10-18 09:56:38 +02:00
|
|
|
|
// set default value so that environment wont be able to overwrite it
|
|
|
|
|
f.defaultValue = f.Value
|
2023-12-11 09:48:36 +01:00
|
|
|
|
f.defaultValueSet = true
|
2022-10-18 09:56:38 +02:00
|
|
|
|
|
2022-05-25 20:49:12 +02:00
|
|
|
|
if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found {
|
2021-02-01 00:10:16 +01:00
|
|
|
|
if val != "" {
|
|
|
|
|
valBool, err := strconv.ParseBool(val)
|
|
|
|
|
|
|
|
|
|
if err != nil {
|
2022-05-25 20:49:12 +02:00
|
|
|
|
return fmt.Errorf("could not parse %q as bool value from %s for flag %s: %s", val, source, f.Name, err)
|
2021-02-01 00:10:16 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
f.Value = valBool
|
2022-09-08 17:51:49 +02:00
|
|
|
|
} else {
|
|
|
|
|
// empty value implies that the env is defined but set to empty string, we have to assume that this is
|
|
|
|
|
// what the user wants. If user doesnt want this then the env needs to be deleted or the flag removed from
|
|
|
|
|
// file
|
|
|
|
|
f.Value = false
|
2021-02-01 00:10:16 +01:00
|
|
|
|
}
|
2022-09-08 17:51:49 +02:00
|
|
|
|
f.HasBeenSet = true
|
2021-02-01 00:10:16 +01:00
|
|
|
|
}
|
|
|
|
|
|
2022-09-13 15:44:44 +02:00
|
|
|
|
count := f.Count
|
|
|
|
|
dest := f.Destination
|
|
|
|
|
|
|
|
|
|
if count == nil {
|
|
|
|
|
count = new(int)
|
|
|
|
|
}
|
2023-07-07 09:05:50 +02:00
|
|
|
|
|
|
|
|
|
// since count will be incremented for each alias as well
|
|
|
|
|
// subtract number of aliases from overall count
|
|
|
|
|
*count -= len(f.Aliases)
|
|
|
|
|
|
2022-09-13 15:44:44 +02:00
|
|
|
|
if dest == nil {
|
|
|
|
|
dest = new(bool)
|
|
|
|
|
}
|
|
|
|
|
|
2021-02-01 00:10:16 +01:00
|
|
|
|
for _, name := range f.Names() {
|
2022-09-13 15:44:44 +02:00
|
|
|
|
value := newBoolValue(f.Value, dest, count)
|
|
|
|
|
set.Var(value, name, f.Usage)
|
2021-02-01 00:10:16 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
2022-05-07 00:48:35 +02:00
|
|
|
|
// Get returns the flag’s value in the given Context.
|
|
|
|
|
func (f *BoolFlag) Get(ctx *Context) bool {
|
|
|
|
|
return ctx.Bool(f.Name)
|
|
|
|
|
}
|
|
|
|
|
|
2021-02-01 00:10:16 +01:00
|
|
|
|
// Bool looks up the value of a local BoolFlag, returns
|
|
|
|
|
// false if not found
|
2022-04-26 14:24:23 +02:00
|
|
|
|
func (cCtx *Context) Bool(name string) bool {
|
|
|
|
|
if fs := cCtx.lookupFlagSet(name); fs != nil {
|
2021-02-01 00:10:16 +01:00
|
|
|
|
return lookupBool(name, fs)
|
|
|
|
|
}
|
|
|
|
|
return false
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func lookupBool(name string, set *flag.FlagSet) bool {
|
|
|
|
|
f := set.Lookup(name)
|
|
|
|
|
if f != nil {
|
|
|
|
|
parsed, err := strconv.ParseBool(f.Value.String())
|
|
|
|
|
if err != nil {
|
|
|
|
|
return false
|
|
|
|
|
}
|
|
|
|
|
return parsed
|
|
|
|
|
}
|
|
|
|
|
return false
|
|
|
|
|
}
|