lib/cmd/cmd.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: Apache-2.0
   4
   5 // package cmd helps define reusable functions that can be exposed as
   6 // [subcommands of] command line programs.
   7 package cmd
   8
   9 import (
  10         "flag"
  11         "fmt"
  12         "io"
  13         "io/ioutil"
  14         "path/filepath"
  15         "regexp"
  16         "runtime"
  17         "sort"
  18         "strings"
  19 )
  20
  21 type Handler interface {
  22         RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int
  23 }
  24
  25 type HandlerFunc func(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int
  26
  27 func (f HandlerFunc) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  28         return f(prog, args, stdin, stdout, stderr)
  29 }
  30
  31 type Version string
  32
  33 func (v Version) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  34         prog = regexp.MustCompile(` -*version$`).ReplaceAllLiteralString(prog, "")
  35         fmt.Fprintf(stdout, "%s %s (%s)\n", prog, v, runtime.Version())
  36         return 0
  37 }
  38
  39 // Multi is a Handler that looks up its first argument in a map, and
  40 // invokes the resulting Handler with the remaining args.
  41 //
  42 // Example:
  43 //
  44 //     os.Exit(Multi(map[string]Handler{
  45 //             "foobar": HandlerFunc(func(prog string, args []string) int {
  46 //                     fmt.Println(args[0])
  47 //                     return 2
  48 //             }),
  49 //     })("/usr/bin/multi", []string{"foobar", "baz"}))
  50 //
  51 // ...prints "baz" and exits 2.
  52 type Multi map[string]Handler
  53
  54 func (m Multi) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  55         if len(args) < 1 {
  56                 fmt.Fprintf(stderr, "usage: %s command [args]\n", prog)
  57                 m.Usage(stderr)
  58                 return 2
  59         }
  60         _, basename := filepath.Split(prog)
  61         if cmd, ok := m[basename]; ok {
  62                 return cmd.RunCommand(prog, args, stdin, stdout, stderr)
  63         } else if cmd, ok = m[args[0]]; ok {
  64                 return cmd.RunCommand(prog+" "+args[0], args[1:], stdin, stdout, stderr)
  65         } else {
  66                 fmt.Fprintf(stderr, "%s: unrecognized command %q\n", prog, args[0])
  67                 m.Usage(stderr)
  68                 return 2
  69         }
  70 }
  71
  72 func (m Multi) Usage(stderr io.Writer) {
  73         fmt.Fprintf(stderr, "\nAvailable commands:\n")
  74         m.listSubcommands(stderr, "")
  75 }
  76
  77 func (m Multi) listSubcommands(out io.Writer, prefix string) {
  78         var subcommands []string
  79         for sc := range m {
  80                 if strings.HasPrefix(sc, "-") {
  81                         // Some subcommands have alternate versions
  82                         // like "--version" for compatibility. Don't
  83                         // clutter the subcommand summary with those.
  84                         continue
  85                 }
  86                 subcommands = append(subcommands, sc)
  87         }
  88         sort.Strings(subcommands)
  89         for _, sc := range subcommands {
  90                 switch cmd := m[sc].(type) {
  91                 case Multi:
  92                         cmd.listSubcommands(out, prefix+sc+" ")
  93                 default:
  94                         fmt.Fprintf(out, "    %s%s\n", prefix, sc)
  95                 }
  96         }
  97 }
  98
  99 type FlagSet interface {
 100         Init(string, flag.ErrorHandling)
 101         Args() []string
 102         NArg() int
 103         Parse([]string) error
 104         SetOutput(io.Writer)
 105         PrintDefaults()
 106 }
 107
 108 // SubcommandToFront silently parses args using flagset, and returns a
 109 // copy of args with the first non-flag argument moved to the
 110 // front. If parsing fails or consumes all of args, args is returned
 111 // unchanged.
 112 //
 113 // SubcommandToFront invokes methods on flagset that have side
 114 // effects, including Parse. In typical usage, flagset will not used
 115 // for anything else after being passed to SubcommandToFront.
 116 func SubcommandToFront(args []string, flagset FlagSet) []string {
 117         flagset.Init("", flag.ContinueOnError)
 118         flagset.SetOutput(ioutil.Discard)
 119         if err := flagset.Parse(args); err != nil || flagset.NArg() == 0 {
 120                 // No subcommand found.
 121                 return args
 122         }
 123         // Move subcommand to the front.
 124         flagargs := len(args) - flagset.NArg()
 125         newargs := make([]string, len(args))
 126         newargs[0] = args[flagargs]
 127         copy(newargs[1:flagargs+1], args[:flagargs])
 128         copy(newargs[flagargs+1:], args[flagargs+1:])
 129         return newargs
 130 }