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