1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
|
package flags
import (
"fmt"
"os"
"strconv"
"strings"
)
type Type uint
const (
UnsetType Type = iota // Unset
ArrayType // Array
BooleanType // Boolean
FloatType // Float
IncrementType // Increment
IntegerType // Integer
MapType // Map
StringType // String
)
type FlagModifier func(f *Flag)
type FlagProcessor func(f *Flag, v interface{}) (interface{}, error)
type FlagCallback func(f *Flag) error
// Add long name aliases for flag
func Alias(aliases ...string) FlagModifier {
return func(f *Flag) {
for _, a := range aliases {
f.aliases = append(f.aliases, a)
}
}
}
// Set description of flag
func Description(d string) FlagModifier {
return func(f *Flag) {
f.description = d
}
}
// Mark flag as being required
func Required() FlagModifier {
return func(f *Flag) {
f.required = true
}
}
// Mark flag as being optional (default state)
func Optional() FlagModifier {
return func(f *Flag) {
f.required = false
}
}
// Prevent flag from being displayed
func Hidden() FlagModifier {
return func(f *Flag) {
f.hidden = true
}
}
// Set default value for flag
func DefaultValue(v interface{}) FlagModifier {
return func(f *Flag) {
f.typeCheck(v)
f.defaultValue = v
}
}
// Set environment variable to read for flag value
func EnvVar(name string) FlagModifier {
return func(f *Flag) {
f.envVar = name
}
}
// Set short name for flag
func ShortName(n rune) FlagModifier {
return func(f *Flag) {
f.shortName = n
}
}
// Set the subtype of the flag (used for array and map types)
func SetSubtype(t Type) FlagModifier {
return func(f *Flag) {
f.subkind = t
}
}
// Add a processor to be executed before the flag value is
// set. The processor receives the current value to be set
// into the flag. The value returned by the process will be
// the value actually set into the flag.
func AddProcessor(fn FlagProcessor) FlagModifier {
return func(f *Flag) {
f.processors = append(f.processors, fn)
}
}
// Add a callback to be executed when flag is visited before
// the flag value is set. This can be used to modify the
// final value set.
func AddCallback(fn FlagCallback) FlagModifier {
return func(f *Flag) {
f.callbacks = append(f.callbacks, fn)
}
}
// Set value into custom pointer
func customVar(v interface{}) FlagModifier {
return func(f *Flag) {
f.ptrTypeCheck(v)
f.value = v
f.ptr = true
}
}
type Flag struct {
aliases []string // long name aliases
called bool // mark if called via cli
callbacks []FlagCallback // callback functions
defaultValue interface{} // default value when not updated
description string // description of flag
envVar string // environment variable to check for value
group *Group // group flag is attached to
hidden bool // flag is hidden from display
longName string // long name of flag
matchedName string // long or short name matched for flag (includes aliases)
processors []FlagProcessor // processor functions
ptr bool // mark if value is pointer
required bool // mark if flag requires value set
shortName rune // short name of flag
kind Type // data type of value
subkind Type // data type of values within array or map type
updated bool // value was updated (either by env var or cli)
value interface{} // value for flag
}
// Create a new flag
func newFlag(
name string, // long name of flag
kind Type, // data type of the flag
group *Group, // group flag is attached to
modifiers ...FlagModifier, // any modifier functions
) *Flag {
if group == nil {
panic("flag must be attached to group")
}
f := &Flag{
longName: name,
kind: kind,
group: group,
}
group.flags = append(group.flags, f)
for _, fn := range modifiers {
fn(f)
}
if kind == BooleanType {
Alias(fmt.Sprintf("no-%s", f.longName))(f)
}
return f
}
// List of aliases for this flag
func (f *Flag) Aliases() []string {
return f.aliases
}
// Flag value was set via CLI
func (f *Flag) Called() bool {
return f.called
}
// Flag name (long, short, aliases) matched on CLI
func (f *Flag) CalledAs() string {
return f.matchedName
}
// Default value assigned to flag
func (f *Flag) DefaultValue() interface{} {
return f.defaultValue
}
// Description of flag usage
func (f *Flag) Description() string {
return f.description
}
// Environment variable name used to populate flag value
func (f *Flag) EnvVar() string {
return f.envVar
}
// Group flag is attached to
func (f *Flag) Group() *Group {
return f.group
}
// Flag is hidden from display
func (f *Flag) Hidden() bool {
return f.hidden
}
// Long name of the flag
func (f *Flag) LongName() string {
return f.longName
}
// Flag is required to be set
func (f *Flag) Required() bool {
return f.required
}
// Short name of the flag
func (f *Flag) ShortName() rune {
return f.shortName
}
// Flag value was set via CLI or environment variable
func (f *Flag) Updated() bool {
return f.updated
}
// Value assigned to flag
func (f *Flag) Value() interface{} {
if f.ptr {
switch f.kind {
case ArrayType:
switch f.subkind {
case BooleanType:
return *(f.value.(*[]bool))
case FloatType:
return *(f.value.(*[]float64))
case IntegerType:
return *(f.value.(*[]int64))
case StringType:
return *(f.value.(*[]string))
default:
panic("unsupported array subtype: " + f.subkind.String())
}
case BooleanType:
return *(f.value.(*bool))
case FloatType:
return *(f.value.(*float64))
case IncrementType, IntegerType:
return *(f.value.(*int64))
case MapType:
switch f.subkind {
case BooleanType:
return *(f.value.(*map[string]bool))
case FloatType:
return *(f.value.(*map[string]float64))
case IntegerType:
return *(f.value.(*map[string]int64))
case StringType:
return *(f.value.(*map[string]string))
default:
panic("unsupported map subtype: " + f.subkind.String())
}
case StringType:
return *(f.value.(*string))
}
}
return f.value
}
// Initialize the flag to make ready for parsing. This is called
// by the Set before parsing.
func (f *Flag) init() error {
// if the value is already set, the flag has been previously
// used so we should consider it invalid
if f.updated || f.called {
return fmt.Errorf("flag has already been used")
}
// If the value is a custom variable then we don't need to initialize
if !f.ptr {
// Now we want to initialize our value so it can
// be modified as needed.
switch f.kind {
case ArrayType:
switch f.subkind {
case BooleanType:
f.value = []bool{}
case FloatType:
f.value = []float64{}
case IntegerType:
f.value = []int64{}
case StringType:
f.value = []string{}
default:
panic("invalid subtype for array: " + f.subkind.String())
}
case BooleanType:
var val bool
f.value = val
case FloatType:
var val float64
f.value = val
case IncrementType, IntegerType:
var val int64
f.value = val
case MapType:
switch f.subkind {
case BooleanType:
f.value = map[string]bool{}
case FloatType:
f.value = map[string]float64{}
case IntegerType:
f.value = map[string]int64{}
case StringType:
f.value = map[string]string{}
default:
panic("invalid subtype for map: " + f.subkind.String())
}
case StringType:
var val string
f.value = val
}
}
// Check if we have an environment variable configured, and if it
// is set, then set the value into the flag
if f.envVar != "" {
if eval := os.Getenv(f.envVar); eval != "" {
if err := f.setValue(eval); err != nil {
return err
}
f.updated = true
}
}
return nil
}
// Marks the flag as being called from the CLI and sets
// the flag name used.
func (f *Flag) markCalled(name string) {
defer func() {
f.matchedName = name
f.called = true
f.updated = true
}()
if f.longName == name || string(f.shortName) == name {
return
}
for _, n := range f.aliases {
if n == name {
return
}
}
panic(fmt.Sprintf(
"matched flag name (%s) is not a valid name for this flag (%s)",
name, f.longName))
}
// Set a value into the flag
func (f *Flag) setValue(v string) (err error) {
switch f.kind {
case ArrayType:
err = f.setValueArray(v)
case BooleanType:
err = f.setValueBoolean(v)
case FloatType:
err = f.setValueFloat(v)
case IncrementType:
err = f.setValueIncrement(v)
case MapType:
err = f.setValueMap(v)
case StringType:
err = f.setValueString(v)
default:
err = fmt.Errorf("invalid type, cannot set value")
}
if err != nil {
return
}
for _, fn := range f.callbacks {
if err = fn(f); err != nil {
return
}
}
return
}
// Set value into map type
func (f *Flag) setValueMap(v string) (err error) {
parts := strings.SplitN(v, "=", 2)
if len(parts) != 2 {
return fmt.Errorf("invalid value passed for map flag - %s", v)
}
key, value := parts[0], parts[1]
val, err := f.convertValue(value)
if err != nil {
return
}
for _, fn := range f.processors {
if val, err = fn(f, val); err != nil {
return
}
}
switch f.subkind {
case BooleanType:
var m map[string]bool
if f.ptr {
m = *(f.value.(*map[string]bool))
} else {
m = f.value.(map[string]bool)
}
m[key] = val.(bool)
case FloatType:
var m map[string]float64
if f.ptr {
m = *(f.value.(*map[string]float64))
} else {
m = f.value.(map[string]float64)
}
m[key] = val.(float64)
case IntegerType:
var m map[string]int64
if f.ptr {
m = *(f.value.(*map[string]int64))
} else {
m = f.value.(map[string]int64)
}
m[key] = val.(int64)
case StringType:
var m map[string]string
if f.ptr {
m = *(f.value.(*map[string]string))
} else {
m = f.value.(map[string]string)
}
m[key] = val.(string)
default:
return fmt.Errorf("invalid subtype configured for map flag - %s", f.subkind.String())
}
return
}
// Set value into array type
func (f *Flag) setValueArray(val string) (err error) {
v, err := f.convertValue(val)
if err != nil {
return
}
for _, fn := range f.processors {
if v, err = fn(f, v); err != nil {
return
}
}
switch f.subkind {
case BooleanType:
var array []bool
if f.ptr {
array = *(f.value.(*[]bool))
} else {
array = f.value.([]bool)
}
newArray := make([]bool, len(array)+1)
copy(newArray, array)
newArray[len(newArray)-1] = v.(bool)
if f.ptr {
*(f.value.(*[]bool)) = newArray
} else {
f.value = newArray
}
case FloatType:
var array []float64
if f.ptr {
array = *(f.value.(*[]float64))
} else {
array = f.value.([]float64)
}
newArray := make([]float64, len(array)+1)
copy(newArray, array)
newArray[len(newArray)-1] = v.(float64)
if f.ptr {
*(f.value.(*[]float64)) = newArray
} else {
f.value = newArray
}
case IntegerType:
var array []int64
if f.ptr {
array = *(f.value.(*[]int64))
} else {
array = f.value.([]int64)
}
newArray := make([]int64, len(array)+1)
copy(newArray, array)
newArray[len(newArray)-1] = v.(int64)
if f.ptr {
*(f.value.(*[]int64)) = newArray
} else {
f.value = newArray
}
case StringType:
var array []string
if f.ptr {
array = *(f.value.(*[]string))
} else {
array = f.value.([]string)
}
newArray := make([]string, len(array)+1)
copy(newArray, array)
newArray[len(newArray)-1] = v.(string)
if f.ptr {
*(f.value.(*[]string)) = newArray
} else {
f.value = newArray
}
default:
return fmt.Errorf("invalid subtype configured for array flag - %s", f.subkind.String())
}
return nil
}
// Set value into boolean type
func (f *Flag) setValueBoolean(val string) (err error) {
v, err := f.convertValue(val)
if err != nil {
return
}
for _, fn := range f.processors {
if v, err = fn(f, v); err != nil {
return
}
}
if f.ptr {
*(f.value.(*bool)) = v.(bool)
return
}
f.value = v
return
}
// Set value into float type
func (f *Flag) setValueFloat(val string) (err error) {
v, err := f.convertValue(val)
if err != nil {
return
}
for _, fn := range f.processors {
if v, err = fn(f, v); err != nil {
return
}
}
if f.ptr {
*(f.value.(*float64)) = v.(float64)
return
}
f.value = v
return
}
// Set value into integer type
func (f *Flag) setValueInteger(val string) (err error) {
v, err := f.convertValue(val)
if err != nil {
return
}
for _, fn := range f.processors {
if v, err = fn(f, v); err != nil {
return
}
}
if f.ptr {
*(f.value.(*int64)) = v.(int64)
return
}
f.value = v
return
}
// Set value into string type
func (f *Flag) setValueString(val string) (err error) {
v, err := f.convertValue(val)
if err != nil {
return
}
for _, fn := range f.processors {
if v, err = fn(f, v); err != nil {
return
}
}
if f.ptr {
*(f.value.(*string)) = v.(string)
return
}
f.value = v
return
}
// Set value on increment type
func (f *Flag) setValueIncrement(val string) (err error) {
if f.ptr {
*(f.value.(*int64)) = *(f.value.(*int64)) + 1
return
}
f.value = interface{}(f.value.(int64) + 1)
return
}
// Convert given value to expected type
func (f *Flag) convertValue(v string) (interface{}, error) {
switch f.kind {
case ArrayType, MapType:
return f.doConvert(v, f.subkind)
case IncrementType:
return 1, nil
default:
return f.doConvert(v, f.kind)
}
}
// Actually do the conversion based on type
func (f *Flag) doConvert(v string, t Type) (interface{}, error) {
switch t {
case BooleanType:
b, err := strconv.ParseBool(v)
if err != nil {
return nil, err
}
return b, nil
case FloatType:
pf, err := strconv.ParseFloat(v, 64)
if err != nil {
return nil, err
}
return pf, nil
case IntegerType:
pi, err := strconv.ParseInt(v, 10, 64)
if err != nil {
return nil, err
}
return pi, nil
case StringType:
// Original values are strings, so just return the value
return v, nil
default:
return nil, fmt.Errorf("invalid type for conversion - %s", f.kind.String())
}
}
// Check that the value given is the type expected by the flag. This
// will panic on unexpected type.
func (f *Flag) typeCheck(v interface{}) {
switch f.kind {
case ArrayType:
switch f.subkind {
case BooleanType:
if _, ok := v.([]bool); !ok {
panic(fmt.Sprintf("invalid variable type - expected: []bool received: %T", v))
}
case FloatType:
if _, ok := v.([]float64); !ok {
panic(fmt.Sprintf("invalid variable type - expected: []float64 received: %T", v))
}
case IntegerType:
if _, ok := v.([]int64); !ok {
panic(fmt.Sprintf("invalid variable type - expected: []int64 received: %T", v))
}
case StringType:
if _, ok := v.([]string); !ok {
panic(fmt.Sprintf("invalid variable type - expected: []string received: %T", v))
}
default:
panic("invalid subtype for array: " + f.subkind.String())
}
case BooleanType:
if _, ok := v.(bool); !ok {
panic(fmt.Sprintf("invalid variable type - expected: bool received: %T", v))
}
case FloatType:
if _, ok := v.(float64); !ok {
panic(fmt.Sprintf("invalid variable type - expected: float64 received: %T", v))
}
case IncrementType, IntegerType:
if _, ok := v.(int64); !ok {
panic(fmt.Sprintf("invalid variable type - expected: int64 received: %T", v))
}
case MapType:
switch f.subkind {
case BooleanType:
if _, ok := v.(map[string]bool); !ok {
panic(fmt.Sprintf("invalid variable type - expected: map[string]bool received: %T", v))
}
case FloatType:
if _, ok := v.(map[string]float64); !ok {
panic(fmt.Sprintf("invalid variable type - expected: map[string]float64 received: %T", v))
}
case IntegerType:
if _, ok := v.(map[string]int64); !ok {
panic(fmt.Sprintf("invalid variable type - expected: map[string]int64 received: %T", v))
}
case StringType:
if _, ok := v.(map[string]string); !ok {
panic(fmt.Sprintf("invalid variable type - expected: map[string]string received: %T", v))
}
default:
panic("invalid subtype for map: " + f.subkind.String())
}
case StringType:
if _, ok := v.(string); !ok {
panic(fmt.Sprintf("invalid variable type - expected: string received: %T", v))
}
}
}
// Check that the value given is a pointer to the type expected by the flag. This
// will panic on unexpected type.
func (f *Flag) ptrTypeCheck(v interface{}) {
switch f.kind {
case ArrayType:
switch f.subkind {
case BooleanType:
if c, ok := v.(*[]bool); !ok {
panic(fmt.Sprintf("invalid pointer variable - expected: *[]bool received: %T", v))
} else {
if *c == nil {
panic(fmt.Sprintf("array pointer value cannot be nil - %#v", c))
}
}
case FloatType:
if c, ok := v.(*[]float64); !ok {
panic(fmt.Sprintf("invalid pointer variable - expected: *[]float64 received: %T", v))
} else {
if *c == nil {
panic(fmt.Sprintf("array pointer value cannot be nil - %#v", c))
}
}
case IntegerType:
if c, ok := v.(*[]int64); !ok {
panic(fmt.Sprintf("invalid pointer variable - expected: *[]int64 received: %T", v))
} else {
if *c == nil {
panic(fmt.Sprintf("array pointer value cannot be nil - %#v", c))
}
}
case StringType:
if c, ok := v.(*[]string); !ok {
panic(fmt.Sprintf("invalid pointer variable - expected: *[]string received: %T", v))
} else {
if *c == nil {
panic(fmt.Sprintf("array pointer value cannot be nil - %#v", c))
}
}
default:
panic("invalid subtype for array: " + f.subkind.String())
}
case BooleanType:
if _, ok := v.(*bool); !ok {
panic(fmt.Sprintf("invalid pointer variable - expected *bool received %T", v))
}
case FloatType:
if _, ok := v.(*float64); !ok {
panic(fmt.Sprintf("invalid pointer variable - expected *float64 received %T", v))
}
case IncrementType, IntegerType:
if _, ok := v.(*int64); !ok {
panic(fmt.Sprintf("invalid pointer variable - expected *int64 received %T", v))
}
case MapType:
switch f.subkind {
case BooleanType:
if c, ok := v.(*map[string]bool); !ok {
panic(fmt.Sprintf("invalid pointer variable - expected: *map[string]bool received: %T", v))
} else {
if *c == nil {
panic(fmt.Sprintf("map pointer value cannot be nil - %#v", c))
}
}
case FloatType:
if c, ok := v.(*map[string]float64); !ok {
panic(fmt.Sprintf("invalid pointer variable - expected: *map[string]float64 received: %T", v))
} else {
if *c == nil {
panic(fmt.Sprintf("map pointer value cannot be nil - %#v", c))
}
}
case IntegerType:
if c, ok := v.(*map[string]int64); !ok {
panic(fmt.Sprintf("invalid pointer variable - expected: *map[string]int64 received: %T", v))
} else {
if *c == nil {
panic(fmt.Sprintf("map pointer value cannot be nil - %#v", c))
}
}
case StringType:
if c, ok := v.(*map[string]string); !ok {
panic(fmt.Sprintf("invalid pointer variable - expected: *map[string]string received: %T", v))
} else {
if *c == nil {
panic(fmt.Sprintf("map pointer value cannot be nil - %#v", c))
}
}
default:
panic("invalid subtype for array: " + f.subkind.String())
}
case StringType:
if _, ok := v.(*string); !ok {
panic(fmt.Sprintf("invalid pointer variable - expected *string received %T", v))
}
}
}
|