include/isl/arg.h

   1 /*
   2  * Copyright 2008-2009 Katholieke Universiteit Leuven
   3  *
   4  * Use of this software is governed by the GNU LGPLv2.1 license
   5  *
   6  * Written by Sven Verdoolaege, K.U.Leuven, Departement
   7  * Computerwetenschappen, Celestijnenlaan 200A, B-3001 Leuven, Belgium
   8  */
   9
  10 #ifndef ISL_ARG_H
  11 #define ISL_ARG_H
  12
  13 #include <stddef.h>
  14 #include <stdlib.h>
  15
  16 #if defined(__cplusplus)
  17 extern "C" {
  18 #endif
  19
  20 struct isl_arg_choice {
  21         const char      *name;
  22         unsigned         value;
  23 };
  24
  25 struct isl_arg_flags {
  26         const char      *name;
  27         unsigned         mask;
  28         unsigned         value;
  29 };
  30
  31 enum isl_arg_type {
  32         isl_arg_end,
  33         isl_arg_alias,
  34         isl_arg_arg,
  35         isl_arg_bool,
  36         isl_arg_child,
  37         isl_arg_choice,
  38         isl_arg_flags,
  39         isl_arg_user,
  40         isl_arg_long,
  41         isl_arg_ulong,
  42         isl_arg_str,
  43         isl_arg_version
  44 };
  45
  46 struct isl_arg {
  47         enum isl_arg_type        type;
  48         char                     short_name;
  49         const char              *long_name;
  50         const char              *argument_name;
  51         size_t                   offset;
  52         const char              *help_msg;
  53 #define ISL_ARG_SINGLE_DASH     (1 << 0)
  54 #define ISL_ARG_BOOL_ARG        (1 << 1)
  55 #define ISL_ARG_HIDDEN          (1 << 2)
  56         unsigned                 flags;
  57         union {
  58         struct {
  59                 struct isl_arg_choice   *choice;
  60                 unsigned                 default_value;
  61                 unsigned                 default_selected;
  62                 int (*set)(void *opt, unsigned val);
  63         } choice;
  64         struct {
  65                 struct isl_arg_flags    *flags;
  66                 unsigned                 default_value;
  67         } flags;
  68         struct {
  69                 unsigned                 default_value;
  70                 int (*set)(void *opt, unsigned val);
  71         } b;
  72         struct {
  73                 long                    default_value;
  74                 long                    default_selected;
  75                 int (*set)(void *opt, long val);
  76         } l;
  77         struct {
  78                 unsigned long           default_value;
  79         } ul;
  80         struct {
  81                 const char              *default_value;
  82         } str;
  83         struct {
  84                 struct isl_arg          *child;
  85                 size_t                   size;
  86         } child;
  87         struct {
  88                 void (*print_version)(void);
  89         } version;
  90         struct {
  91                 int (*init)(void*);
  92                 void (*clear)(void*);
  93         } user;
  94         } u;
  95 };
  96
  97 #define ISL_ARG_ALIAS(l)        {                                       \
  98         .type = isl_arg_alias,                                          \
  99         .long_name = l,                                                 \
 100 },
 101 #define ISL_ARG_ARG(st,f,a,d)   {                                       \
 102         .type = isl_arg_arg,                                            \
 103         .argument_name = a,                                             \
 104         .offset = offsetof(st, f),                                      \
 105         .u = { .str = { .default_value = d } }                          \
 106 },
 107 #define ISL_ARG_CHOICE(st,f,s,l,c,d,h)  {                               \
 108         .type = isl_arg_choice,                                         \
 109         .short_name = s,                                                \
 110         .long_name = l,                                                 \
 111         .offset = offsetof(st, f),                                      \
 112         .help_msg = h,                                                  \
 113         .u = { .choice = { .choice = c, .default_value = d,             \
 114                             .default_selected = d, .set = NULL } }      \
 115 },
 116 #define ISL_ARG_OPT_CHOICE(st,f,s,l,c,d,ds,h)   {                       \
 117         .type = isl_arg_choice,                                         \
 118         .short_name = s,                                                \
 119         .long_name = l,                                                 \
 120         .offset = offsetof(st, f),                                      \
 121         .help_msg = h,                                                  \
 122         .u = { .choice = { .choice = c, .default_value = d,             \
 123                             .default_selected = ds, .set = NULL } }     \
 124 },
 125 #define ISL_ARG_USER_OPT_CHOICE(st,f,s,l,c,setter,d,ds,h)       {       \
 126         .type = isl_arg_choice,                                         \
 127         .short_name = s,                                                \
 128         .long_name = l,                                                 \
 129         .offset = offsetof(st, f),                                      \
 130         .help_msg = h,                                                  \
 131         .u = { .choice = { .choice = c, .default_value = d,             \
 132                             .default_selected = ds, .set = setter } }   \
 133 },
 134 #define _ISL_ARG_BOOL_F(o,s,l,setter,d,h,fl)    {                       \
 135         .type = isl_arg_bool,                                           \
 136         .short_name = s,                                                \
 137         .long_name = l,                                                 \
 138         .offset = o,                                                    \
 139         .help_msg = h,                                                  \
 140         .flags = fl,                                                    \
 141         .u = { .b = { .default_value = d, .set = setter } }             \
 142 },
 143 #define ISL_ARG_BOOL_F(st,f,s,l,d,h,fl)                                 \
 144         _ISL_ARG_BOOL_F(offsetof(st, f),s,l,NULL,d,h,fl)
 145 #define ISL_ARG_BOOL(st,f,s,l,d,h)                                      \
 146         ISL_ARG_BOOL_F(st,f,s,l,d,h,0)
 147 #define ISL_ARG_PHANTOM_BOOL_F(s,l,setter,h,fl)                         \
 148         _ISL_ARG_BOOL_F(-1,s,l,setter,0,h,fl)
 149 #define ISL_ARG_PHANTOM_BOOL(s,l,setter,h)                              \
 150         ISL_ARG_PHANTOM_BOOL_F(s,l,setter,h,0)
 151 #define ISL_ARG_LONG(st,f,s,lo,d,h)     {                               \
 152         .type = isl_arg_long,                                           \
 153         .short_name = s,                                                \
 154         .long_name = lo,                                                \
 155         .offset = offsetof(st, f),                                      \
 156         .help_msg = h,                                                  \
 157         .u = { .l = { .default_value = d, .default_selected = d,        \
 158                       .set = NULL } }                                   \
 159 },
 160 #define ISL_ARG_USER_LONG(st,f,s,lo,setter,d,h) {                       \
 161         .type = isl_arg_long,                                           \
 162         .short_name = s,                                                \
 163         .long_name = lo,                                                \
 164         .offset = offsetof(st, f),                                      \
 165         .help_msg = h,                                                  \
 166         .u = { .l = { .default_value = d, .default_selected = d,        \
 167                       .set = setter } }                                 \
 168 },
 169 #define ISL_ARG_OPT_LONG(st,f,s,lo,d,ds,h)      {                       \
 170         .type = isl_arg_long,                                           \
 171         .short_name = s,                                                \
 172         .long_name = lo,                                                \
 173         .offset = offsetof(st, f),                                      \
 174         .help_msg = h,                                                  \
 175         .u = { .l = { .default_value = d, .default_selected = ds,       \
 176                       .set = NULL } }                                   \
 177 },
 178 #define ISL_ARG_ULONG(st,f,s,l,d,h)     {                               \
 179         .type = isl_arg_ulong,                                          \
 180         .short_name = s,                                                \
 181         .long_name = l,                                                 \
 182         .offset = offsetof(st, f),                                      \
 183         .help_msg = h,                                                  \
 184         .u = { .ul = { .default_value = d } }                           \
 185 },
 186 #define ISL_ARG_STR(st,f,s,l,a,d,h)     {                               \
 187         .type = isl_arg_str,                                            \
 188         .short_name = s,                                                \
 189         .long_name = l,                                                 \
 190         .argument_name = a,                                             \
 191         .offset = offsetof(st, f),                                      \
 192         .help_msg = h,                                                  \
 193         .u = { .str = { .default_value = d } }                          \
 194 },
 195 #define ISL_ARG_CHILD(st,f,l,c,h)       {                               \
 196         .type = isl_arg_child,                                          \
 197         .long_name = l,                                                 \
 198         .offset = offsetof(st, f),                                      \
 199         .help_msg = h,                                                  \
 200         .u = { .child = { .child = c, .size = sizeof(*((st *)NULL)->f) } }\
 201 },
 202 #define ISL_ARG_FLAGS(st,f,s,l,c,d,h)   {                               \
 203         .type = isl_arg_flags,                                          \
 204         .short_name = s,                                                \
 205         .long_name = l,                                                 \
 206         .offset = offsetof(st, f),                                      \
 207         .help_msg = h,                                                  \
 208         .u = { .flags = { .flags = c, .default_value = d } }            \
 209 },
 210 #define ISL_ARG_USER(st,f,i,c) {                                        \
 211         .type = isl_arg_user,                                           \
 212         .offset = offsetof(st, f),                                      \
 213         .u = { .user = { .init = i, .clear = c} }                       \
 214 },
 215 #define ISL_ARG_VERSION(print) {                                        \
 216         .type = isl_arg_version,                                        \
 217         .u = { .version = { .print_version = print } }                  \
 218 },
 219 #define ISL_ARG_END     { isl_arg_end }
 220
 221 #define ISL_ARG_ALL     (1 << 0)
 222
 223 void isl_arg_set_defaults(struct isl_arg *arg, void *opt);
 224 void isl_arg_free(struct isl_arg *arg, void *opt);
 225 int isl_arg_parse(struct isl_arg *arg, int argc, char **argv, void *opt,
 226         unsigned flags);
 227
 228 #define ISL_ARG_DECL(prefix,st,arg)                                     \
 229 extern struct isl_arg arg[];                                            \
 230 st *prefix ## _new_with_defaults();                                     \
 231 void prefix ## _free(st *opt);                                          \
 232 int prefix ## _parse(st *opt, int argc, char **argv, unsigned flags);
 233
 234 #define ISL_ARG_DEF(prefix,st,arg)                                      \
 235 st *prefix ## _new_with_defaults()                                      \
 236 {                                                                       \
 237         st *opt = (st *)calloc(1, sizeof(st));                          \
 238         if (opt)                                                        \
 239                 isl_arg_set_defaults(arg, opt);                         \
 240         return opt;                                                     \
 241 }                                                                       \
 242                                                                         \
 243 void prefix ## _free(st *opt)                                           \
 244 {                                                                       \
 245         isl_arg_free(arg, opt);                                         \
 246 }                                                                       \
 247                                                                         \
 248 int prefix ## _parse(st *opt, int argc, char **argv, unsigned flags)    \
 249 {                                                                       \
 250         return isl_arg_parse(arg, argc, argv, opt, flags);              \
 251 }
 252
 253 #if defined(__cplusplus)
 254 }
 255 #endif
 256
 257 #endif