X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Fopt%2Fopt.h;h=539a0a664de155962f3d2efdf116eca52d25fcee;hp=65008091a0861ade804d06e8fc302bcf74a6aa51;hb=e34192d580958aaffff3754a4e2bf1eccbb489f8;hpb=f4b1f445a7b21b1599530afb897ef54efe15479d;ds=inline diff --git a/ccan/opt/opt.h b/ccan/opt/opt.h index 65008091..539a0a66 100644 --- a/ccan/opt/opt.h +++ b/ccan/opt/opt.h @@ -1,37 +1,20 @@ #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. * @@ -40,23 +23,24 @@ struct opt_table { * string 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 hypens followed by one or more characters. + * 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), (arg)), { (arg) }, (desc) } /** * OPT_WITH_ARG() - macro for initializing long and short option (with arg) - * @names: the option names eg. "--foo=", "-f" or "-f/--foo ". + * @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 @@ -68,8 +52,8 @@ struct opt_table { * 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 hypens followed by one or more characters. + * 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. * @@ -80,8 +64,8 @@ struct opt_table { * 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), (show), (arg)), { (arg) }, (desc) } /** * OPT_SUBTABLE() - macro for including another table inside a table. @@ -90,14 +74,15 @@ 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_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 @@ -107,28 +92,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. @@ -142,15 +128,15 @@ void opt_register_table(const struct opt_table table[], const char *desc); * string 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), (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. @@ -164,17 +150,21 @@ void opt_register_table(const struct opt_table table[], const char *desc); * @cb returns false, opt_parse() will stop parsing 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) + * { + * 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), (show), (arg)), (arg), (desc)) /** * 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 @@ -185,21 +175,48 @@ void opt_register_table(const struct opt_table table[], const char *desc); * remain, 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 */ bool opt_parse(int *argc, char *argv[], void (*errlog)(const char *fmt, ...)); +/** + * opt_free_table - free the table. + * + * This frees the internal memory. Call this as the last + * opt function. + */ +void opt_free_table(void); + /** * 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. @@ -217,6 +234,10 @@ 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. * + * 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(). */ char *opt_usage(const char *argv0, const char *extra); @@ -229,6 +250,9 @@ char *opt_usage(const char *argv0, const char *extra); */ extern const char opt_hidden[]; +/* Maximum length of arg to show in opt_usage */ +#define OPT_SHOW_LEN 80 + /* Standard helpers. You can write your own: */ /* Sets the @b to true. */ char *opt_set_bool(bool *b); @@ -265,34 +289,56 @@ char *opt_version_and_exit(const char *version); char *opt_usage_and_exit(const char *extra); /* Below here are private declarations. */ +/* You can use this directly to build tables, but the macros will ensure + * consistency and type safety. */ +enum opt_type { + 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. */ +}; + +struct opt_table { + const char *names; /* pipe-separated names, --longopt or -s */ + enum opt_type type; + 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); + union { + const void *carg; + void *arg; + size_t tlen; + } u; + const char *desc; +}; + /* Resolves to the four parameters for non-arg callbacks. */ #define OPT_CB_NOARG(cb, arg) \ OPT_NOARG, \ - cast_if_any(char *(*)(void *), (cb), &*(cb), \ + cast_if_any(char *(*)(void *), (cb), (cb)+0, \ char *(*)(typeof(*(arg))*), \ char *(*)(const typeof(*(arg))*), \ char *(*)(const void *)), \ - NULL, NULL, (arg) + NULL, NULL /* Resolves to the four parameters for arg callbacks. */ #define OPT_CB_ARG(cb, show, arg) \ OPT_HASARG, NULL, \ - cast_if_any(char *(*)(const char *,void *), (cb), &*(cb), \ + cast_if_any(char *(*)(const char *,void *), (cb), (cb)+0, \ char *(*)(const char *, typeof(*(arg))*), \ char *(*)(const char *, const typeof(*(arg))*), \ char *(*)(const char *, const void *)), \ - cast_if_type(void (*)(char buf[], const void *), (show), &*(show), \ - void (*)(char buf[], const typeof(*(arg))*)), \ - (arg) + cast_if_type(void (*)(char buf[], const void *), (show), (show)+0, \ + void (*)(char buf[], const typeof(*(arg))*)) /* Non-typesafe register function. */ -void _opt_register(const char *names, enum opt_flags flags, +void _opt_register(const char *names, enum opt_type type, char *(*cb)(void *arg), char *(*cb_arg)(const char *optarg, void *arg), void (*show)(char buf[OPT_SHOW_LEN], const void *arg), - void *arg, const char *desc); + const void *arg, const char *desc); /* We use this to get typechecking for OPT_SUBTABLE */ -static inline int _check_is_entry(struct opt_table *e) { return 0; } +static inline int _check_is_entry(struct opt_table *e UNUSED) { return 0; } #endif /* CCAN_OPT_H */