opt: correct description, and neaten main header order.
authorRusty Russell <rusty@rustcorp.com.au>
Tue, 18 Jan 2011 07:21:51 +0000 (17:51 +1030)
committerRusty Russell <rusty@rustcorp.com.au>
Tue, 18 Jan 2011 07:21:51 +0000 (17:51 +1030)
Reordering header makes it more readable, and we don't rely on
getopt_long any more.

ccan/opt/_info
ccan/opt/opt.h

index 0e0e0a538bac42ca4efa175e31c911d2c41c6b1a..e818b2ebdfb5813d7d23b302b691064c187a1979 100644 (file)
@@ -5,7 +5,7 @@
 /**
  * opt - simple command line parsing
  *
 /**
  * opt - simple command line parsing
  *
- * Simple but powerful command line parsing, built on top of getopt_long.
+ * Simple but powerful command line parsing.
  *
  * Example:
  * #include <ccan/opt/opt.h>
  *
  * Example:
  * #include <ccan/opt/opt.h>
index 15699e1c916952b391352060a192b166b9abbfaa..8796752a133f9f8d70854af0d99ba52af4d8b51c 100644 (file)
@@ -3,27 +3,7 @@
 #include <ccan/typesafe_cb/typesafe_cb.h>
 #include <stdbool.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; /* 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;
-};
+struct opt_table;
 
 /**
  * OPT_WITHOUT_ARG() - macro for initializing an opt_table entry (without arg)
 
 /**
  * OPT_WITHOUT_ARG() - macro for initializing an opt_table entry (without arg)
@@ -124,7 +104,7 @@ struct opt_table {
  * ...
  *     opt_register_table(opts, NULL);
  */
  * ...
  *     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
 
 /**
  * opt_register_noarg - register an option with no arguments
@@ -259,6 +239,9 @@ char *opt_usage(const char *argv0, const char *extra);
  */
 extern const char opt_hidden[];
 
  */
 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);
 /* Standard helpers.  You can write your own: */
 /* Sets the @b to true. */
 char *opt_set_bool(bool *b);
@@ -295,6 +278,25 @@ char *opt_version_and_exit(const char *version);
 char *opt_usage_and_exit(const char *extra);
 
 /* Below here are private declarations. */
 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,                                      \
 /* Resolves to the four parameters for non-arg callbacks. */
 #define OPT_CB_NOARG(cb, arg)                          \
        OPT_NOARG,                                      \