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
6 Copyright (C) 1987, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97
7 Free Software Foundation, Inc.
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.
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.
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.
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 not,
24 write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 Boston, MA 02110-1301, USA. */
27 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
28 Ditto for AIX 3.2 and <stdlib.h>. */
39 #if !defined (__STDC__) || !__STDC__
40 /* This is a separate conditional since some stdc systems
41 reject `defined (const)'. */
49 /* Comment out all this code if we are using the GNU C Library, and are not
50 actually compiling the library itself. This code is part of the GNU C
51 Library, but also included in many other GNU distributions. Compiling
52 and linking in this code is a waste when using the GNU C library
53 (especially if it is a shared library). Rather than having every GNU
54 program understand `configure --with-gnu-libc' and omit the object files,
55 it is simpler to just do this in the source for each such file. */
57 #define GETOPT_INTERFACE_VERSION 2
58 #if !defined (_LIBC) && defined (__GLIBC__) && __GLIBC__ >= 2
59 #include <gnu-versions.h>
60 #if _GNU_GETOPT_INTERFACE_VERSION == GETOPT_INTERFACE_VERSION
68 /* This needs to come after some library #include
69 to get __GNU_LIBRARY__ defined. */
70 #ifdef __GNU_LIBRARY__
71 /* Don't include stdlib.h for non-GNU C libraries because some of them
72 contain conflicting prototypes for getopt. */
75 #endif /* GNU C library. */
84 #if defined (WIN32) && !defined (__CYGWIN32__)
85 /* It's not Unix, really. See? Capital letters. */
87 #define getpid() GetCurrentProcessId()
91 /* This is for other GNU distributions with internationalized messages.
92 When compiling libc, the _ macro is predefined. */
95 # define _(msgid) gettext (msgid)
97 # define _(msgid) (msgid)
101 /* This version of `getopt' appears to the caller like standard Unix `getopt'
102 but it behaves differently for the user, since it allows the user
103 to intersperse the options with the other arguments.
105 As `getopt' works, it permutes the elements of ARGV so that,
106 when it is done, all the options precede everything else. Thus
107 all application programs are extended to handle flexible argument order.
109 Setting the environment variable POSIXLY_CORRECT disables permutation.
110 Then the behavior is completely standard.
112 GNU application programs can use a third alternative mode in which
113 they can distinguish the relative order of options and other arguments. */
117 /* For communication from `getopt' to the caller.
118 When `getopt' finds an option that takes an argument,
119 the argument value is returned here.
120 Also, when `ordering' is RETURN_IN_ORDER,
121 each non-option ARGV-element is returned here. */
125 /* Index in ARGV of the next element to be scanned.
126 This is used for communication to and from the caller
127 and for communication between successive calls to `getopt'.
129 On entry to `getopt', zero means this is the first call; initialize.
131 When `getopt' returns -1, this is the index of the first of the
132 non-option elements that the caller should itself scan.
134 Otherwise, `optind' communicates from one call to the next
135 how much of ARGV has been scanned so far. */
137 /* 1003.2 says this must be 1 before any call. */
140 /* Formerly, initialization of getopt depended on optind==0, which
141 causes problems with re-calling getopt as programs generally don't
144 int __getopt_initialized = 0;
146 /* The next char to be scanned in the option-element
147 in which the last option character we returned was found.
148 This allows us to pick up the scan where we left off.
150 If this is zero, or a null string, it means resume the scan
151 by advancing to the next ARGV-element. */
153 static char *nextchar;
155 /* Callers store zero here to inhibit the error message
156 for unrecognized options. */
160 /* Set to an option character which was unrecognized.
161 This must be initialized on some systems to avoid linking in the
162 system's own getopt implementation. */
166 /* Describe how to deal with options that follow non-option ARGV-elements.
168 If the caller did not specify anything,
169 the default is REQUIRE_ORDER if the environment variable
170 POSIXLY_CORRECT is defined, PERMUTE otherwise.
172 REQUIRE_ORDER means don't recognize them as options;
173 stop option processing when the first non-option is seen.
174 This is what Unix does.
175 This mode of operation is selected by either setting the environment
176 variable POSIXLY_CORRECT, or using `+' as the first character
177 of the list of option characters.
179 PERMUTE is the default. We permute the contents of ARGV as we scan,
180 so that eventually all the non-options are at the end. This allows options
181 to be given in any order, even with programs that were not written to
184 RETURN_IN_ORDER is an option available to programs that were written
185 to expect options and other ARGV-elements in any order and that care about
186 the ordering of the two. We describe each non-option ARGV-element
187 as if it were the argument of an option with character code 1.
188 Using `-' as the first character of the list of option characters
189 selects this mode of operation.
191 The special argument `--' forces an end of option-scanning regardless
192 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
193 `--' can cause `getopt' to return -1 with `optind' != ARGC. */
197 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
200 /* Value of POSIXLY_CORRECT environment variable. */
201 static char *posixly_correct;
203 #ifdef __GNU_LIBRARY__
204 /* We want to avoid inclusion of string.h with non-GNU libraries
205 because there are many ways it can cause trouble.
206 On some systems, it contains special magic macros that don't work
209 #define my_index strchr
212 /* Avoid depending on library functions or files
213 whose names are inconsistent. */
231 /* If using GCC, we can safely declare strlen this way.
232 If not using GCC, it is ok not to declare it. */
234 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
235 That was relevant to code that was here before. */
236 #if !defined (__STDC__) || !__STDC__
237 /* gcc with -traditional declares the built-in strlen to return int,
238 and has done so at least since version 2.4.5. -- rms. */
239 extern int strlen (const char *);
240 #endif /* not __STDC__ */
241 #endif /* __GNUC__ */
243 #endif /* not __GNU_LIBRARY__ */
245 /* Handle permutation of arguments. */
247 /* Describe the part of ARGV that contains non-options that have
248 been skipped. `first_nonopt' is the index in ARGV of the first of them;
249 `last_nonopt' is the index after the last of them. */
251 static int first_nonopt;
252 static int last_nonopt;
255 /* Bash 2.0 gives us an environment variable containing flags
256 indicating ARGV elements that should not be considered arguments. */
258 static const char *nonoption_flags;
259 static int nonoption_flags_len;
261 static int original_argc;
262 static char *const *original_argv;
264 /* Make sure the environment variable bash 2.0 puts in the environment
265 is valid for the getopt call we must make sure that the ARGV passed
266 to getopt is that one passed to the process. */
267 static void store_args (int argc, char *const *argv) __attribute__ ((unused));
269 store_args (int argc, char *const *argv)
271 /* XXX This is no good solution. We should rather copy the args so
272 that we can compare them later. But we must not use malloc(3). */
273 original_argc = argc;
274 original_argv = argv;
276 text_set_element (__libc_subinit, store_args);
279 /* Exchange two adjacent subsequences of ARGV.
280 One subsequence is elements [first_nonopt,last_nonopt)
281 which contains all the non-options that have been skipped so far.
282 The other is elements [last_nonopt,optind), which contains all
283 the options processed since those non-options were skipped.
285 `first_nonopt' and `last_nonopt' are relocated so that they describe
286 the new indices of the non-options in ARGV after they are moved. */
288 #if defined (__STDC__) && __STDC__
289 static void exchange (char **);
296 int bottom = first_nonopt;
297 int middle = last_nonopt;
301 /* Exchange the shorter segment with the far end of the longer segment.
302 That puts the shorter segment into the right place.
303 It leaves the longer segment in the right place overall,
304 but it consists of two parts that need to be swapped next. */
306 while (top > middle && middle > bottom)
308 if (top - middle > middle - bottom)
310 /* Bottom segment is the short one. */
311 int len = middle - bottom;
314 /* Swap it with the top part of the top segment. */
315 for (i = 0; i < len; i++)
317 tem = argv[bottom + i];
318 argv[bottom + i] = argv[top - (middle - bottom) + i];
319 argv[top - (middle - bottom) + i] = tem;
321 /* Exclude the moved bottom segment from further swapping. */
326 /* Top segment is the short one. */
327 int len = top - middle;
330 /* Swap it with the bottom part of the bottom segment. */
331 for (i = 0; i < len; i++)
333 tem = argv[bottom + i];
334 argv[bottom + i] = argv[middle + i];
335 argv[middle + i] = tem;
337 /* Exclude the moved top segment from further swapping. */
342 /* Update records for the slots the non-options now occupy. */
344 first_nonopt += (optind - last_nonopt);
345 last_nonopt = optind;
348 /* Initialize the internal data when the first call is made. */
350 #if defined (__STDC__) && __STDC__
351 static const char *_getopt_initialize (int, char *const *, const char *);
354 _getopt_initialize (argc, argv, optstring)
357 const char *optstring;
359 /* Start processing options with ARGV-element 1 (since ARGV-element 0
360 is the program name); the sequence of previously skipped
361 non-option ARGV-elements is empty. */
363 first_nonopt = last_nonopt = optind = 1;
367 posixly_correct = getenv ("POSIXLY_CORRECT");
369 /* Determine how to handle the ordering of options and nonoptions. */
371 if (optstring[0] == '-')
373 ordering = RETURN_IN_ORDER;
376 else if (optstring[0] == '+')
378 ordering = REQUIRE_ORDER;
381 else if (posixly_correct != NULL)
382 ordering = REQUIRE_ORDER;
387 if (posixly_correct == NULL
388 && argc == original_argc && argv == original_argv)
390 /* Bash 2.0 puts a special variable in the environment for each
391 command it runs, specifying which ARGV elements are the results of
392 file name wildcard expansion and therefore should not be
393 considered as options. */
395 sprintf (var, "_%d_GNU_nonoption_argv_flags_", getpid ());
396 nonoption_flags = getenv (var);
397 if (nonoption_flags == NULL)
398 nonoption_flags_len = 0;
400 nonoption_flags_len = strlen (nonoption_flags);
403 nonoption_flags_len = 0;
409 /* Scan elements of ARGV (whose length is ARGC) for option characters
412 If an element of ARGV starts with '-', and is not exactly "-" or "--",
413 then it is an option element. The characters of this element
414 (aside from the initial '-') are option characters. If `getopt'
415 is called repeatedly, it returns successively each of the option characters
416 from each of the option elements.
418 If `getopt' finds another option character, it returns that character,
419 updating `optind' and `nextchar' so that the next call to `getopt' can
420 resume the scan with the following option character or ARGV-element.
422 If there are no more option characters, `getopt' returns -1.
423 Then `optind' is the index in ARGV of the first ARGV-element
424 that is not an option. (The ARGV-elements have been permuted
425 so that those that are not options now come last.)
427 OPTSTRING is a string containing the legitimate option characters.
428 If an option character is seen that is not listed in OPTSTRING,
429 return '?' after printing an error message. If you set `opterr' to
430 zero, the error message is suppressed but we still return '?'.
432 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
433 so the following text in the same ARGV-element, or the text of the following
434 ARGV-element, is returned in `optarg'. Two colons mean an option that
435 wants an optional arg; if there is text in the current ARGV-element,
436 it is returned in `optarg', otherwise `optarg' is set to zero.
438 If OPTSTRING starts with `-' or `+', it requests different methods of
439 handling the non-option ARGV-elements.
440 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
442 Long-named options begin with `--' instead of `-'.
443 Their names may be abbreviated as long as the abbreviation is unique
444 or is an exact match for some defined option. If they have an
445 argument, it follows the option name in the same ARGV-element, separated
446 from the option name by a `=', or else the in next ARGV-element.
447 When `getopt' finds a long-named option, it returns 0 if that option's
448 `flag' field is nonzero, the value of the option's `val' field
449 if the `flag' field is zero.
451 The elements of ARGV aren't really const, because we permute them.
452 But we pretend they're const in the prototype to be compatible
455 LONGOPTS is a vector of `struct option' terminated by an
456 element containing a name which is zero.
458 LONGIND returns the index in LONGOPT of the long-named option found.
459 It is only valid when a long-named option has been found by the most
462 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
463 long-named options. */
466 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
469 const char *optstring;
470 const struct option *longopts;
476 if (!__getopt_initialized || optind == 0)
478 optstring = _getopt_initialize (argc, argv, optstring);
479 optind = 1; /* Don't scan ARGV[0], the program name. */
480 __getopt_initialized = 1;
483 /* Test whether ARGV[optind] points to a non-option argument.
484 Either it does not have option syntax, or there is an environment flag
485 from the shell indicating it is not an option. The later information
486 is only used when the used in the GNU libc. */
488 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
489 || (optind < nonoption_flags_len \
490 && nonoption_flags[optind] == '1'))
492 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
495 if (nextchar == NULL || *nextchar == '\0')
497 /* Advance to the next ARGV-element. */
499 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
500 moved back by the user (who may also have changed the arguments). */
501 if (last_nonopt > optind)
502 last_nonopt = optind;
503 if (first_nonopt > optind)
504 first_nonopt = optind;
506 if (ordering == PERMUTE)
508 /* If we have just processed some options following some non-options,
509 exchange them so that the options come first. */
511 if (first_nonopt != last_nonopt && last_nonopt != optind)
512 exchange ((char **) argv);
513 else if (last_nonopt != optind)
514 first_nonopt = optind;
516 /* Skip any additional non-options
517 and extend the range of non-options previously skipped. */
519 while (optind < argc && NONOPTION_P)
521 last_nonopt = optind;
524 /* The special ARGV-element `--' means premature end of options.
525 Skip it like a null option,
526 then exchange with previous non-options as if it were an option,
527 then skip everything else like a non-option. */
529 if (optind != argc && !strcmp (argv[optind], "--"))
533 if (first_nonopt != last_nonopt && last_nonopt != optind)
534 exchange ((char **) argv);
535 else if (first_nonopt == last_nonopt)
536 first_nonopt = optind;
542 /* If we have done all the ARGV-elements, stop the scan
543 and back over any non-options that we skipped and permuted. */
547 /* Set the next-arg-index to point at the non-options
548 that we previously skipped, so the caller will digest them. */
549 if (first_nonopt != last_nonopt)
550 optind = first_nonopt;
554 /* If we have come to a non-option and did not permute it,
555 either stop the scan or describe it to the caller and pass it by. */
559 if (ordering == REQUIRE_ORDER)
561 optarg = argv[optind++];
565 /* We have found another option-ARGV-element.
566 Skip the initial punctuation. */
568 nextchar = (argv[optind] + 1
569 + (longopts != NULL && argv[optind][1] == '-'));
572 /* Decode the current option-ARGV-element. */
574 /* Check whether the ARGV-element is a long option.
576 If long_only and the ARGV-element has the form "-f", where f is
577 a valid short option, don't consider it an abbreviated form of
578 a long option that starts with f. Otherwise there would be no
579 way to give the -f short option.
581 On the other hand, if there's a long option "fubar" and
582 the ARGV-element is "-fu", do consider that an abbreviation of
583 the long option, just like "--fu", and not "-f" with arg "u".
585 This distinction seems to be the most useful approach. */
588 && (argv[optind][1] == '-'
589 || (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
592 const struct option *p;
593 const struct option *pfound = NULL;
599 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
602 /* Test all long options for either exact match
603 or abbreviated matches. */
604 for (p = longopts, option_index = 0; p->name; p++, option_index++)
605 if (!strncmp (p->name, nextchar, nameend - nextchar))
607 if ((unsigned int) (nameend - nextchar)
608 == (unsigned int) strlen (p->name))
610 /* Exact match found. */
612 indfound = option_index;
616 else if (pfound == NULL)
618 /* First nonexact match found. */
620 indfound = option_index;
623 /* Second or later nonexact match found. */
630 fprintf (stderr, _("%s: option `%s' is ambiguous\n"),
631 argv[0], argv[optind]);
632 nextchar += strlen (nextchar);
640 option_index = indfound;
644 /* Don't test has_arg with >, because some C compilers don't
645 allow it to be used on enums. */
647 optarg = nameend + 1;
651 if (argv[optind - 1][1] == '-')
654 _("%s: option `--%s' doesn't allow an argument\n"),
655 argv[0], pfound->name);
657 /* +option or -option */
659 _("%s: option `%c%s' doesn't allow an argument\n"),
660 argv[0], argv[optind - 1][0], pfound->name);
662 nextchar += strlen (nextchar);
664 optopt = pfound->val;
668 else if (pfound->has_arg == 1)
671 optarg = argv[optind++];
676 _("%s: option `%s' requires an argument\n"),
677 argv[0], argv[optind - 1]);
678 nextchar += strlen (nextchar);
679 optopt = pfound->val;
680 return optstring[0] == ':' ? ':' : '?';
683 nextchar += strlen (nextchar);
685 *longind = option_index;
688 *(pfound->flag) = pfound->val;
694 /* Can't find it as a long option. If this is not getopt_long_only,
695 or the option starts with '--' or is not a valid short
696 option, then it's an error.
697 Otherwise interpret it as a short option. */
698 if (!long_only || argv[optind][1] == '-'
699 || my_index (optstring, *nextchar) == NULL)
703 if (argv[optind][1] == '-')
705 fprintf (stderr, _("%s: unrecognized option `--%s'\n"),
708 /* +option or -option */
709 fprintf (stderr, _("%s: unrecognized option `%c%s'\n"),
710 argv[0], argv[optind][0], nextchar);
712 nextchar = (char *) "";
719 /* Look at and handle the next short option-character. */
722 char c = *nextchar++;
723 char *temp = my_index (optstring, c);
725 /* Increment `optind' when we start to process its last character. */
726 if (*nextchar == '\0')
729 if (temp == NULL || c == ':')
734 /* 1003.2 specifies the format of this message. */
735 fprintf (stderr, _("%s: illegal option -- %c\n"),
738 fprintf (stderr, _("%s: invalid option -- %c\n"),
744 /* Convenience. Treat POSIX -W foo same as long option --foo */
745 if (temp[0] == 'W' && temp[1] == ';')
748 const struct option *p;
749 const struct option *pfound = NULL;
755 /* This is an option that requires an argument. */
756 if (*nextchar != '\0')
759 /* If we end this ARGV-element by taking the rest as an arg,
760 we must advance to the next element now. */
763 else if (optind == argc)
767 /* 1003.2 specifies the format of this message. */
768 fprintf (stderr, _("%s: option requires an argument -- %c\n"),
772 if (optstring[0] == ':')
779 /* We already incremented `optind' once;
780 increment it again when taking next ARGV-elt as argument. */
781 optarg = argv[optind++];
783 /* optarg is now the argument, see if it's in the
784 table of longopts. */
786 for (nextchar = nameend = optarg; *nameend && *nameend != '='; nameend++)
789 /* Test all long options for either exact match
790 or abbreviated matches. */
791 for (p = longopts, option_index = 0; p->name; p++, option_index++)
792 if (!strncmp (p->name, nextchar, nameend - nextchar))
794 if ((unsigned int) (nameend - nextchar) == strlen (p->name))
796 /* Exact match found. */
798 indfound = option_index;
802 else if (pfound == NULL)
804 /* First nonexact match found. */
806 indfound = option_index;
809 /* Second or later nonexact match found. */
815 fprintf (stderr, _("%s: option `-W %s' is ambiguous\n"),
816 argv[0], argv[optind]);
817 nextchar += strlen (nextchar);
823 option_index = indfound;
826 /* Don't test has_arg with >, because some C compilers don't
827 allow it to be used on enums. */
829 optarg = nameend + 1;
833 fprintf (stderr, _("\
834 %s: option `-W %s' doesn't allow an argument\n"),
835 argv[0], pfound->name);
837 nextchar += strlen (nextchar);
841 else if (pfound->has_arg == 1)
844 optarg = argv[optind++];
849 _("%s: option `%s' requires an argument\n"),
850 argv[0], argv[optind - 1]);
851 nextchar += strlen (nextchar);
852 return optstring[0] == ':' ? ':' : '?';
855 nextchar += strlen (nextchar);
857 *longind = option_index;
860 *(pfound->flag) = pfound->val;
866 return 'W'; /* Let the application handle it. */
872 /* This is an option that accepts an argument optionally. */
873 if (*nextchar != '\0')
884 /* This is an option that requires an argument. */
885 if (*nextchar != '\0')
888 /* If we end this ARGV-element by taking the rest as an arg,
889 we must advance to the next element now. */
892 else if (optind == argc)
896 /* 1003.2 specifies the format of this message. */
898 _("%s: option requires an argument -- %c\n"),
902 if (optstring[0] == ':')
908 /* We already incremented `optind' once;
909 increment it again when taking next ARGV-elt as argument. */
910 optarg = argv[optind++];
919 getopt (argc, argv, optstring)
922 const char *optstring;
924 return _getopt_internal (argc, argv, optstring,
925 (const struct option *) 0,
930 #endif /* Not ELIDE_CODE. */
934 /* Compile with -DTEST to make an executable for use in testing
935 the above definition of `getopt'. */
943 int digit_optind = 0;
947 int this_option_optind = optind ? optind : 1;
949 c = getopt (argc, argv, "abc:d:0123456789");
965 if (digit_optind != 0 && digit_optind != this_option_optind)
966 printf ("digits occur in two different argv-elements.\n");
967 digit_optind = this_option_optind;
968 printf ("option %c\n", c);
972 printf ("option a\n");
976 printf ("option b\n");
980 printf ("option c with value `%s'\n", optarg);
987 printf ("?? getopt returned character code 0%o ??\n", c);
993 printf ("non-option ARGV-elements: ");
994 while (optind < argc)
995 printf ("%s ", argv[optind++]);