X-Git-Url: http://git.ozlabs.org/?a=blobdiff_plain;f=ccan%2Fopt%2Fopt.h;h=8796752a133f9f8d70854af0d99ba52af4d8b51c;hb=c6c779398e42756a7cb1c566e8fd23b955c4775f;hp=f9a047adb527e790339d759b388304a1de27e687;hpb=af15570a6d911f5b90fbc6f6ecfc9db9cfddcba9;p=ccan diff --git a/ccan/opt/opt.h b/ccan/opt/opt.h index f9a047ad..8796752a 100644 --- a/ccan/opt/opt.h +++ b/ccan/opt/opt.h @@ -3,27 +3,7 @@ #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; /* 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); - void *arg; - const char *desc; -}; +struct opt_table; /** * OPT_WITHOUT_ARG() - macro for initializing an opt_table entry (without arg) @@ -32,7 +12,7 @@ struct opt_table { * @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. * @@ -42,7 +22,7 @@ struct opt_table { * * 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. + * character, long options are two hyphens followed by one or more characters. * * See Also: * OPT_WITH_ARG() @@ -58,7 +38,7 @@ struct opt_table { * @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 @@ -71,7 +51,7 @@ struct opt_table { * * 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. + * 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. * @@ -124,14 +104,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". * @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. @@ -153,7 +133,7 @@ void opt_register_table(const struct opt_table table[], const char *desc); * @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. @@ -259,6 +239,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); @@ -295,6 +278,25 @@ 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); + void *arg; + const char *desc; +}; + /* Resolves to the four parameters for non-arg callbacks. */ #define OPT_CB_NOARG(cb, arg) \ OPT_NOARG, \