X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Fopt%2Fopt.h;h=f9a047adb527e790339d759b388304a1de27e687;hp=74bda85bf348b1fc22c5f5cf7a5b81939f6ffb07;hb=af15570a6d911f5b90fbc6f6ecfc9db9cfddcba9;hpb=f8b1841d26dabd23c053f5fc61dbd1536cdad43c;ds=sidebyside

diff --git a/ccan/opt/opt.h b/ccan/opt/opt.h
index 74bda85b..f9a047ad 100644
--- a/ccan/opt/opt.h
+++ b/ccan/opt/opt.h
@@ -5,9 +5,9 @@
 
 /* You can use this directly to build tables, but the macros will ensure
  * consistency and type safety. */
-enum opt_flags {
-	OPT_NOARG = 1,		/* -f/--foo */
-	OPT_HASARG = 2,		/* -f arg/--foo=arg/--foo arg */
+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. */
 };
@@ -16,9 +16,8 @@ enum opt_flags {
 #define OPT_SHOW_LEN 80
 
 struct opt_table {
-	const char *longopt; /* --longopt, or NULL */
-	char shortopt; /* -s, or 0 */
-	enum opt_flags flags;
+	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);
@@ -28,32 +27,36 @@ struct opt_table {
 
 /**
  * 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.
+ * @desc: the description for opt_usage(), or opt_hidden.
  *
  * This is a typesafe wrapper for intializing 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.
  *
- * 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, desc)	\
+	{ (names), OPT_CB_NOARG((cb), (arg)), (desc) }
 
 /**
  * OPT_WITH_ARG() - macro for initializing long and short option (with arg)
- * @longopt: the name of the argument (eg. "foo" for "--foo <arg>"), or NULL.
- * @shortopt: the character of the argument (eg. 'f' for "-f <arg>"), or 0.
+ * @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
  * is of type "char *cb(const char *, type *)",
@@ -66,41 +69,37 @@ struct opt_table {
  * argument; unless it uses the entire OPT_SHOW_LEN bytes it should
  * nul-terminate that buffer.
  *
- * At least one of @longopt and @shortopt must be non-zero.  If the
- * @cb returns false, opt_parse() will stop parsing 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.
+ * 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_WITHOUT_ARG()
  */
-#define OPT_WITH_ARG(longopt, shortopt, cb, show, arg)	\
-	(longopt), (shortopt), OPT_CB_ARG((cb), (show), (arg))
+#define OPT_WITH_ARG(name, cb, show, arg, desc)	\
+	{ (name), OPT_CB_ARG((cb), (show), (arg)), (desc) }
 
 /**
  * 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, 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
@@ -110,12 +109,15 @@ extern const char opt_table_hidden[];
  * The table must be terminated by OPT_ENDTABLE.
  *
  * Example:
+ * static int verbose = 0;
  * static struct opt_table opts[] = {
- * 	{ OPT_WITHOUT_ARG("verbose", 'v', opt_inc_intval, &verbose),
- * 	  "Verbose mode (can be specified more than once)" },
- * 	{ OPT_WITHOUT_ARG("usage", 0, 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
  * };
  *
@@ -126,8 +128,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.
@@ -139,18 +140,18 @@ void opt_register_table(const struct opt_table table[], const char *desc);
  * 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.
+ * @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.
  *
@@ -166,17 +167,21 @@ 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,
- *			 "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(longopt, shortopt, cb, show, arg, desc)	\
-   _opt_register((longopt), (shortopt), OPT_CB_ARG((cb), (show), (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.
  * @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
@@ -187,10 +192,13 @@ void opt_register_table(const struct opt_table table[], const char *desc);
  * 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, ...));
 
@@ -198,10 +206,26 @@ 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.
@@ -216,12 +240,25 @@ 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.
+ *
+ * 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);
 
+/**
+ * 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);
@@ -261,7 +298,7 @@ char *opt_usage_and_exit(const char *extra);
 /* 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 *)),		\
@@ -270,16 +307,16 @@ char *opt_usage_and_exit(const char *extra);
 /* 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)
 
 /* Non-typesafe register function. */
-void _opt_register(const char *longopt, char shortopt, enum opt_flags flags,
+void _opt_register(const char *names, enum opt_type type,
 		   char *(*cb)(void *arg),
 		   char *(*cb_arg)(const char *optarg, void *arg),
 		   void (*show)(char buf[OPT_SHOW_LEN], const void *arg),