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

101 lines
2.1 KiB
Go
Raw Normal View History

package cli
2022-04-26 14:24:23 +02:00
import (
"flag"
"fmt"
)
// TakesValue returns true of the flag takes a value, otherwise false
func (f *StringFlag) TakesValue() bool {
return true
}
// GetUsage returns the usage string for the flag
func (f *StringFlag) GetUsage() string {
return f.Usage
}
2022-05-25 20:49:12 +02:00
// GetCategory returns the category for the flag
func (f *StringFlag) 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 *StringFlag) GetValue() string {
return f.Value
}
2022-04-26 14:24:23 +02:00
// GetDefaultText returns the default text for this flag
func (f *StringFlag) 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-04-26 14:24:23 +02:00
}
2023-12-11 09:48:36 +01:00
if val == "" {
return val
}
return fmt.Sprintf("%q", val)
2022-04-26 14:24:23 +02:00
}
// GetEnvVars returns the env vars for this flag
func (f *StringFlag) GetEnvVars() []string {
return f.EnvVars
}
// Apply populates the flag given the flag set and environment
func (f *StringFlag) 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, _, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found {
f.Value = val
f.HasBeenSet = true
}
for _, name := range f.Names() {
if f.Destination != nil {
set.StringVar(f.Destination, name, f.Value, f.Usage)
continue
}
set.String(name, f.Value, f.Usage)
}
return nil
}
2022-05-07 00:48:35 +02:00
// Get returns the flags value in the given Context.
func (f *StringFlag) Get(ctx *Context) string {
return ctx.String(f.Name)
}
2022-10-01 16:20:01 +02:00
// RunAction executes flag action if set
func (f *StringFlag) RunAction(c *Context) error {
if f.Action != nil {
return f.Action(c, c.String(f.Name))
}
return nil
}
// String looks up the value of a local StringFlag, returns
// "" if not found
2022-04-26 14:24:23 +02:00
func (cCtx *Context) String(name string) string {
if fs := cCtx.lookupFlagSet(name); fs != nil {
return lookupString(name, fs)
}
return ""
}
func lookupString(name string, set *flag.FlagSet) string {
2023-05-10 08:13:50 +02:00
if f := set.Lookup(name); f != nil {
return f.Value.String()
}
return ""
}