opt: allow const arguments.
[ccan] / ccan / opt / opt.h
index 15699e1c916952b391352060a192b166b9abbfaa..539a0a664de155962f3d2efdf116eca52d25fcee 100644 (file)
@@ -1,29 +1,11 @@
 #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>
 
-/* 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)
@@ -48,7 +30,7 @@ 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), (arg)), { (arg) }, (desc) }
 
 /**
  * OPT_WITH_ARG() - macro for initializing long and short option (with arg)
@@ -83,7 +65,7 @@ struct opt_table {
  *     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), (show), (arg)), { (arg) }, (desc) }
 
 /**
  * OPT_SUBTABLE() - macro for including another table inside a table.
@@ -92,14 +74,15 @@ 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_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
@@ -124,7 +107,7 @@ struct opt_table {
  * ...
  *     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
@@ -145,7 +128,7 @@ void opt_register_table(const struct opt_table table[], const char *desc);
  * string 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), (arg)), (arg), (desc))
 
 /**
  * opt_register_arg - register an option with an arguments
@@ -175,7 +158,7 @@ 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), (show), (arg)), (arg), (desc))
 
 /**
  * opt_parse - parse arguments.
@@ -202,6 +185,14 @@ void opt_register_table(const struct opt_table table[], const char *desc);
  */
 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.
@@ -259,6 +250,9 @@ 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);
@@ -295,6 +289,29 @@ char *opt_version_and_exit(const char *version);
 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);
+       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,                                      \
@@ -302,7 +319,7 @@ char *opt_usage_and_exit(const char *extra);
                    char *(*)(typeof(*(arg))*),         \
                    char *(*)(const typeof(*(arg))*),   \
                    char *(*)(const void *)),           \
-       NULL, NULL, (arg)
+       NULL, NULL
 
 /* Resolves to the four parameters for arg callbacks. */
 #define OPT_CB_ARG(cb, show, arg)                                      \
@@ -312,17 +329,16 @@ char *opt_usage_and_exit(const char *extra);
                    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)
+                    void (*)(char buf[], const typeof(*(arg))*))
 
 /* 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 */