X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Fopt%2Fopt.h;fp=ccan%2Fopt%2Fopt.h;h=8bbc8f51d162c9e19c7c9bc1c480002899922719;hp=e7896340d32a5fbf56988ca13b456f6c71597860;hb=50212d0d271f967d9f5d14c116ec54c0050882a8;hpb=bb2a75f445f408e43730fc55a1a978581ebe9b96 diff --git a/ccan/opt/opt.h b/ccan/opt/opt.h index e7896340..8bbc8f51 100644 --- a/ccan/opt/opt.h +++ b/ccan/opt/opt.h @@ -31,7 +31,7 @@ struct opt_table; * OPT_WITH_ARG() */ #define OPT_WITHOUT_ARG(names, cb, arg, desc) \ - { (names), OPT_CB_NOARG((cb), (arg)), { (arg) }, (desc) } + { (names), OPT_CB_NOARG((cb), 0, (arg)), { (arg) }, (desc) } /** * OPT_WITH_ARG() - macro for initializing an opt_table entry (with arg) @@ -66,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)), { (arg) }, (desc) } + { (name), OPT_CB_ARG((cb), 0, (show), (arg)), { (arg) }, (desc) } /** * OPT_SUBTABLE() - macro for including another table inside a table. @@ -78,6 +78,39 @@ struct opt_table; 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. * @@ -129,7 +162,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)), (arg), (desc)) + _opt_register((names), OPT_CB_NOARG((cb), 0, (arg)), (arg), (desc)) /** * opt_register_arg - register an option with an arguments @@ -160,7 +193,40 @@ 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)), (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_parse - parse arguments. @@ -169,8 +235,9 @@ 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(). As this - * occurs successfully each option is removed from argc and argv. + * 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 @@ -186,10 +253,39 @@ void opt_register_table(const struct opt_table *table, const char *desc); * } * * See Also: - * opt_log_stderr, opt_log_stderr_exit + * 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_free_table - reset the opt library. * @@ -337,7 +433,8 @@ 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. */ + OPT_EARLY = 8, /* Parse this from opt_early_parse() only. */ + OPT_END = 16, /* End of the table. */ }; struct opt_table { @@ -355,8 +452,8 @@ struct opt_table { }; /* Resolves to the four parameters for non-arg callbacks. */ -#define OPT_CB_NOARG(cb, arg) \ - OPT_NOARG, \ +#define OPT_CB_NOARG(cb, pre, arg) \ + OPT_NOARG|(pre), \ typesafe_cb_cast3(char *(*)(void *), \ char *(*)(typeof(*(arg))*), \ char *(*)(const typeof(*(arg))*), \ @@ -364,8 +461,8 @@ struct opt_table { NULL, NULL /* Resolves to the four parameters for arg callbacks. */ -#define OPT_CB_ARG(cb, show, arg) \ - OPT_HASARG, NULL, \ +#define OPT_CB_ARG(cb, pre, show, arg) \ + OPT_HASARG|(pre), NULL, \ typesafe_cb_cast3(char *(*)(const char *,void *), \ char *(*)(const char *, typeof(*(arg))*), \ char *(*)(const char *, const typeof(*(arg))*), \