1package pflag
2
3import "fmt"
4
5// -- string Value
6type stringValue string
7
8func newStringValue(val string, p *string) *stringValue {
9	*p = val
10	return (*stringValue)(p)
11}
12
13func (s *stringValue) Set(val string) error {
14	*s = stringValue(val)
15	return nil
16}
17func (s *stringValue) Type() string {
18	return "string"
19}
20
21func (s *stringValue) String() string { return fmt.Sprintf("%s", *s) }
22
23func stringConv(sval string) (interface{}, error) {
24	return sval, nil
25}
26
27// GetString return the string value of a flag with the given name
28func (f *FlagSet) GetString(name string) (string, error) {
29	val, err := f.getFlagType(name, "string", stringConv)
30	if err != nil {
31		return "", err
32	}
33	return val.(string), nil
34}
35
36// StringVar defines a string flag with specified name, default value, and usage string.
37// The argument p points to a string variable in which to store the value of the flag.
38func (f *FlagSet) StringVar(p *string, name string, value string, usage string) {
39	f.VarP(newStringValue(value, p), name, "", usage)
40}
41
42// StringVarP is like StringVar, but accepts a shorthand letter that can be used after a single dash.
43func (f *FlagSet) StringVarP(p *string, name, shorthand string, value string, usage string) {
44	f.VarP(newStringValue(value, p), name, shorthand, usage)
45}
46
47// StringVar defines a string flag with specified name, default value, and usage string.
48// The argument p points to a string variable in which to store the value of the flag.
49func StringVar(p *string, name string, value string, usage string) {
50	CommandLine.VarP(newStringValue(value, p), name, "", usage)
51}
52
53// StringVarP is like StringVar, but accepts a shorthand letter that can be used after a single dash.
54func StringVarP(p *string, name, shorthand string, value string, usage string) {
55	CommandLine.VarP(newStringValue(value, p), name, shorthand, usage)
56}
57
58// String defines a string flag with specified name, default value, and usage string.
59// The return value is the address of a string variable that stores the value of the flag.
60func (f *FlagSet) String(name string, value string, usage string) *string {
61	p := new(string)
62	f.StringVarP(p, name, "", value, usage)
63	return p
64}
65
66// StringP is like String, but accepts a shorthand letter that can be used after a single dash.
67func (f *FlagSet) StringP(name, shorthand string, value string, usage string) *string {
68	p := new(string)
69	f.StringVarP(p, name, shorthand, value, usage)
70	return p
71}
72
73// String defines a string flag with specified name, default value, and usage string.
74// The return value is the address of a string variable that stores the value of the flag.
75func String(name string, value string, usage string) *string {
76	return CommandLine.StringP(name, "", value, usage)
77}
78
79// StringP is like String, but accepts a shorthand letter that can be used after a single dash.
80func StringP(name, shorthand string, value string, usage string) *string {
81	return CommandLine.StringP(name, shorthand, value, usage)
82}
83