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