(__WAIT_STATUS): Always use non-GCC defn, for now.
[kopensolaris-gnu/glibc.git] / posix / getopt.c
1 /* Getopt for GNU.
2    NOTE: getopt is now part of the C library, so if you don't know what
3    "Keep this file name-space clean" means, talk to roland@gnu.ai.mit.edu
4    before changing it!
5
6    Copyright (C) 1987, 88, 89, 90, 91, 92, 93, 94
7         Free Software Foundation, Inc.
8
9 This file is part of the GNU C Library.  Its master source is NOT part of
10 the C library, however.  The master source lives in /gd/gnu/lib.
11
12 The GNU C Library is free software; you can redistribute it and/or
13 modify it under the terms of the GNU Library General Public License as
14 published by the Free Software Foundation; either version 2 of the
15 License, or (at your option) any later version.
16
17 The GNU C Library is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20 Library General Public License for more details.
21
22 You should have received a copy of the GNU Library General Public
23 License along with the GNU C Library; see the file COPYING.LIB.  If
24 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
25 Cambridge, MA 02139, USA.  */
26 \f
27 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
28    Ditto for AIX 3.2 and <stdlib.h>.  */
29 #ifndef _NO_PROTO
30 #define _NO_PROTO
31 #endif
32
33 #ifdef HAVE_CONFIG_H
34 #if defined (emacs) || defined (CONFIG_BROKETS)
35 /* We use <config.h> instead of "config.h" so that a compilation
36    using -I. -I$srcdir will use ./config.h rather than $srcdir/config.h
37    (which it would do because it found this file in $srcdir).  */
38 #include <config.h>
39 #else
40 #include "config.h"
41 #endif
42 #endif
43
44 #ifndef __STDC__
45 /* This is a separate conditional since some stdc systems
46    reject `defined (const)'.  */
47 #ifndef const
48 #define const
49 #endif
50 #endif
51
52 #include <stdio.h>
53
54 /* Comment out all this code if we are using the GNU C Library, and are not
55    actually compiling the library itself.  This code is part of the GNU C
56    Library, but also included in many other GNU distributions.  Compiling
57    and linking in this code is a waste when using the GNU C library
58    (especially if it is a shared library).  Rather than having every GNU
59    program understand `configure --with-gnu-libc' and omit the object files,
60    it is simpler to just do this in the source for each such file.  */
61
62 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
63
64
65 /* This needs to come after some library #include
66    to get __GNU_LIBRARY__ defined.  */
67 #ifdef  __GNU_LIBRARY__
68 /* Don't include stdlib.h for non-GNU C libraries because some of them
69    contain conflicting prototypes for getopt.  */
70 #include <stdlib.h>
71 #endif  /* GNU C library.  */
72
73 /* This version of `getopt' appears to the caller like standard Unix `getopt'
74    but it behaves differently for the user, since it allows the user
75    to intersperse the options with the other arguments.
76
77    As `getopt' works, it permutes the elements of ARGV so that,
78    when it is done, all the options precede everything else.  Thus
79    all application programs are extended to handle flexible argument order.
80
81    Setting the environment variable POSIXLY_CORRECT disables permutation.
82    Then the behavior is completely standard.
83
84    GNU application programs can use a third alternative mode in which
85    they can distinguish the relative order of options and other arguments.  */
86
87 #include "getopt.h"
88
89 /* For communication from `getopt' to the caller.
90    When `getopt' finds an option that takes an argument,
91    the argument value is returned here.
92    Also, when `ordering' is RETURN_IN_ORDER,
93    each non-option ARGV-element is returned here.  */
94
95 char *optarg = NULL;
96
97 /* Index in ARGV of the next element to be scanned.
98    This is used for communication to and from the caller
99    and for communication between successive calls to `getopt'.
100
101    On entry to `getopt', zero means this is the first call; initialize.
102
103    When `getopt' returns EOF, this is the index of the first of the
104    non-option elements that the caller should itself scan.
105
106    Otherwise, `optind' communicates from one call to the next
107    how much of ARGV has been scanned so far.  */
108
109 /* XXX 1003.2 says this must be 1 before any call.  */
110 int optind = 0;
111
112 /* The next char to be scanned in the option-element
113    in which the last option character we returned was found.
114    This allows us to pick up the scan where we left off.
115
116    If this is zero, or a null string, it means resume the scan
117    by advancing to the next ARGV-element.  */
118
119 static char *nextchar;
120
121 /* Callers store zero here to inhibit the error message
122    for unrecognized options.  */
123
124 int opterr = 1;
125
126 /* Set to an option character which was unrecognized.
127    This must be initialized on some systems to avoid linking in the
128    system's own getopt implementation.  */
129
130 int optopt = '?';
131
132 /* Describe how to deal with options that follow non-option ARGV-elements.
133
134    If the caller did not specify anything,
135    the default is REQUIRE_ORDER if the environment variable
136    POSIXLY_CORRECT is defined, PERMUTE otherwise.
137
138    REQUIRE_ORDER means don't recognize them as options;
139    stop option processing when the first non-option is seen.
140    This is what Unix does.
141    This mode of operation is selected by either setting the environment
142    variable POSIXLY_CORRECT, or using `+' as the first character
143    of the list of option characters.
144
145    PERMUTE is the default.  We permute the contents of ARGV as we scan,
146    so that eventually all the non-options are at the end.  This allows options
147    to be given in any order, even with programs that were not written to
148    expect this.
149
150    RETURN_IN_ORDER is an option available to programs that were written
151    to expect options and other ARGV-elements in any order and that care about
152    the ordering of the two.  We describe each non-option ARGV-element
153    as if it were the argument of an option with character code 1.
154    Using `-' as the first character of the list of option characters
155    selects this mode of operation.
156
157    The special argument `--' forces an end of option-scanning regardless
158    of the value of `ordering'.  In the case of RETURN_IN_ORDER, only
159    `--' can cause `getopt' to return EOF with `optind' != ARGC.  */
160
161 static enum
162 {
163   REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
164 } ordering;
165
166 /* Value of POSIXLY_CORRECT environment variable.  */
167 static char *posixly_correct;
168 \f
169 #ifdef  __GNU_LIBRARY__
170 /* We want to avoid inclusion of string.h with non-GNU libraries
171    because there are many ways it can cause trouble.
172    On some systems, it contains special magic macros that don't work
173    in GCC.  */
174 #include <string.h>
175 #define my_index        strchr
176 #else
177
178 /* Avoid depending on library functions or files
179    whose names are inconsistent.  */
180
181 char *getenv ();
182
183 static char *
184 my_index (str, chr)
185      const char *str;
186      int chr;
187 {
188   while (*str)
189     {
190       if (*str == chr)
191         return (char *) str;
192       str++;
193     }
194   return 0;
195 }
196
197 /* If using GCC, we can safely declare strlen this way.
198    If not using GCC, it is ok not to declare it.  */
199 #ifdef __GNUC__
200 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
201    That was relevant to code that was here before.  */
202 #ifndef __STDC__
203 /* gcc with -traditional declares the built-in strlen to return int,
204    and has done so at least since version 2.4.5. -- rms.  */
205 extern int strlen (const char *);
206 #endif /* not __STDC__ */
207 #endif /* __GNUC__ */
208
209 #endif /* not __GNU_LIBRARY__ */
210 \f
211 /* Handle permutation of arguments.  */
212
213 /* Describe the part of ARGV that contains non-options that have
214    been skipped.  `first_nonopt' is the index in ARGV of the first of them;
215    `last_nonopt' is the index after the last of them.  */
216
217 static int first_nonopt;
218 static int last_nonopt;
219
220 /* Exchange two adjacent subsequences of ARGV.
221    One subsequence is elements [first_nonopt,last_nonopt)
222    which contains all the non-options that have been skipped so far.
223    The other is elements [last_nonopt,optind), which contains all
224    the options processed since those non-options were skipped.
225
226    `first_nonopt' and `last_nonopt' are relocated so that they describe
227    the new indices of the non-options in ARGV after they are moved.  */
228
229 static void
230 exchange (argv)
231      char **argv;
232 {
233   int bottom = first_nonopt;
234   int middle = last_nonopt;
235   int top = optind;
236   char *tem;
237
238   /* Exchange the shorter segment with the far end of the longer segment.
239      That puts the shorter segment into the right place.
240      It leaves the longer segment in the right place overall,
241      but it consists of two parts that need to be swapped next.  */
242
243   while (top > middle && middle > bottom)
244     {
245       if (top - middle > middle - bottom)
246         {
247           /* Bottom segment is the short one.  */
248           int len = middle - bottom;
249           register int i;
250
251           /* Swap it with the top part of the top segment.  */
252           for (i = 0; i < len; i++)
253             {
254               tem = argv[bottom + i];
255               argv[bottom + i] = argv[top - (middle - bottom) + i];
256               argv[top - (middle - bottom) + i] = tem;
257             }
258           /* Exclude the moved bottom segment from further swapping.  */
259           top -= len;
260         }
261       else
262         {
263           /* Top segment is the short one.  */
264           int len = top - middle;
265           register int i;
266
267           /* Swap it with the bottom part of the bottom segment.  */
268           for (i = 0; i < len; i++)
269             {
270               tem = argv[bottom + i];
271               argv[bottom + i] = argv[middle + i];
272               argv[middle + i] = tem;
273             }
274           /* Exclude the moved top segment from further swapping.  */
275           bottom += len;
276         }
277     }
278
279   /* Update records for the slots the non-options now occupy.  */
280
281   first_nonopt += (optind - last_nonopt);
282   last_nonopt = optind;
283 }
284
285 /* Initialize the internal data when the first call is made.  */
286
287 static const char *
288 _getopt_initialize (optstring)
289      const char *optstring;
290 {
291   /* Start processing options with ARGV-element 1 (since ARGV-element 0
292      is the program name); the sequence of previously skipped
293      non-option ARGV-elements is empty.  */
294
295   first_nonopt = last_nonopt = optind = 1;
296
297   nextchar = NULL;
298
299   posixly_correct = getenv ("POSIXLY_CORRECT");
300
301   /* Determine how to handle the ordering of options and nonoptions.  */
302
303   if (optstring[0] == '-')
304     {
305       ordering = RETURN_IN_ORDER;
306       ++optstring;
307     }
308   else if (optstring[0] == '+')
309     {
310       ordering = REQUIRE_ORDER;
311       ++optstring;
312     }
313   else if (posixly_correct != NULL)
314     ordering = REQUIRE_ORDER;
315   else
316     ordering = PERMUTE;
317
318   return optstring;
319 }
320 \f
321 /* Scan elements of ARGV (whose length is ARGC) for option characters
322    given in OPTSTRING.
323
324    If an element of ARGV starts with '-', and is not exactly "-" or "--",
325    then it is an option element.  The characters of this element
326    (aside from the initial '-') are option characters.  If `getopt'
327    is called repeatedly, it returns successively each of the option characters
328    from each of the option elements.
329
330    If `getopt' finds another option character, it returns that character,
331    updating `optind' and `nextchar' so that the next call to `getopt' can
332    resume the scan with the following option character or ARGV-element.
333
334    If there are no more option characters, `getopt' returns `EOF'.
335    Then `optind' is the index in ARGV of the first ARGV-element
336    that is not an option.  (The ARGV-elements have been permuted
337    so that those that are not options now come last.)
338
339    OPTSTRING is a string containing the legitimate option characters.
340    If an option character is seen that is not listed in OPTSTRING,
341    return '?' after printing an error message.  If you set `opterr' to
342    zero, the error message is suppressed but we still return '?'.
343
344    If a char in OPTSTRING is followed by a colon, that means it wants an arg,
345    so the following text in the same ARGV-element, or the text of the following
346    ARGV-element, is returned in `optarg'.  Two colons mean an option that
347    wants an optional arg; if there is text in the current ARGV-element,
348    it is returned in `optarg', otherwise `optarg' is set to zero.
349
350    If OPTSTRING starts with `-' or `+', it requests different methods of
351    handling the non-option ARGV-elements.
352    See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
353
354    Long-named options begin with `--' instead of `-'.
355    Their names may be abbreviated as long as the abbreviation is unique
356    or is an exact match for some defined option.  If they have an
357    argument, it follows the option name in the same ARGV-element, separated
358    from the option name by a `=', or else the in next ARGV-element.
359    When `getopt' finds a long-named option, it returns 0 if that option's
360    `flag' field is nonzero, the value of the option's `val' field
361    if the `flag' field is zero.
362
363    The elements of ARGV aren't really const, because we permute them.
364    But we pretend they're const in the prototype to be compatible
365    with other systems.
366
367    LONGOPTS is a vector of `struct option' terminated by an
368    element containing a name which is zero.
369
370    LONGIND returns the index in LONGOPT of the long-named option found.
371    It is only valid when a long-named option has been found by the most
372    recent call.
373
374    If LONG_ONLY is nonzero, '-' as well as '--' can introduce
375    long-named options.  */
376
377 int
378 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
379      int argc;
380      char *const *argv;
381      const char *optstring;
382      const struct option *longopts;
383      int *longind;
384      int long_only;
385 {
386   optarg = NULL;
387
388   if (optind == 0)
389     optstring = _getopt_initialize (optstring);
390
391   if (nextchar == NULL || *nextchar == '\0')
392     {
393       /* Advance to the next ARGV-element.  */
394
395       if (ordering == PERMUTE)
396         {
397           /* If we have just processed some options following some non-options,
398              exchange them so that the options come first.  */
399
400           if (first_nonopt != last_nonopt && last_nonopt != optind)
401             exchange ((char **) argv);
402           else if (last_nonopt != optind)
403             first_nonopt = optind;
404
405           /* Skip any additional non-options
406              and extend the range of non-options previously skipped.  */
407
408           while (optind < argc
409                  && (argv[optind][0] != '-' || argv[optind][1] == '\0'))
410             optind++;
411           last_nonopt = optind;
412         }
413
414       /* The special ARGV-element `--' means premature end of options.
415          Skip it like a null option,
416          then exchange with previous non-options as if it were an option,
417          then skip everything else like a non-option.  */
418
419       if (optind != argc && !strcmp (argv[optind], "--"))
420         {
421           optind++;
422
423           if (first_nonopt != last_nonopt && last_nonopt != optind)
424             exchange ((char **) argv);
425           else if (first_nonopt == last_nonopt)
426             first_nonopt = optind;
427           last_nonopt = argc;
428
429           optind = argc;
430         }
431
432       /* If we have done all the ARGV-elements, stop the scan
433          and back over any non-options that we skipped and permuted.  */
434
435       if (optind == argc)
436         {
437           /* Set the next-arg-index to point at the non-options
438              that we previously skipped, so the caller will digest them.  */
439           if (first_nonopt != last_nonopt)
440             optind = first_nonopt;
441           return EOF;
442         }
443
444       /* If we have come to a non-option and did not permute it,
445          either stop the scan or describe it to the caller and pass it by.  */
446
447       if ((argv[optind][0] != '-' || argv[optind][1] == '\0'))
448         {
449           if (ordering == REQUIRE_ORDER)
450             return EOF;
451           optarg = argv[optind++];
452           return 1;
453         }
454
455       /* We have found another option-ARGV-element.
456          Skip the initial punctuation.  */
457
458       nextchar = (argv[optind] + 1
459                   + (longopts != NULL && argv[optind][1] == '-'));
460     }
461
462   /* Decode the current option-ARGV-element.  */
463
464   /* Check whether the ARGV-element is a long option.
465
466      If long_only and the ARGV-element has the form "-f", where f is
467      a valid short option, don't consider it an abbreviated form of
468      a long option that starts with f.  Otherwise there would be no
469      way to give the -f short option.
470
471      On the other hand, if there's a long option "fubar" and
472      the ARGV-element is "-fu", do consider that an abbreviation of
473      the long option, just like "--fu", and not "-f" with arg "u".
474
475      This distinction seems to be the most useful approach.  */
476
477   if (longopts != NULL
478       && (argv[optind][1] == '-'
479           || (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
480     {
481       char *nameend;
482       const struct option *p;
483       const struct option *pfound = NULL;
484       int exact = 0;
485       int ambig = 0;
486       int indfound;
487       int option_index;
488
489       for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
490         /* Do nothing.  */ ;
491
492       /* Test all long options for either exact match
493          or abbreviated matches.  */
494       for (p = longopts, option_index = 0; p->name; p++, option_index++)
495         if (!strncmp (p->name, nextchar, nameend - nextchar))
496           {
497             if (nameend - nextchar == strlen (p->name))
498               {
499                 /* Exact match found.  */
500                 pfound = p;
501                 indfound = option_index;
502                 exact = 1;
503                 break;
504               }
505             else if (pfound == NULL)
506               {
507                 /* First nonexact match found.  */
508                 pfound = p;
509                 indfound = option_index;
510               }
511             else
512               /* Second or later nonexact match found.  */
513               ambig = 1;
514           }
515
516       if (ambig && !exact)
517         {
518           if (opterr)
519             fprintf (stderr, "%s: option `%s' is ambiguous\n",
520                      argv[0], argv[optind]);
521           nextchar += strlen (nextchar);
522           optind++;
523           return '?';
524         }
525
526       if (pfound != NULL)
527         {
528           option_index = indfound;
529           optind++;
530           if (*nameend)
531             {
532               /* Don't test has_arg with >, because some C compilers don't
533                  allow it to be used on enums.  */
534               if (pfound->has_arg)
535                 optarg = nameend + 1;
536               else
537                 {
538                   if (opterr)
539                     {
540                       if (argv[optind - 1][1] == '-')
541                         /* --option */
542                         fprintf (stderr,
543                                  "%s: option `--%s' doesn't allow an argument\n",
544                                  argv[0], pfound->name);
545                       else
546                         /* +option or -option */
547                         fprintf (stderr,
548                              "%s: option `%c%s' doesn't allow an argument\n",
549                              argv[0], argv[optind - 1][0], pfound->name);
550                     }
551                   nextchar += strlen (nextchar);
552                   return '?';
553                 }
554             }
555           else if (pfound->has_arg == 1)
556             {
557               if (optind < argc)
558                 optarg = argv[optind++];
559               else
560                 {
561                   if (opterr)
562                     fprintf (stderr, "%s: option `%s' requires an argument\n",
563                              argv[0], argv[optind - 1]);
564                   nextchar += strlen (nextchar);
565                   return optstring[0] == ':' ? ':' : '?';
566                 }
567             }
568           nextchar += strlen (nextchar);
569           if (longind != NULL)
570             *longind = option_index;
571           if (pfound->flag)
572             {
573               *(pfound->flag) = pfound->val;
574               return 0;
575             }
576           return pfound->val;
577         }
578
579       /* Can't find it as a long option.  If this is not getopt_long_only,
580          or the option starts with '--' or is not a valid short
581          option, then it's an error.
582          Otherwise interpret it as a short option.  */
583       if (!long_only || argv[optind][1] == '-'
584           || my_index (optstring, *nextchar) == NULL)
585         {
586           if (opterr)
587             {
588               if (argv[optind][1] == '-')
589                 /* --option */
590                 fprintf (stderr, "%s: unrecognized option `--%s'\n",
591                          argv[0], nextchar);
592               else
593                 /* +option or -option */
594                 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
595                          argv[0], argv[optind][0], nextchar);
596             }
597           nextchar = (char *) "";
598           optind++;
599           return '?';
600         }
601     }
602
603   /* Look at and handle the next short option-character.  */
604
605   {
606     char c = *nextchar++;
607     char *temp = my_index (optstring, c);
608
609     /* Increment `optind' when we start to process its last character.  */
610     if (*nextchar == '\0')
611       ++optind;
612
613     if (temp == NULL || c == ':')
614       {
615         if (opterr)
616           {
617             if (posixly_correct)
618               /* 1003.2 specifies the format of this message.  */
619               fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
620             else
621               fprintf (stderr, "%s: invalid option -- %c\n", argv[0], c);
622           }
623         optopt = c;
624         return '?';
625       }
626     if (temp[1] == ':')
627       {
628         if (temp[2] == ':')
629           {
630             /* This is an option that accepts an argument optionally.  */
631             if (*nextchar != '\0')
632               {
633                 optarg = nextchar;
634                 optind++;
635               }
636             else
637               optarg = NULL;
638             nextchar = NULL;
639           }
640         else
641           {
642             /* This is an option that requires an argument.  */
643             if (*nextchar != '\0')
644               {
645                 optarg = nextchar;
646                 /* If we end this ARGV-element by taking the rest as an arg,
647                    we must advance to the next element now.  */
648                 optind++;
649               }
650             else if (optind == argc)
651               {
652                 if (opterr)
653                   {
654                     /* 1003.2 specifies the format of this message.  */
655                     fprintf (stderr, "%s: option requires an argument -- %c\n",
656                              argv[0], c);
657                   }
658                 optopt = c;
659                 if (optstring[0] == ':')
660                   c = ':';
661                 else
662                   c = '?';
663               }
664             else
665               /* We already incremented `optind' once;
666                  increment it again when taking next ARGV-elt as argument.  */
667               optarg = argv[optind++];
668             nextchar = NULL;
669           }
670       }
671     return c;
672   }
673 }
674
675 int
676 getopt (argc, argv, optstring)
677      int argc;
678      char *const *argv;
679      const char *optstring;
680 {
681   return _getopt_internal (argc, argv, optstring,
682                            (const struct option *) 0,
683                            (int *) 0,
684                            0);
685 }
686
687 #endif  /* _LIBC or not __GNU_LIBRARY__.  */
688 \f
689 #ifdef TEST
690
691 /* Compile with -DTEST to make an executable for use in testing
692    the above definition of `getopt'.  */
693
694 int
695 main (argc, argv)
696      int argc;
697      char **argv;
698 {
699   int c;
700   int digit_optind = 0;
701
702   while (1)
703     {
704       int this_option_optind = optind ? optind : 1;
705
706       c = getopt (argc, argv, "abc:d:0123456789");
707       if (c == EOF)
708         break;
709
710       switch (c)
711         {
712         case '0':
713         case '1':
714         case '2':
715         case '3':
716         case '4':
717         case '5':
718         case '6':
719         case '7':
720         case '8':
721         case '9':
722           if (digit_optind != 0 && digit_optind != this_option_optind)
723             printf ("digits occur in two different argv-elements.\n");
724           digit_optind = this_option_optind;
725           printf ("option %c\n", c);
726           break;
727
728         case 'a':
729           printf ("option a\n");
730           break;
731
732         case 'b':
733           printf ("option b\n");
734           break;
735
736         case 'c':
737           printf ("option c with value `%s'\n", optarg);
738           break;
739
740         case '?':
741           break;
742
743         default:
744           printf ("?? getopt returned character code 0%o ??\n", c);
745         }
746     }
747
748   if (optind < argc)
749     {
750       printf ("non-option ARGV-elements: ");
751       while (optind < argc)
752         printf ("%s ", argv[optind++]);
753       printf ("\n");
754     }
755
756   exit (0);
757 }
758
759 #endif /* TEST */