repack: mark more strings for translation
[git/git.git] / parse-options.h
CommitLineData
4a59fd13
PH
1#ifndef PARSE_OPTIONS_H
2#define PARSE_OPTIONS_H
3
4enum parse_opt_type {
db7244bd 5 /* special types */
4a59fd13 6 OPTION_END,
580d5bff 7 OPTION_ARGUMENT,
d7a38c54 8 OPTION_GROUP,
e0319ff5 9 OPTION_NUMBER,
db7244bd
PH
10 /* options with no arguments */
11 OPTION_BIT,
2f4b97f9 12 OPTION_NEGBIT,
b04ba2bb 13 OPTION_COUNTUP,
db7244bd 14 OPTION_SET_INT,
11588263 15 OPTION_CMDMODE,
db7244bd 16 /* options with arguments (usually) */
4a59fd13
PH
17 OPTION_STRING,
18 OPTION_INTEGER,
2a514ed8 19 OPTION_MAGNITUDE,
ffe659f9 20 OPTION_CALLBACK,
b0b3a8b6 21 OPTION_LOWLEVEL_CALLBACK,
df217ed6 22 OPTION_FILENAME
4a59fd13
PH
23};
24
25enum parse_opt_flags {
26 PARSE_OPT_KEEP_DASHDASH = 1,
a0ec9d25 27 PARSE_OPT_STOP_AT_NON_OPTION = 2,
a32a4eaa 28 PARSE_OPT_KEEP_ARGV0 = 4,
b5ce3a54 29 PARSE_OPT_KEEP_UNKNOWN = 8,
4b05548f 30 PARSE_OPT_NO_INTERNAL_HELP = 16
4a59fd13
PH
31};
32
ffe659f9
PH
33enum parse_opt_option_flags {
34 PARSE_OPT_OPTARG = 1,
f481e22a 35 PARSE_OPT_NOARG = 2,
db7244bd 36 PARSE_OPT_NONEG = 4,
dd3bf0f4 37 PARSE_OPT_HIDDEN = 8,
1cc6985c 38 PARSE_OPT_LASTARG_DEFAULT = 16,
51a9949e 39 PARSE_OPT_NODASH = 32,
29f25d49 40 PARSE_OPT_LITERAL_ARGHELP = 64,
b9d7f4b4 41 PARSE_OPT_SHELL_EVAL = 256,
ebc4a04e
NTND
42 PARSE_OPT_NOCOMPLETE = 512,
43 PARSE_OPT_COMP_ARG = 1024
ffe659f9
PH
44};
45
46struct option;
47typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
48
b0b3a8b6
JN
49struct parse_opt_ctx_t;
50typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
51 const struct option *opt, int unset);
52
9b3beb58
PH
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
54e6dc7d
NTND
69 * homogeneous across the repository. Should be wrapped by N_() for
70 * translation.
9b3beb58
PH
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.
54e6dc7d 76 * Should be wrapped by N_() for translation.
9b3beb58
PH
77 *
78 * `flags`::
79 * mask of parse_opt_option_flags.
3ea3c215 80 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
ef45e4da 81 * PARSE_OPT_NOARG: says that this option does not take an argument
db7244bd 82 * PARSE_OPT_NONEG: says that this option cannot be negated
51a9949e
RS
83 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
84 * shown only in the full usage.
e169b974
SB
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.
51a9949e 90 * PARSE_OPT_NODASH: this option doesn't start with a dash.
29f25d49
SB
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.
b9d7f4b4
NTND
94 * PARSE_OPT_NOCOMPLETE: by default all visible options are completable
95 * by git-completion.bash. This option suppresses that.
ebc4a04e
NTND
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.
9b3beb58
PH
99 *
100 * `callback`::
b0b3a8b6
JN
101 * pointer to the callback to use for OPTION_CALLBACK or
102 * OPTION_LOWLEVEL_CALLBACK.
9b3beb58
PH
103 *
104 * `defval`::
105 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
d3c08114 106 * OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
9b3beb58
PH
107 * CALLBACKS can use it like they want.
108 */
4a59fd13
PH
109struct option {
110 enum parse_opt_type type;
111 int short_name;
112 const char *long_name;
113 void *value;
d7a38c54
PH
114 const char *argh;
115 const char *help;
ffe659f9
PH
116
117 int flags;
118 parse_opt_cb *callback;
ffe659f9 119 intptr_t defval;
4a59fd13
PH
120};
121
2de37349
NTND
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
4a59fd13 130#define OPT_END() { OPTION_END }
34aec9f5
SB
131#define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
132 (h), PARSE_OPT_NOARG}
d7a38c54 133#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
2de37349 134#define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0)
34aec9f5
SB
135#define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
136 (h), PARSE_OPT_NOARG, NULL, (b) }
2de37349
NTND
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)
4741edd5
SB
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}
14691e38 142#define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
11588263 143 (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
54e6dc7d 144#define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
2a514ed8
CB
145#define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \
146 N_("n"), (h), PARSE_OPT_NONEG }
d7a38c54 147#define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
c8ba1639
JK
148#define OPT_STRING_LIST(s, l, v, a, h) \
149 { OPTION_CALLBACK, (s), (l), (v), (a), \
150 (h), 0, &parse_opt_string_list }
b475e442
NTND
151#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
152 (h), PARSE_OPT_NOARG, &parse_opt_tertiary }
1f4a711a 153#define OPT_DATE(s, l, v, h) \
54e6dc7d 154 { OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0, \
1f4a711a 155 parse_opt_approxidate_cb }
27ec394a 156#define OPT_EXPIRY_DATE(s, l, v, h) \
e703d711 157 { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
27ec394a 158 parse_opt_expiry_date_cb }
ffe659f9
PH
159#define OPT_CALLBACK(s, l, v, a, h, f) \
160 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
e0319ff5
RS
161#define OPT_NUMBER_CALLBACK(v, h, f) \
162 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
163 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
df217ed6 164#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
54e6dc7d 165 N_("file"), (h) }
73e9da01 166#define OPT_COLOR_FLAG(s, l, v, h) \
54e6dc7d 167 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
73e9da01
ML
168 parse_opt_color_flag_cb, (intptr_t)"always" }
169
6acec038
RS
170#define OPT_NOOP_NOARG(s, l) \
171 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
54e6dc7d 172 N_("no-op (backward compatibility)"), \
6acec038
RS
173 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
174
4a59fd13 175/* parse_options() will filter out the processed options and leave the
54e6dc7d
NTND
176 * non-option arguments in argv[]. usagestr strings should be marked
177 * for translation with N_().
4a59fd13
PH
178 * Returns the number of arguments left in argv[].
179 */
37782920 180extern int parse_options(int argc, const char **argv, const char *prefix,
4a59fd13 181 const struct option *options,
d7a38c54
PH
182 const char * const usagestr[], int flags);
183
184extern NORETURN void usage_with_options(const char * const *usagestr,
185 const struct option *options);
4a59fd13 186
451bb210
CC
187extern NORETURN void usage_msg_opt(const char *msg,
188 const char * const *usagestr,
189 const struct option *options);
190
1f275b7c
DI
191extern int optbug(const struct option *opt, const char *reason);
192extern int opterror(const struct option *opt, const char *reason, int flags);
ff0a80af 193#if defined(__GNUC__)
87fe5df3 194#define opterror(o,r,f) (opterror((o),(r),(f)), const_error())
a469a101
JK
195#endif
196
3ea3c215 197/*----- incremental advanced APIs -----*/
7e7bbcb4 198
ee68b87a
PH
199enum {
200 PARSE_OPT_HELP = -1,
201 PARSE_OPT_DONE,
979240fe 202 PARSE_OPT_NON_OPTION,
3bb0923f 203 PARSE_OPT_ERROR,
4b05548f 204 PARSE_OPT_UNKNOWN
ee68b87a
PH
205};
206
26141b5b
PH
207/*
208 * It's okay for the caller to consume argv/argc in the usual way.
209 * Other fields of that structure are private to parse-options and should not
210 * be modified in any way.
211 */
7e7bbcb4
PH
212struct parse_opt_ctx_t {
213 const char **argv;
214 const char **out;
5ad0d3d5 215 int argc, cpidx, total;
7e7bbcb4
PH
216 const char *opt;
217 int flags;
37782920 218 const char *prefix;
7e7bbcb4
PH
219};
220
221extern void parse_options_start(struct parse_opt_ctx_t *ctx,
37782920 222 int argc, const char **argv, const char *prefix,
9ca1169f 223 const struct option *options, int flags);
7e7bbcb4 224
ff43ec3e
PH
225extern int parse_options_step(struct parse_opt_ctx_t *ctx,
226 const struct option *options,
227 const char * const usagestr[]);
228
7e7bbcb4
PH
229extern int parse_options_end(struct parse_opt_ctx_t *ctx);
230
023ff39b 231extern struct option *parse_options_concat(struct option *a, struct option *b);
7e7bbcb4 232
0ce865b1
PH
233/*----- some often used options -----*/
234extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
1f4a711a 235extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
27ec394a 236extern int parse_opt_expiry_date_cb(const struct option *, const char *, int);
73e9da01 237extern int parse_opt_color_flag_cb(const struct option *, const char *, int);
7f87aff2 238extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
b2172fdf 239extern int parse_opt_object_name(const struct option *, const char *, int);
9d306b5a 240extern int parse_opt_commits(const struct option *, const char *, int);
cb6020bb 241extern int parse_opt_tertiary(const struct option *, const char *, int);
c8ba1639 242extern int parse_opt_string_list(const struct option *, const char *, int);
6acec038 243extern int parse_opt_noop_cb(const struct option *, const char *, int);
ce564eb1 244extern int parse_opt_unknown_cb(const struct option *, const char *, int);
6b3ee18d 245extern int parse_opt_passthru(const struct option *, const char *, int);
ffad85c5 246extern int parse_opt_passthru_argv(const struct option *, const char *, int);
0ce865b1 247
212c0a6f
NTND
248#define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
249#define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
7f87aff2 250#define OPT__VERBOSITY(var) \
54e6dc7d 251 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
7f87aff2 252 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
54e6dc7d 253 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
7f87aff2 254 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
212c0a6f 255#define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
1224781d 256#define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f))
0ce865b1 257#define OPT__ABBREV(var) \
54e6dc7d
NTND
258 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
259 N_("use <n> digits to display SHA-1s"), \
0ce865b1 260 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
73e9da01
ML
261#define OPT__COLOR(var, h) \
262 OPT_COLOR_FLAG(0, "color", (var), (h))
7e29b825 263#define OPT_COLUMN(s, l, v, h) \
a054e049 264 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
6b3ee18d
PT
265#define OPT_PASSTHRU(s, l, v, a, h, f) \
266 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
ffad85c5
PT
267#define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
268 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
f266c916
KN
269#define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
270 { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
271 PARSE_OPT_LASTARG_DEFAULT | flag, \
272 parse_opt_commits, (intptr_t) "HEAD" \
273 }
eab98ee5 274#define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
ac3f5a34 275#define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
eab98ee5 276#define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
ac3f5a34 277#define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
0ce865b1 278
4a59fd13 279#endif