VictoriaMetrics/vendor/github.com/urfave/cli/v2/flag_generic.go

132 lines
2.8 KiB
Go
Raw Normal View History

package cli
import (
"flag"
"fmt"
)
// Generic is a generic parseable type identified by a specific flag
type Generic interface {
Set(value string) error
String() string
}
2022-10-18 09:56:38 +02:00
type stringGeneric struct {
value string
}
func (s *stringGeneric) Set(value string) error {
s.value = value
return nil
}
func (s *stringGeneric) String() string {
return s.value
}
// TakesValue returns true of the flag takes a value, otherwise false
func (f *GenericFlag) TakesValue() bool {
return true
}
// GetUsage returns the usage string for the flag
func (f *GenericFlag) GetUsage() string {
return f.Usage
}
2022-05-25 20:49:12 +02:00
// GetCategory returns the category for the flag
func (f *GenericFlag) GetCategory() string {
return f.Category
}
// GetValue returns the flags value as string representation and an empty
// string if the flag takes no value at all.
func (f *GenericFlag) GetValue() string {
if f.Value != nil {
return f.Value.String()
}
return ""
}
2022-04-26 14:24:23 +02:00
// GetDefaultText returns the default text for this flag
func (f *GenericFlag) GetDefaultText() string {
if f.DefaultText != "" {
return f.DefaultText
}
2023-12-11 09:48:36 +01:00
val := f.Value
if f.defaultValueSet {
val = f.defaultValue
2022-10-18 09:56:38 +02:00
}
2023-12-11 09:48:36 +01:00
if val != nil {
return val.String()
}
2022-10-18 09:56:38 +02:00
return ""
2022-04-26 14:24:23 +02:00
}
// GetEnvVars returns the env vars for this flag
func (f *GenericFlag) GetEnvVars() []string {
return f.EnvVars
}
// Apply takes the flagset and calls Set on the generic flag with the value
// provided by the user for parsing by the flag
2022-09-08 17:51:49 +02:00
func (f *GenericFlag) 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
if f.Value != nil {
f.defaultValue = &stringGeneric{value: f.Value.String()}
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 {
if val != "" {
if err := f.Value.Set(val); err != nil {
2022-05-25 20:49:12 +02:00
return fmt.Errorf("could not parse %q from %s as value for flag %s: %s", val, source, f.Name, err)
}
f.HasBeenSet = true
}
}
for _, name := range f.Names() {
2022-10-10 21:03:45 +02:00
if f.Destination != nil {
set.Var(f.Destination, name, f.Usage)
continue
}
set.Var(f.Value, name, f.Usage)
}
return nil
}
2022-05-07 00:48:35 +02:00
// Get returns the flags value in the given Context.
func (f *GenericFlag) Get(ctx *Context) interface{} {
return ctx.Generic(f.Name)
}
2022-10-01 16:20:01 +02:00
// RunAction executes flag action if set
func (f *GenericFlag) RunAction(c *Context) error {
if f.Action != nil {
return f.Action(c, c.Generic(f.Name))
}
return nil
}
// Generic looks up the value of a local GenericFlag, returns
// nil if not found
2022-04-26 14:24:23 +02:00
func (cCtx *Context) Generic(name string) interface{} {
if fs := cCtx.lookupFlagSet(name); fs != nil {
return lookupGeneric(name, fs)
}
return nil
}
func lookupGeneric(name string, set *flag.FlagSet) interface{} {
2023-05-10 08:13:50 +02:00
if f := set.Lookup(name); f != nil {
return f.Value
}
return nil
}