libbb/getopt_ulflags.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * universal getopt_ulflags implementation for busybox
   4  *
   5  * Copyright (C) 2003-2005  Vladimir Oleynik  <dzo@simtreas.ru>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  20  *
  21  */
  22
  23 #include <getopt.h>
  24 #include <string.h>
  25 #include <assert.h>
  26 #include <stdlib.h>
  27 #include "libbb.h"
  28
  29 /*                  Documentation !
  30
  31 unsigned long
  32 bb_getopt_ulflags (int argc, char **argv, const char *applet_opts, ...)
  33
  34         The command line options must be declared in const char
  35         *applet_opts as a string of chars, for example:
  36
  37         flags = bb_getopt_ulflags(argc, argv, "rnug");
  38
  39         If one of the given options is found, a flag value is added to
  40         the return value (an unsigned long).
  41
  42         The flag value is determined by the position of the char in
  43         applet_opts string.  For example, in the above case:
  44
  45         flags = bb_getopt_ulflags(argc, argv, "rnug");
  46
  47         "r" will add 1    (bit 1 : 0x01)
  48         "n" will add 2    (bit 2 : 0x02)
  49         "u  will add 4    (bit 3 : 0x03)
  50         "g" will add 8    (bit 4 : 0x04)
  51
  52          and so on.  You can also look at the return value as a bit
  53          field and each option sets one of bits.
  54
  55  ":"    If one of the options requires an argument, then add a ":"
  56         after the char in applet_opts and provide a pointer to store
  57         the argument.  For example:
  58
  59         char *pointer_to_arg_for_a;
  60         char *pointer_to_arg_for_b;
  61         char *pointer_to_arg_for_c;
  62         char *pointer_to_arg_for_d;
  63
  64         flags = bb_getopt_ulflags(argc, argv, "a:b:c:d:",
  65                          &pointer_to_arg_for_a, &pointer_to_arg_for_b,
  66                          &pointer_to_arg_for_c, &pointer_to_arg_for_d);
  67
  68         The type of the pointer (char* or llist_t *) may be controlled
  69         by the "*" special character that is set in the external string
  70         bb_opt_complementally (see below for more info).
  71
  72 static const struct option bb_default_long_options[]
  73
  74         This struct allows you to define long options.  The syntax for
  75         declaring the array is just like that of getopt's longopts.
  76         (see getopt(3))
  77
  78         static const struct option applet_long_options[] = {
  79                 { "verbose", 0, 0, v },
  80                 { 0, 0, 0, 0 }
  81         };
  82         bb_applet_long_options = applet_long_options;
  83
  84         The last argument (val) can undefined from applet_opts.
  85         If you use this, then:
  86         - return bit have next position after short options
  87         - if has_arg is not "no_argument", use ptr for arg also
  88         - bb_opt_complementally have effects for this too
  89
  90         Note: a good applet will make long options configurable via the
  91         config process and not a required feature.  The current standard
  92         is to name the config option CONFIG_FEATURE_<applet>_LONG_OPTIONS.
  93
  94 const char *bb_opt_complementally
  95
  96  ":"    The colon (":") is used to separate groups of two or more chars
  97         and/or groups of chars and special characters (stating some
  98         conditions to be checked).
  99
 100  "abc"  If groups of two or more chars are specified, the first char
 101         is the main option and the other chars are secondary options.
 102         Their flags will be turned on if the main option is found even
 103         if they are not specifed on the command line.  For example:
 104
 105         bb_opt_complementally = "abc";
 106
 107         flags = bb_getopt_ulflags(argc, argv, "abcd")
 108
 109         If getopt() finds "-a" on the command line, then
 110         bb_getopt_ulflags's return value will be as if "-a -b -c" were
 111         found.
 112
 113  "ww"   Option have int counter usaging. For example ps applet:
 114         if w is given once, GNU ps sets the width to 132,
 115         if w is given more than once, it is "unlimited"
 116
 117         int w_counter = 0;
 118         bb_opt_complementally = "ww";
 119         flags = bb_getopt_ulflags(argc, argv, "w", &w_counter);
 120
 121         if((flags & 1))
 122                 width = (w_counter == 1) ? 132 : INT_MAX;
 123         else
 124                 get_terminal_width(...&width...);
 125
 126         w_counter - have counter -w usaging, must set int pointer
 127         to bb_getopt_ulflags() after all other requires
 128
 129 Special characters:
 130
 131  "-"    A dash between two options causes the second of the two
 132         to be unset (and ignored or triggered) if it is given on
 133         the command line.
 134
 135         For example:
 136         The du applet has the options "-s" and "-d depth".  If
 137         bb_getopt_ulflags finds -s, then -d is unset or if it finds -d
 138         then -s is unset.  (Note:  busybox implements the GNU
 139         "--max-depth" option as "-d".)  To obtain this behavior, you
 140         set bb_opt_complementally = "s-d:d-s".  Only one flag value is
 141         added to bb_getopt_ulflags's return value depending on the
 142         position of the options on the command line.  If one of the
 143         two options requires an argument pointer (":" in applet_opts
 144         as in "d:") optarg is set accordingly.
 145
 146         char *smax_print_depth;
 147
 148         bb_opt_complementally = "s-d:d-s:x-x";
 149         opt = bb_getopt_ulflags(argc, argv, "sd:x", &smax_print_depth);
 150
 151         if (opt & 2) {
 152                  max_print_depth = bb_xgetularg10_bnd(smax_print_depth,
 153                              0, INT_MAX);
 154         }
 155         if(opt & 4)
 156                 printf("Detected odd -x usaging\n");
 157
 158  "~"    A tilde between two options, or between an option and a group
 159         of options, means that they are mutually exclusive.  Unlike
 160         the "-" case above, an error will be forced if the options
 161         are used together.
 162
 163         For example:
 164         The cut applet must have only one type of list specified, so
 165         -b, -c and -f are mutally exclusive and should raise an error
 166         if specified together.  In this case you must set
 167         bb_opt_complementally = "b~cf:c~bf:f~bc".  If two of the
 168         mutually exclusive options are found, bb_getopt_ulflags's
 169         return value will have the error flag set (BB_GETOPT_ERROR) so
 170         that we can check for it:
 171
 172         if (flags & BB_GETOPT_ERROR)
 173                 bb_show_usage();
 174
 175  "!"    If previous point set BB_GETOPT_ERROR, don`t return and call
 176         previous example internally
 177
 178  "*"    A star after a char in bb_opt_complementally means that the
 179         option can occur multiple times:
 180
 181         For example:
 182         The grep applet can have one or more "-e pattern" arguments.
 183         In this case you should use bb_getopt_ulflags() as follows:
 184
 185         llist_t *patterns = NULL;
 186
 187         (this pointer must be initializated to NULL if the list is empty
 188         as required by *llist_add_to(llist_t *old_head, char *new_item).)
 189
 190         bb_opt_complementally = "e*";
 191
 192         bb_getopt_ulflags(argc, argv, "e:", &patterns);
 193         $ grep -e user -e root /etc/passwd
 194         root:x:0:0:root:/root:/bin/bash
 195         user:x:500:500::/home/user:/bin/bash
 196 */
 197
 198 const char *bb_opt_complementally;
 199
 200 typedef struct {
 201         unsigned char opt;
 202         char list_flg;
 203         unsigned long switch_on;
 204         unsigned long switch_off;
 205         unsigned long incongruously;
 206         void **optarg;               /* char **optarg or llist_t **optarg */
 207         int *counter;
 208 } t_complementally;
 209
 210 /* You can set bb_applet_long_options for parse called long options */
 211
 212 static const struct option bb_default_long_options[] = {
 213 /*      { "help", 0, NULL, '?' }, */
 214         { 0, 0, 0, 0 }
 215 };
 216
 217 const struct option *bb_applet_long_options = bb_default_long_options;
 218
 219 unsigned long
 220 bb_getopt_ulflags (int argc, char **argv, const char *applet_opts, ...)
 221 {
 222         unsigned long flags = 0;
 223         t_complementally complementally[sizeof(flags) * 8 + 1];
 224         int c;
 225         const unsigned char *s;
 226         t_complementally *on_off;
 227         va_list p;
 228         const struct option *l_o;
 229         char flg_show_usage_if_error = 0;
 230
 231         va_start (p, applet_opts);
 232
 233         /* skip GNU extension */
 234         s = applet_opts;
 235         if(*s == '+' || *s == '-')
 236                 s++;
 237
 238         c = 0;
 239         on_off = complementally;
 240         for (; *s; s++) {
 241                 if(c >= (int)(sizeof(flags)*8))
 242                         break;
 243                 on_off->opt = *s;
 244                 on_off->switch_on = (1 << c);
 245                 on_off->list_flg = 0;
 246                 on_off->switch_off = 0;
 247                 on_off->incongruously = 0;
 248                 on_off->optarg = NULL;
 249                 on_off->counter = NULL;
 250                 if (s[1] == ':') {
 251                         on_off->optarg = va_arg (p, void **);
 252                         do
 253                                 s++;
 254                         while (s[1] == ':');
 255                 }
 256                 on_off++;
 257                 c++;
 258         }
 259         on_off->opt = 0;
 260
 261         for(l_o = bb_applet_long_options; l_o->name; l_o++) {
 262                 for(on_off = complementally; on_off->opt != 0; on_off++)
 263                         if(on_off->opt == l_o->val)
 264                                 break;
 265                 if(on_off->opt == 0) {
 266                         if(c >= (int)(sizeof(flags)*8))
 267                                 break;
 268                         on_off->opt = l_o->val;
 269                         on_off->switch_on = (1 << c);
 270                         on_off->list_flg = 0;
 271                         on_off->switch_off = 0;
 272                         on_off->incongruously = 0;
 273                         on_off->counter = NULL;
 274                         if(l_o->has_arg != no_argument)
 275                                 on_off->optarg = va_arg (p, void **);
 276                         else
 277                                 on_off->optarg = NULL;
 278                         on_off++;
 279                         on_off->opt = 0;
 280                         c++;
 281                 }
 282         }
 283         c = 0;
 284         for (s = bb_opt_complementally; s && *s; s++) {
 285                 t_complementally *pair;
 286
 287                 if (*s == ':') {
 288                         c = 0;
 289                         continue;
 290                 }
 291                 if (c)
 292                         continue;
 293                 if(*s == '!') {
 294                         flg_show_usage_if_error = '!';
 295                         continue;
 296                 }
 297                 for (on_off = complementally; on_off->opt; on_off++)
 298                         if (on_off->opt == *s)
 299                                 break;
 300                 pair = on_off;
 301                 for(s++; *s && *s != ':'; s++) {
 302                         if (*s == '-' || *s == '~') {
 303                                 c = *s;
 304                         } else if(*s == '*') {
 305                                 pair->list_flg++;
 306                         } else {
 307                                 unsigned long *pair_switch = &(pair->switch_on);
 308                                 if(c)
 309                                         pair_switch = c == '-' ? &(pair->switch_off) : &(pair->incongruously);
 310                                 for (on_off = complementally; on_off->opt; on_off++)
 311                                         if (on_off->opt == *s) {
 312                                                 if(pair_switch == &(on_off->switch_on))
 313                                                   on_off->counter = va_arg (p, int *);
 314                                                 else
 315                                                   *pair_switch |= on_off->switch_on;
 316                                                 break;
 317                                         }
 318                         }
 319                 }
 320                 s--;
 321         }
 322
 323         while ((c = getopt_long (argc, argv, applet_opts,
 324                                  bb_applet_long_options, NULL)) > 0) {
 325                 unsigned long trigger;
 326
 327                 for (on_off = complementally; on_off->opt != c; on_off++) {
 328                         if(!on_off->opt)
 329                                 bb_show_usage ();
 330                 }
 331                 if(flags & on_off->incongruously) {
 332                         if(flg_show_usage_if_error)
 333                                 bb_show_usage ();
 334                         flags |= BB_GETOPT_ERROR;
 335                 }
 336                 trigger = on_off->switch_on & on_off->switch_off;
 337                 flags &= ~(on_off->switch_off ^ trigger);
 338                 flags |= on_off->switch_on ^ trigger;
 339                 flags ^= trigger;
 340                 if(on_off->counter)
 341                         (*(on_off->counter))++;
 342                 if(on_off->list_flg) {
 343                         *(llist_t **)(on_off->optarg) =
 344                                 llist_add_to(*(llist_t **)(on_off->optarg), optarg);
 345                 } else if (on_off->optarg) {
 346                         *(char **)(on_off->optarg) = optarg;
 347                 }
 348         }
 349
 350         return flags;
 351 }