2013-07-18 00:00:02 +00:00
|
|
|
package cli
|
|
|
|
|
|
|
|
import (
|
|
|
|
"flag"
|
|
|
|
"strconv"
|
|
|
|
)
|
|
|
|
|
|
|
|
// Context is a type that is passed through to
|
|
|
|
// each Handler action in a cli application. Context
|
|
|
|
// can be used to retrieve context-specific Args and
|
|
|
|
// parsed command-line options.
|
|
|
|
type Context struct {
|
2013-07-19 15:34:01 +00:00
|
|
|
App *App
|
2013-07-19 01:00:52 +00:00
|
|
|
flagSet *flag.FlagSet
|
|
|
|
globalSet *flag.FlagSet
|
2013-07-18 00:00:02 +00:00
|
|
|
}
|
|
|
|
|
2013-11-24 13:40:21 +00:00
|
|
|
type Args []string
|
|
|
|
|
2013-11-01 14:31:37 +00:00
|
|
|
// Creates a new context. For use in when invoking an App or Command action.
|
2013-07-19 15:34:01 +00:00
|
|
|
func NewContext(app *App, set *flag.FlagSet, globalSet *flag.FlagSet) *Context {
|
|
|
|
return &Context{app, set, globalSet}
|
2013-07-18 00:00:02 +00:00
|
|
|
}
|
|
|
|
|
2013-07-19 01:00:52 +00:00
|
|
|
// Looks up the value of a local int flag, returns 0 if no int flag exists
|
2013-07-19 00:29:06 +00:00
|
|
|
func (c *Context) Int(name string) int {
|
2013-07-19 01:00:52 +00:00
|
|
|
return c.lookupInt(name, c.flagSet)
|
2013-07-18 00:00:02 +00:00
|
|
|
}
|
|
|
|
|
2013-07-19 01:00:52 +00:00
|
|
|
// Looks up the value of a local bool flag, returns false if no bool flag exists
|
2013-07-19 00:29:06 +00:00
|
|
|
func (c *Context) Bool(name string) bool {
|
2013-07-19 01:00:52 +00:00
|
|
|
return c.lookupBool(name, c.flagSet)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Looks up the value of a local string flag, returns "" if no string flag exists
|
|
|
|
func (c *Context) String(name string) string {
|
|
|
|
return c.lookupString(name, c.flagSet)
|
|
|
|
}
|
|
|
|
|
2013-09-24 19:36:01 +00:00
|
|
|
// Looks up the value of a local string slice flag, returns nil if no string slice flag exists
|
|
|
|
func (c *Context) StringSlice(name string) []string {
|
2013-09-24 01:41:31 +00:00
|
|
|
return c.lookupStringSlice(name, c.flagSet)
|
|
|
|
}
|
|
|
|
|
2013-09-24 19:36:01 +00:00
|
|
|
// Looks up the value of a local int slice flag, returns nil if no int slice flag exists
|
|
|
|
func (c *Context) IntSlice(name string) []int {
|
|
|
|
return c.lookupIntSlice(name, c.flagSet)
|
|
|
|
}
|
|
|
|
|
2013-07-19 01:00:52 +00:00
|
|
|
// Looks up the value of a global int flag, returns 0 if no int flag exists
|
|
|
|
func (c *Context) GlobalInt(name string) int {
|
|
|
|
return c.lookupInt(name, c.globalSet)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Looks up the value of a global bool flag, returns false if no bool flag exists
|
|
|
|
func (c *Context) GlobalBool(name string) bool {
|
|
|
|
return c.lookupBool(name, c.globalSet)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Looks up the value of a global string flag, returns "" if no string flag exists
|
|
|
|
func (c *Context) GlobalString(name string) string {
|
|
|
|
return c.lookupString(name, c.globalSet)
|
|
|
|
}
|
|
|
|
|
2013-09-24 19:36:01 +00:00
|
|
|
// Looks up the value of a global string slice flag, returns nil if no string slice flag exists
|
|
|
|
func (c *Context) GlobalStringSlice(name string) []string {
|
|
|
|
return c.lookupStringSlice(name, c.globalSet)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Looks up the value of a global int slice flag, returns nil if no int slice flag exists
|
|
|
|
func (c *Context) GlobalIntSlice(name string) []int {
|
|
|
|
return c.lookupIntSlice(name, c.globalSet)
|
|
|
|
}
|
|
|
|
|
2013-11-01 14:31:37 +00:00
|
|
|
// Returns the command line arguments associated with the context.
|
2013-11-24 13:40:21 +00:00
|
|
|
func (c *Context) Args() Args {
|
|
|
|
args := Args(c.flagSet.Args())
|
|
|
|
return args
|
2013-07-19 01:00:52 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (c *Context) lookupInt(name string, set *flag.FlagSet) int {
|
|
|
|
f := set.Lookup(name)
|
|
|
|
if f != nil {
|
|
|
|
val, err := strconv.Atoi(f.Value.String())
|
2013-07-18 00:00:02 +00:00
|
|
|
if err != nil {
|
2013-07-19 01:00:52 +00:00
|
|
|
return 0
|
2013-07-18 00:00:02 +00:00
|
|
|
}
|
|
|
|
return val
|
|
|
|
}
|
2013-07-24 14:35:45 +00:00
|
|
|
|
2013-07-22 13:35:56 +00:00
|
|
|
return 0
|
2013-07-18 00:00:02 +00:00
|
|
|
}
|
|
|
|
|
2013-07-19 01:00:52 +00:00
|
|
|
func (c *Context) lookupString(name string, set *flag.FlagSet) string {
|
|
|
|
f := set.Lookup(name)
|
|
|
|
if f != nil {
|
|
|
|
return f.Value.String()
|
2013-07-18 00:00:02 +00:00
|
|
|
}
|
2013-07-24 14:35:45 +00:00
|
|
|
|
2013-07-22 13:35:56 +00:00
|
|
|
return ""
|
2013-07-18 00:00:02 +00:00
|
|
|
}
|
|
|
|
|
2013-09-24 19:36:01 +00:00
|
|
|
func (c *Context) lookupStringSlice(name string, set *flag.FlagSet) []string {
|
2013-09-24 01:41:31 +00:00
|
|
|
f := set.Lookup(name)
|
|
|
|
if f != nil {
|
2013-09-24 19:36:01 +00:00
|
|
|
return (f.Value.(*StringSlice)).Value()
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (c *Context) lookupIntSlice(name string, set *flag.FlagSet) []int {
|
|
|
|
f := set.Lookup(name)
|
|
|
|
if f != nil {
|
|
|
|
return (f.Value.(*IntSlice)).Value()
|
|
|
|
|
2013-09-24 01:41:31 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2013-07-19 01:00:52 +00:00
|
|
|
func (c *Context) lookupBool(name string, set *flag.FlagSet) bool {
|
|
|
|
f := set.Lookup(name)
|
|
|
|
if f != nil {
|
|
|
|
val, err := strconv.ParseBool(f.Value.String())
|
|
|
|
if err != nil {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
return val
|
|
|
|
}
|
2013-07-24 14:35:45 +00:00
|
|
|
|
2013-07-22 13:35:56 +00:00
|
|
|
return false
|
2013-07-18 00:00:02 +00:00
|
|
|
}
|
2013-11-15 10:30:45 +00:00
|
|
|
|
2013-11-24 13:40:21 +00:00
|
|
|
// Returns the nth argument, or else a blank string
|
|
|
|
func (a Args) Get(n int) string {
|
|
|
|
if len(a) > n {
|
|
|
|
return a[n]
|
2013-11-15 10:30:45 +00:00
|
|
|
}
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
2013-11-24 13:40:21 +00:00
|
|
|
// Returns the first argument, or else a blank string
|
|
|
|
func (a Args) First() string {
|
|
|
|
return a.Get(0)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Return the rest of the arguments (not the first one)
|
|
|
|
// or else an empty string slice
|
|
|
|
func (a Args) Tail() []string {
|
|
|
|
if len(a) >= 2 {
|
|
|
|
return []string(a)[1:]
|
|
|
|
}
|
|
|
|
return []string{}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Checks if there are any arguments present
|
|
|
|
func (a Args) Present() bool {
|
|
|
|
return len(a) != 0
|
2013-11-15 10:30:45 +00:00
|
|
|
}
|