parse-options.h

   1 #ifndef PARSE_OPTIONS_H
   2 #define PARSE_OPTIONS_H
   3
   4 enum parse_opt_type {
   5         /* special types */
   6         OPTION_END,
   7         OPTION_ARGUMENT,
   8         OPTION_GROUP,
   9         OPTION_NUMBER,
  10         /* options with no arguments */
  11         OPTION_BIT,
  12         OPTION_NEGBIT,
  13         OPTION_BITOP,
  14         OPTION_COUNTUP,
  15         OPTION_SET_INT,
  16         OPTION_CMDMODE,
  17         /* options with arguments (usually) */
  18         OPTION_STRING,
  19         OPTION_INTEGER,
  20         OPTION_MAGNITUDE,
  21         OPTION_CALLBACK,
  22         OPTION_LOWLEVEL_CALLBACK,
  23         OPTION_FILENAME
  24 };
  25
  26 enum parse_opt_flags {
  27         PARSE_OPT_KEEP_DASHDASH = 1,
  28         PARSE_OPT_STOP_AT_NON_OPTION = 2,
  29         PARSE_OPT_KEEP_ARGV0 = 4,
  30         PARSE_OPT_KEEP_UNKNOWN = 8,
  31         PARSE_OPT_NO_INTERNAL_HELP = 16,
  32         PARSE_OPT_ONE_SHOT = 32
  33 };
  34
  35 enum parse_opt_option_flags {
  36         PARSE_OPT_OPTARG  = 1,
  37         PARSE_OPT_NOARG   = 2,
  38         PARSE_OPT_NONEG   = 4,
  39         PARSE_OPT_HIDDEN  = 8,
  40         PARSE_OPT_LASTARG_DEFAULT = 16,
  41         PARSE_OPT_NODASH = 32,
  42         PARSE_OPT_LITERAL_ARGHELP = 64,
  43         PARSE_OPT_SHELL_EVAL = 256,
  44         PARSE_OPT_NOCOMPLETE = 512,
  45         PARSE_OPT_COMP_ARG = 1024
  46 };
  47
  48 struct option;
  49 typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
  50
  51 struct parse_opt_ctx_t;
  52 typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
  53                                               const struct option *opt,
  54                                               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  *   homogeneous across the repository. Should be wrapped by N_() for
  73  *   translation.
  74  *
  75  * `help`::
  76  *   the short help associated to what the option does.
  77  *   Must never be NULL (except for OPTION_END).
  78  *   OPTION_GROUP uses this pointer to store the group header.
  79  *   Should be wrapped by N_() for translation.
  80  *
  81  * `flags`::
  82  *   mask of parse_opt_option_flags.
  83  *   PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
  84  *   PARSE_OPT_NOARG: says that this option does not take an argument
  85  *   PARSE_OPT_NONEG: says that this option cannot be negated
  86  *   PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
  87  *                     shown only in the full usage.
  88  *   PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
  89  *                              value if no argument is given when the option
  90  *                              is last on the command line. If the option is
  91  *                              not last it will require an argument.
  92  *                              Should not be used with PARSE_OPT_OPTARG.
  93  *   PARSE_OPT_NODASH: this option doesn't start with a dash.
  94  *   PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
  95  *                              (i.e. '<argh>') in the help message.
  96  *                              Useful for options with multiple parameters.
  97  *   PARSE_OPT_NOCOMPLETE: by default all visible options are completable
  98  *                         by git-completion.bash. This option suppresses that.
  99  *   PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
 100  *                       complete an option as --name= not --name even if
 101  *                       the option takes optional argument.
 102  *
 103  * `callback`::
 104  *   pointer to the callback to use for OPTION_CALLBACK
 105  *
 106  * `defval`::
 107  *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
 108  *   OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
 109  *   CALLBACKS can use it like they want.
 110  *
 111  * `ll_callback`::
 112  *   pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
 113  *
 114  */
 115 struct option {
 116         enum parse_opt_type type;
 117         int short_name;
 118         const char *long_name;
 119         void *value;
 120         const char *argh;
 121         const char *help;
 122
 123         int flags;
 124         parse_opt_cb *callback;
 125         intptr_t defval;
 126         parse_opt_ll_cb *ll_callback;
 127         intptr_t extra;
 128 };
 129
 130 #define OPT_BIT_F(s, l, v, h, b, f) { OPTION_BIT, (s), (l), (v), NULL, (h), \
 131                                       PARSE_OPT_NOARG|(f), NULL, (b) }
 132 #define OPT_COUNTUP_F(s, l, v, h, f) { OPTION_COUNTUP, (s), (l), (v), NULL, \
 133                                        (h), PARSE_OPT_NOARG|(f) }
 134 #define OPT_SET_INT_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
 135                                           (h), PARSE_OPT_NOARG | (f), NULL, (i) }
 136 #define OPT_BOOL_F(s, l, v, h, f)   OPT_SET_INT_F(s, l, v, h, 1, f)
 137 #define OPT_CALLBACK_F(s, l, v, a, h, f, cb)                    \
 138         { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), (cb) }
 139 #define OPT_STRING_F(s, l, v, a, h, f)   { OPTION_STRING,  (s), (l), (v), (a), (h), (f) }
 140 #define OPT_INTEGER_F(s, l, v, h, f)     { OPTION_INTEGER, (s), (l), (v), N_("n"), (h), (f) }
 141
 142 #define OPT_END()                   { OPTION_END }
 143 #define OPT_ARGUMENT(l, v, h)       { OPTION_ARGUMENT, 0, (l), (v), NULL, \
 144                                       (h), PARSE_OPT_NOARG, NULL, 1 }
 145 #define OPT_GROUP(h)                { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
 146 #define OPT_BIT(s, l, v, h, b)      OPT_BIT_F(s, l, v, h, b, 0)
 147 #define OPT_BITOP(s, l, v, h, set, clear) { OPTION_BITOP, (s), (l), (v), NULL, (h), \
 148                                             PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, \
 149                                             (set), NULL, (clear) }
 150 #define OPT_NEGBIT(s, l, v, h, b)   { OPTION_NEGBIT, (s), (l), (v), NULL, \
 151                                       (h), PARSE_OPT_NOARG, NULL, (b) }
 152 #define OPT_COUNTUP(s, l, v, h)     OPT_COUNTUP_F(s, l, v, h, 0)
 153 #define OPT_SET_INT(s, l, v, h, i)  OPT_SET_INT_F(s, l, v, h, i, 0)
 154 #define OPT_BOOL(s, l, v, h)        OPT_BOOL_F(s, l, v, h, 0)
 155 #define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
 156                                       (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
 157 #define OPT_CMDMODE(s, l, v, h, i)  { OPTION_CMDMODE, (s), (l), (v), NULL, \
 158                                       (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
 159 #define OPT_INTEGER(s, l, v, h)     OPT_INTEGER_F(s, l, v, h, 0)
 160 #define OPT_MAGNITUDE(s, l, v, h)   { OPTION_MAGNITUDE, (s), (l), (v), \
 161                                       N_("n"), (h), PARSE_OPT_NONEG }
 162 #define OPT_STRING(s, l, v, a, h)   OPT_STRING_F(s, l, v, a, h, 0)
 163 #define OPT_STRING_LIST(s, l, v, a, h) \
 164                                     { OPTION_CALLBACK, (s), (l), (v), (a), \
 165                                       (h), 0, &parse_opt_string_list }
 166 #define OPT_UYN(s, l, v, h)         { OPTION_CALLBACK, (s), (l), (v), NULL, \
 167                                       (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
 168 #define OPT_EXPIRY_DATE(s, l, v, h) \
 169         { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0,     \
 170           parse_opt_expiry_date_cb }
 171 #define OPT_CALLBACK(s, l, v, a, h, f) OPT_CALLBACK_F(s, l, v, a, h, 0, f)
 172 #define OPT_NUMBER_CALLBACK(v, h, f) \
 173         { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
 174           PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
 175 #define OPT_FILENAME(s, l, v, h)    { OPTION_FILENAME, (s), (l), (v), \
 176                                        N_("file"), (h) }
 177 #define OPT_COLOR_FLAG(s, l, v, h) \
 178         { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
 179                 parse_opt_color_flag_cb, (intptr_t)"always" }
 180
 181 #define OPT_NOOP_NOARG(s, l) \
 182         { OPTION_CALLBACK, (s), (l), NULL, NULL, \
 183           N_("no-op (backward compatibility)"),         \
 184           PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
 185
 186 /*
 187  * parse_options() will filter out the processed options and leave the
 188  * non-option arguments in argv[]. argv0 is assumed program name and
 189  * skipped.
 190  *
 191  * usagestr strings should be marked for translation with N_().
 192  *
 193  * Returns the number of arguments left in argv[].
 194  *
 195  * In one-shot mode, argv0 is not a program name, argv[] is left
 196  * untouched and parse_options() returns the number of options
 197  * processed.
 198  */
 199 int parse_options(int argc, const char **argv, const char *prefix,
 200                   const struct option *options,
 201                   const char * const usagestr[], int flags);
 202
 203 NORETURN void usage_with_options(const char * const *usagestr,
 204                                  const struct option *options);
 205
 206 NORETURN void usage_msg_opt(const char *msg,
 207                             const char * const *usagestr,
 208                             const struct option *options);
 209
 210 int optbug(const struct option *opt, const char *reason);
 211 const char *optname(const struct option *opt, int flags);
 212
 213 /*
 214  * Use these assertions for callbacks that expect to be called with NONEG and
 215  * NOARG respectively, and do not otherwise handle the "unset" and "arg"
 216  * parameters.
 217  */
 218 #define BUG_ON_OPT_NEG(unset) do { \
 219         if ((unset)) \
 220                 BUG("option callback does not expect negation"); \
 221 } while (0)
 222 #define BUG_ON_OPT_ARG(arg) do { \
 223         if ((arg)) \
 224                 BUG("option callback does not expect an argument"); \
 225 } while (0)
 226
 227 /*
 228  * Similar to the assertions above, but checks that "arg" is always non-NULL.
 229  * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both
 230  * assertions in a single line.
 231  */
 232 #define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \
 233         BUG_ON_OPT_NEG(unset); \
 234         if(!(arg)) \
 235                 BUG("option callback expects an argument"); \
 236 } while(0)
 237
 238 /*----- incremental advanced APIs -----*/
 239
 240 enum parse_opt_result {
 241         PARSE_OPT_COMPLETE = -3,
 242         PARSE_OPT_HELP = -2,
 243         PARSE_OPT_ERROR = -1,   /* must be the same as error() */
 244         PARSE_OPT_DONE = 0,     /* fixed so that "return 0" works */
 245         PARSE_OPT_NON_OPTION,
 246         PARSE_OPT_UNKNOWN
 247 };
 248
 249 /*
 250  * It's okay for the caller to consume argv/argc in the usual way.
 251  * Other fields of that structure are private to parse-options and should not
 252  * be modified in any way.
 253  */
 254 struct parse_opt_ctx_t {
 255         const char **argv;
 256         const char **out;
 257         int argc, cpidx, total;
 258         const char *opt;
 259         int flags;
 260         const char *prefix;
 261 };
 262
 263 void parse_options_start(struct parse_opt_ctx_t *ctx,
 264                          int argc, const char **argv, const char *prefix,
 265                          const struct option *options, int flags);
 266
 267 int parse_options_step(struct parse_opt_ctx_t *ctx,
 268                        const struct option *options,
 269                        const char * const usagestr[]);
 270
 271 int parse_options_end(struct parse_opt_ctx_t *ctx);
 272
 273 struct option *parse_options_concat(struct option *a, struct option *b);
 274
 275 /*----- some often used options -----*/
 276 int parse_opt_abbrev_cb(const struct option *, const char *, int);
 277 int parse_opt_expiry_date_cb(const struct option *, const char *, int);
 278 int parse_opt_color_flag_cb(const struct option *, const char *, int);
 279 int parse_opt_verbosity_cb(const struct option *, const char *, int);
 280 int parse_opt_object_name(const struct option *, const char *, int);
 281 int parse_opt_commits(const struct option *, const char *, int);
 282 int parse_opt_tertiary(const struct option *, const char *, int);
 283 int parse_opt_string_list(const struct option *, const char *, int);
 284 int parse_opt_noop_cb(const struct option *, const char *, int);
 285 int parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx, const struct option *, const char *, int);
 286 int parse_opt_passthru(const struct option *, const char *, int);
 287 int parse_opt_passthru_argv(const struct option *, const char *, int);
 288
 289 #define OPT__VERBOSE(var, h)  OPT_COUNTUP('v', "verbose", (var), (h))
 290 #define OPT__QUIET(var, h)    OPT_COUNTUP('q', "quiet",   (var), (h))
 291 #define OPT__VERBOSITY(var) \
 292         { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
 293           PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
 294         { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
 295           PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
 296 #define OPT__DRY_RUN(var, h)  OPT_BOOL('n', "dry-run", (var), (h))
 297 #define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force",   (var), (h), (f))
 298 #define OPT__ABBREV(var)  \
 299         { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
 300           N_("use <n> digits to display SHA-1s"),       \
 301           PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
 302 #define OPT__COLOR(var, h) \
 303         OPT_COLOR_FLAG(0, "color", (var), (h))
 304 #define OPT_COLUMN(s, l, v, h) \
 305         { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
 306 #define OPT_PASSTHRU(s, l, v, a, h, f) \
 307         { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
 308 #define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
 309         { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
 310 #define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
 311         { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
 312           PARSE_OPT_LASTARG_DEFAULT | flag, \
 313           parse_opt_commits, (intptr_t) "HEAD" \
 314         }
 315 #define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
 316 #define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
 317 #define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
 318 #define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
 319
 320 #endif