X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Fopt%2Fopt.h;h=55a78d8ff139e9cbe1de384d4d1da0021557e3aa;hp=7d7bc571fc2363f40241497297bcdc32ff5f6716;hb=cf1b26db4b43f3e5a4448abcd45c424cc2207928;hpb=0191b7a74144ea8193961235f45715e715d4d8eb diff --git a/ccan/opt/opt.h b/ccan/opt/opt.h index 7d7bc571..55a78d8f 100644 --- a/ccan/opt/opt.h +++ b/ccan/opt/opt.h @@ -1,38 +1,21 @@ +/* Licensed under GPLv3+ - 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_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. */ -}; - -/* 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_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); - 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. * @@ -41,24 +24,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, desc) \ - { (names), OPT_CB_NOARG((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 @@ -70,8 +53,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. * @@ -83,7 +66,7 @@ struct opt_table { * OPT_WITHOUT_ARG() */ #define OPT_WITH_ARG(name, cb, show, arg, desc) \ - { (name), OPT_CB_ARG((cb), (show), (arg)), (desc) } + { (name), OPT_CB_ARG((cb), (show), (arg)), { (arg) }, (desc) } /** * OPT_SUBTABLE() - macro for including another table inside a table. @@ -92,14 +75,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 @@ -124,14 +108,14 @@ struct opt_table { * ... * 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. @@ -145,15 +129,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 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. @@ -172,10 +156,10 @@ void opt_register_table(const struct opt_table table[], const char *desc); * errx(1, "BOOM! %s", optarg); * } * ... - * opt_register_arg("--explode/--boom", explode, NULL, NULL, opt_hidden); + * 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. @@ -202,6 +186,16 @@ void opt_register_table(const struct opt_table table[], const char *desc); */ bool opt_parse(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_log_stderr - print message to stderr. * @fmt: printf-style format. @@ -259,6 +253,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); @@ -285,6 +282,41 @@ void opt_show_longval(char buf[OPT_SHOW_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); +/* 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); + + +void opt_show_intval_bi(char buf[OPT_SHOW_LEN], const int *x); +void opt_show_longval_bi(char buf[OPT_SHOW_LEN], const long *x); +void opt_show_longlongval_bi(char buf[OPT_SHOW_LEN], const long long *x); +void opt_show_uintval_bi(char buf[OPT_SHOW_LEN], const unsigned int *x); +void opt_show_ulongval_bi(char buf[OPT_SHOW_LEN], const unsigned long *x); +void opt_show_ulonglongval_bi(char buf[OPT_SHOW_LEN], const unsigned long long *x); + +void opt_show_intval_si(char buf[OPT_SHOW_LEN], const int *x); +void opt_show_longval_si(char buf[OPT_SHOW_LEN], const long *x); +void opt_show_longlongval_si(char buf[OPT_SHOW_LEN], const long long *x); +void opt_show_uintval_si(char buf[OPT_SHOW_LEN], const unsigned int *x); +void opt_show_ulongval_si(char buf[OPT_SHOW_LEN], const unsigned long *x); +void opt_show_ulonglongval_si(char buf[OPT_SHOW_LEN], const unsigned long long *x); + + + + /* Increment. */ char *opt_inc_intval(int *i); @@ -295,34 +327,57 @@ 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), \ - char *(*)(typeof(*(arg))*), \ - char *(*)(const typeof(*(arg))*), \ - char *(*)(const void *)), \ - NULL, NULL, (arg) + typesafe_cb_cast3(char *(*)(void *), \ + char *(*)(typeof(*(arg))*), \ + char *(*)(const typeof(*(arg))*), \ + char *(*)(const void *), (cb)), \ + 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), \ - 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) + typesafe_cb_cast3(char *(*)(const char *,void *), \ + char *(*)(const char *, typeof(*(arg))*), \ + char *(*)(const char *, const typeof(*(arg))*), \ + char *(*)(const char *, const void *), \ + (cb)), \ + typesafe_cb_cast(void (*)(char buf[], const void *), \ + void (*)(char buf[], const typeof(*(arg))*), (show)) /* Non-typesafe register function. */ 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 */