X-Git-Url: http://git.ozlabs.org/?a=blobdiff_plain;f=ccan%2Fopt%2Fopt.h;h=e7896340d32a5fbf56988ca13b456f6c71597860;hb=140cd1699215bdb2a849459644823b88ab7d42cf;hp=812fec869aeba311d27e0dd4844ab34d862a9958;hpb=66711021849dd07cd29383c9ed40ab4b9f3d1e07;p=ccan diff --git a/ccan/opt/opt.h b/ccan/opt/opt.h index 812fec86..e7896340 100644 --- a/ccan/opt/opt.h +++ b/ccan/opt/opt.h @@ -1,3 +1,4 @@ +/* Licensed under GPLv3+ - see LICENSE file for details */ #ifndef CCAN_OPT_H #define CCAN_OPT_H #include @@ -30,10 +31,10 @@ struct opt_table; * 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) + * 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) @@ -65,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. @@ -74,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, NULL, NULL, NULL, NULL, NULL } +#define OPT_ENDTABLE { NULL, OPT_END, NULL, NULL, NULL, { NULL }, NULL } /** * opt_register_table - register a table of options @@ -127,7 +129,7 @@ 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 @@ -145,8 +147,9 @@ 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 and return false. * * Example: * static char *explode(const char *optarg, void *unused) @@ -157,7 +160,7 @@ void opt_register_table(const struct opt_table *table, const char *desc); * 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. @@ -166,12 +169,15 @@ void opt_register_table(const struct opt_table *table, const char *desc); * @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_table()/opt_register_arg()/opt_register_noarg(). As this + * occurs successfully each option is removed from argc and argv. * - * On success, argc and argv are adjusted so only the non-option elements - * remain, and true is returned. + * 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 will contain only the non-option + * elements, and true is returned. * * Example: * if (!opt_parse(&argc, argv, opt_log_stderr)) { @@ -185,10 +191,12 @@ 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 - free the table. + * opt_free_table - reset the opt library. * - * This frees the internal memory. Call this as the last - * opt function. + * 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); @@ -278,6 +286,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); @@ -303,36 +346,40 @@ struct opt_table { 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; + 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)+0, \ - 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)+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)+0, \ - 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 UNUSED) { return 0; }