X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Fopt%2Fopt.h;h=6f4b9dda8c85a4f33389863963b57f1a87214ea4;hp=253d03c4098691988a8edf4ef4352d3b72931be5;hb=HEAD;hpb=d89e5744f30b584ac4909ce1164af1289c41359b diff --git a/ccan/opt/opt.h b/ccan/opt/opt.h index 253d03c4..e0331be2 100644 --- a/ccan/opt/opt.h +++ b/ccan/opt/opt.h @@ -1,77 +1,73 @@ +/* Licensed under GPLv2+ - see LICENSE file for details */ #ifndef CCAN_OPT_H #define CCAN_OPT_H +#include #include #include +#include -/* You can use this directly to build tables, but the macros will ensure - * consistency and type safety. */ -enum opt_flags { - OPT_NOARG = 1, /* -f/--foo */ - OPT_HASARG = 2, /* -f arg/--foo=arg/--foo arg */ - OPT_SUBTABLE = 4, /* Actually, longopt points to a subtable... */ - OPT_END = 8, /* End of the table. */ -}; - -/* Maximum length of arg to show in opt_usage */ -#define OPT_SHOW_LEN 80 - -struct opt_table { - const char *names; /* slash-separated names, --longopt or -s */ - enum opt_flags flags; - char *(*cb)(void *arg); /* OPT_NOARG */ - char *(*cb_arg)(const char *optarg, void *arg); /* OPT_HASARG */ - void (*show)(char buf[OPT_SHOW_LEN], const void *arg); - void *arg; - const char *desc; -}; +struct opt_table; /** * OPT_WITHOUT_ARG() - macro for initializing an opt_table entry (without arg) - * @names: the names of the option eg. "--foo", "-f" or "--foo/-f/--foobar". + * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar". * @cb: the callback when the option is found. * @arg: the argument to hand to @cb. + * @desc: the description for opt_usage(), or opt_hidden. * - * This is a typesafe wrapper for intializing a struct opt_table. The callback + * This is a typesafe wrapper for initializing a struct opt_table. The callback * of type "char *cb(type *)", "char *cb(const type *)" or "char *cb(void *)", * where "type" is the type of the @arg argument. * * If the @cb returns non-NULL, opt_parse() will stop parsing, use the * returned string to form an error message for errlog(), free() the - * string and return false. + * string (or see opt_set_alloc) and return false. + * + * Any number of equivalent short or long options can be listed in @names, + * separated by '|'. Short options are a single hyphen followed by a single + * character, long options are two hyphens followed by one or more characters. * * See Also: * OPT_WITH_ARG() */ -#define OPT_WITHOUT_ARG(names, cb, arg) \ - (names), OPT_CB_NOARG((cb), (arg)) +#define OPT_WITHOUT_ARG(names, cb, arg, desc) \ + { (names), OPT_CB_NOARG((cb), 0, (arg)), { (arg) }, (desc) } /** - * OPT_WITH_ARG() - macro for initializing long and short option (with arg) - * @names: the names of the option eg. "--foo", "-f" or "--foo/-f/--foobar". + * OPT_WITH_ARG() - macro for initializing an opt_table entry (with arg) + * @names: the option names eg. "--foo=", "-f" or "-f|--foo ". * @cb: the callback when the option is found (along with ). * @show: the callback to print the value in get_usage (or NULL) * @arg: the argument to hand to @cb and @show + * @desc: the description for opt_usage(), or opt_hidden. * - * This is a typesafe wrapper for intializing a struct opt_table. The callback + * This is a typesafe wrapper for initializing a struct opt_table. The callback * is of type "char *cb(const char *, type *)", * "char *cb(const char *, const type *)" or "char *cb(const char *, void *)", * where "type" is the type of the @arg argument. The first argument to the * @cb is the argument found on the commandline. * - * Similarly, if @show is not NULL, it should be of type "void *show(char *, - * const type *)". It should write up to OPT_SHOW_LEN bytes into the first - * argument; unless it uses the entire OPT_SHOW_LEN bytes it should - * nul-terminate that buffer. + * Similarly, if @show is not NULL, it should be of type "bool show(char *, + * size_t len, const type *)". If there is no default, it should return false, + * otherwise it should write up to len bytes into the first argument and + * return true; unless it uses the entire len bytes it should nul-terminate that + * buffer. + * + * Any number of equivalent short or long options can be listed in @names, + * separated by '|'. Short options are a single hyphen followed by a single + * character, long options are two hyphens followed by one or more characters. + * A space or equals in @names is ignored for parsing, and only used + * for printing the usage. * * If the @cb returns non-NULL, opt_parse() will stop parsing, use the * returned string to form an error message for errlog(), free() the - * string and return false. + * string (or see opt_set_alloc) and return false. * * See Also: * OPT_WITHOUT_ARG() */ -#define OPT_WITH_ARG(name, cb, show, arg) \ - (name), OPT_CB_ARG((cb), (show), (arg)) +#define OPT_WITH_ARG(name, cb, show, arg, desc) \ + { (name), OPT_CB_ARG((cb), 0, (show), (arg)), { (arg) }, (desc) } /** * OPT_SUBTABLE() - macro for including another table inside a table. @@ -80,14 +76,48 @@ struct opt_table { */ #define OPT_SUBTABLE(table, desc) \ { (const char *)(table), OPT_SUBTABLE, \ - sizeof(_check_is_entry(table)) ? NULL : NULL, NULL, NULL, NULL, (desc) } + sizeof(_check_is_entry(table)) ? NULL : NULL, NULL, NULL, \ + { NULL }, (desc) } + +/** + * OPT_EARLY_WITHOUT_ARG() - macro for a early opt_table entry (without arg) + * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar". + * @cb: the callback when the option is found. + * @arg: the argument to hand to @cb. + * @desc: the description for opt_usage(), or opt_hidden. + * + * This is the same as OPT_WITHOUT_ARG, but for opt_early_parse() instead of + * opt_parse(). + * + * See Also: + * OPT_EARLY_WITH_ARG(), opt_early_parse() + */ +#define OPT_EARLY_WITHOUT_ARG(names, cb, arg, desc) \ + { (names), OPT_CB_NOARG((cb), OPT_EARLY, (arg)), { (arg) }, (desc) } + +/** + * OPT_EARLY_WITH_ARG() - macro for an early opt_table entry (with arg) + * @names: the option names eg. "--foo=", "-f" or "-f|--foo ". + * @cb: the callback when the option is found (along with ). + * @show: the callback to print the value in get_usage (or NULL) + * @arg: the argument to hand to @cb and @show + * @desc: the description for opt_usage(), or opt_hidden. + * + * This is the same as OPT_WITH_ARG, but for opt_early_parse() instead of + * opt_parse(). + * + * See Also: + * OPT_EARLY_WITHOUT_ARG(), opt_early_parse() + */ +#define OPT_EARLY_WITH_ARG(name, cb, show, arg, desc) \ + { (name), OPT_CB_ARG((cb), OPT_EARLY, (show), (arg)), { (arg) }, (desc) } /** * OPT_ENDTABLE - macro to create final entry in table. * * This must be the final element in the opt_table array. */ -#define OPT_ENDTABLE { NULL, OPT_END } +#define OPT_ENDTABLE { NULL, OPT_END, NULL, NULL, NULL, { NULL }, NULL } /** * opt_register_table - register a table of options @@ -97,28 +127,29 @@ struct opt_table { * The table must be terminated by OPT_ENDTABLE. * * Example: + * static int verbose = 0; * static struct opt_table opts[] = { - * { OPT_WITHOUT_ARG("--verbose", opt_inc_intval, &verbose), - * "Verbose mode (can be specified more than once)" }, - * { OPT_WITHOUT_ARG("-v", opt_inc_intval, &verbose), - * "Verbose mode (can be specified more than once)" }, - * { OPT_WITHOUT_ARG("--usage", opt_usage_and_exit, - * "args...\nA silly test program."), - * "Print this message." }, + * OPT_WITHOUT_ARG("--verbose", opt_inc_intval, &verbose, + * "Verbose mode (can be specified more than once)"), + * OPT_WITHOUT_ARG("-v", opt_inc_intval, &verbose, + * "Verbose mode (can be specified more than once)"), + * OPT_WITHOUT_ARG("--usage", opt_usage_and_exit, + * "args...\nA silly test program.", + * "Print this message."), * OPT_ENDTABLE * }; * * ... * opt_register_table(opts, NULL); */ -void opt_register_table(const struct opt_table table[], const char *desc); +void opt_register_table(const struct opt_table *table, const char *desc); /** * opt_register_noarg - register an option with no arguments - * @names: the names of the option eg. "--foo", "-f" or "--foo/-f/--foobar". + * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar". * @cb: the callback when the option is found. * @arg: the argument to hand to @cb. - * @desc: the verbose desction of the option (for opt_usage()), or NULL. + * @desc: the verbose description of the option (for opt_usage()), or NULL. * * This is used for registering a single commandline option which takes * no argument. @@ -129,18 +160,18 @@ void opt_register_table(const struct opt_table table[], const char *desc); * * If the @cb returns non-NULL, opt_parse() will stop parsing, use the * returned string to form an error message for errlog(), free() the - * string and return false. + * string (or see opt_set_alloc) and return false. */ #define opt_register_noarg(names, cb, arg, desc) \ - _opt_register((names), OPT_CB_NOARG((cb), (arg)), (desc)) + _opt_register((names), OPT_CB_NOARG((cb), 0, (arg)), (arg), (desc)) /** * opt_register_arg - register an option with an arguments - * @names: the names of the option eg. "--foo", "-f" or "--foo/-f/--foobar". + * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar". * @cb: the callback when the option is found. - * @show: the callback when the option is found. + * @show: the callback to print the value in get_usage (or NULL) * @arg: the argument to hand to @cb. - * @desc: the verbose desction of the option (for opt_usage()), or NULL. + * @desc: the verbose description of the option (for opt_usage()), or NULL. * * This is used for registering a single commandline option which takes * an argument. @@ -150,46 +181,192 @@ void opt_register_table(const struct opt_table table[], const char *desc); * where "type" is the type of the @arg argument. The first argument to the * @cb is the argument found on the commandline. * - * At least one of @longopt and @shortopt must be non-zero. If the - * @cb returns false, opt_parse() will stop parsing and return false. + * If the @cb returns non-NULL, opt_parse() will stop parsing, use the + * returned string to form an error message for errlog(), free() the + * string (or see opt_set_alloc) and return false. * * Example: - * opt_register_arg("--explode", explode_cb, NULL, - * "Make the machine explode (developers only)"); + * static char *explode(const char *optarg, void *unused UNNEEDED) + * { + * errx(1, "BOOM! %s", optarg); + * } + * ... + * opt_register_arg("--explode|--boom", explode, NULL, NULL, opt_hidden); */ #define opt_register_arg(names, cb, show, arg, desc) \ - _opt_register((names), OPT_CB_ARG((cb), (show), (arg)), (desc)) + _opt_register((names), OPT_CB_ARG((cb),0,(show), (arg)), (arg), (desc)) + +/** + * opt_register_early_noarg - register an early option with no arguments + * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar". + * @cb: the callback when the option is found. + * @arg: the argument to hand to @cb. + * @desc: the verbose description of the option (for opt_usage()), or NULL. + * + * This is the same as opt_register_noarg(), but for opt_early_parse(). + * + * See Also: + * opt_register_early_arg(), opt_early_parse() + */ +#define opt_register_early_noarg(names, cb, arg, desc) \ + _opt_register((names), OPT_CB_NOARG((cb), OPT_EARLY, (arg)), \ + (arg), (desc)) + +/** + * opt_register_early_arg - register an early option with an arguments + * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar". + * @cb: the callback when the option is found. + * @show: the callback to print the value in get_usage (or NULL) + * @arg: the argument to hand to @cb. + * @desc: the verbose description of the option (for opt_usage()), or NULL. + * + * This is the same as opt_register_arg(), but for opt_early_parse(). + * + * See Also: + * opt_register_early_noarg(), opt_early_parse() + */ +#define opt_register_early_arg(names, cb, show, arg, desc) \ + _opt_register((names), OPT_CB_ARG((cb), OPT_EARLY, (show),(arg)), \ + (arg), (desc)) + +/** + * opt_unregister - unregister an option. + * @names: the names it was registered with. + * + * This undoes opt_register[_early]_[no]arg. Returns true if the option was + * found, otherwise false. + */ +bool opt_unregister(const char *names); /** * opt_parse - parse arguments. * @argc: pointer to argc * @argv: argv array. - * @errlog: the function to print errors (usually opt_log_stderr). + * @errlog: the function to print errors * * This iterates through the command line and calls callbacks registered with - * opt_register_table()/opt_register_arg()/opt_register_noarg(). If there - * are unknown options, missing arguments or a callback returns false, then - * an error message is printed and false is returned. + * opt_register_arg()/opt_register_noarg() or OPT_WITHOUT_ARG/OPT_WITH_ARG + * entries in tables registered with opt_register_table(). As this occurs + * each option is removed from argc and argv. + * + * If there are unknown options, missing arguments or a callback + * returns false, then an error message is printed and false is + * returned: the erroneous option is not removed. * - * On success, argc and argv are adjusted so only the non-option elements - * remain, and true is returned. + * On success, argc and argv will contain only the non-option + * elements, and true is returned. * * Example: - * if (!opt_parse(argc, argv, opt_log_stderr)) { - * printf("%s", opt_usage(argv[0], "...")); + * if (!opt_parse(&argc, argv, opt_log_stderr)) { + * printf("You screwed up, aborting!\n"); * exit(1); * } + * + * See Also: + * opt_log_stderr, opt_log_stderr_exit, opt_early_parse() */ bool opt_parse(int *argc, char *argv[], void (*errlog)(const char *fmt, ...)); +/** + * opt_early_parse - parse early arguments. + * @argc: argc + * @argv: argv array. + * @errlog: the function to print errors + * + * There are times when you want to parse some arguments before any other + * arguments; this is especially important for debugging flags (eg. --verbose) + * when you have complicated callbacks in option processing. + * + * You can use opt_early_parse() to only parse options registered with + * opt_register_earlyarg()/opt_register_early_noarg() or + * OPT_EARLY_WITHOUT_ARG/OPT_EARLY_WITH_ARG entries in tables registered with + * opt_register_table(). + * + * Note that unlike opt_parse(), argc and argv are not altered. + * + * Example: + * if (!opt_early_parse(argc, argv, opt_log_stderr)) { + * printf("You screwed up, aborting!\n"); + * exit(1); + * } + * + * See Also: + * opt_parse() + */ +bool opt_early_parse(int argc, char *argv[], + void (*errlog)(const char *fmt, ...)); + +/** + * opt_early_parse_incomplete - parse early arguments, ignoring unknown ones. + * @argc: argc + * @argv: argv array. + * @errlog: the function to print errors + * + * If you have plugins, you might need to do early parsing (eg. to find the + * plugin directory) but you don't know what options the plugins will want. + * + * Thus, this function is just like opt_early_parse, but ignores unknown options. + * + * Example: + * if (!opt_early_parse_incomplete(argc, argv, opt_log_stderr)) { + * printf("You screwed up, aborting!\n"); + * exit(1); + * } + * + * See Also: + * opt_early_parse() + */ +bool opt_early_parse_incomplete(int argc, char *argv[], + void (*errlog)(const char *fmt, ...)); + + +/** + * opt_free_table - reset the opt library. + * + * This frees the internal memory and returns counters to zero. Call + * this as the last opt function to avoid memory leaks. You can also + * use this function to reset option handling to its initial state (no + * options registered). + */ +void opt_free_table(void); + +/** + * opt_set_alloc - set alloc/realloc/free function for opt to use. + * @allocfn: allocator function + * @reallocfn: reallocator function, ptr may be NULL, size never 0. + * @freefn: free function + * + * By default opt uses malloc/realloc/free, and simply crashes if they fail. + * You can set your own variants here. + */ +void opt_set_alloc(void *(*allocfn)(size_t size), + void *(*reallocfn)(void *ptr, size_t size), + void (*freefn)(void *ptr)); + /** * opt_log_stderr - print message to stderr. * @fmt: printf-style format. * - * This is the standard helper for opt_parse, to print errors. + * This is a helper for opt_parse, to print errors to stderr. + * + * See Also: + * opt_log_stderr_exit */ void opt_log_stderr(const char *fmt, ...); +/** + * opt_log_stderr_exit - print message to stderr, then exit(1) + * @fmt: printf-style format. + * + * Just like opt_log_stderr, only then does exit(1). This means that + * when handed to opt_parse, opt_parse will never return false. + * + * Example: + * // This never returns false; just exits if there's an erorr. + * opt_parse(&argc, argv, opt_log_stderr_exit); + */ +void opt_log_stderr_exit(const char *fmt, ...); + /** * opt_invalid_argument - helper to allocate an "Invalid argument '%s'" string * @arg: the argument which was invalid. @@ -207,10 +384,44 @@ char *opt_invalid_argument(const char *arg); * and a table of all the options with their descriptions. If an option has * description opt_hidden, it is not shown here. * + * The table of options is formatted such that descriptions are + * wrapped on space boundaries. If a description has a "\n" that is + * left intact, and the following characters indented appropriately. + * If the description begins with one or more space/tab (or has a + * space or tab following a "\n") that line is output without wrapping. + * + * If "extra" is NULL, then the extra information is taken from any + * registered option which calls opt_usage_and_exit(). This avoids duplicating + * that string in the common case. + * * The result should be passed to free(). + * + * See Also: + * opt_usage_and_exit() + * + * Example: + * opt_register_arg("--explode|--boom", explode, NULL, NULL, + * "This line will be wrapped by opt_usage\n" + * " But this won't because it's indented."); */ char *opt_usage(const char *argv0, const char *extra); +/** + * opt_usage_exit_fail - complain about bad usage to stderr, exit with status 1. + * @msg...: printf-style message to output. + * + * This prints argv[0] (if opt_parse has been called), a colon, then + * the message to stderr (just like errx()). Then it prints out the + * usage message, taken from any registered option which uses + * opt_usage_and_exit() as described in opt_usage(argv0, NULL) above. + * Then it exits with status 1. + * + * Example: + * if (argc != 5) + * opt_usage_exit_fail("Need 5 arguments, only got %u", argc); + */ +void opt_usage_exit_fail(const char *msg, ...) NORETURN; + /** * opt_hidden - string for undocumented options. * @@ -224,29 +435,72 @@ extern const char opt_hidden[]; char *opt_set_bool(bool *b); /* Sets @b based on arg: (yes/no/true/false). */ char *opt_set_bool_arg(const char *arg, bool *b); -void opt_show_bool(char buf[OPT_SHOW_LEN], const bool *b); +bool opt_show_bool(char *buf, size_t len, const bool *b); /* The inverse */ char *opt_set_invbool(bool *b); -void opt_show_invbool(char buf[OPT_SHOW_LEN], const bool *b); +bool opt_show_invbool(char *buf, size_t len, const bool *b); /* Sets @b based on !arg: (yes/no/true/false). */ char *opt_set_invbool_arg(const char *arg, bool *b); /* Set a char *. */ char *opt_set_charp(const char *arg, char **p); -void opt_show_charp(char buf[OPT_SHOW_LEN], char *const *p); +/* If *p is NULL, this returns false (i.e. doesn't show a default) */ +bool opt_show_charp(char *buf, size_t len, char *const *p); /* Set an integer value, various forms. Sets to 1 on arg == NULL. */ char *opt_set_intval(const char *arg, int *i); -void opt_show_intval(char buf[OPT_SHOW_LEN], const int *i); +bool opt_show_intval(char *buf, size_t len, const int *i); char *opt_set_uintval(const char *arg, unsigned int *ui); -void opt_show_uintval(char buf[OPT_SHOW_LEN], const unsigned int *ui); +bool opt_show_uintval(char *buf, size_t len, const unsigned int *ui); char *opt_set_longval(const char *arg, long *l); -void opt_show_longval(char buf[OPT_SHOW_LEN], const long *l); +bool opt_show_longval(char *buf, size_t len, const long *l); char *opt_set_ulongval(const char *arg, unsigned long *ul); -void opt_show_ulongval(char buf[OPT_SHOW_LEN], const unsigned long *ul); +bool opt_show_ulongval(char *buf, size_t len, const unsigned long *ul); + +/* Set an floating point value, various forms. */ +char *opt_set_floatval(const char *arg, float *f); +bool opt_show_floatval(char *buf, size_t len, const float *f); +char *opt_set_doubleval(const char *arg, double *d); +bool opt_show_doubleval(char *buf, size_t len, const double *d); + +/* the following setting functions accept k, M, G, T, P, or E suffixes, which + multiplies the numeric value by the corresponding power of 1000 or 1024 + (for the _si and _bi versions, respectively). + */ +char *opt_set_intval_bi(const char *arg, int *i); +char *opt_set_intval_si(const char *arg, int *i); +char *opt_set_uintval_bi(const char *arg, unsigned int *u); +char *opt_set_uintval_si(const char *arg, unsigned int *u); +char *opt_set_longval_bi(const char *arg, long *l); +char *opt_set_longval_si(const char *arg, long *l); +char *opt_set_ulongval_bi(const char *arg, unsigned long *ul); +char *opt_set_ulongval_si(const char *arg, unsigned long *ul); +char *opt_set_longlongval_bi(const char *arg, long long *ll); +char *opt_set_longlongval_si(const char *arg, long long *ll); +char *opt_set_ulonglongval_bi(const char *arg, unsigned long long *ll); +char *opt_set_ulonglongval_si(const char *arg, unsigned long long *ll); + -/* Increment. */ +bool opt_show_intval_bi(char *buf, size_t len, const int *x); +bool opt_show_longval_bi(char *buf, size_t len, const long *x); +bool opt_show_longlongval_bi(char *buf, size_t len, const long long *x); +bool opt_show_uintval_bi(char *buf, size_t len, const unsigned int *x); +bool opt_show_ulongval_bi(char *buf, size_t len, const unsigned long *x); +bool opt_show_ulonglongval_bi(char *buf, size_t len, const unsigned long long *x); + +bool opt_show_intval_si(char *buf, size_t len, const int *x); +bool opt_show_longval_si(char *buf, size_t len, const long *x); +bool opt_show_longlongval_si(char *buf, size_t len, const long long *x); +bool opt_show_uintval_si(char *buf, size_t len, const unsigned int *x); +bool opt_show_ulongval_si(char *buf, size_t len, const unsigned long *x); +bool opt_show_ulonglongval_si(char *buf, size_t len, const unsigned long long *x); + + + + +/* Increment and decrement. */ char *opt_inc_intval(int *i); +char *opt_dec_intval(int *i); /* Display version string to stdout, exit(0). */ char *opt_version_and_exit(const char *version); @@ -254,35 +508,88 @@ char *opt_version_and_exit(const char *version); /* Display usage string to stdout, exit(0). */ char *opt_usage_and_exit(const char *extra); +/** + * opt_find_long: low-level access to the parser + * @arg: string of form 'arg' or 'arg=val'. + * @optarg: set to `val` of present in arg, otherwise NULL. Can be NULL. + * + * Returns NULL if option is unknown. Sets *@optarg to NULL if + * there's no '='. + */ +struct opt_table *opt_find_long(const char *arg, const char **optarg); + +/** + * opt_find_short: low-level access to the parser + * @arg: character representing short option + * + * Returns NULL if option is unknown. + */ +struct opt_table *opt_find_short(char arg); + +/* opt_type bits reserved for users to play with (ignored!). + * You can set bits in type e.g. (1<