X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Fopt%2Fopt.h;h=65008091a0861ade804d06e8fc302bcf74a6aa51;hp=f47b1c880265a8003123cc0e609fc37d241450fc;hb=f4b1f445a7b21b1599530afb897ef54efe15479d;hpb=d7d5abe98caeec82d784ce525e0444ff438acd46 diff --git a/ccan/opt/opt.h b/ccan/opt/opt.h index f47b1c88..65008091 100644 --- a/ccan/opt/opt.h +++ b/ccan/opt/opt.h @@ -12,20 +12,22 @@ enum opt_flags { 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 *longopt; /* --longopt, or NULL */ - char shortopt; /* -s, or 0 */ + 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; }; /** * OPT_WITHOUT_ARG() - macro for initializing an opt_table entry (without arg) - * @longopt: the name of the argument (eg. "foo" for "--foo"), or NULL. - * @shortopt: the character of the argument (eg. 'f' for "-f"), or 0. + * @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. * @@ -33,64 +35,69 @@ struct opt_table { * of type "char *cb(type *)", "char *cb(const type *)" or "char *cb(void *)", * where "type" is the type of the @arg argument. * - * At least one of @longopt and @shortopt must be non-zero. If the - * @cb returns non-NULL, opt_parse() will stop parsing, use the returned - * string to form an error message, free() the string 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. + * + * 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. * * See Also: * OPT_WITH_ARG() */ -#define OPT_WITHOUT_ARG(longopt, shortopt, cb, arg) \ - (longopt), (shortopt), OPT_CB_NOARG((cb), (arg)) +#define OPT_WITHOUT_ARG(names, cb, arg) \ + (names), OPT_CB_NOARG((cb), (arg)) /** * OPT_WITH_ARG() - macro for initializing long and short option (with arg) - * @longopt: the name of the argument (eg. "foo" for "--foo "), or NULL. - * @shortopt: the character of the argument (eg. 'f' for "-f "), or 0. + * @names: the option names eg. "--foo=", "-f" or "-f/--foo ". * @cb: the callback when the option is found (along with ). - * @arg: the argument to hand to @cb. + * @show: the callback to print the value in get_usage (or NULL) + * @arg: the argument to hand to @cb and @show * * This is a typesafe wrapper for intializing a struct opt_table. The callback - * is of type "bool cb(const char *, type *)", - * "bool cb(const char *, const type *)" or "bool cb(const char *, void *)", + * 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. * - * At least one of @longopt and @shortopt must be non-zero. If the - * @cb returns false, opt_parse() will stop parsing and return false. + * 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. + * + * 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. + * 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. * * See Also: - * OPT_WITH_ARG() + * OPT_WITHOUT_ARG() */ -#define OPT_WITH_ARG(longopt, shortopt, cb, arg) \ - (longopt), (shortopt), OPT_CB_ARG((cb), (arg)) +#define OPT_WITH_ARG(name, cb, show, arg) \ + (name), OPT_CB_ARG((cb), (show), (arg)) /** * OPT_SUBTABLE() - macro for including another table inside a table. * @table: the table to include in this table. * @desc: description of this subtable (for opt_usage()) or NULL. - * - * The @desc field can be opt_table_hidden to hide the options from opt_usage(). */ #define OPT_SUBTABLE(table, desc) \ - { (const char *)(table), sizeof(_check_is_entry(table)), \ - OPT_SUBTABLE, NULL, NULL, NULL, (desc) } - -/** - * opt_table_hidden - string for undocumented option tables. - * - * This can be used as the desc option to OPT_SUBTABLE or passed to - * opt_register_table() if you want the options not to be shown by - * opt_usage(). - */ -extern const char opt_table_hidden[]; + { (const char *)(table), OPT_SUBTABLE, \ + 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, 0, OPT_END } +#define OPT_ENDTABLE { NULL, OPT_END } /** * opt_register_table - register a table of options @@ -101,9 +108,11 @@ extern const char opt_table_hidden[]; * * Example: * static struct opt_table opts[] = { - * { OPT_WITHOUT_ARG("verbose", 'v', opt_inc_intval, &verbose), + * { OPT_WITHOUT_ARG("--verbose", opt_inc_intval, &verbose), * "Verbose mode (can be specified more than once)" }, - * { OPT_WITHOUT_ARG("usage", 0, opt_usage_and_exit, + * { 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 @@ -116,8 +125,7 @@ void opt_register_table(const struct opt_table table[], const char *desc); /** * opt_register_noarg - register an option with no arguments - * @longopt: the name of the argument (eg. "foo" for "--foo"), or NULL. - * @shortopt: the character of the argument (eg. 'f' for "-f"), or 0. + * @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. @@ -125,29 +133,30 @@ void opt_register_table(const struct opt_table table[], const char *desc); * This is used for registering a single commandline option which takes * no argument. * - * The callback is of type "bool cb(type *)", "bool cb(const type *)" - * or "bool cb(void *)", where "type" is the type of the @arg + * The callback is of type "char *cb(type *)", "char *cb(const type *)" + * or "char *cb(void *)", where "type" is the type of the @arg * argument. * - * 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. */ -#define opt_register_noarg(longopt, shortopt, cb, arg, desc) \ - _opt_register((longopt), (shortopt), OPT_CB_NOARG((cb), (arg)), (desc)) +#define opt_register_noarg(names, cb, arg, desc) \ + _opt_register((names), OPT_CB_NOARG((cb), (arg)), (desc)) /** * opt_register_arg - register an option with an arguments - * @longopt: the name of the argument (eg. "foo" for "--foo"), or NULL. - * @shortopt: the character of the argument (eg. 'f' for "-f"), or 0. + * @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. * @arg: the argument to hand to @cb. * @desc: the verbose desction of the option (for opt_usage()), or NULL. * * This is used for registering a single commandline option which takes * an argument. * - * The callback is of type "bool cb(const char *, type *)", - * "bool cb(const char *, const type *)" or "bool cb(const char *, void *)", + * 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. * @@ -155,11 +164,11 @@ 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", 'e', explode_cb, NULL, + * opt_register_arg("--explode", explode_cb, NULL, * "Make the machine explode (developers only)"); */ -#define opt_register_arg(longopt, shortopt, cb, arg, desc) \ - _opt_register((longopt), (shortopt), OPT_CB_ARG((cb), (arg)), (desc)) +#define opt_register_arg(names, cb, show, arg, desc) \ + _opt_register((names), OPT_CB_ARG((cb), (show), (arg)), (desc)) /** * opt_parse - parse arguments. @@ -205,35 +214,52 @@ char *opt_invalid_argument(const char *arg); * @extra: extra details to print after the initial command, or NULL. * * Creates a usage message, with the program name, arguments, some extra details - * and a table of all the options with their descriptions. + * and a table of all the options with their descriptions. If an option has + * description opt_hidden, it is not shown here. * * The result should be passed to free(). */ char *opt_usage(const char *argv0, const char *extra); +/** + * opt_hidden - string for undocumented options. + * + * This can be used as the desc parameter if you want an option not to be + * shown by opt_usage(). + */ +extern const char opt_hidden[]; + /* Standard helpers. You can write your own: */ /* Sets the @b to true. */ 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); /* The inverse */ char *opt_set_invbool(bool *b); +void opt_show_invbool(char buf[OPT_SHOW_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); /* 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); char *opt_set_uintval(const char *arg, unsigned int *ui); +void opt_show_uintval(char buf[OPT_SHOW_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); char *opt_set_ulongval(const char *arg, unsigned long *ul); +void opt_show_ulongval(char buf[OPT_SHOW_LEN], const unsigned long *ul); /* Increment. */ char *opt_inc_intval(int *i); /* Display version string to stdout, exit(0). */ -char *opt_show_version_and_exit(const char *version); +char *opt_version_and_exit(const char *version); /* Display usage string to stdout, exit(0). */ char *opt_usage_and_exit(const char *extra); @@ -245,22 +271,25 @@ char *opt_usage_and_exit(const char *extra); cast_if_any(char *(*)(void *), (cb), &*(cb), \ char *(*)(typeof(*(arg))*), \ char *(*)(const typeof(*(arg))*), \ - char *(*)(const typeof(*(arg))*)), \ - NULL, (arg) + char *(*)(const void *)), \ + NULL, NULL, (arg) /* Resolves to the four parameters for arg callbacks. */ -#define OPT_CB_ARG(cb, arg) \ +#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 typeof(*(arg))*)), \ + char *(*)(const char *, const void *)), \ + cast_if_type(void (*)(char buf[], const void *), (show), &*(show), \ + void (*)(char buf[], const typeof(*(arg))*)), \ (arg) /* Non-typesafe register function. */ -void _opt_register(const char *longopt, char shortopt, enum opt_flags flags, +void _opt_register(const char *names, enum opt_flags flags, 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); /* We use this to get typechecking for OPT_SUBTABLE */