parse-options.h

   1 #ifndef PARSE_OPTIONS_H
   2 #define PARSE_OPTIONS_H
   3
   4 /**
   5  * Refer to Documentation/technical/api-parse-options.txt for the API doc.
   6  */
   7
   8 enum parse_opt_type {
   9         /* special types */
  10         OPTION_END,
  11         OPTION_GROUP,
  12         OPTION_NUMBER,
  13         OPTION_ALIAS,
  14         OPTION_SUBCOMMAND,
  15         /* options with no arguments */
  16         OPTION_BIT,
  17         OPTION_NEGBIT,
  18         OPTION_BITOP,
  19         OPTION_COUNTUP,
  20         OPTION_SET_INT,
  21         /* options with arguments (usually) */
  22         OPTION_STRING,
  23         OPTION_INTEGER,
  24         OPTION_MAGNITUDE,
  25         OPTION_CALLBACK,
  26         OPTION_LOWLEVEL_CALLBACK,
  27         OPTION_FILENAME
  28 };
  29
  30 enum parse_opt_flags {
  31         PARSE_OPT_KEEP_DASHDASH = 1 << 0,
  32         PARSE_OPT_STOP_AT_NON_OPTION = 1 << 1,
  33         PARSE_OPT_KEEP_ARGV0 = 1 << 2,
  34         PARSE_OPT_KEEP_UNKNOWN_OPT = 1 << 3,
  35         PARSE_OPT_NO_INTERNAL_HELP = 1 << 4,
  36         PARSE_OPT_ONE_SHOT = 1 << 5,
  37         PARSE_OPT_SHELL_EVAL = 1 << 6,
  38         PARSE_OPT_SUBCOMMAND_OPTIONAL = 1 << 7,
  39 };
  40
  41 enum parse_opt_option_flags {
  42         PARSE_OPT_OPTARG  = 1 << 0,
  43         PARSE_OPT_NOARG   = 1 << 1,
  44         PARSE_OPT_NONEG   = 1 << 2,
  45         PARSE_OPT_HIDDEN  = 1 << 3,
  46         PARSE_OPT_LASTARG_DEFAULT = 1 << 4,
  47         PARSE_OPT_NODASH = 1 << 5,
  48         PARSE_OPT_LITERAL_ARGHELP = 1 << 6,
  49         PARSE_OPT_FROM_ALIAS = 1 << 7,
  50         PARSE_OPT_NOCOMPLETE = 1 << 9,
  51         PARSE_OPT_COMP_ARG = 1 << 10,
  52         PARSE_OPT_CMDMODE = 1 << 11,
  53 };
  54
  55 enum parse_opt_result {
  56         PARSE_OPT_COMPLETE = -3,
  57         PARSE_OPT_HELP = -2,
  58         PARSE_OPT_ERROR = -1,   /* must be the same as error() */
  59         PARSE_OPT_DONE = 0,     /* fixed so that "return 0" works */
  60         PARSE_OPT_NON_OPTION,
  61         PARSE_OPT_SUBCOMMAND,
  62         PARSE_OPT_UNKNOWN
  63 };
  64
  65 struct option;
  66 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
  67
  68 struct parse_opt_ctx_t;
  69 typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
  70                                               const struct option *opt,
  71                                               const char *arg, int unset);
  72
  73 typedef int parse_opt_subcommand_fn(int argc, const char **argv,
  74                                     const char *prefix);
  75
  76 /*
  77  * `type`::
  78  *   holds the type of the option, you must have an OPTION_END last in your
  79  *   array.
  80  *
  81  * `short_name`::
  82  *   the character to use as a short option name, '\0' if none.
  83  *
  84  * `long_name`::
  85  *   the long option (without the leading dashes) or subcommand name,
  86  *   NULL if none.
  87  *
  88  * `value`::
  89  *   stores pointers to the values to be filled.
  90  *
  91  * `argh`::
  92  *   token to explain the kind of argument this option wants. Does not
  93  *   begin in capital letter, and does not end with a full stop.
  94  *   Should be wrapped by N_() for translation.
  95  *   Is automatically enclosed in brackets when printed, unless it
  96  *   contains any of the following characters: ()<>[]|
  97  *   E.g. "name" is shown as "<name>" to indicate that a name value
  98  *   needs to be supplied, not the literal string "name", but
  99  *   "<start>,<end>" and "(this|that)" are printed verbatim.
 100  *
 101  * `help`::
 102  *   the short help associated to what the option does.
 103  *   Must never be NULL (except for OPTION_END and OPTION_SUBCOMMAND).
 104  *   OPTION_GROUP uses this pointer to store the group header.
 105  *   Should be wrapped by N_() for translation.
 106  *
 107  * `flags`::
 108  *   mask of parse_opt_option_flags.
 109  *   PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
 110  *   PARSE_OPT_NOARG: says that this option does not take an argument
 111  *   PARSE_OPT_NONEG: says that this option cannot be negated
 112  *   PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
 113  *                     shown only in the full usage.
 114  *   PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
 115  *                              value if no argument is given when the option
 116  *                              is last on the command line. If the option is
 117  *                              not last it will require an argument.
 118  *                              Should not be used with PARSE_OPT_OPTARG.
 119  *   PARSE_OPT_NODASH: this option doesn't start with a dash; can only be a
 120  *                     short option and can't accept arguments.
 121  *   PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
 122  *                              (i.e. '<argh>') in the help message.
 123  *                              Useful for options with multiple parameters.
 124  *   PARSE_OPT_NOCOMPLETE: by default all visible options are completable
 125  *                         by git-completion.bash. This option suppresses that.
 126  *   PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
 127  *                       complete an option as --name= not --name even if
 128  *                       the option takes optional argument.
 129  *
 130  * `callback`::
 131  *   pointer to the callback to use for OPTION_CALLBACK
 132  *
 133  * `defval`::
 134  *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
 135  *   OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
 136  *   CALLBACKS can use it like they want.
 137  *
 138  * `ll_callback`::
 139  *   pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
 140  *
 141  * `subcommand_fn`::
 142  *   pointer to a function to use for OPTION_SUBCOMMAND.
 143  *   It will be put in value when the subcommand is given on the command line.
 144  */
 145 struct option {
 146         enum parse_opt_type type;
 147         int short_name;
 148         const char *long_name;
 149         void *value;
 150         const char *argh;
 151         const char *help;
 152
 153         enum parse_opt_option_flags flags;
 154         parse_opt_cb *callback;
 155         intptr_t defval;
 156         parse_opt_ll_cb *ll_callback;
 157         intptr_t extra;
 158         parse_opt_subcommand_fn *subcommand_fn;
 159 };
 160
 161 #define OPT_BIT_F(s, l, v, h, b, f) { OPTION_BIT, (s), (l), (v), NULL, (h), \
 162                                       PARSE_OPT_NOARG|(f), NULL, (b) }
 163 #define OPT_COUNTUP_F(s, l, v, h, f) { OPTION_COUNTUP, (s), (l), (v), NULL, \
 164                                        (h), PARSE_OPT_NOARG|(f) }
 165 #define OPT_SET_INT_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
 166                                           (h), PARSE_OPT_NOARG | (f), NULL, (i) }
 167 #define OPT_BOOL_F(s, l, v, h, f)   OPT_SET_INT_F(s, l, v, h, 1, f)
 168 #define OPT_CALLBACK_F(s, l, v, a, h, f, cb)                    \
 169         { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), (cb) }
 170 #define OPT_STRING_F(s, l, v, a, h, f)   { OPTION_STRING,  (s), (l), (v), (a), (h), (f) }
 171 #define OPT_INTEGER_F(s, l, v, h, f)     { OPTION_INTEGER, (s), (l), (v), N_("n"), (h), (f) }
 172
 173 #define OPT_END()                   { OPTION_END }
 174 #define OPT_GROUP(h)                { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
 175 #define OPT_BIT(s, l, v, h, b)      OPT_BIT_F(s, l, v, h, b, 0)
 176 #define OPT_BITOP(s, l, v, h, set, clear) { OPTION_BITOP, (s), (l), (v), NULL, (h), \
 177                                             PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, \
 178                                             (set), NULL, (clear) }
 179 #define OPT_NEGBIT(s, l, v, h, b)   { OPTION_NEGBIT, (s), (l), (v), NULL, \
 180                                       (h), PARSE_OPT_NOARG, NULL, (b) }
 181 #define OPT_COUNTUP(s, l, v, h)     OPT_COUNTUP_F(s, l, v, h, 0)
 182 #define OPT_SET_INT(s, l, v, h, i)  OPT_SET_INT_F(s, l, v, h, i, 0)
 183 #define OPT_BOOL(s, l, v, h)        OPT_BOOL_F(s, l, v, h, 0)
 184 #define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
 185                                       (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
 186 #define OPT_CMDMODE_F(s, l, v, h, i, f)  { OPTION_SET_INT, (s), (l), (v), NULL, \
 187                                       (h), PARSE_OPT_CMDMODE|PARSE_OPT_NOARG|PARSE_OPT_NONEG | (f), NULL, (i) }
 188 #define OPT_CMDMODE(s, l, v, h, i)  OPT_CMDMODE_F(s, l, v, h, i, 0)
 189
 190 #define OPT_INTEGER(s, l, v, h)     OPT_INTEGER_F(s, l, v, h, 0)
 191 #define OPT_MAGNITUDE(s, l, v, h)   { OPTION_MAGNITUDE, (s), (l), (v), \
 192                                       N_("n"), (h), PARSE_OPT_NONEG }
 193 #define OPT_STRING(s, l, v, a, h)   OPT_STRING_F(s, l, v, a, h, 0)
 194 #define OPT_STRING_LIST(s, l, v, a, h) \
 195                                     { OPTION_CALLBACK, (s), (l), (v), (a), \
 196                                       (h), 0, &parse_opt_string_list }
 197 #define OPT_UYN(s, l, v, h)         { OPTION_CALLBACK, (s), (l), (v), NULL, \
 198                                       (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
 199 #define OPT_EXPIRY_DATE(s, l, v, h) \
 200         { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0,     \
 201           parse_opt_expiry_date_cb }
 202 #define OPT_CALLBACK(s, l, v, a, h, f) OPT_CALLBACK_F(s, l, v, a, h, 0, f)
 203 #define OPT_NUMBER_CALLBACK(v, h, f) \
 204         { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
 205           PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
 206 #define OPT_FILENAME(s, l, v, h)    { OPTION_FILENAME, (s), (l), (v), \
 207                                        N_("file"), (h) }
 208 #define OPT_COLOR_FLAG(s, l, v, h) \
 209         { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
 210                 parse_opt_color_flag_cb, (intptr_t)"always" }
 211
 212 #define OPT_NOOP_NOARG(s, l) \
 213         { OPTION_CALLBACK, (s), (l), NULL, NULL, \
 214           N_("no-op (backward compatibility)"),         \
 215           PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
 216
 217 #define OPT_ALIAS(s, l, source_long_name) \
 218         { OPTION_ALIAS, (s), (l), (source_long_name) }
 219
 220 #define OPT_SUBCOMMAND_F(l, v, fn, f) { \
 221         .type = OPTION_SUBCOMMAND, \
 222         .long_name = (l), \
 223         .value = (v), \
 224         .flags = (f), \
 225         .subcommand_fn = (fn) }
 226 #define OPT_SUBCOMMAND(l, v, fn)    OPT_SUBCOMMAND_F((l), (v), (fn), 0)
 227
 228 /*
 229  * parse_options() will filter out the processed options and leave the
 230  * non-option arguments in argv[]. argv0 is assumed program name and
 231  * skipped.
 232  *
 233  * usagestr strings should be marked for translation with N_().
 234  *
 235  * Returns the number of arguments left in argv[].
 236  *
 237  * In one-shot mode, argv0 is not a program name, argv[] is left
 238  * untouched and parse_options() returns the number of options
 239  * processed.
 240  */
 241 int parse_options(int argc, const char **argv, const char *prefix,
 242                   const struct option *options,
 243                   const char * const usagestr[],
 244                   enum parse_opt_flags flags);
 245
 246 NORETURN void usage_with_options(const char * const *usagestr,
 247                                  const struct option *options);
 248
 249 NORETURN void usage_msg_opt(const char *msg,
 250                             const char * const *usagestr,
 251                             const struct option *options);
 252
 253 /**
 254  * usage_msg_optf() is like usage_msg_opt() except that the first
 255  * argument is a format string, and optional format arguments follow
 256  * after the 3rd option.
 257  */
 258 __attribute__((format (printf,1,4)))
 259 void NORETURN usage_msg_optf(const char *fmt,
 260                              const char * const *usagestr,
 261                              const struct option *options, ...);
 262
 263 void die_for_incompatible_opt4(int opt1, const char *opt1_name,
 264                                int opt2, const char *opt2_name,
 265                                int opt3, const char *opt3_name,
 266                                int opt4, const char *opt4_name);
 267
 268
 269 static inline void die_for_incompatible_opt3(int opt1, const char *opt1_name,
 270                                              int opt2, const char *opt2_name,
 271                                              int opt3, const char *opt3_name)
 272 {
 273         die_for_incompatible_opt4(opt1, opt1_name,
 274                                   opt2, opt2_name,
 275                                   opt3, opt3_name,
 276                                   0, "");
 277 }
 278
 279 /*
 280  * Use these assertions for callbacks that expect to be called with NONEG and
 281  * NOARG respectively, and do not otherwise handle the "unset" and "arg"
 282  * parameters.
 283  */
 284 #define BUG_ON_OPT_NEG(unset) do { \
 285         if ((unset)) \
 286                 BUG("option callback does not expect negation"); \
 287 } while (0)
 288 #define BUG_ON_OPT_ARG(arg) do { \
 289         if ((arg)) \
 290                 BUG("option callback does not expect an argument"); \
 291 } while (0)
 292
 293 /*
 294  * Similar to the assertions above, but checks that "arg" is always non-NULL.
 295  * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both
 296  * assertions in a single line.
 297  */
 298 #define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \
 299         BUG_ON_OPT_NEG(unset); \
 300         if(!(arg)) \
 301                 BUG("option callback expects an argument"); \
 302 } while(0)
 303
 304 /*----- incremental advanced APIs -----*/
 305
 306 /*
 307  * It's okay for the caller to consume argv/argc in the usual way.
 308  * Other fields of that structure are private to parse-options and should not
 309  * be modified in any way.
 310  */
 311 struct parse_opt_ctx_t {
 312         const char **argv;
 313         const char **out;
 314         int argc, cpidx, total;
 315         const char *opt;
 316         enum parse_opt_flags flags;
 317         unsigned has_subcommands;
 318         const char *prefix;
 319         const char **alias_groups; /* must be in groups of 3 elements! */
 320         struct option *updated_options;
 321 };
 322
 323 void parse_options_start(struct parse_opt_ctx_t *ctx,
 324                          int argc, const char **argv, const char *prefix,
 325                          const struct option *options,
 326                          enum parse_opt_flags flags);
 327
 328 enum parse_opt_result parse_options_step(struct parse_opt_ctx_t *ctx,
 329                                          const struct option *options,
 330                                          const char * const usagestr[]);
 331
 332 int parse_options_end(struct parse_opt_ctx_t *ctx);
 333
 334 struct option *parse_options_dup(const struct option *a);
 335 struct option *parse_options_concat(const struct option *a, const struct option *b);
 336
 337 /*----- some often used options -----*/
 338 int parse_opt_abbrev_cb(const struct option *, const char *, int);
 339 int parse_opt_expiry_date_cb(const struct option *, const char *, int);
 340 int parse_opt_color_flag_cb(const struct option *, const char *, int);
 341 int parse_opt_verbosity_cb(const struct option *, const char *, int);
 342 /* value is struct oid_array* */
 343 int parse_opt_object_name(const struct option *, const char *, int);
 344 /* value is struct object_id* */
 345 int parse_opt_object_id(const struct option *, const char *, int);
 346 int parse_opt_commits(const struct option *, const char *, int);
 347 int parse_opt_commit(const struct option *, const char *, int);
 348 int parse_opt_tertiary(const struct option *, const char *, int);
 349 int parse_opt_string_list(const struct option *, const char *, int);
 350 int parse_opt_noop_cb(const struct option *, const char *, int);
 351 enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx,
 352                                            const struct option *,
 353                                            const char *, int);
 354 int parse_opt_passthru(const struct option *, const char *, int);
 355 int parse_opt_passthru_argv(const struct option *, const char *, int);
 356 /* value is enum branch_track* */
 357 int parse_opt_tracking_mode(const struct option *, const char *, int);
 358
 359 #define OPT__VERBOSE(var, h)  OPT_COUNTUP('v', "verbose", (var), (h))
 360 #define OPT__QUIET(var, h)    OPT_COUNTUP('q', "quiet",   (var), (h))
 361 #define OPT__VERBOSITY(var) \
 362         { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
 363           PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
 364         { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
 365           PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
 366 #define OPT__DRY_RUN(var, h)  OPT_BOOL('n', "dry-run", (var), (h))
 367 #define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force",   (var), (h), (f))
 368 #define OPT__ABBREV(var)  \
 369         { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
 370           N_("use <n> digits to display object names"), \
 371           PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
 372 #define OPT__COLOR(var, h) \
 373         OPT_COLOR_FLAG(0, "color", (var), (h))
 374 #define OPT_COLUMN(s, l, v, h) \
 375         { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
 376 #define OPT_PASSTHRU(s, l, v, a, h, f) \
 377         { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
 378 #define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
 379         { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
 380 #define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
 381         { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
 382           PARSE_OPT_LASTARG_DEFAULT | flag, \
 383           parse_opt_commits, (intptr_t) "HEAD" \
 384         }
 385 #define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
 386 #define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
 387 #define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
 388 #define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
 389 #define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message"))
 390 #define OPT_PATHSPEC_FROM_FILE(v) OPT_FILENAME(0, "pathspec-from-file", v, N_("read pathspec from file"))
 391 #define OPT_PATHSPEC_FILE_NUL(v)  OPT_BOOL(0, "pathspec-file-nul", v, N_("with --pathspec-from-file, pathspec elements are separated with NUL character"))
 392 #define OPT_AUTOSTASH(v) OPT_BOOL(0, "autostash", v, N_("automatically stash/stash pop before and after"))
 393
 394 #endif