1 #ifndef PARSE_OPTIONS_H
2 #define PARSE_OPTIONS_H
10 /* options with no arguments */
16 /* options with arguments (usually) */
21 OPTION_LOWLEVEL_CALLBACK
,
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
33 enum parse_opt_option_flags
{
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
46 typedef int parse_opt_cb(const struct option
*, const char *arg
, int unset
);
48 struct parse_opt_ctx_t
;
49 typedef int parse_opt_ll_cb(struct parse_opt_ctx_t
*ctx
,
50 const struct option
*opt
, int unset
);
54 * holds the type of the option, you must have an OPTION_END last in your
58 * the character to use as a short option name, '\0' if none.
61 * the long option name, without the leading dashes, NULL if none.
64 * stores pointers to the values to be filled.
67 * token to explain the kind of argument this option wants. Keep it
68 * homogeneous across the repository. Should be wrapped by N_() for
72 * the short help associated to what the option does.
73 * Must never be NULL (except for OPTION_END).
74 * OPTION_GROUP uses this pointer to store the group header.
75 * Should be wrapped by N_() for translation.
78 * mask of parse_opt_option_flags.
79 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
80 * PARSE_OPT_NOARG: says that this option does not take an argument
81 * PARSE_OPT_NONEG: says that this option cannot be negated
82 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
83 * shown only in the full usage.
84 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
85 * value if no argument is given when the option
86 * is last on the command line. If the option is
87 * not last it will require an argument.
88 * Should not be used with PARSE_OPT_OPTARG.
89 * PARSE_OPT_NODASH: this option doesn't start with a dash.
90 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
91 * (i.e. '<argh>') in the help message.
92 * Useful for options with multiple parameters.
93 * PARSE_OPT_NOCOMPLETE: by default all visible options are completable
94 * by git-completion.bash. This option suppresses that.
97 * pointer to the callback to use for OPTION_CALLBACK or
98 * OPTION_LOWLEVEL_CALLBACK.
101 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
102 * OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
103 * CALLBACKS can use it like they want.
106 enum parse_opt_type type
;
108 const char *long_name
;
114 parse_opt_cb
*callback
;
118 #define OPT_BIT_F(s, l, v, h, b, f) { OPTION_BIT, (s), (l), (v), NULL, (h), \
119 PARSE_OPT_NOARG|(f), NULL, (b) }
120 #define OPT_COUNTUP_F(s, l, v, h, f) { OPTION_COUNTUP, (s), (l), (v), NULL, \
121 (h), PARSE_OPT_NOARG|(f) }
122 #define OPT_SET_INT_F(s, l, v, h, i, f) { OPTION_SET_INT, (s), (l), (v), NULL, \
123 (h), PARSE_OPT_NOARG | (f), NULL, (i) }
124 #define OPT_BOOL_F(s, l, v, h, f) OPT_SET_INT_F(s, l, v, h, 1, f)
126 #define OPT_END() { OPTION_END }
127 #define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
128 (h), PARSE_OPT_NOARG}
129 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
130 #define OPT_BIT(s, l, v, h, b) OPT_BIT_F(s, l, v, h, b, 0)
131 #define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
132 (h), PARSE_OPT_NOARG, NULL, (b) }
133 #define OPT_COUNTUP(s, l, v, h) OPT_COUNTUP_F(s, l, v, h, 0)
134 #define OPT_SET_INT(s, l, v, h, i) OPT_SET_INT_F(s, l, v, h, i, 0)
135 #define OPT_BOOL(s, l, v, h) OPT_BOOL_F(s, l, v, h, 0)
136 #define OPT_HIDDEN_BOOL(s, l, v, h) { OPTION_SET_INT, (s), (l), (v), NULL, \
137 (h), PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1}
138 #define OPT_CMDMODE(s, l, v, h, i) { OPTION_CMDMODE, (s), (l), (v), NULL, \
139 (h), PARSE_OPT_NOARG|PARSE_OPT_NONEG, NULL, (i) }
140 #define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), N_("n"), (h) }
141 #define OPT_MAGNITUDE(s, l, v, h) { OPTION_MAGNITUDE, (s), (l), (v), \
142 N_("n"), (h), PARSE_OPT_NONEG }
143 #define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
144 #define OPT_STRING_LIST(s, l, v, a, h) \
145 { OPTION_CALLBACK, (s), (l), (v), (a), \
146 (h), 0, &parse_opt_string_list }
147 #define OPT_UYN(s, l, v, h, f) { OPTION_CALLBACK, (s), (l), (v), NULL, \
148 (h), PARSE_OPT_NOARG|(f), &parse_opt_tertiary }
149 #define OPT_DATE(s, l, v, h) \
150 { OPTION_CALLBACK, (s), (l), (v), N_("time"),(h), 0, \
151 parse_opt_approxidate_cb }
152 #define OPT_EXPIRY_DATE(s, l, v, h) \
153 { OPTION_CALLBACK, (s), (l), (v), N_("expiry-date"),(h), 0, \
154 parse_opt_expiry_date_cb }
155 #define OPT_CALLBACK(s, l, v, a, h, f) \
156 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
157 #define OPT_NUMBER_CALLBACK(v, h, f) \
158 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
159 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
160 #define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
162 #define OPT_COLOR_FLAG(s, l, v, h) \
163 { OPTION_CALLBACK, (s), (l), (v), N_("when"), (h), PARSE_OPT_OPTARG, \
164 parse_opt_color_flag_cb, (intptr_t)"always" }
166 #define OPT_NOOP_NOARG(s, l) \
167 { OPTION_CALLBACK, (s), (l), NULL, NULL, \
168 N_("no-op (backward compatibility)"), \
169 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, parse_opt_noop_cb }
171 /* parse_options() will filter out the processed options and leave the
172 * non-option arguments in argv[]. usagestr strings should be marked
173 * for translation with N_().
174 * Returns the number of arguments left in argv[].
176 extern int parse_options(int argc
, const char **argv
, const char *prefix
,
177 const struct option
*options
,
178 const char * const usagestr
[], int flags
);
180 extern NORETURN
void usage_with_options(const char * const *usagestr
,
181 const struct option
*options
);
183 extern NORETURN
void usage_msg_opt(const char *msg
,
184 const char * const *usagestr
,
185 const struct option
*options
);
187 extern int optbug(const struct option
*opt
, const char *reason
);
188 extern int opterror(const struct option
*opt
, const char *reason
, int flags
);
189 #if defined(__GNUC__)
190 #define opterror(o,r,f) (opterror((o),(r),(f)), const_error())
193 /*----- incremental advanced APIs -----*/
198 PARSE_OPT_NON_OPTION
,
203 * It's okay for the caller to consume argv/argc in the usual way.
204 * Other fields of that structure are private to parse-options and should not
205 * be modified in any way.
207 struct parse_opt_ctx_t
{
210 int argc
, cpidx
, total
;
216 extern void parse_options_start(struct parse_opt_ctx_t
*ctx
,
217 int argc
, const char **argv
, const char *prefix
,
218 const struct option
*options
, int flags
);
220 extern int parse_options_step(struct parse_opt_ctx_t
*ctx
,
221 const struct option
*options
,
222 const char * const usagestr
[]);
224 extern int parse_options_end(struct parse_opt_ctx_t
*ctx
);
226 extern struct option
*parse_options_concat(struct option
*a
, struct option
*b
);
228 /*----- some often used options -----*/
229 extern int parse_opt_abbrev_cb(const struct option
*, const char *, int);
230 extern int parse_opt_approxidate_cb(const struct option
*, const char *, int);
231 extern int parse_opt_expiry_date_cb(const struct option
*, const char *, int);
232 extern int parse_opt_color_flag_cb(const struct option
*, const char *, int);
233 extern int parse_opt_verbosity_cb(const struct option
*, const char *, int);
234 extern int parse_opt_object_name(const struct option
*, const char *, int);
235 extern int parse_opt_commits(const struct option
*, const char *, int);
236 extern int parse_opt_tertiary(const struct option
*, const char *, int);
237 extern int parse_opt_string_list(const struct option
*, const char *, int);
238 extern int parse_opt_noop_cb(const struct option
*, const char *, int);
239 extern int parse_opt_unknown_cb(const struct option
*, const char *, int);
240 extern int parse_opt_passthru(const struct option
*, const char *, int);
241 extern int parse_opt_passthru_argv(const struct option
*, const char *, int);
243 #define OPT__VERBOSE(var, h) OPT_COUNTUP('v', "verbose", (var), (h))
244 #define OPT__QUIET(var, h) OPT_COUNTUP('q', "quiet", (var), (h))
245 #define OPT__VERBOSITY(var) \
246 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, N_("be more verbose"), \
247 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
248 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, N_("be more quiet"), \
249 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
250 #define OPT__DRY_RUN(var, h) OPT_BOOL('n', "dry-run", (var), (h))
251 #define OPT__FORCE(var, h, f) OPT_COUNTUP_F('f', "force", (var), (h), (f))
252 #define OPT__ABBREV(var) \
253 { OPTION_CALLBACK, 0, "abbrev", (var), N_("n"), \
254 N_("use <n> digits to display SHA-1s"), \
255 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
256 #define OPT__COLOR(var, h) \
257 OPT_COLOR_FLAG(0, "color", (var), (h))
258 #define OPT_COLUMN(s, l, v, h) \
259 { OPTION_CALLBACK, (s), (l), (v), N_("style"), (h), PARSE_OPT_OPTARG, parseopt_column_callback }
260 #define OPT_PASSTHRU(s, l, v, a, h, f) \
261 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru }
262 #define OPT_PASSTHRU_ARGV(s, l, v, a, h, f) \
263 { OPTION_CALLBACK, (s), (l), (v), (a), (h), (f), parse_opt_passthru_argv }
264 #define _OPT_CONTAINS_OR_WITH(name, variable, help, flag) \
265 { OPTION_CALLBACK, 0, name, (variable), N_("commit"), (help), \
266 PARSE_OPT_LASTARG_DEFAULT | flag, \
267 parse_opt_commits, (intptr_t) "HEAD" \
269 #define OPT_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("contains", v, h, PARSE_OPT_NONEG)
270 #define OPT_NO_CONTAINS(v, h) _OPT_CONTAINS_OR_WITH("no-contains", v, h, PARSE_OPT_NONEG)
271 #define OPT_WITH(v, h) _OPT_CONTAINS_OR_WITH("with", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)
272 #define OPT_WITHOUT(v, h) _OPT_CONTAINS_OR_WITH("without", v, h, PARSE_OPT_HIDDEN | PARSE_OPT_NONEG)