1 #ifndef PARSE_OPTIONS_H
2 #define PARSE_OPTIONS_H
10 /* options with no arguments */
13 OPTION_BOOLEAN
, /* _INCR would have been a better name */
16 /* options with arguments (usually) */
23 enum parse_opt_flags
{
24 PARSE_OPT_KEEP_DASHDASH
= 1,
25 PARSE_OPT_STOP_AT_NON_OPTION
= 2,
26 PARSE_OPT_KEEP_ARGV0
= 4,
27 PARSE_OPT_KEEP_UNKNOWN
= 8,
28 PARSE_OPT_NO_INTERNAL_HELP
= 16,
31 enum parse_opt_option_flags
{
36 PARSE_OPT_LASTARG_DEFAULT
= 16,
37 PARSE_OPT_NODASH
= 32,
38 PARSE_OPT_LITERAL_ARGHELP
= 64,
42 typedef int parse_opt_cb(const struct option
*, const char *arg
, int unset
);
46 * holds the type of the option, you must have an OPTION_END last in your
50 * the character to use as a short option name, '\0' if none.
53 * the long option name, without the leading dashes, NULL if none.
56 * stores pointers to the values to be filled.
59 * token to explain the kind of argument this option wants. Keep it
60 * homogeneous across the repository.
63 * the short help associated to what the option does.
64 * Must never be NULL (except for OPTION_END).
65 * OPTION_GROUP uses this pointer to store the group header.
68 * mask of parse_opt_option_flags.
69 * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
70 * PARSE_OPT_NOARG: says that this option takes no argument
71 * PARSE_OPT_NONEG: says that this option cannot be negated
72 * PARSE_OPT_HIDDEN: this option is skipped in the default usage, and
73 * shown only in the full usage.
74 * PARSE_OPT_LASTARG_DEFAULT: says that this option will take the default
75 * value if no argument is given when the option
76 * is last on the command line. If the option is
77 * not last it will require an argument.
78 * Should not be used with PARSE_OPT_OPTARG.
79 * PARSE_OPT_NODASH: this option doesn't start with a dash.
80 * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets
81 * (i.e. '<argh>') in the help message.
82 * Useful for options with multiple parameters.
85 * pointer to the callback to use for OPTION_CALLBACK.
88 * default value to fill (*->value) with for PARSE_OPT_OPTARG.
89 * OPTION_{BIT,SET_INT,SET_PTR} store the {mask,integer,pointer} to put in
91 * CALLBACKS can use it like they want.
94 enum parse_opt_type type
;
96 const char *long_name
;
102 parse_opt_cb
*callback
;
106 #define OPT_END() { OPTION_END }
107 #define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, \
108 (h), PARSE_OPT_NOARG}
109 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
110 #define OPT_BIT(s, l, v, h, b) { OPTION_BIT, (s), (l), (v), NULL, (h), \
111 PARSE_OPT_NOARG, NULL, (b) }
112 #define OPT_NEGBIT(s, l, v, h, b) { OPTION_NEGBIT, (s), (l), (v), NULL, \
113 (h), PARSE_OPT_NOARG, NULL, (b) }
114 #define OPT_BOOLEAN(s, l, v, h) { OPTION_BOOLEAN, (s), (l), (v), NULL, \
115 (h), PARSE_OPT_NOARG }
116 #define OPT_SET_INT(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, \
117 (h), PARSE_OPT_NOARG, NULL, (i) }
118 #define OPT_SET_PTR(s, l, v, h, p) { OPTION_SET_PTR, (s), (l), (v), NULL, \
119 (h), PARSE_OPT_NOARG, NULL, (p) }
120 #define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), "n", (h) }
121 #define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
122 #define OPT_DATE(s, l, v, h) \
123 { OPTION_CALLBACK, (s), (l), (v), "time",(h), 0, \
124 parse_opt_approxidate_cb }
125 #define OPT_CALLBACK(s, l, v, a, h, f) \
126 { OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
127 #define OPT_NUMBER_CALLBACK(v, h, f) \
128 { OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
129 PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
130 #define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
133 /* parse_options() will filter out the processed options and leave the
134 * non-option arguments in argv[].
135 * Returns the number of arguments left in argv[].
137 extern int parse_options(int argc
, const char **argv
, const char *prefix
,
138 const struct option
*options
,
139 const char * const usagestr
[], int flags
);
141 extern NORETURN
void usage_with_options(const char * const *usagestr
,
142 const struct option
*options
);
144 /*----- incremental advanced APIs -----*/
153 * It's okay for the caller to consume argv/argc in the usual way.
154 * Other fields of that structure are private to parse-options and should not
155 * be modified in any way.
157 struct parse_opt_ctx_t
{
166 extern int parse_options_usage(const char * const *usagestr
,
167 const struct option
*opts
);
169 extern void parse_options_start(struct parse_opt_ctx_t
*ctx
,
170 int argc
, const char **argv
, const char *prefix
,
173 extern int parse_options_step(struct parse_opt_ctx_t
*ctx
,
174 const struct option
*options
,
175 const char * const usagestr
[]);
177 extern int parse_options_end(struct parse_opt_ctx_t
*ctx
);
180 /*----- some often used options -----*/
181 extern int parse_opt_abbrev_cb(const struct option
*, const char *, int);
182 extern int parse_opt_approxidate_cb(const struct option
*, const char *, int);
183 extern int parse_opt_verbosity_cb(const struct option
*, const char *, int);
184 extern int parse_opt_with_commit(const struct option
*, const char *, int);
186 #define OPT__VERBOSE(var) OPT_BOOLEAN('v', "verbose", (var), "be verbose")
187 #define OPT__QUIET(var) OPT_BOOLEAN('q', "quiet", (var), "be quiet")
188 #define OPT__VERBOSITY(var) \
189 { OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \
190 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
191 { OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
192 PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
193 #define OPT__DRY_RUN(var) OPT_BOOLEAN('n', "dry-run", (var), "dry run")
194 #define OPT__ABBREV(var) \
195 { OPTION_CALLBACK, 0, "abbrev", (var), "n", \
196 "use <n> digits to display SHA-1s", \
197 PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }