* OPT_WITH_ARG()
*/
#define OPT_WITHOUT_ARG(names, cb, arg, desc) \
- { (names), OPT_CB_NOARG((cb), (arg)), { (arg) }, (desc) }
+ { (names), OPT_CB_NOARG((cb), 0, (arg)), { (arg) }, (desc) }
/**
* OPT_WITH_ARG() - macro for initializing an opt_table entry (with arg)
* OPT_WITHOUT_ARG()
*/
#define OPT_WITH_ARG(name, cb, show, arg, desc) \
- { (name), OPT_CB_ARG((cb), (show), (arg)), { (arg) }, (desc) }
+ { (name), OPT_CB_ARG((cb), 0, (show), (arg)), { (arg) }, (desc) }
/**
* OPT_SUBTABLE() - macro for including another table inside a table.
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.
*
* string and return false.
*/
#define opt_register_noarg(names, cb, arg, desc) \
- _opt_register((names), OPT_CB_NOARG((cb), (arg)), (arg), (desc))
+ _opt_register((names), OPT_CB_NOARG((cb), 0, (arg)), (arg), (desc))
/**
* opt_register_arg - register an option with an arguments
* 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)), (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.
* @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(). As this
- * occurs successfully each option is removed from argc and argv.
+ * 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.
*
* If there are unknown options, missing arguments or a callback
* returns false, then an error message is printed and false is
* }
*
* 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.
*
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 {
};
/* Resolves to the four parameters for non-arg callbacks. */
-#define OPT_CB_NOARG(cb, arg) \
- OPT_NOARG, \
+#define OPT_CB_NOARG(cb, pre, arg) \
+ OPT_NOARG|(pre), \
typesafe_cb_cast3(char *(*)(void *), \
char *(*)(typeof(*(arg))*), \
char *(*)(const typeof(*(arg))*), \
NULL, NULL
/* Resolves to the four parameters for arg callbacks. */
-#define OPT_CB_ARG(cb, show, arg) \
- OPT_HASARG, NULL, \
+#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))*), \
--- /dev/null
+/* With errlog == NULL, we never get a "failure". */
+#include <ccan/tap/tap.h>
+#include <stdlib.h>
+#include <ccan/opt/opt.c>
+#include <ccan/opt/usage.c>
+#include <ccan/opt/helpers.c>
+#include <ccan/opt/parse.c>
+#include "utils.h"
+
+struct opt_table some_early_table[] = {
+ OPT_EARLY_WITHOUT_ARG("--verbose|-v", test_noarg,
+ "vvv", "Description of verbose"),
+ OPT_EARLY_WITH_ARG("--debug|-d", test_arg, show_arg,
+ "ddd", "Description of debug"),
+ OPT_WITHOUT_ARG("-h|--hhh", test_noarg, "hhh", "Description of hhh"),
+ OPT_ENDTABLE
+};
+
+int main(int argc, char *argv[])
+{
+ const char *myname = argv[0];
+
+ plan_tests(37);
+
+ /* Simple short arg.*/
+ opt_register_noarg("-a", test_noarg, NULL, "All");
+ opt_register_early_noarg("-b", test_noarg, NULL, "All");
+
+ /* Early parsing doesn't mangle. */
+ ok1(parse_early_args(&argc, &argv, "-a", NULL));
+ ok1(argc == 2);
+ ok1(argv[0] == myname);
+ ok1(strcmp(argv[1], "-a") == 0);
+ ok1(argv[2] == NULL);
+ ok1(test_cb_called == 0);
+
+ /* ... even if it processes arg. */
+ ok1(parse_early_args(&argc, &argv, "-b", NULL));
+ ok1(argc == 2);
+ ok1(argv[0] == myname);
+ ok1(strcmp(argv[1], "-b") == 0);
+ ok1(argv[2] == NULL);
+ ok1(test_cb_called == 1);
+
+ ok1(parse_early_args(&argc, &argv, "-ab", NULL));
+ ok1(argc == 2);
+ ok1(argv[0] == myname);
+ ok1(strcmp(argv[1], "-ab") == 0);
+ ok1(argv[2] == NULL);
+ ok1(test_cb_called == 2);
+
+ ok1(parse_args(&argc, &argv, "-ab", NULL));
+ ok1(argc == 1);
+ ok1(argv[0] == myname);
+ ok1(argv[1] == NULL);
+ ok1(test_cb_called == 3);
+
+ opt_register_table(some_early_table, "Some early args");
+ ok1(parse_early_args(&argc, &argv, "--verbose", "-dddd", "-h", NULL));
+ ok1(argc == 4);
+ ok1(argv[0] == myname);
+ ok1(strcmp(argv[1], "--verbose") == 0);
+ ok1(strcmp(argv[2], "-dddd") == 0);
+ ok1(strcmp(argv[3], "-h") == 0);
+ ok1(argv[4] == NULL);
+ ok1(test_cb_called == 5);
+
+ ok1(parse_args(&argc, &argv, "--verbose", "-d", "ddd", "-h", NULL));
+ ok1(argc == 1);
+ ok1(argv[0] == myname);
+ ok1(argv[1] == NULL);
+ ok1(test_cb_called == 6);
+
+ /* parse_args allocates argv */
+ free(argv);
+ return exit_status();
+}
projects / ccan / commitdiff