Pierre Habouzit | 4a59fd1 | 2007-10-15 01:35:37 +0200 | [diff] [blame] | 1 | #ifndef PARSE_OPTIONS_H |
| 2 | #define PARSE_OPTIONS_H |
| 3 | |
Heba Waly | 7db0305 | 2019-11-17 21:04:54 +0000 | [diff] [blame] | 4 | /** |
| 5 | * Refer to Documentation/technical/api-parse-options.txt for the API doc. |
| 6 | */ |
| 7 | |
Pierre Habouzit | 4a59fd1 | 2007-10-15 01:35:37 +0200 | [diff] [blame] | 8 | enum parse_opt_type { |
Pierre Habouzit | db7244b | 2007-11-07 11:20:27 +0100 | [diff] [blame] | 9 | /* special types */ |
Pierre Habouzit | 4a59fd1 | 2007-10-15 01:35:37 +0200 | [diff] [blame] | 10 | OPTION_END, |
Pierre Habouzit | 580d5bf | 2008-03-02 11:35:56 +0100 | [diff] [blame] | 11 | OPTION_ARGUMENT, |
Pierre Habouzit | d7a38c5 | 2007-10-15 01:38:30 +0200 | [diff] [blame] | 12 | OPTION_GROUP, |
René Scharfe | e0319ff | 2009-05-07 21:45:08 +0200 | [diff] [blame] | 13 | OPTION_NUMBER, |
Nguyễn Thái Ngọc Duy | 5c38742 | 2019-04-29 17:05:25 +0700 | [diff] [blame] | 14 | OPTION_ALIAS, |
Pierre Habouzit | db7244b | 2007-11-07 11:20:27 +0100 | [diff] [blame] | 15 | /* options with no arguments */ |
| 16 | OPTION_BIT, |
René Scharfe | 2f4b97f | 2009-05-07 21:44:17 +0200 | [diff] [blame] | 17 | OPTION_NEGBIT, |
Nguyễn Thái Ngọc Duy | f62470c | 2019-01-27 07:35:25 +0700 | [diff] [blame] | 18 | OPTION_BITOP, |
Junio C Hamano | b04ba2b | 2011-09-27 16:56:49 -0700 | [diff] [blame] | 19 | OPTION_COUNTUP, |
Pierre Habouzit | db7244b | 2007-11-07 11:20:27 +0100 | [diff] [blame] | 20 | OPTION_SET_INT, |
Pierre Habouzit | db7244b | 2007-11-07 11:20:27 +0100 | [diff] [blame] | 21 | /* options with arguments (usually) */ |
Pierre Habouzit | 4a59fd1 | 2007-10-15 01:35:37 +0200 | [diff] [blame] | 22 | OPTION_STRING, |
| 23 | OPTION_INTEGER, |
Charles Bailey | 2a514ed | 2015-06-21 19:25:44 +0100 | [diff] [blame] | 24 | OPTION_MAGNITUDE, |
Pierre Habouzit | ffe659f | 2007-10-15 01:45:45 +0200 | [diff] [blame] | 25 | OPTION_CALLBACK, |
Jonathan Nieder | b0b3a8b | 2010-12-01 17:32:16 -0600 | [diff] [blame] | 26 | OPTION_LOWLEVEL_CALLBACK, |
Stephen Boyd | df217ed | 2009-05-23 11:53:13 -0700 | [diff] [blame] | 27 | OPTION_FILENAME |
Pierre Habouzit | 4a59fd1 | 2007-10-15 01:35:37 +0200 | [diff] [blame] | 28 | }; |
| 29 | |
| 30 | enum parse_opt_flags { |
| 31 | PARSE_OPT_KEEP_DASHDASH = 1, |
Johannes Schindelin | a0ec9d2 | 2008-02-29 01:45:09 +0000 | [diff] [blame] | 32 | PARSE_OPT_STOP_AT_NON_OPTION = 2, |
Pierre Habouzit | a32a4ea | 2008-06-24 00:31:31 +0200 | [diff] [blame] | 33 | PARSE_OPT_KEEP_ARGV0 = 4, |
René Scharfe | b5ce3a5 | 2009-03-08 19:12:47 +0100 | [diff] [blame] | 34 | PARSE_OPT_KEEP_UNKNOWN = 8, |
Nguyễn Thái Ngọc Duy | 202fbb3 | 2019-01-27 07:35:23 +0700 | [diff] [blame] | 35 | PARSE_OPT_NO_INTERNAL_HELP = 16, |
| 36 | PARSE_OPT_ONE_SHOT = 32 |
Pierre Habouzit | 4a59fd1 | 2007-10-15 01:35:37 +0200 | [diff] [blame] | 37 | }; |
| 38 | |
Pierre Habouzit | ffe659f | 2007-10-15 01:45:45 +0200 | [diff] [blame] | 39 | enum parse_opt_option_flags { |
| 40 | PARSE_OPT_OPTARG = 1, |
Pierre Habouzit | f481e22 | 2007-10-16 00:32:38 +0200 | [diff] [blame] | 41 | PARSE_OPT_NOARG = 2, |
Pierre Habouzit | db7244b | 2007-11-07 11:20:27 +0100 | [diff] [blame] | 42 | PARSE_OPT_NONEG = 4, |
Pierre Habouzit | dd3bf0f | 2007-11-19 10:21:44 +0100 | [diff] [blame] | 43 | PARSE_OPT_HIDDEN = 8, |
Pierre Habouzit | 1cc6985 | 2008-07-08 12:34:08 +0200 | [diff] [blame] | 44 | PARSE_OPT_LASTARG_DEFAULT = 16, |
René Scharfe | 51a9949 | 2009-05-07 21:45:42 +0200 | [diff] [blame] | 45 | PARSE_OPT_NODASH = 32, |
Stephen Boyd | 29f25d4 | 2009-05-21 00:33:17 -0700 | [diff] [blame] | 46 | PARSE_OPT_LITERAL_ARGHELP = 64, |
Nguyễn Thái Ngọc Duy | b9d7f4b | 2018-02-09 18:01:40 +0700 | [diff] [blame] | 47 | PARSE_OPT_SHELL_EVAL = 256, |
Nguyễn Thái Ngọc Duy | ebc4a04 | 2018-02-09 18:02:12 +0700 | [diff] [blame] | 48 | PARSE_OPT_NOCOMPLETE = 512, |
Paolo Bonzini | bc8620b | 2020-02-20 15:15:16 +0100 | [diff] [blame] | 49 | PARSE_OPT_COMP_ARG = 1024, |
| 50 | PARSE_OPT_CMDMODE = 2048 |
Pierre Habouzit | ffe659f | 2007-10-15 01:45:45 +0200 | [diff] [blame] | 51 | }; |
| 52 | |
René Scharfe | 19800bd | 2019-08-20 20:49:07 +0200 | [diff] [blame] | 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 | |
Pierre Habouzit | ffe659f | 2007-10-15 01:45:45 +0200 | [diff] [blame] | 62 | struct option; |
| 63 | typedef int parse_opt_cb(const struct option *, const char *arg, int unset); |
| 64 | |
Jonathan Nieder | b0b3a8b | 2010-12-01 17:32:16 -0600 | [diff] [blame] | 65 | struct parse_opt_ctx_t; |
Nguyễn Thái Ngọc Duy | f41179f | 2019-01-27 07:35:27 +0700 | [diff] [blame] | 66 | typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx, |
Nguyễn Thái Ngọc Duy | 3ebbe28 | 2019-01-27 07:35:28 +0700 | [diff] [blame] | 67 | const struct option *opt, |
| 68 | const char *arg, int unset); |
Jonathan Nieder | b0b3a8b | 2010-12-01 17:32:16 -0600 | [diff] [blame] | 69 | |
Pierre Habouzit | 9b3beb5 | 2007-11-05 13:03:22 +0100 | [diff] [blame] | 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. Keep it |
Nguyễn Thái Ngọc Duy | 54e6dc7 | 2012-05-06 21:23:51 +0700 | [diff] [blame] | 86 | * homogeneous across the repository. Should be wrapped by N_() for |
| 87 | * translation. |
Pierre Habouzit | 9b3beb5 | 2007-11-05 13:03:22 +0100 | [diff] [blame] | 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. |
Nguyễn Thái Ngọc Duy | 54e6dc7 | 2012-05-06 21:23:51 +0700 | [diff] [blame] | 93 | * Should be wrapped by N_() for translation. |
Pierre Habouzit | 9b3beb5 | 2007-11-05 13:03:22 +0100 | [diff] [blame] | 94 | * |
| 95 | * `flags`:: |
| 96 | * mask of parse_opt_option_flags. |
Mike Ralphson | 3ea3c21 | 2009-04-17 19:13:30 +0100 | [diff] [blame] | 97 | * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs) |
Jonathan Nieder | ef45e4d | 2010-08-22 21:56:38 +0530 | [diff] [blame] | 98 | * PARSE_OPT_NOARG: says that this option does not take an argument |
Pierre Habouzit | db7244b | 2007-11-07 11:20:27 +0100 | [diff] [blame] | 99 | * PARSE_OPT_NONEG: says that this option cannot be negated |
René Scharfe | 51a9949 | 2009-05-07 21:45:42 +0200 | [diff] [blame] | 100 | * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and |
| 101 | * shown only in the full usage. |
Stephen Boyd | e169b97 | 2009-06-07 16:39:15 -0700 | [diff] [blame] | 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. |
René Scharfe | 51a9949 | 2009-05-07 21:45:42 +0200 | [diff] [blame] | 107 | * PARSE_OPT_NODASH: this option doesn't start with a dash. |
Stephen Boyd | 29f25d4 | 2009-05-21 00:33:17 -0700 | [diff] [blame] | 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. |
Nguyễn Thái Ngọc Duy | b9d7f4b | 2018-02-09 18:01:40 +0700 | [diff] [blame] | 111 | * PARSE_OPT_NOCOMPLETE: by default all visible options are completable |
| 112 | * by git-completion.bash. This option suppresses that. |
Nguyễn Thái Ngọc Duy | ebc4a04 | 2018-02-09 18:02:12 +0700 | [diff] [blame] | 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. |
Pierre Habouzit | 9b3beb5 | 2007-11-05 13:03:22 +0100 | [diff] [blame] | 116 | * |
| 117 | * `callback`:: |
Nguyễn Thái Ngọc Duy | bf3ff33 | 2019-01-27 07:35:26 +0700 | [diff] [blame] | 118 | * pointer to the callback to use for OPTION_CALLBACK |
Pierre Habouzit | 9b3beb5 | 2007-11-05 13:03:22 +0100 | [diff] [blame] | 119 | * |
| 120 | * `defval`:: |
| 121 | * default value to fill (*->value) with for PARSE_OPT_OPTARG. |
Ivan Ukhov | d3c0811 | 2015-03-29 10:32:55 +0200 | [diff] [blame] | 122 | * OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met. |
Pierre Habouzit | 9b3beb5 | 2007-11-05 13:03:22 +0100 | [diff] [blame] | 123 | * CALLBACKS can use it like they want. |
Nguyễn Thái Ngọc Duy | bf3ff33 | 2019-01-27 07:35:26 +0700 | [diff] [blame] | 124 | * |
| 125 | * `ll_callback`:: |
| 126 | * pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK |
| 127 | * |
Pierre Habouzit | 9b3beb5 | 2007-11-05 13:03:22 +0100 | [diff] [blame] | 128 | */ |
Pierre Habouzit | 4a59fd1 | 2007-10-15 01:35:37 +0200 | [diff] [blame] | 129 | struct option { |
| 130 | enum parse_opt_type type; |
| 131 | int short_name; |
| 132 | const char *long_name; |
| 133 | void *value; |
Pierre Habouzit | d7a38c5 | 2007-10-15 01:38:30 +0200 | [diff] [blame] | 134 | const char *argh; |
| 135 | const char *help; |
Pierre Habouzit | ffe659f | 2007-10-15 01:45:45 +0200 | [diff] [blame] | 136 | |
| 137 | int flags; |
| 138 | parse_opt_cb *callback; |
Pierre Habouzit | ffe659f | 2007-10-15 01:45:45 +0200 | [diff] [blame] | 139 | intptr_t defval; |
Nguyễn Thái Ngọc Duy | bf3ff33 | 2019-01-27 07:35:26 +0700 | [diff] [blame] | 140 | parse_opt_ll_cb *ll_callback; |
Nguyễn Thái Ngọc Duy | f62470c | 2019-01-27 07:35:25 +0700 | [diff] [blame] | 141 | intptr_t extra; |
Pierre Habouzit | 4a59fd1 | 2007-10-15 01:35:37 +0200 | [diff] [blame] | 142 | }; |
| 143 | |
Nguyễn Thái Ngọc Duy | 2de3734 | 2018-02-09 18:01:41 +0700 | [diff] [blame] | 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) |
Nguyễn Thái Ngọc Duy | d473e2e | 2019-01-27 07:35:33 +0700 | [diff] [blame] | 151 | #define OPT_CALLBACK_F(s, l, v, a, h, f, cb) \ |
| 152 | { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), (cb) } |
Nguyễn Thái Ngọc Duy | 31fba9d | 2019-03-24 15:20:05 +0700 | [diff] [blame] | 153 | #define OPT_STRING_F(s, l, v, a, h, f) { OPTION_STRING, (s), (l), (v), (a), (h), (f) } |
Nguyễn Thái Ngọc Duy | 16ed6c9 | 2019-03-24 15:20:08 +0700 | [diff] [blame] | 154 | #define OPT_INTEGER_F(s, l, v, h, f) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h), (f) } |
Nguyễn Thái Ngọc Duy | 2de3734 | 2018-02-09 18:01:41 +0700 | [diff] [blame] | 155 | |
Pierre Habouzit | 4a59fd1 | 2007-10-15 01:35:37 +0200 | [diff] [blame] | 156 | #define OPT_END() { OPTION_END } |
Johannes Schindelin | 1a85b49 | 2019-03-14 04:25:04 -0700 | [diff] [blame] | 157 | #define OPT_ARGUMENT(l, v, h) { OPTION_ARGUMENT, 0, (l), (v), NULL, \ |
| 158 | (h), PARSE_OPT_NOARG, NULL, 1 } |
Pierre Habouzit | d7a38c5 | 2007-10-15 01:38:30 +0200 | [diff] [blame] | 159 | #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) } |
Nguyễn Thái Ngọc Duy | 2de3734 | 2018-02-09 18:01:41 +0700 | [diff] [blame] | 160 | #define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0) |
Nguyễn Thái Ngọc Duy | f62470c | 2019-01-27 07:35:25 +0700 | [diff] [blame] | 161 | #define OPT_BITOP(s, l, v, h, set, clear) { OPTION_BITOP, (s), (l), (v), NULL, (h), \ |
| 162 | PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, \ |
Nguyễn Thái Ngọc Duy | bf3ff33 | 2019-01-27 07:35:26 +0700 | [diff] [blame] | 163 | (set), NULL, (clear) } |
Stephen Boyd | 34aec9f | 2009-06-04 16:43:57 -0700 | [diff] [blame] | 164 | #define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \ |
| 165 | (h), PARSE_OPT_NOARG, NULL, (b) } |
Nguyễn Thái Ngọc Duy | 2de3734 | 2018-02-09 18:01:41 +0700 | [diff] [blame] | 166 | #define OPT_COUNTUP(s, l, v, h) OPT_COUNTUP_F(s, l, v, h, 0) |
| 167 | #define OPT_SET_INT(s, l, v, h, i) OPT_SET_INT_F(s, l, v, h, i, 0) |
| 168 | #define OPT_BOOL(s, l, v, h) OPT_BOOL_F(s, l, v, h, 0) |
Stefan Beller | 4741edd | 2013-08-03 13:51:18 +0200 | [diff] [blame] | 169 | #define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \ |
| 170 | (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1} |
Paolo Bonzini | bc8620b | 2020-02-20 15:15:16 +0100 | [diff] [blame] | 171 | #define OPT_CMDMODE(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, \ |
| 172 | (h), PARSE_OPT_CMDMODE|PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) } |
Nguyễn Thái Ngọc Duy | 16ed6c9 | 2019-03-24 15:20:08 +0700 | [diff] [blame] | 173 | #define OPT_INTEGER(s, l, v, h) OPT_INTEGER_F(s, l, v, h, 0) |
Charles Bailey | 2a514ed | 2015-06-21 19:25:44 +0100 | [diff] [blame] | 174 | #define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \ |
| 175 | N_("n"), (h), PARSE_OPT_NONEG } |
Nguyễn Thái Ngọc Duy | 31fba9d | 2019-03-24 15:20:05 +0700 | [diff] [blame] | 176 | #define OPT_STRING(s, l, v, a, h) OPT_STRING_F(s, l, v, a, h, 0) |
Jeff King | c8ba163 | 2011-06-09 11:55:23 -0400 | [diff] [blame] | 177 | #define OPT_STRING_LIST(s, l, v, a, h) \ |
| 178 | { OPTION_CALLBACK, (s), (l), (v), (a), \ |
| 179 | (h), 0, &parse_opt_string_list } |
Nguyễn Thái Ngọc Duy | b475e44 | 2018-03-07 08:05:01 +0700 | [diff] [blame] | 180 | #define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \ |
| 181 | (h), PARSE_OPT_NOARG, &parse_opt_tertiary } |
Junio C Hamano | 27ec394 | 2013-04-25 11:13:49 -0700 | [diff] [blame] | 182 | #define OPT_EXPIRY_DATE(s, l, v, h) \ |
Junio C Hamano | e703d71 | 2014-03-23 15:58:12 -0700 | [diff] [blame] | 183 | { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \ |
Junio C Hamano | 27ec394 | 2013-04-25 11:13:49 -0700 | [diff] [blame] | 184 | parse_opt_expiry_date_cb } |
Nguyễn Thái Ngọc Duy | d473e2e | 2019-01-27 07:35:33 +0700 | [diff] [blame] | 185 | #define OPT_CALLBACK(s, l, v, a, h, f) OPT_CALLBACK_F(s, l, v, a, h, 0, f) |
René Scharfe | e0319ff | 2009-05-07 21:45:08 +0200 | [diff] [blame] | 186 | #define OPT_NUMBER_CALLBACK(v, h, f) \ |
| 187 | { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \ |
| 188 | PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) } |
Stephen Boyd | df217ed | 2009-05-23 11:53:13 -0700 | [diff] [blame] | 189 | #define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \ |
Nguyễn Thái Ngọc Duy | 54e6dc7 | 2012-05-06 21:23:51 +0700 | [diff] [blame] | 190 | N_("file"), (h) } |
Mark Lodato | 73e9da0 | 2010-02-16 23:55:58 -0500 | [diff] [blame] | 191 | #define OPT_COLOR_FLAG(s, l, v, h) \ |
Nguyễn Thái Ngọc Duy | 54e6dc7 | 2012-05-06 21:23:51 +0700 | [diff] [blame] | 192 | { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \ |
Mark Lodato | 73e9da0 | 2010-02-16 23:55:58 -0500 | [diff] [blame] | 193 | parse_opt_color_flag_cb, (intptr_t)"always" } |
| 194 | |
René Scharfe | 6acec03 | 2011-09-28 19:44:30 +0200 | [diff] [blame] | 195 | #define OPT_NOOP_NOARG(s, l) \ |
| 196 | { OPTION_CALLBACK, (s), (l), NULL, NULL, \ |
Nguyễn Thái Ngọc Duy | 54e6dc7 | 2012-05-06 21:23:51 +0700 | [diff] [blame] | 197 | N_("no-op (backward compatibility)"), \ |
René Scharfe | 6acec03 | 2011-09-28 19:44:30 +0200 | [diff] [blame] | 198 | PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb } |
| 199 | |
Nguyễn Thái Ngọc Duy | 5c38742 | 2019-04-29 17:05:25 +0700 | [diff] [blame] | 200 | #define OPT_ALIAS(s, l, source_long_name) \ |
| 201 | { OPTION_ALIAS, (s), (l), (source_long_name) } |
| 202 | |
Nguyễn Thái Ngọc Duy | 202fbb3 | 2019-01-27 07:35:23 +0700 | [diff] [blame] | 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 | * |
Pierre Habouzit | 4a59fd1 | 2007-10-15 01:35:37 +0200 | [diff] [blame] | 210 | * Returns the number of arguments left in argv[]. |
Nguyễn Thái Ngọc Duy | 202fbb3 | 2019-01-27 07:35:23 +0700 | [diff] [blame] | 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. |
Pierre Habouzit | 4a59fd1 | 2007-10-15 01:35:37 +0200 | [diff] [blame] | 215 | */ |
Nguyễn Thái Ngọc Duy | 1987b0b | 2019-01-17 20:05:00 +0700 | [diff] [blame] | 216 | int parse_options(int argc, const char **argv, const char *prefix, |
| 217 | const struct option *options, |
| 218 | const char * const usagestr[], int flags); |
Pierre Habouzit | d7a38c5 | 2007-10-15 01:38:30 +0200 | [diff] [blame] | 219 | |
Nguyễn Thái Ngọc Duy | 1987b0b | 2019-01-17 20:05:00 +0700 | [diff] [blame] | 220 | NORETURN void usage_with_options(const char * const *usagestr, |
| 221 | const struct option *options); |
Pierre Habouzit | 4a59fd1 | 2007-10-15 01:35:37 +0200 | [diff] [blame] | 222 | |
Nguyễn Thái Ngọc Duy | 1987b0b | 2019-01-17 20:05:00 +0700 | [diff] [blame] | 223 | NORETURN void usage_msg_opt(const char *msg, |
| 224 | const char * const *usagestr, |
| 225 | const struct option *options); |
Christian Couder | 451bb21 | 2009-02-02 06:12:58 +0100 | [diff] [blame] | 226 | |
Nguyễn Thái Ngọc Duy | 1987b0b | 2019-01-17 20:05:00 +0700 | [diff] [blame] | 227 | int optbug(const struct option *opt, const char *reason); |
Nguyễn Thái Ngọc Duy | 9440b83 | 2018-11-10 06:16:11 +0100 | [diff] [blame] | 228 | const char *optname(const struct option *opt, int flags); |
Jeff King | a469a10 | 2012-12-15 12:42:10 -0500 | [diff] [blame] | 229 | |
Jeff King | 517fe80 | 2018-11-05 01:45:42 -0500 | [diff] [blame] | 230 | /* |
| 231 | * Use these assertions for callbacks that expect to be called with NONEG and |
| 232 | * NOARG respectively, and do not otherwise handle the "unset" and "arg" |
| 233 | * parameters. |
| 234 | */ |
| 235 | #define BUG_ON_OPT_NEG(unset) do { \ |
| 236 | if ((unset)) \ |
| 237 | BUG("option callback does not expect negation"); \ |
| 238 | } while (0) |
| 239 | #define BUG_ON_OPT_ARG(arg) do { \ |
| 240 | if ((arg)) \ |
| 241 | BUG("option callback does not expect an argument"); \ |
| 242 | } while (0) |
| 243 | |
Brandon Richardson | cbdeab9 | 2019-03-07 11:44:09 -0400 | [diff] [blame] | 244 | /* |
| 245 | * Similar to the assertions above, but checks that "arg" is always non-NULL. |
| 246 | * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both |
| 247 | * assertions in a single line. |
| 248 | */ |
| 249 | #define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \ |
| 250 | BUG_ON_OPT_NEG(unset); \ |
| 251 | if(!(arg)) \ |
| 252 | BUG("option callback expects an argument"); \ |
| 253 | } while(0) |
| 254 | |
Mike Ralphson | 3ea3c21 | 2009-04-17 19:13:30 +0100 | [diff] [blame] | 255 | /*----- incremental advanced APIs -----*/ |
Pierre Habouzit | 7e7bbcb | 2008-06-23 21:59:37 +0200 | [diff] [blame] | 256 | |
Pierre Habouzit | 26141b5 | 2008-06-23 22:55:11 +0200 | [diff] [blame] | 257 | /* |
| 258 | * It's okay for the caller to consume argv/argc in the usual way. |
| 259 | * Other fields of that structure are private to parse-options and should not |
| 260 | * be modified in any way. |
| 261 | */ |
Pierre Habouzit | 7e7bbcb | 2008-06-23 21:59:37 +0200 | [diff] [blame] | 262 | struct parse_opt_ctx_t { |
| 263 | const char **argv; |
| 264 | const char **out; |
René Scharfe | 5ad0d3d | 2015-11-17 11:25:38 +0100 | [diff] [blame] | 265 | int argc, cpidx, total; |
Pierre Habouzit | 7e7bbcb | 2008-06-23 21:59:37 +0200 | [diff] [blame] | 266 | const char *opt; |
| 267 | int flags; |
Stephen Boyd | 3778292 | 2009-05-23 11:53:12 -0700 | [diff] [blame] | 268 | const char *prefix; |
Nguyễn Thái Ngọc Duy | 5c38742 | 2019-04-29 17:05:25 +0700 | [diff] [blame] | 269 | const char **alias_groups; /* must be in groups of 3 elements! */ |
| 270 | struct option *updated_options; |
Pierre Habouzit | 7e7bbcb | 2008-06-23 21:59:37 +0200 | [diff] [blame] | 271 | }; |
| 272 | |
Nguyễn Thái Ngọc Duy | 1987b0b | 2019-01-17 20:05:00 +0700 | [diff] [blame] | 273 | void parse_options_start(struct parse_opt_ctx_t *ctx, |
| 274 | int argc, const char **argv, const char *prefix, |
| 275 | const struct option *options, int flags); |
Pierre Habouzit | 7e7bbcb | 2008-06-23 21:59:37 +0200 | [diff] [blame] | 276 | |
Nguyễn Thái Ngọc Duy | 1987b0b | 2019-01-17 20:05:00 +0700 | [diff] [blame] | 277 | int parse_options_step(struct parse_opt_ctx_t *ctx, |
| 278 | const struct option *options, |
| 279 | const char * const usagestr[]); |
Pierre Habouzit | ff43ec3 | 2008-06-23 22:38:58 +0200 | [diff] [blame] | 280 | |
Nguyễn Thái Ngọc Duy | 1987b0b | 2019-01-17 20:05:00 +0700 | [diff] [blame] | 281 | int parse_options_end(struct parse_opt_ctx_t *ctx); |
Pierre Habouzit | 7e7bbcb | 2008-06-23 21:59:37 +0200 | [diff] [blame] | 282 | |
Nguyễn Thái Ngọc Duy | 2087182 | 2019-03-29 17:39:04 +0700 | [diff] [blame] | 283 | struct option *parse_options_dup(const struct option *a); |
René Scharfe | c840785 | 2020-02-09 16:57:56 +0100 | [diff] [blame] | 284 | struct option *parse_options_concat(const struct option *a, const struct option *b); |
Pierre Habouzit | 7e7bbcb | 2008-06-23 21:59:37 +0200 | [diff] [blame] | 285 | |
Pierre Habouzit | 0ce865b | 2007-10-14 11:05:12 +0200 | [diff] [blame] | 286 | /*----- some often used options -----*/ |
Nguyễn Thái Ngọc Duy | 1987b0b | 2019-01-17 20:05:00 +0700 | [diff] [blame] | 287 | int parse_opt_abbrev_cb(const struct option *, const char *, int); |
| 288 | int parse_opt_expiry_date_cb(const struct option *, const char *, int); |
| 289 | int parse_opt_color_flag_cb(const struct option *, const char *, int); |
| 290 | int parse_opt_verbosity_cb(const struct option *, const char *, int); |
Phillip Wood | 3389853 | 2019-04-17 15:30:40 +0100 | [diff] [blame] | 291 | /* value is struct oid_array* */ |
Nguyễn Thái Ngọc Duy | 1987b0b | 2019-01-17 20:05:00 +0700 | [diff] [blame] | 292 | int parse_opt_object_name(const struct option *, const char *, int); |
Phillip Wood | 3389853 | 2019-04-17 15:30:40 +0100 | [diff] [blame] | 293 | /* value is struct object_id* */ |
| 294 | int parse_opt_object_id(const struct option *, const char *, int); |
Nguyễn Thái Ngọc Duy | 1987b0b | 2019-01-17 20:05:00 +0700 | [diff] [blame] | 295 | int parse_opt_commits(const struct option *, const char *, int); |
Phillip Wood | 7d3488e | 2019-04-17 15:30:39 +0100 | [diff] [blame] | 296 | int parse_opt_commit(const struct option *, const char *, int); |
Nguyễn Thái Ngọc Duy | 1987b0b | 2019-01-17 20:05:00 +0700 | [diff] [blame] | 297 | int parse_opt_tertiary(const struct option *, const char *, int); |
| 298 | int parse_opt_string_list(const struct option *, const char *, int); |
| 299 | int parse_opt_noop_cb(const struct option *, const char *, int); |
Johannes Schindelin | 567fce1 | 2019-05-13 15:43:17 -0700 | [diff] [blame] | 300 | enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx, |
| 301 | const struct option *, |
| 302 | const char *, int); |
Nguyễn Thái Ngọc Duy | 1987b0b | 2019-01-17 20:05:00 +0700 | [diff] [blame] | 303 | int parse_opt_passthru(const struct option *, const char *, int); |
| 304 | int parse_opt_passthru_argv(const struct option *, const char *, int); |
Pierre Habouzit | 0ce865b | 2007-10-14 11:05:12 +0200 | [diff] [blame] | 305 | |
Nguyễn Thái Ngọc Duy | 212c0a6 | 2013-12-07 12:02:53 +0700 | [diff] [blame] | 306 | #define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h)) |
| 307 | #define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h)) |
Tuncer Ayaz | 7f87aff | 2008-11-15 01:14:24 +0100 | [diff] [blame] | 308 | #define OPT__VERBOSITY(var) \ |
Nguyễn Thái Ngọc Duy | 54e6dc7 | 2012-05-06 21:23:51 +0700 | [diff] [blame] | 309 | { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \ |
Tuncer Ayaz | 7f87aff | 2008-11-15 01:14:24 +0100 | [diff] [blame] | 310 | PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \ |
Nguyễn Thái Ngọc Duy | 54e6dc7 | 2012-05-06 21:23:51 +0700 | [diff] [blame] | 311 | { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \ |
Tuncer Ayaz | 7f87aff | 2008-11-15 01:14:24 +0100 | [diff] [blame] | 312 | PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 } |
Nguyễn Thái Ngọc Duy | 212c0a6 | 2013-12-07 12:02:53 +0700 | [diff] [blame] | 313 | #define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h)) |
Nguyễn Thái Ngọc Duy | 1224781 | 2018-02-09 18:01:42 +0700 | [diff] [blame] | 314 | #define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f)) |
Pierre Habouzit | 0ce865b | 2007-10-14 11:05:12 +0200 | [diff] [blame] | 315 | #define OPT__ABBREV(var) \ |
Nguyễn Thái Ngọc Duy | 54e6dc7 | 2012-05-06 21:23:51 +0700 | [diff] [blame] | 316 | { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \ |
Junio C Hamano | 4279000 | 2020-08-13 18:07:12 -0700 | [diff] [blame] | 317 | N_("use <n> digits to display object names"), \ |
Pierre Habouzit | 0ce865b | 2007-10-14 11:05:12 +0200 | [diff] [blame] | 318 | PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 } |
Mark Lodato | 73e9da0 | 2010-02-16 23:55:58 -0500 | [diff] [blame] | 319 | #define OPT__COLOR(var, h) \ |
| 320 | OPT_COLOR_FLAG(0, "color", (var), (h)) |
Nguyễn Thái Ngọc Duy | 7e29b82 | 2012-04-21 11:44:32 +0700 | [diff] [blame] | 321 | #define OPT_COLUMN(s, l, v, h) \ |
Nguyễn Thái Ngọc Duy | a054e04 | 2012-08-20 19:31:50 +0700 | [diff] [blame] | 322 | { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback } |
Paul Tan | 6b3ee18 | 2015-06-14 16:41:48 +0800 | [diff] [blame] | 323 | #define OPT_PASSTHRU(s, l, v, a, h, f) \ |
| 324 | { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru } |
Paul Tan | ffad85c | 2015-06-14 16:41:49 +0800 | [diff] [blame] | 325 | #define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \ |
| 326 | { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv } |
Karthik Nayak | f266c91 | 2015-07-07 21:36:15 +0530 | [diff] [blame] | 327 | #define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \ |
| 328 | { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \ |
| 329 | PARSE_OPT_LASTARG_DEFAULT | flag, \ |
| 330 | parse_opt_commits, (intptr_t) "HEAD" \ |
| 331 | } |
Ævar Arnfjörð Bjarmason | eab98ee | 2017-03-24 18:40:53 +0000 | [diff] [blame] | 332 | #define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG) |
Ævar Arnfjörð Bjarmason | ac3f5a3 | 2017-03-24 18:40:57 +0000 | [diff] [blame] | 333 | #define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG) |
Ævar Arnfjörð Bjarmason | eab98ee | 2017-03-24 18:40:53 +0000 | [diff] [blame] | 334 | #define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG) |
Ævar Arnfjörð Bjarmason | ac3f5a3 | 2017-03-24 18:40:57 +0000 | [diff] [blame] | 335 | #define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG) |
Denton Liu | ca04dc9 | 2019-04-17 11:23:26 +0100 | [diff] [blame] | 336 | #define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message")) |
Alexandr Miloslavskiy | add9770 | 2019-11-06 15:51:13 +0000 | [diff] [blame] | 337 | #define OPT_PATHSPEC_FROM_FILE(v) OPT_FILENAME(0, "pathspec-from-file", v, N_("read pathspec from file")) |
| 338 | #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")) |
Denton Liu | a03b555 | 2020-04-07 10:28:07 -0400 | [diff] [blame] | 339 | #define OPT_AUTOSTASH(v) OPT_BOOL(0, "autostash", v, N_("automatically stash/stash pop before and after")) |
Pierre Habouzit | 0ce865b | 2007-10-14 11:05:12 +0200 | [diff] [blame] | 340 | |
Pierre Habouzit | 4a59fd1 | 2007-10-15 01:35:37 +0200 | [diff] [blame] | 341 | #endif |