tools/lib/subcmd/parse-options.h

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