findutils/*: move usage and applet bits to *.c files
[oweals/busybox.git] / libbb / getopt32.c
index 5190fa61a945f288312e4b37bc1267a2978dda88..b5f83c1273aa2df8d06f0c93ed1cb2fa23fbac50 100644 (file)
@@ -72,6 +72,9 @@ getopt32(char **argv, const char *applet_opts, ...)
         env -i ls -d /
         Here we want env to process just the '-i', not the '-d'.
 
+ "!"    Report bad option, missing required options,
+        inconsistent options with all-ones return value (instead of abort).
+
 const char *applet_long_options
 
         This struct allows you to define long options:
@@ -144,15 +147,15 @@ const char *opt_complementary
 
 Special characters:
 
- "-"    A dash as the first char in a opt_complementary group forces
-        all arguments to be treated as options, even if they have
-        no leading dashes. Next char in this case can't be a digit (0-9),
-        use ':' or end of line. For example:
+ "-"    A group consisting of just a dash forces all arguments
+        to be treated as options, even if they have no leading dashes.
+        Next char in this case can't be a digit (0-9), use ':' or end of line.
+        Example:
 
-        opt_complementary = "-:w-x:x-w";
-        getopt32(argv, "wx");
+        opt_complementary = "-:w-x:x-w"; // "-w-x:x-w" would also work,
+        getopt32(argv, "wx");            // but is less readable
 
-        Allows any arguments to be given without a dash (./program w x)
+        This makes it possible to use options without a dash (./program w x)
         as well as with a dash (./program -x).
 
         NB: getopt32() will leak a small amount of memory if you use
@@ -311,7 +314,7 @@ typedef struct {
 } t_complementary;
 
 /* You can set applet_long_options for parse called long options */
-#if ENABLE_GETOPT_LONG
+#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
 static const struct option bb_null_long_options[1] = {
        { 0, 0, 0, 0 }
 };
@@ -327,11 +330,12 @@ getopt32(char **argv, const char *applet_opts, ...)
        unsigned flags = 0;
        unsigned requires = 0;
        t_complementary complementary[33]; /* last stays zero-filled */
+       char first_char;
        int c;
        const unsigned char *s;
        t_complementary *on_off;
        va_list p;
-#if ENABLE_GETOPT_LONG
+#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
        const struct option *l_o;
        struct option *long_options = (struct option *) &bb_null_long_options;
 #endif
@@ -357,6 +361,11 @@ getopt32(char **argv, const char *applet_opts, ...)
        on_off = complementary;
        memset(on_off, 0, sizeof(complementary));
 
+       /* skip bbox extension */
+       first_char = applet_opts[0];
+       if (first_char == '!')
+               applet_opts++;
+
        /* skip GNU extension */
        s = (const unsigned char *)applet_opts;
        if (*s == '+' || *s == '-')
@@ -375,7 +384,7 @@ getopt32(char **argv, const char *applet_opts, ...)
                c++;
        }
 
-#if ENABLE_GETOPT_LONG
+#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
        if (applet_long_options) {
                const char *optstr;
                unsigned i, count;
@@ -414,8 +423,12 @@ getopt32(char **argv, const char *applet_opts, ...)
                        c++;
  next_long: ;
                }
+               /* Make it unnecessary to clear applet_long_options
+                * by hand after each call to getopt32
+                */
+               applet_long_options = NULL;
        }
-#endif /* ENABLE_GETOPT_LONG */
+#endif /* ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG */
        for (s = (const unsigned char *)opt_complementary; s && *s; s++) {
                t_complementary *pair;
                unsigned *pair_switch;
@@ -476,15 +489,15 @@ getopt32(char **argv, const char *applet_opts, ...)
                        s++;
                }
                pair = on_off;
-               pair_switch = &(pair->switch_on);
+               pair_switch = &pair->switch_on;
                for (s++; *s && *s != ':'; s++) {
                        if (*s == '?') {
-                               pair_switch = &(pair->requires);
+                               pair_switch = &pair->requires;
                        } else if (*s == '-') {
-                               if (pair_switch == &(pair->switch_off))
-                                       pair_switch = &(pair->incongruously);
+                               if (pair_switch == &pair->switch_off)
+                                       pair_switch = &pair->incongruously;
                                else
-                                       pair_switch = &(pair->switch_off);
+                                       pair_switch = &pair->switch_off;
                        } else {
                                for (on_off = complementary; on_off->opt_char; on_off++)
                                        if (on_off->opt_char == *s) {
@@ -495,6 +508,7 @@ getopt32(char **argv, const char *applet_opts, ...)
                }
                s--;
        }
+       opt_complementary = NULL;
        va_end(p);
 
        if (spec_flgs & (FIRST_ARGV_IS_OPT | ALL_ARGV_IS_OPTS)) {
@@ -534,7 +548,7 @@ getopt32(char **argv, const char *applet_opts, ...)
         * "fake" short options, like this one:
         * wget $'-\203' "Test: test" http://kernel.org/
         * (supposed to act as --header, but doesn't) */
-#if ENABLE_GETOPT_LONG
+#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
        while ((c = getopt_long(argc, argv, applet_opts,
                        long_options, NULL)) != -1) {
 #else
@@ -549,11 +563,11 @@ getopt32(char **argv, const char *applet_opts, ...)
                         * is always NULL (see above) */
                        if (on_off->opt_char == '\0' /* && c != '\0' */) {
                                /* c is probably '?' - "bad option" */
-                               bb_show_usage();
+                               goto error;
                        }
                }
                if (flags & on_off->incongruously)
-                       bb_show_usage();
+                       goto error;
                trigger = on_off->switch_on & on_off->switch_off;
                flags &= ~(on_off->switch_off ^ trigger);
                flags |= on_off->switch_on ^ trigger;
@@ -577,16 +591,24 @@ getopt32(char **argv, const char *applet_opts, ...)
 
        /* check depending requires for given options */
        for (on_off = complementary; on_off->opt_char; on_off++) {
-               if (on_off->requires && (flags & on_off->switch_on) &&
-                                       (flags & on_off->requires) == 0)
-                       bb_show_usage();
+               if (on_off->requires
+                && (flags & on_off->switch_on)
+                && (flags & on_off->requires) == 0
+               ) {
+                       goto error;
+               }
        }
        if (requires && (flags & requires) == 0)
-               bb_show_usage();
+               goto error;
        argc -= optind;
        if (argc < min_arg || (max_arg >= 0 && argc > max_arg))
-               bb_show_usage();
+               goto error;
 
        option_mask32 = flags;
        return flags;
+
+ error:
+       if (first_char != '!')
+               bb_show_usage();
+       return (int32_t)-1;
 }