#ifndef CCAN_OPT_H
#define CCAN_OPT_H
+#include <ccan/compiler/compiler.h>
#include <ccan/typesafe_cb/typesafe_cb.h>
#include <stdbool.h>
-/* 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; /* slash-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)
- * @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.
*
- * 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.
*
* 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.
+ * separated by '|'. Short options are a single hyphen followed by a single
+ * character, long options are two hyphens followed by one or more characters.
*
* See Also:
* OPT_WITH_ARG()
/**
* 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
* @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
* 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.
+ * separated by '|'. Short options are a single hyphen followed by a single
+ * 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.
*
*
* This must be the final element in the opt_table array.
*/
-#define OPT_ENDTABLE { NULL, OPT_END }
+#define OPT_ENDTABLE { NULL, OPT_END, NULL, NULL, NULL, NULL, NULL }
/**
* opt_register_table - register a table of options
* ...
* 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".
+ * @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.
/**
* 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 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.
* errx(1, "BOOM! %s", optarg);
* }
* ...
- * opt_register_arg("--explode/--boom", explode, NULL, NULL, opt_hidden);
+ * 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
*
* Example:
* if (!opt_parse(&argc, argv, opt_log_stderr)) {
- * printf("%s", opt_usage(argv[0], "<args>..."));
+ * 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_free_table - free the table.
+ *
+ * This frees the internal memory. Call this as the last
+ * opt function.
+ */
+void opt_free_table(void);
+
/**
* 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);
*/
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);
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, \
- cast_if_any(char *(*)(void *), (cb), &*(cb), \
+ cast_if_any(char *(*)(void *), (cb), (cb)+0, \
char *(*)(typeof(*(arg))*), \
char *(*)(const typeof(*(arg))*), \
char *(*)(const void *)), \
/* 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), \
+ 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), \
+ cast_if_type(void (*)(char buf[], const void *), (show), (show)+0, \
void (*)(char buf[], const typeof(*(arg))*)), \
(arg)
void *arg, const char *desc);
/* We use this to get typechecking for OPT_SUBTABLE */
-static inline int _check_is_entry(struct opt_table *e) { return 0; }
+static inline int _check_is_entry(struct opt_table *e UNUSED) { return 0; }
#endif /* CCAN_OPT_H */
projects / ccan / blobdiff