git.ozlabs.org Git - ccan/blob - ccan/opt/opt.h

   1 /* Licensed under GPLv2+ - see LICENSE file for details */
   2 #ifndef CCAN_OPT_H
   3 #define CCAN_OPT_H
   4 #include <ccan/compiler/compiler.h>
   5 #include <ccan/typesafe_cb/typesafe_cb.h>
   6 #include <stdbool.h>
   7 #include <stdlib.h>
   8
   9 struct opt_table;
  10
  11 /**
  12  * OPT_WITHOUT_ARG() - macro for initializing an opt_table entry (without arg)
  13  * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar".
  14  * @cb: the callback when the option is found.
  15  * @arg: the argument to hand to @cb.
  16  * @desc: the description for opt_usage(), or opt_hidden.
  17  *
  18  * This is a typesafe wrapper for initializing a struct opt_table.  The callback
  19  * of type "char *cb(type *)", "char *cb(const type *)" or "char *cb(void *)",
  20  * where "type" is the type of the @arg argument.
  21  *
  22  * If the @cb returns non-NULL, opt_parse() will stop parsing, use the
  23  * returned string to form an error message for errlog(), free() the
  24  * string (or see opt_set_alloc) and return false.
  25  *
  26  * Any number of equivalent short or long options can be listed in @names,
  27  * separated by '|'.  Short options are a single hyphen followed by a single
  28  * character, long options are two hyphens followed by one or more characters.
  29  *
  30  * See Also:
  31  *      OPT_WITH_ARG()
  32  */
  33 #define OPT_WITHOUT_ARG(names, cb, arg, desc)   \
  34         { (names), OPT_CB_NOARG((cb), 0, (arg)), { (arg) }, (desc) }
  35
  36 /**
  37  * OPT_WITH_ARG() - macro for initializing an opt_table entry (with arg)
  38  * @names: the option names eg. "--foo=<arg>", "-f" or "-f|--foo <arg>".
  39  * @cb: the callback when the option is found (along with <arg>).
  40  * @show: the callback to print the value in get_usage (or NULL)
  41  * @arg: the argument to hand to @cb and @show
  42  * @desc: the description for opt_usage(), or opt_hidden.
  43  *
  44  * This is a typesafe wrapper for initializing a struct opt_table.  The callback
  45  * is of type "char *cb(const char *, type *)",
  46  * "char *cb(const char *, const type *)" or "char *cb(const char *, void *)",
  47  * where "type" is the type of the @arg argument.  The first argument to the
  48  * @cb is the argument found on the commandline.
  49  *
  50  * Similarly, if @show is not NULL, it should be of type "void *show(char *,
  51  * const type *)".  It should write up to OPT_SHOW_LEN bytes into the first
  52  * argument; unless it uses the entire OPT_SHOW_LEN bytes it should
  53  * nul-terminate that buffer.
  54  *
  55  * Any number of equivalent short or long options can be listed in @names,
  56  * separated by '|'.  Short options are a single hyphen followed by a single
  57  * character, long options are two hyphens followed by one or more characters.
  58  * A space or equals in @names is ignored for parsing, and only used
  59  * for printing the usage.
  60  *
  61  * If the @cb returns non-NULL, opt_parse() will stop parsing, use the
  62  * returned string to form an error message for errlog(), free() the
  63  * string (or see opt_set_alloc) and return false.
  64  *
  65  * See Also:
  66  *      OPT_WITHOUT_ARG()
  67  */
  68 #define OPT_WITH_ARG(name, cb, show, arg, desc) \
  69         { (name), OPT_CB_ARG((cb), 0, (show), (arg)), { (arg) }, (desc) }
  70
  71 /**
  72  * OPT_SUBTABLE() - macro for including another table inside a table.
  73  * @table: the table to include in this table.
  74  * @desc: description of this subtable (for opt_usage()) or NULL.
  75  */
  76 #define OPT_SUBTABLE(table, desc)                                       \
  77         { (const char *)(table), OPT_SUBTABLE,                          \
  78           sizeof(_check_is_entry(table)) ? NULL : NULL, NULL, NULL,     \
  79           { NULL }, (desc) }
  80
  81 /**
  82  * OPT_EARLY_WITHOUT_ARG() - macro for a early opt_table entry (without arg)
  83  * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar".
  84  * @cb: the callback when the option is found.
  85  * @arg: the argument to hand to @cb.
  86  * @desc: the description for opt_usage(), or opt_hidden.
  87  *
  88  * This is the same as OPT_WITHOUT_ARG, but for opt_early_parse() instead of
  89  * opt_parse().
  90  *
  91  * See Also:
  92  *      OPT_EARLY_WITH_ARG(), opt_early_parse()
  93  */
  94 #define OPT_EARLY_WITHOUT_ARG(names, cb, arg, desc)     \
  95         { (names), OPT_CB_NOARG((cb), OPT_EARLY, (arg)), { (arg) }, (desc) }
  96
  97 /**
  98  * OPT_EARLY_WITH_ARG() - macro for an early opt_table entry (with arg)
  99  * @names: the option names eg. "--foo=<arg>", "-f" or "-f|--foo <arg>".
 100  * @cb: the callback when the option is found (along with <arg>).
 101  * @show: the callback to print the value in get_usage (or NULL)
 102  * @arg: the argument to hand to @cb and @show
 103  * @desc: the description for opt_usage(), or opt_hidden.
 104  *
 105  * This is the same as OPT_WITH_ARG, but for opt_early_parse() instead of
 106  * opt_parse().
 107  *
 108  * See Also:
 109  *      OPT_EARLY_WITHOUT_ARG(), opt_early_parse()
 110  */
 111 #define OPT_EARLY_WITH_ARG(name, cb, show, arg, desc)   \
 112         { (name), OPT_CB_ARG((cb), OPT_EARLY, (show), (arg)), { (arg) }, (desc) }
 113
 114 /**
 115  * OPT_ENDTABLE - macro to create final entry in table.
 116  *
 117  * This must be the final element in the opt_table array.
 118  */
 119 #define OPT_ENDTABLE { NULL, OPT_END, NULL, NULL, NULL, { NULL }, NULL }
 120
 121 /**
 122  * opt_register_table - register a table of options
 123  * @table: the table of options
 124  * @desc: description of this subtable (for opt_usage()) or NULL.
 125  *
 126  * The table must be terminated by OPT_ENDTABLE.
 127  *
 128  * Example:
 129  * static int verbose = 0;
 130  * static struct opt_table opts[] = {
 131  *      OPT_WITHOUT_ARG("--verbose", opt_inc_intval, &verbose,
 132  *                      "Verbose mode (can be specified more than once)"),
 133  *      OPT_WITHOUT_ARG("-v", opt_inc_intval, &verbose,
 134  *                      "Verbose mode (can be specified more than once)"),
 135  *      OPT_WITHOUT_ARG("--usage", opt_usage_and_exit,
 136  *                      "args...\nA silly test program.",
 137  *                      "Print this message."),
 138  *      OPT_ENDTABLE
 139  * };
 140  *
 141  * ...
 142  *      opt_register_table(opts, NULL);
 143  */
 144 void opt_register_table(const struct opt_table *table, const char *desc);
 145
 146 /**
 147  * opt_register_noarg - register an option with no arguments
 148  * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar".
 149  * @cb: the callback when the option is found.
 150  * @arg: the argument to hand to @cb.
 151  * @desc: the verbose description of the option (for opt_usage()), or NULL.
 152  *
 153  * This is used for registering a single commandline option which takes
 154  * no argument.
 155  *
 156  * The callback is of type "char *cb(type *)", "char *cb(const type *)"
 157  * or "char *cb(void *)", where "type" is the type of the @arg
 158  * argument.
 159  *
 160  * If the @cb returns non-NULL, opt_parse() will stop parsing, use the
 161  * returned string to form an error message for errlog(), free() the
 162  * string (or see opt_set_alloc) and return false.
 163  */
 164 #define opt_register_noarg(names, cb, arg, desc)                        \
 165         _opt_register((names), OPT_CB_NOARG((cb), 0, (arg)), (arg), (desc))
 166
 167 /**
 168  * opt_register_arg - register an option with an arguments
 169  * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar".
 170  * @cb: the callback when the option is found.
 171  * @show: the callback to print the value in get_usage (or NULL)
 172  * @arg: the argument to hand to @cb.
 173  * @desc: the verbose description of the option (for opt_usage()), or NULL.
 174  *
 175  * This is used for registering a single commandline option which takes
 176  * an argument.
 177  *
 178  * The callback is of type "char *cb(const char *, type *)",
 179  * "char *cb(const char *, const type *)" or "char *cb(const char *, void *)",
 180  * where "type" is the type of the @arg argument.  The first argument to the
 181  * @cb is the argument found on the commandline.
 182  *
 183  * If the @cb returns non-NULL, opt_parse() will stop parsing, use the
 184  * returned string to form an error message for errlog(), free() the
 185  * string (or see opt_set_alloc) and return false.
 186  *
 187  * Example:
 188  * static char *explode(const char *optarg, void *unused)
 189  * {
 190  *      errx(1, "BOOM! %s", optarg);
 191  * }
 192  * ...
 193  *      opt_register_arg("--explode|--boom", explode, NULL, NULL, opt_hidden);
 194  */
 195 #define opt_register_arg(names, cb, show, arg, desc)                    \
 196         _opt_register((names), OPT_CB_ARG((cb),0,(show), (arg)), (arg), (desc))
 197
 198 /**
 199  * opt_register_early_noarg - register an early option with no arguments
 200  * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar".
 201  * @cb: the callback when the option is found.
 202  * @arg: the argument to hand to @cb.
 203  * @desc: the verbose description of the option (for opt_usage()), or NULL.
 204  *
 205  * This is the same as opt_register_noarg(), but for opt_early_parse().
 206  *
 207  * See Also:
 208  *      opt_register_early_arg(), opt_early_parse()
 209  */
 210 #define opt_register_early_noarg(names, cb, arg, desc)                  \
 211         _opt_register((names), OPT_CB_NOARG((cb), OPT_EARLY, (arg)),    \
 212                       (arg), (desc))
 213
 214 /**
 215  * opt_register_early_arg - register an early option with an arguments
 216  * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar".
 217  * @cb: the callback when the option is found.
 218  * @show: the callback to print the value in get_usage (or NULL)
 219  * @arg: the argument to hand to @cb.
 220  * @desc: the verbose description of the option (for opt_usage()), or NULL.
 221  *
 222  * This is the same as opt_register_arg(), but for opt_early_parse().
 223  *
 224  * See Also:
 225  *      opt_register_early_noarg(), opt_early_parse()
 226  */
 227 #define opt_register_early_arg(names, cb, show, arg, desc)              \
 228         _opt_register((names), OPT_CB_ARG((cb), OPT_EARLY, (show),(arg)), \
 229                       (arg), (desc))
 230
 231 /**
 232  * opt_parse - parse arguments.
 233  * @argc: pointer to argc
 234  * @argv: argv array.
 235  * @errlog: the function to print errors
 236  *
 237  * This iterates through the command line and calls callbacks registered with
 238  * opt_register_arg()/opt_register_noarg() or OPT_WITHOUT_ARG/OPT_WITH_ARG
 239  * entries in tables registered with opt_register_table().  As this occurs
 240  * each option is removed from argc and argv.
 241  *
 242  * If there are unknown options, missing arguments or a callback
 243  * returns false, then an error message is printed and false is
 244  * returned: the erroneous option is not removed.
 245  *
 246  * On success, argc and argv will contain only the non-option
 247  * elements, and true is returned.
 248  *
 249  * Example:
 250  *      if (!opt_parse(&argc, argv, opt_log_stderr)) {
 251  *              printf("You screwed up, aborting!\n");
 252  *              exit(1);
 253  *      }
 254  *
 255  * See Also:
 256  *      opt_log_stderr, opt_log_stderr_exit, opt_early_parse()
 257  */
 258 bool opt_parse(int *argc, char *argv[], void (*errlog)(const char *fmt, ...));
 259
 260 /**
 261  * opt_early_parse - parse early arguments.
 262  * @argc: argc
 263  * @argv: argv array.
 264  * @errlog: the function to print errors
 265  *
 266  * There are times when you want to parse some arguments before any other
 267  * arguments; this is especially important for debugging flags (eg. --verbose)
 268  * when you have complicated callbacks in option processing.
 269  *
 270  * You can use opt_early_parse() to only parse options registered with
 271  * opt_register_earlyarg()/opt_register_early_noarg() or
 272  * OPT_EARLY_WITHOUT_ARG/OPT_EARLY_WITH_ARG entries in tables registered with
 273  * opt_register_table().
 274  *
 275  * Note that unlike opt_parse(), argc and argv are not altered.
 276  *
 277  * Example:
 278  *      if (!opt_early_parse(argc, argv, opt_log_stderr)) {
 279  *              printf("You screwed up, aborting!\n");
 280  *              exit(1);
 281  *      }
 282  *
 283  * See Also:
 284  *      opt_parse()
 285  */
 286 bool opt_early_parse(int argc, char *argv[],
 287                      void (*errlog)(const char *fmt, ...));
 288
 289 /**
 290  * opt_free_table - reset the opt library.
 291  *
 292  * This frees the internal memory and returns counters to zero.  Call
 293  * this as the last opt function to avoid memory leaks.  You can also
 294  * use this function to reset option handling to its initial state (no
 295  * options registered).
 296  */
 297 void opt_free_table(void);
 298
 299 /**
 300  * opt_set_alloc - set alloc/realloc/free function for opt to use.
 301  * @allocfn: allocator function
 302  * @reallocfn: reallocator function, ptr may be NULL, size never 0.
 303  * @freefn: free function
 304  *
 305  * By default opt uses malloc/realloc/free, and simply crashes if they fail.
 306  * You can set your own variants here.
 307  */
 308 void opt_set_alloc(void *(*allocfn)(size_t size),
 309                    void *(*reallocfn)(void *ptr, size_t size),
 310                    void (*freefn)(void *ptr));
 311
 312 /**
 313  * opt_log_stderr - print message to stderr.
 314  * @fmt: printf-style format.
 315  *
 316  * This is a helper for opt_parse, to print errors to stderr.
 317  *
 318  * See Also:
 319  *      opt_log_stderr_exit
 320  */
 321 void opt_log_stderr(const char *fmt, ...);
 322
 323 /**
 324  * opt_log_stderr_exit - print message to stderr, then exit(1)
 325  * @fmt: printf-style format.
 326  *
 327  * Just like opt_log_stderr, only then does exit(1).  This means that
 328  * when handed to opt_parse, opt_parse will never return false.
 329  *
 330  * Example:
 331  *      // This never returns false; just exits if there's an erorr.
 332  *      opt_parse(&argc, argv, opt_log_stderr_exit);
 333  */
 334 void opt_log_stderr_exit(const char *fmt, ...);
 335
 336 /**
 337  * opt_invalid_argument - helper to allocate an "Invalid argument '%s'" string
 338  * @arg: the argument which was invalid.
 339  *
 340  * This is a helper for callbacks to return a simple error string.
 341  */
 342 char *opt_invalid_argument(const char *arg);
 343
 344 /**
 345  * opt_usage - create usage message
 346  * @argv0: the program name
 347  * @extra: extra details to print after the initial command, or NULL.
 348  *
 349  * Creates a usage message, with the program name, arguments, some extra details
 350  * and a table of all the options with their descriptions.  If an option has
 351  * description opt_hidden, it is not shown here.
 352  *
 353  * The table of options is formatted such that descriptions are
 354  * wrapped on space boundaries.  If a description has a "\n" that is
 355  * left intact, and the following characters indented appropriately.
 356  * If the description begins with one or more space/tab (or has a
 357  * space or tab following a "\n") that line is output without wrapping.
 358  *
 359  * If "extra" is NULL, then the extra information is taken from any
 360  * registered option which calls opt_usage_and_exit().  This avoids duplicating
 361  * that string in the common case.
 362  *
 363  * The result should be passed to free().
 364  *
 365  * See Also:
 366  *      opt_usage_and_exit()
 367  *
 368  * Example:
 369  *      opt_register_arg("--explode|--boom", explode, NULL, NULL,
 370  *                       "This line will be wrapped by opt_usage\n"
 371  *                       "  But this won't because it's indented.");
 372  */
 373 char *opt_usage(const char *argv0, const char *extra);
 374
 375 /**
 376  * opt_hidden - string for undocumented options.
 377  *
 378  * This can be used as the desc parameter if you want an option not to be
 379  * shown by opt_usage().
 380  */
 381 extern const char opt_hidden[];
 382
 383 /* Maximum length of arg to show in opt_usage */
 384 #define OPT_SHOW_LEN 80
 385
 386 /* Standard helpers.  You can write your own: */
 387 /* Sets the @b to true. */
 388 char *opt_set_bool(bool *b);
 389 /* Sets @b based on arg: (yes/no/true/false). */
 390 char *opt_set_bool_arg(const char *arg, bool *b);
 391 void opt_show_bool(char buf[OPT_SHOW_LEN], const bool *b);
 392 /* The inverse */
 393 char *opt_set_invbool(bool *b);
 394 void opt_show_invbool(char buf[OPT_SHOW_LEN], const bool *b);
 395 /* Sets @b based on !arg: (yes/no/true/false). */
 396 char *opt_set_invbool_arg(const char *arg, bool *b);
 397
 398 /* Set a char *. */
 399 char *opt_set_charp(const char *arg, char **p);
 400 void opt_show_charp(char buf[OPT_SHOW_LEN], char *const *p);
 401
 402 /* Set an integer value, various forms.  Sets to 1 on arg == NULL. */
 403 char *opt_set_intval(const char *arg, int *i);
 404 void opt_show_intval(char buf[OPT_SHOW_LEN], const int *i);
 405 char *opt_set_uintval(const char *arg, unsigned int *ui);
 406 void opt_show_uintval(char buf[OPT_SHOW_LEN], const unsigned int *ui);
 407 char *opt_set_longval(const char *arg, long *l);
 408 void opt_show_longval(char buf[OPT_SHOW_LEN], const long *l);
 409 char *opt_set_ulongval(const char *arg, unsigned long *ul);
 410 void opt_show_ulongval(char buf[OPT_SHOW_LEN], const unsigned long *ul);
 411
 412 /* the following setting functions accept k, M, G, T, P, or E suffixes, which
 413    multiplies the numeric value by the corresponding power of 1000 or 1024
 414    (for the _si and _bi versions, respectively).
 415  */
 416 char *opt_set_intval_bi(const char *arg, int *i);
 417 char *opt_set_intval_si(const char *arg, int *i);
 418 char *opt_set_uintval_bi(const char *arg, unsigned int *u);
 419 char *opt_set_uintval_si(const char *arg, unsigned int *u);
 420 char *opt_set_longval_bi(const char *arg, long *l);
 421 char *opt_set_longval_si(const char *arg, long *l);
 422 char *opt_set_ulongval_bi(const char *arg, unsigned long *ul);
 423 char *opt_set_ulongval_si(const char *arg, unsigned long *ul);
 424 char *opt_set_longlongval_bi(const char *arg, long long *ll);
 425 char *opt_set_longlongval_si(const char *arg, long long *ll);
 426 char *opt_set_ulonglongval_bi(const char *arg, unsigned long long *ll);
 427 char *opt_set_ulonglongval_si(const char *arg, unsigned long long *ll);
 428
 429
 430 void opt_show_intval_bi(char buf[OPT_SHOW_LEN], const int *x);
 431 void opt_show_longval_bi(char buf[OPT_SHOW_LEN], const long *x);
 432 void opt_show_longlongval_bi(char buf[OPT_SHOW_LEN], const long long *x);
 433 void opt_show_uintval_bi(char buf[OPT_SHOW_LEN], const unsigned int *x);
 434 void opt_show_ulongval_bi(char buf[OPT_SHOW_LEN], const unsigned long *x);
 435 void opt_show_ulonglongval_bi(char buf[OPT_SHOW_LEN], const unsigned long long *x);
 436
 437 void opt_show_intval_si(char buf[OPT_SHOW_LEN], const int *x);
 438 void opt_show_longval_si(char buf[OPT_SHOW_LEN], const long *x);
 439 void opt_show_longlongval_si(char buf[OPT_SHOW_LEN], const long long *x);
 440 void opt_show_uintval_si(char buf[OPT_SHOW_LEN], const unsigned int *x);
 441 void opt_show_ulongval_si(char buf[OPT_SHOW_LEN], const unsigned long *x);
 442 void opt_show_ulonglongval_si(char buf[OPT_SHOW_LEN], const unsigned long long *x);
 443
 444
 445
 446
 447 /* Increment. */
 448 char *opt_inc_intval(int *i);
 449
 450 /* Display version string to stdout, exit(0). */
 451 char *opt_version_and_exit(const char *version);
 452
 453 /* Display usage string to stdout, exit(0). */
 454 char *opt_usage_and_exit(const char *extra);
 455
 456 /* Below here are private declarations. */
 457 /* You can use this directly to build tables, but the macros will ensure
 458  * consistency and type safety. */
 459 enum opt_type {
 460         OPT_NOARG = 1,          /* -f|--foo */
 461         OPT_HASARG = 2,         /* -f arg|--foo=arg|--foo arg */
 462         OPT_SUBTABLE = 4,       /* Actually, longopt points to a subtable... */
 463         OPT_EARLY = 8,          /* Parse this from opt_early_parse() only. */
 464         OPT_END = 16,           /* End of the table. */
 465 };
 466
 467 struct opt_table {
 468         const char *names; /* pipe-separated names, --longopt or -s */
 469         enum opt_type type;
 470         char *(*cb)(void *arg); /* OPT_NOARG */
 471         char *(*cb_arg)(const char *optarg, void *arg); /* OPT_HASARG */
 472         void (*show)(char buf[OPT_SHOW_LEN], const void *arg);
 473         union {
 474                 const void *carg;
 475                 void *arg;
 476                 size_t tlen;
 477         } u;
 478         const char *desc;
 479 };
 480
 481 /* Resolves to the four parameters for non-arg callbacks. */
 482 #define OPT_CB_NOARG(cb, pre, arg)                      \
 483         OPT_NOARG|(pre),                                \
 484         typesafe_cb_cast3(char *(*)(void *),    \
 485                           char *(*)(typeof(*(arg))*),   \
 486                           char *(*)(const typeof(*(arg))*),     \
 487                           char *(*)(const void *), (cb)),       \
 488         NULL, NULL
 489
 490 /* Resolves to the four parameters for arg callbacks. */
 491 #define OPT_CB_ARG(cb, pre, show, arg)                                  \
 492         OPT_HASARG|(pre), NULL,                                         \
 493         typesafe_cb_cast3(char *(*)(const char *,void *),       \
 494                           char *(*)(const char *, typeof(*(arg))*),     \
 495                           char *(*)(const char *, const typeof(*(arg))*), \
 496                           char *(*)(const char *, const void *),        \
 497                           (cb)),                                        \
 498         typesafe_cb_cast(void (*)(char buf[], const void *),            \
 499                          void (*)(char buf[], const typeof(*(arg))*), (show))
 500
 501 /* Non-typesafe register function. */
 502 void _opt_register(const char *names, enum opt_type type,
 503                    char *(*cb)(void *arg),
 504                    char *(*cb_arg)(const char *optarg, void *arg),
 505                    void (*show)(char buf[OPT_SHOW_LEN], const void *arg),
 506                    const void *arg, const char *desc);
 507
 508 /* We use this to get typechecking for OPT_SUBTABLE */
 509 static inline int _check_is_entry(struct opt_table *e UNUSED) { return 0; }
 510
 511 #endif /* CCAN_OPT_H */