1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168 |
- // Copyright 2009 The Go Authors. All rights reserved.
- // Use of this source code is governed by a BSD-style
- // license that can be found in the LICENSE file.
- /*
- Package flag implements command-line flag parsing.
- Usage:
- Define flags using flag.String(), Bool(), Int(), etc.
- This declares an integer flag, -flagname, stored in the pointer ip, with type *int.
- import "flag"
- var ip = flag.Int("flagname", 1234, "help message for flagname")
- If you like, you can bind the flag to a variable using the Var() functions.
- var flagvar int
- func init() {
- flag.IntVar(&flagvar, "flagname", 1234, "help message for flagname")
- }
- Or you can create custom flags that satisfy the Value interface (with
- pointer receivers) and couple them to flag parsing by
- flag.Var(&flagVal, "name", "help message for flagname")
- For such flags, the default value is just the initial value of the variable.
- After all flags are defined, call
- flag.Parse()
- to parse the command line into the defined flags.
- Flags may then be used directly. If you're using the flags themselves,
- they are all pointers; if you bind to variables, they're values.
- fmt.Println("ip has value ", *ip)
- fmt.Println("flagvar has value ", flagvar)
- After parsing, the arguments following the flags are available as the
- slice flag.Args() or individually as flag.Arg(i).
- The arguments are indexed from 0 through flag.NArg()-1.
- Command line flag syntax:
- -flag
- -flag=x
- -flag x // non-boolean flags only
- One or two minus signs may be used; they are equivalent.
- The last form is not permitted for boolean flags because the
- meaning of the command
- cmd -x *
- will change if there is a file called 0, false, etc. You must
- use the -flag=false form to turn off a boolean flag.
- Flag parsing stops just before the first non-flag argument
- ("-" is a non-flag argument) or after the terminator "--".
- Integer flags accept 1234, 0664, 0x1234 and may be negative.
- Boolean flags may be:
- 1, 0, t, f, T, F, true, false, TRUE, FALSE, True, False
- Duration flags accept any input valid for time.ParseDuration.
- The default set of command-line flags is controlled by
- top-level functions. The FlagSet type allows one to define
- independent sets of flags, such as to implement subcommands
- in a command-line interface. The methods of FlagSet are
- analogous to the top-level functions for the command-line
- flag set.
- */
- package fla9
- import (
- "bufio"
- "errors"
- "fmt"
- "io"
- "os"
- "reflect"
- "sort"
- "strconv"
- "strings"
- "time"
- )
- // ErrHelp is the error returned if the -help or -h flag is invoked
- // but no such flag is defined.
- var ErrHelp = errors.New("flag: help requested")
- // -- bool Value
- type boolValue bool
- func newBoolValue(val bool, p *bool) *boolValue {
- *p = val
- return (*boolValue)(p)
- }
- func (b *boolValue) Set(s string) error {
- v, err := strconv.ParseBool(s)
- *b = boolValue(v)
- return err
- }
- func (b *boolValue) Get() interface{} { return bool(*b) }
- func (b *boolValue) String() string { return fmt.Sprintf("%v", *b) }
- func (b *boolValue) IsBoolFlag() bool { return true }
- // optional interface to indicate boolean flags that can be
- // supplied without "=value" text
- type boolFlag interface {
- Value
- IsBoolFlag() bool
- }
- // -- int Value
- type intValue int
- func newIntValue(val int, p *int) *intValue {
- *p = val
- return (*intValue)(p)
- }
- func (i *intValue) Set(s string) error {
- v, err := strconv.ParseInt(s, 0, 64)
- *i = intValue(v)
- return err
- }
- func (i *intValue) Get() interface{} { return int(*i) }
- func (i *intValue) String() string { return fmt.Sprintf("%v", *i) }
- // -- int64 Value
- type int64Value int64
- func newInt64Value(val int64, p *int64) *int64Value {
- *p = val
- return (*int64Value)(p)
- }
- func (i *int64Value) Set(s string) error {
- v, err := strconv.ParseInt(s, 0, 64)
- *i = int64Value(v)
- return err
- }
- func (i *int64Value) Get() interface{} { return int64(*i) }
- func (i *int64Value) String() string { return fmt.Sprintf("%v", *i) }
- // -- uint Value
- type uintValue uint
- func newUintValue(val uint, p *uint) *uintValue {
- *p = val
- return (*uintValue)(p)
- }
- func (i *uintValue) Set(s string) error {
- v, err := strconv.ParseUint(s, 0, 64)
- *i = uintValue(v)
- return err
- }
- func (i *uintValue) Get() interface{} { return uint(*i) }
- func (i *uintValue) String() string { return fmt.Sprintf("%v", *i) }
- // -- uint64 Value
- type uint64Value uint64
- func newUint64Value(val uint64, p *uint64) *uint64Value {
- *p = val
- return (*uint64Value)(p)
- }
- func (i *uint64Value) Set(s string) error {
- v, err := strconv.ParseUint(s, 0, 64)
- *i = uint64Value(v)
- return err
- }
- func (i *uint64Value) Get() interface{} { return uint64(*i) }
- func (i *uint64Value) String() string { return fmt.Sprintf("%v", *i) }
- // -- string Value
- type stringValue string
- func newStringValue(val string, p *string) *stringValue {
- *p = val
- return (*stringValue)(p)
- }
- func (s *stringValue) Set(val string) error {
- *s = stringValue(val)
- return nil
- }
- func (s *stringValue) Get() interface{} { return string(*s) }
- func (s *stringValue) String() string { return fmt.Sprintf("%s", *s) }
- // -- float64 Value
- type float64Value float64
- func newFloat64Value(val float64, p *float64) *float64Value {
- *p = val
- return (*float64Value)(p)
- }
- func (f *float64Value) Set(s string) error {
- v, err := strconv.ParseFloat(s, 64)
- *f = float64Value(v)
- return err
- }
- func (f *float64Value) Get() interface{} { return float64(*f) }
- func (f *float64Value) String() string { return fmt.Sprintf("%v", *f) }
- // -- time.Duration Value
- type durationValue time.Duration
- func newDurationValue(val time.Duration, p *time.Duration) *durationValue {
- *p = val
- return (*durationValue)(p)
- }
- func (d *durationValue) Set(s string) error {
- v, err := time.ParseDuration(s)
- *d = durationValue(v)
- return err
- }
- func (d *durationValue) Get() interface{} { return time.Duration(*d) }
- func (d *durationValue) String() string { return (*time.Duration)(d).String() }
- // Value is the interface to the dynamic value stored in a flag.
- // (The default value is represented as a string.)
- //
- // If a Value has an IsBoolFlag() bool method returning true,
- // the command-line parser makes -name equivalent to -name=true
- // rather than using the next command-line argument.
- //
- // Set is called once, in command line order, for each flag present.
- type Value interface {
- String() string
- Set(string) error
- }
- // Getter is an interface that allows the contents of a Value to be retrieved.
- // It wraps the Value interface, rather than being part of it, because it
- // appeared after Go 1 and its compatibility rules. All Value types provided
- // by this package satisfy the Getter interface.
- type Getter interface {
- Value
- Get() interface{}
- }
- // ErrorHandling defines how FlagSet.Parse behaves if the parse fails.
- type ErrorHandling int
- // These constants cause FlagSet.Parse to behave as described if the parse fails.
- const (
- ContinueOnError ErrorHandling = iota // Return a descriptive error.
- ExitOnError // Call os.Exit(2).
- PanicOnError // Call panic with a descriptive error.
- )
- // A FlagSet represents a set of defined flags. The zero value of a FlagSet
- // has no name and has ContinueOnError error handling.
- type FlagSet struct {
- // Usage is the function called when an error occurs while parsing flags.
- // The field is a function (not a method) that may be changed to point to
- // a custom error handler.
- Usage func()
- name string
- parsed bool
- actual map[string]*Flag
- formal map[string]*Flag
- envPrefix string // prefix to all env variable names
- args []string // arguments after flags
- errorHandling ErrorHandling
- output io.Writer // nil means stderr; use out() accessor
- }
- // A Flag represents the state of a flag.
- type Flag struct {
- Name string // name as it appears on command line
- Usage string // help message
- Value Value // value as set
- DefValue string // default value (as text); for usage message
- }
- // sortFlags returns the flags as a slice in lexicographical sorted order.
- func sortFlags(flags map[string]*Flag) []*Flag {
- list := make(sort.StringSlice, len(flags))
- i := 0
- for _, f := range flags {
- list[i] = f.Name
- i++
- }
- list.Sort()
- result := make([]*Flag, len(list))
- for i, name := range list {
- result[i] = flags[name]
- }
- return result
- }
- func (f *FlagSet) out() io.Writer {
- if f.output == nil {
- return os.Stderr
- }
- return f.output
- }
- // SetOutput sets the destination for usage and error messages.
- // If output is nil, os.Stderr is used.
- func (f *FlagSet) SetOutput(output io.Writer) { f.output = output }
- // VisitAll visits the flags in lexicographical order, calling fn for each.
- // It visits all flags, even those not set.
- func (f *FlagSet) VisitAll(fn func(*Flag)) {
- for _, flag := range sortFlags(f.formal) {
- fn(flag)
- }
- }
- // VisitAll visits the command-line flags in lexicographical order, calling
- // fn for each. It visits all flags, even those not set.
- func VisitAll(fn func(*Flag)) { CommandLine.VisitAll(fn) }
- // Visit visits the flags in lexicographical order, calling fn for each.
- // It visits only those flags that have been set.
- func (f *FlagSet) Visit(fn func(*Flag)) {
- for _, flag := range sortFlags(f.actual) {
- fn(flag)
- }
- }
- // Visit visits the command-line flags in lexicographical order, calling fn
- // for each. It visits only those flags that have been set.
- func Visit(fn func(*Flag)) { CommandLine.Visit(fn) }
- // Lookup returns the Flag structure of the named flag, returning nil if none exists.
- func (f *FlagSet) Lookup(name string) *Flag { return f.formal[name] }
- // Lookup returns the Flag structure of the named command-line flag,
- // returning nil if none exists.
- func Lookup(name string) *Flag { return CommandLine.formal[name] }
- // Set sets the value of the named flag.
- func (f *FlagSet) Set(name, value string) error {
- flag, ok := f.formal[name]
- if !ok {
- return fmt.Errorf("no such flag -%v", name)
- }
- err := flag.Value.Set(value)
- if err != nil {
- return err
- }
- if f.actual == nil {
- f.actual = make(map[string]*Flag)
- }
- f.actual[name] = flag
- return nil
- }
- // Set sets the value of the named command-line flag.
- func Set(name, value string) error { return CommandLine.Set(name, value) }
- // isZeroValue guesses whether the string represents the zero
- // value for a flag. It is not accurate but in practice works OK.
- func isZeroValue(flag *Flag, value string) bool {
- // Build a zero value of the flag's Value type, and see if the
- // result of calling its String method equals the value passed in.
- // This works unless the Value type is itself an interface type.
- typ := reflect.TypeOf(flag.Value)
- var z reflect.Value
- if typ.Kind() == reflect.Ptr {
- z = reflect.New(typ.Elem())
- } else {
- z = reflect.Zero(typ)
- }
- if value == z.Interface().(Value).String() {
- return true
- }
- switch value {
- case "false", "", "0":
- return true
- }
- return false
- }
- // UnquoteUsage extracts a back-quoted name from the usage
- // string for a flag and returns it and the un-quoted usage.
- // Given "a `name` to show" it returns ("name", "a name to show").
- // If there are no back quotes, the name is an educated guess of the
- // type of the flag's value, or the empty string if the flag is boolean.
- func UnquoteUsage(flag *Flag) (name string, usage string) {
- // Look for a back-quoted name, but avoid the strings package.
- usage = flag.Usage
- for i := 0; i < len(usage); i++ {
- if usage[i] == '`' {
- for j := i + 1; j < len(usage); j++ {
- if usage[j] == '`' {
- name = usage[i+1 : j]
- usage = usage[:i] + name + usage[j+1:]
- return name, usage
- }
- }
- break // Only one back quote; use type name.
- }
- }
- // No explicit name, so use type if we can find one.
- name = "value"
- switch flag.Value.(type) {
- case boolFlag:
- name = ""
- case *durationValue:
- name = "duration"
- case *float64Value:
- name = "float"
- case *intValue, *int64Value:
- name = "int"
- case *stringValue:
- name = "string"
- case *uintValue, *uint64Value:
- name = "uint"
- }
- return
- }
- // PrintDefaults prints to standard error the default values of all
- // defined command-line flags in the set. See the documentation for
- // the global function PrintDefaults for more information.
- func (f *FlagSet) PrintDefaults() {
- f.VisitAll(func(flag *Flag) {
- s := fmt.Sprintf(" -%s", flag.Name) // Two spaces before -; see next two comments.
- name, usage := UnquoteUsage(flag)
- if len(name) > 0 {
- s += " " + name
- }
- // Boolean flags of one ASCII letter are so common we
- // treat them specially, putting their usage on the same line.
- if len(s) <= 4 { // space, space, '-', 'x'.
- s += "\t"
- } else {
- // Four spaces before the tab triggers good alignment
- // for both 4- and 8-space tab stops.
- s += "\n \t"
- }
- s += usage
- if !isZeroValue(flag, flag.DefValue) {
- if _, ok := flag.Value.(*stringValue); ok {
- // put quotes on the value
- s += fmt.Sprintf(" (default %q)", flag.DefValue)
- } else {
- s += fmt.Sprintf(" (default %v)", flag.DefValue)
- }
- }
- fmt.Fprint(f.out(), s, "\n")
- })
- }
- // PrintDefaults prints, to standard error unless configured otherwise,
- // a usage message showing the default settings of all defined
- // command-line flags.
- // For an integer valued flag x, the default output has the form
- //
- // -x int
- // usage-message-for-x (default 7)
- //
- // The usage message will appear on a separate line for anything but
- // a bool flag with a one-byte name. For bool flags, the type is
- // omitted and if the flag name is one byte the usage message appears
- // on the same line. The parenthetical default is omitted if the
- // default is the zero value for the type. The listed type, here int,
- // can be changed by placing a back-quoted name in the flag's usage
- // string; the first such item in the message is taken to be a parameter
- // name to show in the message and the back quotes are stripped from
- // the message when displayed. For instance, given
- //
- // flag.String("I", "", "search `directory` for include files")
- //
- // the output will be
- //
- // -I directory
- // search directory for include files.
- func PrintDefaults() { CommandLine.PrintDefaults() }
- // defaultUsage is the default function to print a usage message.
- func defaultUsage(f *FlagSet) {
- if f.name == "" {
- fmt.Fprintf(f.out(), "Usage:\n")
- } else {
- fmt.Fprintf(f.out(), "Usage of %s:\n", f.name)
- }
- f.PrintDefaults()
- }
- // NOTE: Usage is not just defaultUsage(CommandLine)
- // because it serves (via godoc flag Usage) as the example
- // for how to write your own usage function.
- // Usage prints to standard error a usage message documenting all defined command-line flags.
- // It is called when an error occurs while parsing flags.
- // The function is a variable that may be changed to point to a custom function.
- // By default it prints a simple header and calls PrintDefaults; for details about the
- // format of the output and how to control it, see the documentation for PrintDefaults.
- var Usage = func() {
- fmt.Fprintf(os.Stderr, "Usage of %s:\n", os.Args[0])
- PrintDefaults()
- }
- // NFlag returns the number of flags that have been set.
- func (f *FlagSet) NFlag() int { return len(f.actual) }
- // NFlag returns the number of command-line flags that have been set.
- func NFlag() int { return len(CommandLine.actual) }
- // Arg returns the i'th argument. Arg(0) is the first remaining argument
- // after flags have been processed. Arg returns an empty string if the
- // requested element does not exist.
- func (f *FlagSet) Arg(i int) string {
- if i < 0 || i >= len(f.args) {
- return ""
- }
- return f.args[i]
- }
- // Arg returns the i'th command-line argument. Arg(0) is the first remaining argument
- // after flags have been processed. Arg returns an empty string if the
- // requested element does not exist.
- func Arg(i int) string { return CommandLine.Arg(i) }
- // NArg is the number of arguments remaining after flags have been processed.
- func (f *FlagSet) NArg() int { return len(f.args) }
- // NArg is the number of arguments remaining after flags have been processed.
- func NArg() int { return len(CommandLine.args) }
- // Args returns the non-flag arguments.
- func (f *FlagSet) Args() []string { return f.args }
- // Args returns the non-flag command-line arguments.
- func Args() []string { return CommandLine.args }
- // BoolVar defines a bool flag with specified name, default value, and usage string.
- // The argument p points to a bool variable in which to store the value of the flag.
- func (f *FlagSet) BoolVar(p *bool, name string, value bool, usage string) {
- f.Var(newBoolValue(value, p), name, usage)
- }
- // BoolVar defines a bool flag with specified name, default value, and usage string.
- // The argument p points to a bool variable in which to store the value of the flag.
- func BoolVar(p *bool, name string, value bool, usage string) {
- CommandLine.Var(newBoolValue(value, p), name, usage)
- }
- // Bool defines a bool flag with specified name, default value, and usage string.
- // The return value is the address of a bool variable that stores the value of the flag.
- func (f *FlagSet) Bool(name string, value bool, usage string) *bool {
- p := new(bool)
- f.BoolVar(p, name, value, usage)
- return p
- }
- // Bool defines a bool flag with specified name, default value, and usage string.
- // The return value is the address of a bool variable that stores the value of the flag.
- func Bool(name string, value bool, usage string) *bool {
- return CommandLine.Bool(name, value, usage)
- }
- // IntVar defines an int flag with specified name, default value, and usage string.
- // The argument p points to an int variable in which to store the value of the flag.
- func (f *FlagSet) IntVar(p *int, name string, value int, usage string) {
- f.Var(newIntValue(value, p), name, usage)
- }
- // IntVar defines an int flag with specified name, default value, and usage string.
- // The argument p points to an int variable in which to store the value of the flag.
- func IntVar(p *int, name string, value int, usage string) {
- CommandLine.Var(newIntValue(value, p), name, usage)
- }
- // Int defines an int flag with specified name, default value, and usage string.
- // The return value is the address of an int variable that stores the value of the flag.
- func (f *FlagSet) Int(name string, value int, usage string) *int {
- p := new(int)
- f.IntVar(p, name, value, usage)
- return p
- }
- // Int defines an int flag with specified name, default value, and usage string.
- // The return value is the address of an int variable that stores the value of the flag.
- func Int(name string, value int, usage string) *int {
- return CommandLine.Int(name, value, usage)
- }
- // Int64Var defines an int64 flag with specified name, default value, and usage string.
- // The argument p points to an int64 variable in which to store the value of the flag.
- func (f *FlagSet) Int64Var(p *int64, name string, value int64, usage string) {
- f.Var(newInt64Value(value, p), name, usage)
- }
- // Int64Var defines an int64 flag with specified name, default value, and usage string.
- // The argument p points to an int64 variable in which to store the value of the flag.
- func Int64Var(p *int64, name string, value int64, usage string) {
- CommandLine.Var(newInt64Value(value, p), name, usage)
- }
- // Int64 defines an int64 flag with specified name, default value, and usage string.
- // The return value is the address of an int64 variable that stores the value of the flag.
- func (f *FlagSet) Int64(name string, value int64, usage string) *int64 {
- p := new(int64)
- f.Int64Var(p, name, value, usage)
- return p
- }
- // Int64 defines an int64 flag with specified name, default value, and usage string.
- // The return value is the address of an int64 variable that stores the value of the flag.
- func Int64(name string, value int64, usage string) *int64 {
- return CommandLine.Int64(name, value, usage)
- }
- // UintVar defines a uint flag with specified name, default value, and usage string.
- // The argument p points to a uint variable in which to store the value of the flag.
- func (f *FlagSet) UintVar(p *uint, name string, value uint, usage string) {
- f.Var(newUintValue(value, p), name, usage)
- }
- // UintVar defines a uint flag with specified name, default value, and usage string.
- // The argument p points to a uint variable in which to store the value of the flag.
- func UintVar(p *uint, name string, value uint, usage string) {
- CommandLine.Var(newUintValue(value, p), name, usage)
- }
- // Uint defines a uint flag with specified name, default value, and usage string.
- // The return value is the address of a uint variable that stores the value of the flag.
- func (f *FlagSet) Uint(name string, value uint, usage string) *uint {
- p := new(uint)
- f.UintVar(p, name, value, usage)
- return p
- }
- // Uint defines a uint flag with specified name, default value, and usage string.
- // The return value is the address of a uint variable that stores the value of the flag.
- func Uint(name string, value uint, usage string) *uint { return CommandLine.Uint(name, value, usage) }
- // Uint64Var defines a uint64 flag with specified name, default value, and usage string.
- // The argument p points to a uint64 variable in which to store the value of the flag.
- func (f *FlagSet) Uint64Var(p *uint64, name string, value uint64, usage string) {
- f.Var(newUint64Value(value, p), name, usage)
- }
- // Uint64Var defines a uint64 flag with specified name, default value, and usage string.
- // The argument p points to a uint64 variable in which to store the value of the flag.
- func Uint64Var(p *uint64, name string, value uint64, usage string) {
- CommandLine.Var(newUint64Value(value, p), name, usage)
- }
- // Uint64 defines a uint64 flag with specified name, default value, and usage string.
- // The return value is the address of a uint64 variable that stores the value of the flag.
- func (f *FlagSet) Uint64(name string, value uint64, usage string) *uint64 {
- p := new(uint64)
- f.Uint64Var(p, name, value, usage)
- return p
- }
- // Uint64 defines a uint64 flag with specified name, default value, and usage string.
- // The return value is the address of a uint64 variable that stores the value of the flag.
- func Uint64(name string, value uint64, usage string) *uint64 {
- return CommandLine.Uint64(name, value, usage)
- }
- // StringVar defines a string flag with specified name, default value, and usage string.
- // The argument p points to a string variable in which to store the value of the flag.
- func (f *FlagSet) StringVar(p *string, name, value, usage string) {
- f.Var(newStringValue(value, p), name, usage)
- }
- // StringVar defines a string flag with specified name, default value, and usage string.
- // The argument p points to a string variable in which to store the value of the flag.
- func StringVar(p *string, name, value, usage string) {
- CommandLine.Var(newStringValue(value, p), name, usage)
- }
- // String defines a string flag with specified name, default value, and usage string.
- // The return value is the address of a string variable that stores the value of the flag.
- func (f *FlagSet) String(name, value, usage string) *string {
- p := new(string)
- f.StringVar(p, name, value, usage)
- return p
- }
- // String defines a string flag with specified name, default value, and usage string.
- // The return value is the address of a string variable that stores the value of the flag.
- func String(name, value, usage string) *string {
- return CommandLine.String(name, value, usage)
- }
- // Float64Var defines a float64 flag with specified name, default value, and usage string.
- // The argument p points to a float64 variable in which to store the value of the flag.
- func (f *FlagSet) Float64Var(p *float64, name string, value float64, usage string) {
- f.Var(newFloat64Value(value, p), name, usage)
- }
- // Float64Var defines a float64 flag with specified name, default value, and usage string.
- // The argument p points to a float64 variable in which to store the value of the flag.
- func Float64Var(p *float64, name string, value float64, usage string) {
- CommandLine.Var(newFloat64Value(value, p), name, usage)
- }
- // Float64 defines a float64 flag with specified name, default value, and usage string.
- // The return value is the address of a float64 variable that stores the value of the flag.
- func (f *FlagSet) Float64(name string, value float64, usage string) *float64 {
- p := new(float64)
- f.Float64Var(p, name, value, usage)
- return p
- }
- // Float64 defines a float64 flag with specified name, default value, and usage string.
- // The return value is the address of a float64 variable that stores the value of the flag.
- func Float64(name string, value float64, usage string) *float64 {
- return CommandLine.Float64(name, value, usage)
- }
- // DurationVar defines a time.Duration flag with specified name, default value, and usage string.
- // The argument p points to a time.Duration variable in which to store the value of the flag.
- // The flag accepts a value acceptable to time.ParseDuration.
- func (f *FlagSet) DurationVar(p *time.Duration, name string, value time.Duration, usage string) {
- f.Var(newDurationValue(value, p), name, usage)
- }
- // DurationVar defines a time.Duration flag with specified name, default value, and usage string.
- // The argument p points to a time.Duration variable in which to store the value of the flag.
- // The flag accepts a value acceptable to time.ParseDuration.
- func DurationVar(p *time.Duration, name string, value time.Duration, usage string) {
- CommandLine.Var(newDurationValue(value, p), name, usage)
- }
- // Duration defines a time.Duration flag with specified name, default value, and usage string.
- // The return value is the address of a time.Duration variable that stores the value of the flag.
- // The flag accepts a value acceptable to time.ParseDuration.
- func (f *FlagSet) Duration(name string, value time.Duration, usage string) *time.Duration {
- p := new(time.Duration)
- f.DurationVar(p, name, value, usage)
- return p
- }
- // Duration defines a time.Duration flag with specified name, default value, and usage string.
- // The return value is the address of a time.Duration variable that stores the value of the flag.
- // The flag accepts a value acceptable to time.ParseDuration.
- func Duration(name string, value time.Duration, usage string) *time.Duration {
- return CommandLine.Duration(name, value, usage)
- }
- // Var defines a flag with the specified name and usage string. The type and
- // value of the flag are represented by the first argument, of type Value, which
- // typically holds a user-defined implementation of Value. For instance, the
- // caller could create a flag that turns a comma-separated string into a slice
- // of strings by giving the slice the methods of Value; in particular, Set would
- // decompose the comma-separated string into the slice.
- func (f *FlagSet) Var(value Value, name string, usage string) {
- // Remember the default value as a string; it won't change.
- flag := &Flag{name, usage, value, value.String()}
- _, alreadythere := f.formal[name]
- if alreadythere {
- var msg string
- if f.name == "" {
- msg = fmt.Sprintf("flag redefined: %s", name)
- } else {
- msg = fmt.Sprintf("%s flag redefined: %s", f.name, name)
- }
- fmt.Fprintln(f.out(), msg)
- panic(msg) // Happens only if flags are declared with identical names
- }
- if f.formal == nil {
- f.formal = make(map[string]*Flag)
- }
- f.formal[name] = flag
- }
- // Var defines a flag with the specified name and usage string. The type and
- // value of the flag are represented by the first argument, of type Value, which
- // typically holds a user-defined implementation of Value. For instance, the
- // caller could create a flag that turns a comma-separated string into a slice
- // of strings by giving the slice the methods of Value; in particular, Set would
- // decompose the comma-separated string into the slice.
- func Var(value Value, name, usage string) {
- CommandLine.Var(value, name, usage)
- }
- // failf prints to standard error a formatted error and usage message and
- // returns the error.
- func (f *FlagSet) failf(format string, a ...interface{}) error {
- err := fmt.Errorf(format, a...)
- fmt.Fprintln(f.out(), err)
- f.usage()
- return err
- }
- // usage calls the Usage method for the flag set if one is specified,
- // or the appropriate default usage function otherwise.
- func (f *FlagSet) usage() {
- if f.Usage == nil {
- if f == CommandLine {
- Usage()
- } else {
- defaultUsage(f)
- }
- } else {
- f.Usage()
- }
- }
- // parseOne parses one flag. It reports whether a flag was seen.
- func (f *FlagSet) parseOne() (bool, error) {
- if len(f.args) == 0 {
- return false, nil
- }
- s := f.args[0]
- if len(s) < 2 || s[0] != '-' {
- return false, nil
- }
- numMinuses := 1
- if s[1] == '-' {
- numMinuses++
- if len(s) == 2 { // "--" terminates the flags
- f.args = f.args[1:]
- return false, nil
- }
- }
- name := s[numMinuses:]
- if len(name) == 0 || name[0] == '-' || name[0] == '=' {
- return false, f.failf("bad flag syntax: %s", s)
- }
- // ignore go test flags
- if strings.HasPrefix(name, "test.") {
- return false, nil
- }
- // it's a flag. does it have an argument?
- f.args = f.args[1:]
- hasValue := false
- value := ""
- for i := 1; i < len(name); i++ { // equals cannot be first
- if name[i] == '=' {
- value = name[i+1:]
- hasValue = true
- name = name[0:i]
- break
- }
- }
- m := f.formal
- flag, alreadythere := m[name] // BUG
- if !alreadythere {
- if name == "help" || name == "h" { // special case for nice help message.
- f.usage()
- return false, ErrHelp
- }
- return false, f.failf("flag provided but not defined: -%s", name)
- }
- if fv, ok := flag.Value.(boolFlag); ok && fv.IsBoolFlag() { // special case: doesn't need an arg
- if hasValue {
- if err := fv.Set(value); err != nil {
- return false, f.failf("invalid boolean value %q for -%s: %v", value, name, err)
- }
- } else {
- if err := fv.Set("true"); err != nil {
- return false, f.failf("invalid boolean flag %s: %v", name, err)
- }
- }
- } else {
- // It must have a value, which might be the next argument.
- if !hasValue && len(f.args) > 0 {
- // value is the next arg
- hasValue = true
- value, f.args = f.args[0], f.args[1:]
- }
- if !hasValue {
- return false, f.failf("flag needs an argument: -%s", name)
- }
- if err := flag.Value.Set(value); err != nil {
- return false, f.failf("invalid value %q for flag -%s: %v", value, name, err)
- }
- }
- if f.actual == nil {
- f.actual = make(map[string]*Flag)
- }
- f.actual[name] = flag
- return true, nil
- }
- // Parse parses flag definitions from the argument list, which should not
- // include the command name. Must be called after all flags in the FlagSet
- // are defined and before flags are accessed by the program.
- // The return value will be ErrHelp if -help or -h were set but not defined.
- func (f *FlagSet) Parse(arguments []string) error {
- if _, ok := f.formal[DefaultConfigFlagName]; !ok {
- f.String(DefaultConfigFlagName, "", "a file of command line options, each line in optionName=optionValue format")
- }
- f.parsed = true
- f.args = arguments
- for {
- seen, err := f.parseOne()
- if seen {
- continue
- }
- if err == nil {
- break
- }
- switch f.errorHandling {
- case ContinueOnError:
- return err
- case ExitOnError:
- os.Exit(2)
- case PanicOnError:
- panic(err)
- }
- }
- // Parse environment variables
- if err := f.ParseEnv(os.Environ()); err != nil {
- switch f.errorHandling {
- case ContinueOnError:
- return err
- case ExitOnError:
- os.Exit(2)
- case PanicOnError:
- panic(err)
- }
- return err
- }
- // Parse configuration from file
- var cFile string
- if cf := f.formal[DefaultConfigFlagName]; cf != nil {
- cFile = cf.Value.String()
- }
- if cf := f.actual[DefaultConfigFlagName]; cf != nil {
- cFile = cf.Value.String()
- }
- if cFile == "" {
- cFile = f.findConfigArgInUnresolved()
- }
- if cFile != "" {
- if err := f.ParseFile(cFile, true); err != nil {
- switch f.errorHandling {
- case ContinueOnError:
- return err
- case ExitOnError:
- os.Exit(2)
- case PanicOnError:
- panic(err)
- }
- return err
- }
- }
- return nil
- }
- func (f *FlagSet) findConfigArgInUnresolved() string {
- configArg := "-" + DefaultConfigFlagName
- for i := 0; i < len(f.args); i++ {
- if strings.HasPrefix(f.args[i], configArg) {
- if f.args[i] == configArg && i+1 < len(f.args) {
- return f.args[i+1]
- }
- if strings.HasPrefix(f.args[i], configArg+"=") {
- return f.args[i][len(configArg)+1:]
- }
- }
- }
- return ""
- }
- // Parsed reports whether f.Parse has been called.
- func (f *FlagSet) Parsed() bool { return f.parsed }
- // Parse parses the command-line flags from os.Args[1:]. Must be called
- // after all flags are defined and before flags are accessed by the program.
- func Parse() {
- // Ignore errors; CommandLine is set for ExitOnError.
- CommandLine.Parse(os.Args[1:])
- }
- // Parsed reports whether the command-line flags have been parsed.
- func Parsed() bool {
- return CommandLine.Parsed()
- }
- // CommandLine is the default set of command-line flags, parsed from os.Args.
- // The top-level functions such as BoolVar, Arg, and so on are wrappers for the
- // methods of CommandLine.
- var CommandLine = NewFlagSet(os.Args[0], ExitOnError)
- // NewFlagSet returns a new, empty flag set with the specified name and
- // error handling property.
- func NewFlagSet(name string, errorHandling ErrorHandling) *FlagSet {
- f := &FlagSet{
- name: name,
- errorHandling: errorHandling,
- envPrefix: EnvPrefix,
- }
- return f
- }
- // Init sets the name and error handling property for a flag set.
- // By default, the zero FlagSet uses an empty name, EnvPrefix, and the
- // ContinueOnError error handling policy.
- func (f *FlagSet) Init(name string, errorHandling ErrorHandling) {
- f.name = name
- f.envPrefix = EnvPrefix
- f.errorHandling = errorHandling
- }
- // EnvPrefix defines a string that will be implicitly prefixed to a
- // flag name before looking it up in the environment variables.
- var EnvPrefix = "WEED"
- // ParseEnv parses flags from environment variables.
- // Flags already set will be ignored.
- func (f *FlagSet) ParseEnv(environ []string) error {
- env := make(map[string]string)
- for _, s := range environ {
- if i := strings.Index(s, "="); i >= 1 {
- env[s[0:i]] = s[i+1:]
- }
- }
- for _, flag := range f.formal {
- name := flag.Name
- if _, set := f.actual[name]; set {
- continue
- }
- flag, alreadyThere := f.formal[name]
- if !alreadyThere {
- if name == "help" || name == "h" { // special case for nice help message.
- f.usage()
- return ErrHelp
- }
- return f.failf("environment variable provided but not defined: %s", name)
- }
- envKey := strings.ToUpper(flag.Name)
- if f.envPrefix != "" {
- envKey = f.envPrefix + "_" + envKey
- }
- envKey = strings.Replace(envKey, "-", "_", -1)
- value, isSet := env[envKey]
- if !isSet {
- continue
- }
- if fv, ok := flag.Value.(boolFlag); ok && fv.IsBoolFlag() && value == "" {
- // special case: doesn't need an arg
- // flag without value is regarded a bool
- value = ("true")
- }
- if err := flag.Value.Set(value); err != nil {
- return f.failf("invalid value %q for environment variable %s: %v", value, name, err)
- }
- // update f.actual
- if f.actual == nil {
- f.actual = make(map[string]*Flag)
- }
- f.actual[name] = flag
- }
- return nil
- }
- // NewFlagSetWithEnvPrefix returns a new empty flag set with the specified name,
- // environment variable prefix, and error handling property.
- func NewFlagSetWithEnvPrefix(name string, prefix string, errorHandling ErrorHandling) *FlagSet {
- f := NewFlagSet(name, errorHandling)
- f.envPrefix = prefix
- return f
- }
- // DefaultConfigFlagName defines the flag name of the optional config file
- // path. Used to lookup and parse the config file when a default is set and
- // available on disk.
- var DefaultConfigFlagName = "options"
- // ParseFile parses flags from the file in path.
- // Same format as commandline arguments, newlines and lines beginning with a
- // "#" character are ignored. Flags already set will be ignored.
- func (f *FlagSet) ParseFile(path string, ignoreUndefinedConf bool) error {
- fp, err := os.Open(path) // Extract arguments from file
- if err != nil {
- return err
- }
- defer fp.Close()
- scanner := bufio.NewScanner(fp)
- for scanner.Scan() {
- line := strings.TrimSpace(scanner.Text())
- // Ignore empty lines or comments
- if line == "" || line[:1] == "#" || line[:1] == "//" || line[:1] == "--" {
- continue
- }
- // Match `key=value` and `key value`
- name, value := line, ""
- for i, v := range line {
- if v == '=' || v == ' ' || v == ':' {
- name, value = strings.TrimSpace(line[:i]), strings.TrimSpace(line[i+1:])
- break
- }
- }
- name = strings.TrimPrefix(name, "-")
- // Ignore flag when already set; arguments have precedence over file
- if f.actual[name] != nil {
- continue
- }
- flag, alreadyThere := f.formal[name]
- if !alreadyThere {
- if ignoreUndefinedConf {
- continue
- }
- if name == "help" || name == "h" { // special case for nice help message.
- f.usage()
- return ErrHelp
- }
- return f.failf("configuration variable provided but not defined: %s", name)
- }
- if fv, ok := flag.Value.(boolFlag); ok && fv.IsBoolFlag() && value == "" {
- // special case: doesn't need an arg
- value = "true"
- }
- if err := flag.Value.Set(value); err != nil {
- return f.failf("invalid value %q for configuration variable %s: %v", value, name, err)
- }
- // update f.actual
- if f.actual == nil {
- f.actual = make(map[string]*Flag)
- }
- f.actual[name] = flag
- }
- return scanner.Err()
- }
|