/* 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_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. */
};
#define OPT_SHOW_LEN 80
struct opt_table {
- const char *names; /* slash-separated names, --longopt or -s */
+ 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 */
/**
* 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.
* 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
+ * 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(names, cb, arg, desc) \
- (names), OPT_CB_NOARG((cb), (arg)), (desc)
+ { (names), OPT_CB_NOARG((cb), (arg)), (desc) }
/**
* OPT_WITH_ARG() - macro for initializing long and short option (with arg)
- * @names: the option names eg. "--foo=<arg>", "-f" or "-f
/--foo <arg>".
+ * @names: the option names eg. "--foo=<arg>", "-f" or "-f
|--foo <arg>".
* @cb: the callback when the option is found (along with <arg>).
* @show: the callback to print the value in get_usage (or NULL)
* @arg: the argument to hand to @cb and @show
* 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
+ * 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.
* 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)), (desc) }
/**
* OPT_SUBTABLE() - macro for including another table inside a table.
* The table must be terminated by OPT_ENDTABLE.
*
* Example:
+ * static int verbose = 0;
* static struct opt_table opts[] = {
- * { OPT_WITHOUT_ARG("--verbose", opt_inc_intval, &verbose),
- * "Verbose mode (can be specified more than once)" },
- * { 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_WITHOUT_ARG("--verbose", opt_inc_intval, &verbose,
+ * "Verbose mode (can be specified more than once)"),
+ * 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
* };
*
/**
* 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.
/**
* 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 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.
*
* @cb returns false, opt_parse() will stop parsing and return false.
*
* Example:
- * opt_register_arg("--explode", explode_cb, NULL,
- * "Make the machine explode (developers only)");
+ * static char *explode(const char *optarg, void *unused)
+ * {
+ * errx(1, "BOOM! %s", optarg);
+ * }
+ * ...
+ * 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_parse - parse arguments.
* @argc: pointer to argc
* @argv: argv array.
- * @errlog: the function to print errors (usually opt_log_stderr).
+ * @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
* remain, and true is returned.
*
* Example:
- * if (!opt_parse(argc, argv, opt_log_stderr)) {
- * printf("%s", opt_usage(argv[0], "<args>..."));
+ * if (!opt_parse(&argc, argv, opt_log_stderr)) {
+ * printf("You screwed up, aborting!\n");
* exit(1);
* }
+ *
+ * See Also:
+ * opt_log_stderr, opt_log_stderr_exit
*/
bool opt_parse(int *argc, char *argv[], void (*errlog)(const char *fmt, ...));
* opt_log_stderr - print message to stderr.
* @fmt: printf-style format.
*
- * This is the standard helper for opt_parse, to print errors.
+ * This is a helper for opt_parse, to print errors to stderr.
+ *
+ * See Also:
+ * opt_log_stderr_exit
*/
void opt_log_stderr(const char *fmt, ...);
+/**
+ * opt_log_stderr_exit - print message to stderr, then exit(1)
+ * @fmt: printf-style format.
+ *
+ * Just like opt_log_stderr, only then does exit(1). This means that
+ * when handed to opt_parse, opt_parse will never return false.
+ *
+ * Example:
+ * // This never returns false; just exits if there's an erorr.
+ * opt_parse(&argc, argv, opt_log_stderr_exit);
+ */
+void opt_log_stderr_exit(const char *fmt, ...);
+
/**
* opt_invalid_argument - helper to allocate an "Invalid argument '%s'" string
* @arg: the argument which was invalid.
* and a table of all the options with their descriptions. If an option has
* description opt_hidden, it is not shown here.
*
+ * If "extra" is NULL, then the extra information is taken from any
+ * registered option which calls opt_usage_and_exit(). This avoids duplicating
+ * that string in the common case.
+ *
* The result should be passed to free().
*/
char *opt_usage(const char *argv0, const char *extra);
projects / ccan / blobdiff