175 lines
5.6 KiB
C
175 lines
5.6 KiB
C
#ifndef PARSE_OPTIONS_H
|
|
#define PARSE_OPTIONS_H
|
|
|
|
enum parse_opt_type {
|
|
/* special types */
|
|
OPTION_END,
|
|
OPTION_ARGUMENT,
|
|
OPTION_GROUP,
|
|
/* options with no arguments */
|
|
OPTION_BIT,
|
|
OPTION_BOOLEAN, /* _INCR would have been a better name */
|
|
OPTION_SET_INT,
|
|
OPTION_SET_PTR,
|
|
/* options with arguments (usually) */
|
|
OPTION_STRING,
|
|
OPTION_INTEGER,
|
|
OPTION_LONG,
|
|
OPTION_CALLBACK,
|
|
};
|
|
|
|
enum parse_opt_flags {
|
|
PARSE_OPT_KEEP_DASHDASH = 1,
|
|
PARSE_OPT_STOP_AT_NON_OPTION = 2,
|
|
PARSE_OPT_KEEP_ARGV0 = 4,
|
|
PARSE_OPT_KEEP_UNKNOWN = 8,
|
|
PARSE_OPT_NO_INTERNAL_HELP = 16,
|
|
};
|
|
|
|
enum parse_opt_option_flags {
|
|
PARSE_OPT_OPTARG = 1,
|
|
PARSE_OPT_NOARG = 2,
|
|
PARSE_OPT_NONEG = 4,
|
|
PARSE_OPT_HIDDEN = 8,
|
|
PARSE_OPT_LASTARG_DEFAULT = 16,
|
|
};
|
|
|
|
struct option;
|
|
typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
|
|
|
|
/*
|
|
* `type`::
|
|
* holds the type of the option, you must have an OPTION_END last in your
|
|
* array.
|
|
*
|
|
* `short_name`::
|
|
* the character to use as a short option name, '\0' if none.
|
|
*
|
|
* `long_name`::
|
|
* the long option name, without the leading dashes, NULL if none.
|
|
*
|
|
* `value`::
|
|
* stores pointers to the values to be filled.
|
|
*
|
|
* `argh`::
|
|
* token to explain the kind of argument this option wants. Keep it
|
|
* homogenous across the repository.
|
|
*
|
|
* `help`::
|
|
* the short help associated to what the option does.
|
|
* Must never be NULL (except for OPTION_END).
|
|
* OPTION_GROUP uses this pointer to store the group header.
|
|
*
|
|
* `flags`::
|
|
* mask of parse_opt_option_flags.
|
|
* PARSE_OPT_OPTARG: says that the argument is optionnal (not for BOOLEANs)
|
|
* PARSE_OPT_NOARG: says that this option takes no argument, for CALLBACKs
|
|
* PARSE_OPT_NONEG: says that this option cannot be negated
|
|
* PARSE_OPT_HIDDEN this option is skipped in the default usage, showed in
|
|
* the long one.
|
|
*
|
|
* `callback`::
|
|
* pointer to the callback to use for OPTION_CALLBACK.
|
|
*
|
|
* `defval`::
|
|
* default value to fill (*->value) with for PARSE_OPT_OPTARG.
|
|
* OPTION_{BIT,SET_INT,SET_PTR} store the {mask,integer,pointer} to put in
|
|
* the value when met.
|
|
* CALLBACKS can use it like they want.
|
|
*/
|
|
struct option {
|
|
enum parse_opt_type type;
|
|
int short_name;
|
|
const char *long_name;
|
|
void *value;
|
|
const char *argh;
|
|
const char *help;
|
|
|
|
int flags;
|
|
parse_opt_cb *callback;
|
|
intptr_t defval;
|
|
};
|
|
|
|
#define OPT_END() { OPTION_END }
|
|
#define OPT_ARGUMENT(l, h) { OPTION_ARGUMENT, 0, (l), NULL, NULL, (h) }
|
|
#define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
|
|
#define OPT_BIT(s, l, v, h, b) { OPTION_BIT, (s), (l), (v), NULL, (h), 0, NULL, (b) }
|
|
#define OPT_BOOLEAN(s, l, v, h) { OPTION_BOOLEAN, (s), (l), (v), NULL, (h) }
|
|
#define OPT_SET_INT(s, l, v, h, i) { OPTION_SET_INT, (s), (l), (v), NULL, (h), 0, NULL, (i) }
|
|
#define OPT_SET_PTR(s, l, v, h, p) { OPTION_SET_PTR, (s), (l), (v), NULL, (h), 0, NULL, (p) }
|
|
#define OPT_INTEGER(s, l, v, h) { OPTION_INTEGER, (s), (l), (v), NULL, (h) }
|
|
#define OPT_LONG(s, l, v, h) { OPTION_LONG, (s), (l), (v), NULL, (h) }
|
|
#define OPT_STRING(s, l, v, a, h) { OPTION_STRING, (s), (l), (v), (a), (h) }
|
|
#define OPT_DATE(s, l, v, h) \
|
|
{ OPTION_CALLBACK, (s), (l), (v), "time",(h), 0, \
|
|
parse_opt_approxidate_cb }
|
|
#define OPT_CALLBACK(s, l, v, a, h, f) \
|
|
{ OPTION_CALLBACK, (s), (l), (v), (a), (h), 0, (f) }
|
|
|
|
/* parse_options() will filter out the processed options and leave the
|
|
* non-option argments in argv[].
|
|
* Returns the number of arguments left in argv[].
|
|
*/
|
|
extern int parse_options(int argc, const char **argv,
|
|
const struct option *options,
|
|
const char * const usagestr[], int flags);
|
|
|
|
extern NORETURN void usage_with_options(const char * const *usagestr,
|
|
const struct option *options);
|
|
|
|
/*----- incremantal advanced APIs -----*/
|
|
|
|
enum {
|
|
PARSE_OPT_HELP = -1,
|
|
PARSE_OPT_DONE,
|
|
PARSE_OPT_UNKNOWN,
|
|
};
|
|
|
|
/*
|
|
* It's okay for the caller to consume argv/argc in the usual way.
|
|
* Other fields of that structure are private to parse-options and should not
|
|
* be modified in any way.
|
|
*/
|
|
struct parse_opt_ctx_t {
|
|
const char **argv;
|
|
const char **out;
|
|
int argc, cpidx;
|
|
const char *opt;
|
|
int flags;
|
|
};
|
|
|
|
extern int parse_options_usage(const char * const *usagestr,
|
|
const struct option *opts);
|
|
|
|
extern void parse_options_start(struct parse_opt_ctx_t *ctx,
|
|
int argc, const char **argv, int flags);
|
|
|
|
extern int parse_options_step(struct parse_opt_ctx_t *ctx,
|
|
const struct option *options,
|
|
const char * const usagestr[]);
|
|
|
|
extern int parse_options_end(struct parse_opt_ctx_t *ctx);
|
|
|
|
|
|
/*----- some often used options -----*/
|
|
extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
|
|
extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
|
|
extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
|
|
|
|
#define OPT__VERBOSE(var) OPT_BOOLEAN('v', "verbose", (var), "be verbose")
|
|
#define OPT__QUIET(var) OPT_BOOLEAN('q', "quiet", (var), "be quiet")
|
|
#define OPT__VERBOSITY(var) \
|
|
{ OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \
|
|
PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
|
|
{ OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
|
|
PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
|
|
#define OPT__DRY_RUN(var) OPT_BOOLEAN('n', "dry-run", (var), "dry run")
|
|
#define OPT__ABBREV(var) \
|
|
{ OPTION_CALLBACK, 0, "abbrev", (var), "n", \
|
|
"use <n> digits to display SHA-1s", \
|
|
PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
|
|
|
|
extern const char *parse_options_fix_filename(const char *prefix, const char *file);
|
|
|
|
#endif
|