ucw/opt.h

   1 /*
   2  *      UCW Library -- Parsing of command line options
   3  *
   4  *      (c) 2013 Jan Moskyto Matejka <mq@ucw.cz>
   5  *
   6  *      This software may be freely distributed and used according to the terms
   7  *      of the GNU Lesser General Public License.
   8  */
   9
  10 #ifndef _UCW_OPT_H
  11 #define _UCW_OPT_H
  12
  13 #include <ucw/lib.h>
  14 #include <ucw/conf.h>
  15
  16 #include <stdlib.h>
  17 #include <stdio.h>
  18
  19 #define OPT_EXIT_BAD_ARGS 2
  20
  21 /***
  22  * [[opt]]
  23  ***/
  24
  25 enum opt_class {
  26   OPT_CL_END,     // end of list
  27   OPT_CL_BOOL,    // boolean value
  28   OPT_CL_STATIC,  // static value
  29   OPT_CL_SWITCH,  // lookup/switch
  30   OPT_CL_INC,     // incremental value
  31   OPT_CL_CALL,    // call a function
  32   OPT_CL_USER,    // user defined value
  33   OPT_CL_SECTION, // subsection
  34   OPT_CL_HELP,    // help line
  35 };
  36
  37 struct opt_section;
  38 struct opt_item {
  39   const char * name;                    // long-op
  40   void * ptr;                           // where to save
  41   const char * help;                    // description in --help
  42   union opt_union {
  43     struct opt_section * section;       // subsection for OPT_SECTION
  44     int value;                          // value for OPT_SWITCH
  45     void (* call)(struct opt_item * opt, const char * value, void * data);  // function to call for OPT_CALL
  46     struct cf_user_type * utype;        // specification of the user-defined type
  47   } u;
  48   const char letter;                    // short-op
  49   byte flags;
  50   byte cls;                             // enum opt_class
  51   byte type;                            // enum cf_type
  52 };
  53
  54 struct opt_section {
  55   struct opt_item * opt;
  56 };
  57
  58 #define OPT_ITEMS       .opt = ( struct opt_item[] )  /** List of sub-items. **/
  59
  60 /***
  61  * Sub-items to be enclosed in OPT_ITEMS { } list
  62  * ----------------------------------------------
  63  *
  64  *  OPT_HELP_OPTION declares --help and prints a line about that
  65  *  OPT_HELP prints a line into help
  66  *  OPT_HELP2 prints two strings onto a line using the same tab structure as the option listing
  67  *  OPT_BOOL declares boolean option with an auto-negation (--sth and --no-sth). It's also possible to write --sth=y/yes/true/1/n/no/false/0.
  68  *  OPT_STRING, OPT_UNS, OPT_INT declare simple string/uns/int option
  69  *  OPT_SWITCH declares one choice of a switch statement; these have common target and different `value`s; last wins unless OPT_SINGLE is set;
  70  *             parser fails if it matches an OPT_SWITCH with OPT_SINGLE set and also target set.
  71  *             Target must be of signed integer type; it is set to -1 if no switch appears at the command-line.
  72  *  OPT_CALL calls the given function with an argument, giving also the opt_item structure and some custom data.
  73  *  OPT_USER declares a custom type of value defined by the given @cf_user_type in @ttype
  74  *  OPT_INC declares an incremental value like -v/--verbose
  75  *  OPT_SECTION declares a subsection
  76  *
  77  ***/
  78
  79 #define OPT_HELP_OPTION OPT_CALL(0, "help", opt_show_help_internal, NULL, OPT_NO_VALUE, "Show this help")
  80 #define OPT_HELP(line) { .help = line, .cls = OPT_CL_HELP }
  81 #define OPT_BOOL(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = &target, .help = desc, .flags = fl, .cls = OPT_CL_BOOL, .type = CT_INT }
  82 #define OPT_STRING(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, char **), .help = desc, .flags = fl, .cls = OPT_CL_STATIC, .type = CT_STRING }
  83 #define OPT_U64(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, u64 *), .help = desc, .flags = fl, .cls = OPT_CL_STATIC, .type = CT_U64 }
  84 #define OPT_INT(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, int *), .help = desc, .flags = fl, .cls = OPT_CL_STATIC, .type = CT_INT }
  85 #define OPT_DOUBLE(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, double *), .help = desc, .flags = fl, .cls = OPT_CL_STATIC, .type = CT_DOUBLE }
  86 #define OPT_IP(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, u32 *), .help = desc, .flags = fl, .cls = OPT_CL_STATIC, .type = CT_IP }
  87 #define OPT_SWITCH(shortopt, longopt, target, val, fl, desc) { .letter = shortopt, .name = longopt, .ptr = CHECK_PTR_TYPE(&target, int *), .help = desc, .flags = fl, .cls = OPT_CL_SWITCH, .type = CT_LOOKUP, .u.value = val }
  88 #define OPT_CALL(shortopt, longopt, fn, data, fl, desc) { .letter = shortopt, .name = longopt, .ptr = data, .help = desc, .u.call = fn, .flags = fl, .cls = OPT_CL_CALL, .type = CT_USER }
  89 #define OPT_USER(shortopt, longopt, target, ttype, fl, desc) { .letter = shortopt, .name = longopt, .ptr = &target, .u.utype = &ttype, .flags = fl, .help = desc, .cls = OPT_CL_USER, .type = CT_USER }
  90 #define OPT_INC(shortopt, longopt, target, fl, desc) { .letter = shortopt, .name = longopt, .ptr = &target, .flags = fl, .help = desc, .cls = OPT_CL_INC, .type = CT_INT }
  91 #define OPT_SECTION(sec) { .cls = OPT_CL_SECTION, .u.section = &sec }
  92 #define OPT_END { .cls = OPT_CL_END }
  93
  94 /***
  95  * Flags for the preceeding calls
  96  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  97  ***/
  98
  99 #define OPT_REQUIRED        0x1         /** Argument must appear at the command line **/
 100 #define OPT_REQUIRED_VALUE  0x2         /** Argument must have a value **/
 101 #define OPT_NO_VALUE        0x4         /** Argument must have no value **/
 102 #define OPT_MAYBE_VALUE     0x8         /** Argument may have a value **/
 103 #define OPT_VALUE_FLAGS     (OPT_REQUIRED_VALUE | OPT_NO_VALUE | OPT_MAYBE_VALUE)
 104 #define OPT_NEGATIVE        0x10        /** Reversing the effect of OPT_INC or saving @false into OPT_BOOL **/
 105 #define OPT_SINGLE          0x20        /** Argument must appear at most once **/
 106 #define OPT_NO_HELP         0x40        /** Omit this line from help **/
 107 #define OPT_LAST_ARG        0x80        /** Stop processing argv after this line **/
 108
 109 /***
 110  * Value flags defaults
 111  * ~~~~~~~~~~~~~~~~~~~~
 112  *
 113  * OPT_NO_VALUE for OPT_BOOL, OPT_SWITCH and OPT_INC
 114  * OPT_MAYBE_VALUE for OPT_STRING, OPT_UNS, OPT_INT
 115  * Some of the value flags (OPT_NO_VALUE, OPT_MAYBE_VALUE, OPT_REQUIRED_VALUE)
 116  * must be specified for OPT_CALL and OPT_USER.
 117  ***/
 118
 119 static uns opt_default_value_flags[] = {
 120   [OPT_CL_BOOL] = OPT_NO_VALUE,
 121   [OPT_CL_STATIC] = OPT_MAYBE_VALUE,
 122   [OPT_CL_SWITCH] = OPT_NO_VALUE,
 123   [OPT_CL_INC] = OPT_NO_VALUE,
 124   [OPT_CL_CALL] = 0,
 125   [OPT_CL_USER] = 0,
 126   [OPT_CL_SECTION] = 0,
 127   [OPT_CL_HELP] = 0
 128 };
 129
 130 extern const struct opt_section * opt_section_root;
 131 void opt_help_noexit_internal(const struct opt_section * help);
 132
 133 static void opt_help_noexit(void) {
 134   opt_help_noexit_internal(opt_section_root);
 135 }
 136
 137 static void opt_usage_noexit(void) {
 138   fprintf(stderr, "Run with argument --help for more information.\n");
 139 }
 140
 141 static void opt_show_help_internal(struct opt_item * opt UNUSED, const char * value UNUSED, void * data UNUSED) {
 142   opt_help_noexit();
 143   exit(0);
 144 }
 145
 146 static void opt_help(void) {
 147   opt_help_noexit();
 148   exit(1);
 149 }
 150
 151 static void opt_usage(void) {
 152   opt_usage_noexit();
 153   exit(1);
 154 }
 155
 156 /**
 157  * Positional argument handler to be given to opt_parse()
 158  **/
 159 typedef void opt_positional(const char * str);
 160
 161 /**
 162  * Parse all the arguments. Run the @callback for each of the positional argument.
 163  **/
 164 void opt_parse(const struct opt_section * options, char ** argv, opt_positional * callback);
 165
 166 #endif