X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Fopt%2Fopt.h;h=3dd4edc640b268fd4ad8fa76eff578d6f941807b;hp=8796752a133f9f8d70854af0d99ba52af4d8b51c;hb=79715b8c08446fe5e74d2ab9e9db00175169eab3;hpb=1b2efd5679452d03ff7a0dacb496eb3830b37434

diff --git a/ccan/opt/opt.h b/ccan/opt/opt.h
index 8796752a..3dd4edc6 100644
--- a/ccan/opt/opt.h
+++ b/ccan/opt/opt.h
@@ -1,7 +1,10 @@
+/* Licensed under GPLv2+ - see LICENSE file for details */
 #ifndef CCAN_OPT_H
 #define CCAN_OPT_H
+#include <ccan/compiler/compiler.h>
 #include <ccan/typesafe_cb/typesafe_cb.h>
 #include <stdbool.h>
+#include <stdlib.h>
 
 struct opt_table;
 
@@ -18,7 +21,7 @@ struct opt_table;
  *
  * 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.
+ * string (or see opt_set_alloc) 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
@@ -28,10 +31,10 @@ struct opt_table;
  *	OPT_WITH_ARG()
  */
 #define OPT_WITHOUT_ARG(names, cb, arg, desc)	\
-	{ (names), OPT_CB_NOARG((cb), (arg)), (desc) }
+	{ (names), OPT_CB_NOARG((cb), 0, (arg)), { (arg) }, (desc) }
 
 /**
- * OPT_WITH_ARG() - macro for initializing long and short option (with arg)
+ * OPT_WITH_ARG() - macro for initializing an opt_table entry (with 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)
@@ -57,13 +60,13 @@ struct opt_table;
  *
  * 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.
+ * string (or see opt_set_alloc) and return false.
  *
  * See Also:
  *	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), 0, (show), (arg)), { (arg) }, (desc) }
 
 /**
  * OPT_SUBTABLE() - macro for including another table inside a table.
@@ -72,14 +75,48 @@ struct opt_table;
  */
 #define OPT_SUBTABLE(table, desc)					\
 	{ (const char *)(table), OPT_SUBTABLE,				\
-	sizeof(_check_is_entry(table)) ? NULL : NULL, NULL, NULL, NULL, (desc) }
+	  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=<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 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.
  *
  * 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
@@ -122,10 +159,10 @@ void opt_register_table(const struct opt_table *table, const char *desc);
  *
  * 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.
+ * string (or see opt_set_alloc) and return false.
  */
 #define opt_register_noarg(names, cb, arg, desc)			\
-	_opt_register((names), OPT_CB_NOARG((cb), (arg)), (desc))
+	_opt_register((names), OPT_CB_NOARG((cb), 0, (arg)), (arg), (desc))
 
 /**
  * opt_register_arg - register an option with an arguments
@@ -143,8 +180,9 @@ void opt_register_table(const struct opt_table *table, const char *desc);
  * where "type" is the type of the @arg argument.  The first argument to the
  * @cb is the argument found on the commandline.
  *
- * 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 (or see opt_set_alloc) and return false.
  *
  * Example:
  * static char *explode(const char *optarg, void *unused)
@@ -155,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)), (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.
@@ -164,12 +235,16 @@ 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().  If there
- * are unknown options, missing arguments or a callback returns false, then
- * an error message is printed and false is returned.
+ * 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.
  *
- * On success, argc and argv are adjusted so only the non-option elements
- * remain, and true is returned.
+ * If there are unknown options, missing arguments or a callback
+ * returns false, then an error message is printed and false is
+ * returned: the erroneous option is not removed.
+ *
+ * On success, argc and argv will contain only the non-option
+ * elements, and true is returned.
  *
  * Example:
  *	if (!opt_parse(&argc, argv, opt_log_stderr)) {
@@ -178,10 +253,62 @@ 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.
+ *
+ * This frees the internal memory and returns counters to zero.  Call
+ * this as the last opt function to avoid memory leaks.  You can also
+ * use this function to reset option handling to its initial state (no
+ * options registered).
+ */
+void opt_free_table(void);
+
+/**
+ * opt_set_alloc - set alloc/realloc/free function for opt to use.
+ * @allocfn: allocator function
+ * @reallocfn: reallocator function, ptr may be NULL, size never 0.
+ * @freefn: free function
+ *
+ * By default opt uses malloc/realloc/free, and simply crashes if they fail.
+ * You can set your own variants here.
+ */
+void opt_set_alloc(void *(*allocfn)(size_t size),
+		   void *(*reallocfn)(void *ptr, size_t size),
+		   void (*freefn)(void *ptr));
+
 /**
  * opt_log_stderr - print message to stderr.
  * @fmt: printf-style format.
@@ -223,11 +350,25 @@ char *opt_invalid_argument(const char *arg);
  * and a table of all the options with their descriptions.  If an option has
  * description opt_hidden, it is not shown here.
  *
+ * The table of options is formatted such that descriptions are
+ * wrapped on space boundaries.  If a description has a "\n" that is
+ * left intact, and the following characters indented appropriately.
+ * If the description begins with one or more space/tab (or has a
+ * space or tab following a "\n") that line is output without wrapping.
+ *
  * 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().
+ *
+ * See Also:
+ *	opt_usage_and_exit()
+ *
+ * Example:
+ *	opt_register_arg("--explode|--boom", explode, NULL, NULL,
+ *			 "This line will be wrapped by opt_usage\n"
+ *			 "  But this won't because it's indented.");
  */
 char *opt_usage(const char *argv0, const char *extra);
 
@@ -268,6 +409,41 @@ void opt_show_longval(char buf[OPT_SHOW_LEN], const long *l);
 char *opt_set_ulongval(const char *arg, unsigned long *ul);
 void opt_show_ulongval(char buf[OPT_SHOW_LEN], const unsigned long *ul);
 
+/* the following setting functions accept k, M, G, T, P, or E suffixes, which
+   multiplies the numeric value by the corresponding power of 1000 or 1024
+   (for the _si and _bi versions, respectively).
+ */
+char *opt_set_intval_bi(const char *arg, int *i);
+char *opt_set_intval_si(const char *arg, int *i);
+char *opt_set_uintval_bi(const char *arg, unsigned int *u);
+char *opt_set_uintval_si(const char *arg, unsigned int *u);
+char *opt_set_longval_bi(const char *arg, long *l);
+char *opt_set_longval_si(const char *arg, long *l);
+char *opt_set_ulongval_bi(const char *arg, unsigned long *ul);
+char *opt_set_ulongval_si(const char *arg, unsigned long *ul);
+char *opt_set_longlongval_bi(const char *arg, long long *ll);
+char *opt_set_longlongval_si(const char *arg, long long *ll);
+char *opt_set_ulonglongval_bi(const char *arg, unsigned long long *ll);
+char *opt_set_ulonglongval_si(const char *arg, unsigned long long *ll);
+
+
+void opt_show_intval_bi(char buf[OPT_SHOW_LEN], const int *x);
+void opt_show_longval_bi(char buf[OPT_SHOW_LEN], const long *x);
+void opt_show_longlongval_bi(char buf[OPT_SHOW_LEN], const long long *x);
+void opt_show_uintval_bi(char buf[OPT_SHOW_LEN], const unsigned int *x);
+void opt_show_ulongval_bi(char buf[OPT_SHOW_LEN], const unsigned long *x);
+void opt_show_ulonglongval_bi(char buf[OPT_SHOW_LEN], const unsigned long long *x);
+
+void opt_show_intval_si(char buf[OPT_SHOW_LEN], const int *x);
+void opt_show_longval_si(char buf[OPT_SHOW_LEN], const long *x);
+void opt_show_longlongval_si(char buf[OPT_SHOW_LEN], const long long *x);
+void opt_show_uintval_si(char buf[OPT_SHOW_LEN], const unsigned int *x);
+void opt_show_ulongval_si(char buf[OPT_SHOW_LEN], const unsigned long *x);
+void opt_show_ulonglongval_si(char buf[OPT_SHOW_LEN], const unsigned long long *x);
+
+
+
+
 /* Increment. */
 char *opt_inc_intval(int *i);
 
@@ -284,7 +460,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 {
@@ -293,38 +470,42 @@ struct opt_table {
 	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;
+	union {
+		const void *carg;
+		void *arg;
+		size_t tlen;
+	} u;
 	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)+0,	\
-		    char *(*)(typeof(*(arg))*),		\
-		    char *(*)(const typeof(*(arg))*),	\
-		    char *(*)(const void *)),		\
-	NULL, NULL, (arg)
+#define OPT_CB_NOARG(cb, pre, arg)			\
+	OPT_NOARG|(pre),				\
+	typesafe_cb_cast3(char *(*)(void *),	\
+			  char *(*)(typeof(*(arg))*),	\
+			  char *(*)(const typeof(*(arg))*),	\
+			  char *(*)(const void *), (cb)),	\
+	NULL, NULL
 
 /* 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)+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)+0, \
-		     void (*)(char buf[], const typeof(*(arg))*)),	\
-	(arg)
+#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))*), \
+			  char *(*)(const char *, const void *),	\
+			  (cb)),					\
+	typesafe_cb_cast(void (*)(char buf[], const void *),		\
+			 void (*)(char buf[], const typeof(*(arg))*), (show))
 
 /* Non-typesafe register function. */
 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),
-		   void *arg, const char *desc);
+		   const 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 */