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 defines a RunFunc type, representing a process that can
   6 // be invoked from a command line.
   7 package cmd
   8
   9 import (
  10         "flag"
  11         "fmt"
  12         "io"
  13         "io/ioutil"
  14         "sort"
  15         "strings"
  16 )
  17
  18 // A RunFunc runs a command with the given args, and returns an exit
  19 // code.
  20 type RunFunc func(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int
  21
  22 // Multi returns a RunFunc that looks up its first argument in m, and
  23 // invokes the resulting RunFunc with the remaining args.
  24 //
  25 // Example:
  26 //
  27 //     os.Exit(Multi(map[string]RunFunc{
  28 //             "foobar": func(prog string, args []string) int {
  29 //                     fmt.Println(args[0])
  30 //                     return 2
  31 //             },
  32 //     })("/usr/bin/multi", []string{"foobar", "baz"}))
  33 //
  34 // ...prints "baz" and exits 2.
  35 func Multi(m map[string]RunFunc) RunFunc {
  36         return func(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  37                 if len(args) < 1 {
  38                         fmt.Fprintf(stderr, "usage: %s command [args]\n", prog)
  39                         multiUsage(stderr, m)
  40                         return 2
  41                 }
  42                 if cmd, ok := m[args[0]]; !ok {
  43                         fmt.Fprintf(stderr, "unrecognized command %q\n", args[0])
  44                         multiUsage(stderr, m)
  45                         return 2
  46                 } else {
  47                         return cmd(prog+" "+args[0], args[1:], stdin, stdout, stderr)
  48                 }
  49         }
  50 }
  51
  52 func multiUsage(stderr io.Writer, m map[string]RunFunc) {
  53         var subcommands []string
  54         for sc := range m {
  55                 if strings.HasPrefix(sc, "-") {
  56                         // Some subcommands have alternate versions
  57                         // like "--version" for compatibility. Don't
  58                         // clutter the subcommand summary with those.
  59                         continue
  60                 }
  61                 subcommands = append(subcommands, sc)
  62         }
  63         sort.Strings(subcommands)
  64         fmt.Fprintf(stderr, "\nAvailable commands:\n")
  65         for _, sc := range subcommands {
  66                 fmt.Fprintf(stderr, "    %s\n", sc)
  67         }
  68 }
  69
  70 type FlagSet interface {
  71         Init(string, flag.ErrorHandling)
  72         NArg() int
  73         Parse([]string) error
  74         SetOutput(io.Writer)
  75 }
  76
  77 // SubcommandToFront silently parses args using flagset, and returns a
  78 // copy of args with the first non-flag argument moved to the
  79 // front. If parsing fails or consumes all of args, args is returned
  80 // unchanged.
  81 //
  82 // SubcommandToFront invokes methods on flagset that have side
  83 // effects, including Parse. In typical usage, flagset will not used
  84 // for anything else after being passed to SubcommandToFront.
  85 func SubcommandToFront(args []string, flagset FlagSet) []string {
  86         flagset.Init("", flag.ContinueOnError)
  87         flagset.SetOutput(ioutil.Discard)
  88         if err := flagset.Parse(args); err != nil || flagset.NArg() == 0 {
  89                 // No subcommand found.
  90                 return args
  91         }
  92         // Move subcommand to the front.
  93         flagargs := len(args) - flagset.NArg()
  94         newargs := make([]string, len(args))
  95         newargs[0] = args[flagargs]
  96         copy(newargs[1:flagargs+1], args[:flagargs])
  97         copy(newargs[flagargs+1:], args[flagargs+1:])
  98         return newargs
  99 }