tools/lib/subcmd/parse-options.h

   1 #ifndef __SUBCMD_PARSE_OPTIONS_H
   2 #define __SUBCMD_PARSE_OPTIONS_H
   3
   4 #include <linux/kernel.h>
   5 #include <stdbool.h>
   6 #include <stdint.h>
   7
   8 #ifndef NORETURN
   9 #define NORETURN __attribute__((__noreturn__))
  10 #endif
  11
  12 enum parse_opt_type {
  13         /* special types */
  14         OPTION_END,
  15         OPTION_ARGUMENT,
  16         OPTION_GROUP,
  17         /* options with no arguments */
  18         OPTION_BIT,
  19         OPTION_BOOLEAN,
  20         OPTION_INCR,
  21         OPTION_SET_UINT,
  22         OPTION_SET_PTR,
  23         /* options with arguments (usually) */
  24         OPTION_STRING,
  25         OPTION_INTEGER,
  26         OPTION_LONG,
  27         OPTION_CALLBACK,
  28         OPTION_U64,
  29         OPTION_UINTEGER,
  30 };
  31
  32 enum parse_opt_flags {
  33         PARSE_OPT_KEEP_DASHDASH = 1,
  34         PARSE_OPT_STOP_AT_NON_OPTION = 2,
  35         PARSE_OPT_KEEP_ARGV0 = 4,
  36         PARSE_OPT_KEEP_UNKNOWN = 8,
  37         PARSE_OPT_NO_INTERNAL_HELP = 16,
  38 };
  39
  40 enum parse_opt_option_flags {
  41         PARSE_OPT_OPTARG  = 1,
  42         PARSE_OPT_NOARG   = 2,
  43         PARSE_OPT_NONEG   = 4,
  44         PARSE_OPT_HIDDEN  = 8,
  45         PARSE_OPT_LASTARG_DEFAULT = 16,
  46         PARSE_OPT_DISABLED = 32,
  47         PARSE_OPT_EXCLUSIVE = 64,
  48         PARSE_OPT_NOEMPTY  = 128,
  49         PARSE_OPT_NOBUILD  = 256,
  50         PARSE_OPT_CANSKIP  = 512,
  51 };
  52
  53 struct option;
  54 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
  55
  56 /*
  57  * `type`::
  58  *   holds the type of the option, you must have an OPTION_END last in your
  59  *   array.
  60  *
  61  * `short_name`::
  62  *   the character to use as a short option name, '\0' if none.
  63  *
  64  * `long_name`::
  65  *   the long option name, without the leading dashes, NULL if none.
  66  *
  67  * `value`::
  68  *   stores pointers to the values to be filled.
  69  *
  70  * `argh`::
  71  *   token to explain the kind of argument this option wants. Keep it
  72  *   homogenous across the repository.
  73  *
  74  * `help`::
  75  *   the short help associated to what the option does.
  76  *   Must never be NULL (except for OPTION_END).
  77  *   OPTION_GROUP uses this pointer to store the group header.
  78  *
  79  * `flags`::
  80  *   mask of parse_opt_option_flags.
  81  *   PARSE_OPT_OPTARG: says that the argument is optionnal (not for BOOLEANs)
  82  *   PARSE_OPT_NOARG: says that this option takes no argument, for CALLBACKs
  83  *   PARSE_OPT_NONEG: says that this option cannot be negated
  84  *   PARSE_OPT_HIDDEN this option is skipped in the default usage, showed in
  85  *                    the long one.
  86  *
  87  * `callback`::
  88  *   pointer to the callback to use for OPTION_CALLBACK.
  89  *
  90  * `defval`::
  91  *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
  92  *   OPTION_{BIT,SET_UINT,SET_PTR} store the {mask,integer,pointer} to put in
  93  *   the value when met.
  94  *   CALLBACKS can use it like they want.
  95  *
  96  * `set`::
  97  *   whether an option was set by the user
  98  */
  99 struct option {
 100         enum parse_opt_type type;
 101         int short_name;
 102         const char *long_name;
 103         void *value;
 104         const char *argh;
 105         const char *help;
 106         const char *build_opt;
 107
 108         int flags;
 109         parse_opt_cb *callback;
 110         intptr_t defval;
 111         bool *set;
 112         void *data;
 113         const struct option *parent;
 114 };
 115
 116 #define check_vtype(v, type) ( BUILD_BUG_ON_ZERO(!__builtin_types_compatible_p(typeof(v), type)) + v )
 117
 118 #define OPT_END()                   { .type = OPTION_END }
 119 #define OPT_PARENT(p)               { .type = OPTION_END, .parent = (p) }
 120 #define OPT_ARGUMENT(l, h)          { .type = OPTION_ARGUMENT, .long_name = (l), .help = (h) }
 121 #define OPT_GROUP(h)                { .type = OPTION_GROUP, .help = (h) }
 122 #define OPT_BIT(s, l, v, h, b)      { .type = OPTION_BIT, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h), .defval = (b) }
 123 #define OPT_BOOLEAN(s, l, v, h)     { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value = check_vtype(v, bool *), .help = (h) }
 124 #define OPT_BOOLEAN_FLAG(s, l, v, h, f)     { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value = check_vtype(v, bool *), .help = (h), .flags = (f) }
 125 #define OPT_BOOLEAN_SET(s, l, v, os, h) \
 126         { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), \
 127         .value = check_vtype(v, bool *), .help = (h), \
 128         .set = check_vtype(os, bool *)}
 129 #define OPT_INCR(s, l, v, h)        { .type = OPTION_INCR, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) }
 130 #define OPT_SET_UINT(s, l, v, h, i)  { .type = OPTION_SET_UINT, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned int *), .help = (h), .defval = (i) }
 131 #define OPT_SET_PTR(s, l, v, h, p)  { .type = OPTION_SET_PTR, .short_name = (s), .long_name = (l), .value = (v), .help = (h), .defval = (p) }
 132 #define OPT_INTEGER(s, l, v, h)     { .type = OPTION_INTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) }
 133 #define OPT_UINTEGER(s, l, v, h)    { .type = OPTION_UINTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned int *), .help = (h) }
 134 #define OPT_LONG(s, l, v, h)        { .type = OPTION_LONG, .short_name = (s), .long_name = (l), .value = check_vtype(v, long *), .help = (h) }
 135 #define OPT_U64(s, l, v, h)         { .type = OPTION_U64, .short_name = (s), .long_name = (l), .value = check_vtype(v, u64 *), .help = (h) }
 136 #define OPT_STRING(s, l, v, a, h)   { .type = OPTION_STRING,  .short_name = (s), .long_name = (l), .value = check_vtype(v, const char **), .argh = (a), .help = (h) }
 137 #define OPT_STRING_OPTARG(s, l, v, a, h, d) \
 138         { .type = OPTION_STRING,  .short_name = (s), .long_name = (l), \
 139           .value = check_vtype(v, const char **), .argh =(a), .help = (h), \
 140           .flags = PARSE_OPT_OPTARG, .defval = (intptr_t)(d) }
 141 #define OPT_STRING_OPTARG_SET(s, l, v, os, a, h, d) \
 142         { .type = OPTION_STRING, .short_name = (s), .long_name = (l), \
 143           .value = check_vtype(v, const char **), .argh = (a), .help = (h), \
 144           .flags = PARSE_OPT_OPTARG, .defval = (intptr_t)(d), \
 145           .set = check_vtype(os, bool *)}
 146 #define OPT_STRING_NOEMPTY(s, l, v, a, h)   { .type = OPTION_STRING,  .short_name = (s), .long_name = (l), .value = check_vtype(v, const char **), .argh = (a), .help = (h), .flags = PARSE_OPT_NOEMPTY}
 147 #define OPT_DATE(s, l, v, h) \
 148         { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = "time", .help = (h), .callback = parse_opt_approxidate_cb }
 149 #define OPT_CALLBACK(s, l, v, a, h, f) \
 150         { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f) }
 151 #define OPT_CALLBACK_NOOPT(s, l, v, a, h, f) \
 152         { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f), .flags = PARSE_OPT_NOARG }
 153 #define OPT_CALLBACK_DEFAULT(s, l, v, a, h, f, d) \
 154         { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f), .defval = (intptr_t)d, .flags = PARSE_OPT_LASTARG_DEFAULT }
 155 #define OPT_CALLBACK_DEFAULT_NOOPT(s, l, v, a, h, f, d) \
 156         { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l),\
 157         .value = (v), .arg = (a), .help = (h), .callback = (f), .defval = (intptr_t)d,\
 158         .flags = PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NOARG}
 159 #define OPT_CALLBACK_OPTARG(s, l, v, d, a, h, f) \
 160         { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), \
 161           .value = (v), .argh = (a), .help = (h), .callback = (f), \
 162           .flags = PARSE_OPT_OPTARG, .data = (d) }
 163
 164 /* parse_options() will filter out the processed options and leave the
 165  * non-option argments in argv[].
 166  * Returns the number of arguments left in argv[].
 167  *
 168  * NOTE: parse_options() and parse_options_subcommand() may call exit() in the
 169  * case of an error (or for 'special' options like --list-cmds or --list-opts).
 170  */
 171 extern int parse_options(int argc, const char **argv,
 172                          const struct option *options,
 173                          const char * const usagestr[], int flags);
 174
 175 extern int parse_options_subcommand(int argc, const char **argv,
 176                                 const struct option *options,
 177                                 const char *const subcommands[],
 178                                 const char *usagestr[], int flags);
 179
 180 extern NORETURN void usage_with_options(const char * const *usagestr,
 181                                         const struct option *options);
 182 extern NORETURN __attribute__((format(printf,3,4)))
 183 void usage_with_options_msg(const char * const *usagestr,
 184                             const struct option *options,
 185                             const char *fmt, ...);
 186
 187 /*----- incremantal advanced APIs -----*/
 188
 189 enum {
 190         PARSE_OPT_HELP = -1,
 191         PARSE_OPT_DONE,
 192         PARSE_OPT_LIST_OPTS,
 193         PARSE_OPT_LIST_SUBCMDS,
 194         PARSE_OPT_UNKNOWN,
 195 };
 196
 197 /*
 198  * It's okay for the caller to consume argv/argc in the usual way.
 199  * Other fields of that structure are private to parse-options and should not
 200  * be modified in any way.
 201  */
 202 struct parse_opt_ctx_t {
 203         const char **argv;
 204         const char **out;
 205         int argc, cpidx;
 206         const char *opt;
 207         const struct option *excl_opt;
 208         int flags;
 209 };
 210
 211 extern int parse_options_usage(const char * const *usagestr,
 212                                const struct option *opts,
 213                                const char *optstr,
 214                                bool short_opt);
 215
 216
 217 /*----- some often used options -----*/
 218 extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
 219 extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
 220 extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
 221
 222 #define OPT__VERBOSE(var)  OPT_BOOLEAN('v', "verbose", (var), "be verbose")
 223 #define OPT__QUIET(var)    OPT_BOOLEAN('q', "quiet",   (var), "be quiet")
 224 #define OPT__VERBOSITY(var) \
 225         { OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \
 226           PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
 227         { OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
 228           PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
 229 #define OPT__DRY_RUN(var)  OPT_BOOLEAN('n', "dry-run", (var), "dry run")
 230 #define OPT__ABBREV(var)  \
 231         { OPTION_CALLBACK, 0, "abbrev", (var), "n", \
 232           "use <n> digits to display SHA-1s", \
 233           PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
 234
 235 extern const char *parse_options_fix_filename(const char *prefix, const char *file);
 236
 237 void set_option_flag(struct option *opts, int sopt, const char *lopt, int flag);
 238 void set_option_nobuild(struct option *opts, int shortopt, const char *longopt,
 239                         const char *build_opt, bool can_skip);
 240
 241 #endif /* __SUBCMD_PARSE_OPTIONS_H */