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., 59 Temple Place - Suite 330,
25 Boston, MA 02111-1307, 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>. */
40 #if !defined (__STDC__) || !__STDC__
41 /* This is a separate conditional since some stdc systems
42 reject `defined (const)'. */
50 /* Comment out all this code if we are using the GNU C Library, and are not
51 actually compiling the library itself. This code is part of the GNU C
52 Library, but also included in many other GNU distributions. Compiling
53 and linking in this code is a waste when using the GNU C library
54 (especially if it is a shared library). Rather than having every GNU
55 program understand `configure --with-gnu-libc' and omit the object files,
56 it is simpler to just do this in the source for each such file. */
58 #define GETOPT_INTERFACE_VERSION 2
59 #if !defined (_LIBC) && defined (__GLIBC__) && __GLIBC__ >= 2
60 #include <gnu-versions.h>
61 #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. */
81 #ifdef STRNCASECMP_IN_STRINGS_H
87 #if defined (WIN32) && !defined (__CYGWIN32__) || defined(UNDER_CE)
88 /* It's not Unix, really. See? Capital letters. */
90 #define getpid() GetCurrentProcessId()
94 /* This is for other GNU distributions with internationalized messages.
95 When compiling libc, the _ macro is predefined. */
98 #define _(msgid) gettext (msgid)
100 #define _(msgid) (msgid)
104 /* This version of `getopt' appears to the caller like standard Unix `getopt'
105 but it behaves differently for the user, since it allows the user
106 to intersperse the options with the other arguments.
108 As `getopt' works, it permutes the elements of ARGV so that,
109 when it is done, all the options precede everything else. Thus
110 all application programs are extended to handle flexible argument order.
112 Setting the environment variable POSIXLY_CORRECT disables permutation.
113 Then the behavior is completely standard.
115 GNU application programs can use a third alternative mode in which
116 they can distinguish the relative order of options and other arguments. */
120 /* For communication from `getopt' to the caller.
121 When `getopt' finds an option that takes an argument,
122 the argument value is returned here.
123 Also, when `ordering' is RETURN_IN_ORDER,
124 each non-option ARGV-element is returned here. */
128 /* Index in ARGV of the next element to be scanned.
129 This is used for communication to and from the caller
130 and for communication between successive calls to `getopt'.
132 On entry to `getopt', zero means this is the first call; initialize.
134 When `getopt' returns -1, this is the index of the first of the
135 non-option elements that the caller should itself scan.
137 Otherwise, `optind' communicates from one call to the next
138 how much of ARGV has been scanned so far. */
140 /* 1003.2 says this must be 1 before any call. */
143 /* Formerly, initialization of getopt depended on optind==0, which
144 causes problems with re-calling getopt as programs generally don't
147 int __getopt_initialized = 0;
149 /* The next char to be scanned in the option-element
150 in which the last option character we returned was found.
151 This allows us to pick up the scan where we left off.
153 If this is zero, or a null string, it means resume the scan
154 by advancing to the next ARGV-element. */
156 static char *nextchar;
158 /* Callers store zero here to inhibit the error message
159 for unrecognized options. */
163 /* Set to an option character which was unrecognized.
164 This must be initialized on some systems to avoid linking in the
165 system's own getopt implementation. */
169 /* Describe how to deal with options that follow non-option ARGV-elements.
171 If the caller did not specify anything,
172 the default is REQUIRE_ORDER if the environment variable
173 POSIXLY_CORRECT is defined, PERMUTE otherwise.
175 REQUIRE_ORDER means don't recognize them as options;
176 stop option processing when the first non-option is seen.
177 This is what Unix does.
178 This mode of operation is selected by either setting the environment
179 variable POSIXLY_CORRECT, or using `+' as the first character
180 of the list of option characters.
182 PERMUTE is the default. We permute the contents of ARGV as we scan,
183 so that eventually all the non-options are at the end. This allows options
184 to be given in any order, even with programs that were not written to
187 RETURN_IN_ORDER is an option available to programs that were written
188 to expect options and other ARGV-elements in any order and that care about
189 the ordering of the two. We describe each non-option ARGV-element
190 as if it were the argument of an option with character code 1.
191 Using `-' as the first character of the list of option characters
192 selects this mode of operation.
194 The special argument `--' forces an end of option-scanning regardless
195 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
196 `--' can cause `getopt' to return -1 with `optind' != ARGC. */
200 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
204 /* Value of POSIXLY_CORRECT environment variable. */
205 static char *posixly_correct;
207 #ifdef __GNU_LIBRARY__
208 /* We want to avoid inclusion of string.h with non-GNU libraries
209 because there are many ways it can cause trouble.
210 On some systems, it contains special magic macros that don't work
213 #define my_index strchr
216 /* Avoid depending on library functions or files
217 whose names are inconsistent. */
235 /* If using GCC, we can safely declare strlen this way.
236 If not using GCC, it is ok not to declare it. */
238 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
239 That was relevant to code that was here before. */
240 #if !defined (__STDC__) || !__STDC__
241 /* gcc with -traditional declares the built-in strlen to return int,
242 and has done so at least since version 2.4.5. -- rms. */
243 extern int strlen(const char *);
245 #endif /* not __STDC__ */
246 #endif /* __GNUC__ */
248 #endif /* not __GNU_LIBRARY__ */
250 /* Handle permutation of arguments. */
252 /* Describe the part of ARGV that contains non-options that have
253 been skipped. `first_nonopt' is the index in ARGV of the first of them;
254 `last_nonopt' is the index after the last of them. */
256 static int first_nonopt;
257 static int last_nonopt;
260 /* Bash 2.0 gives us an environment variable containing flags
261 indicating ARGV elements that should not be considered arguments. */
263 static const char *nonoption_flags;
264 static int nonoption_flags_len;
266 static int original_argc;
267 static char *const *original_argv;
269 /* Make sure the environment variable bash 2.0 puts in the environment
270 is valid for the getopt call we must make sure that the ARGV passed
271 to getopt is that one passed to the process. */
272 static void store_args(int argc, char *const *argv) __attribute__((unused));
274 store_args(int argc, char *const *argv)
276 /* XXX This is no good solution. We should rather copy the args so
277 that we can compare them later. But we must not use malloc(3). */
278 original_argc = argc;
279 original_argv = argv;
281 text_set_element(__libc_subinit, store_args);
284 /* Exchange two adjacent subsequences of ARGV.
285 One subsequence is elements [first_nonopt,last_nonopt)
286 which contains all the non-options that have been skipped so far.
287 The other is elements [last_nonopt,optind), which contains all
288 the options processed since those non-options were skipped.
290 `first_nonopt' and `last_nonopt' are relocated so that they describe
291 the new indices of the non-options in ARGV after they are moved. */
293 #if defined (__STDC__) && __STDC__
294 static void exchange(char **);
302 int bottom = first_nonopt;
303 int middle = last_nonopt;
307 /* Exchange the shorter segment with the far end of the longer segment.
308 That puts the shorter segment into the right place.
309 It leaves the longer segment in the right place overall,
310 but it consists of two parts that need to be swapped next. */
312 while (top > middle && middle > bottom)
314 if (top - middle > middle - bottom)
316 /* Bottom segment is the short one. */
317 int len = middle - bottom;
320 /* Swap it with the top part of the top segment. */
321 for (i = 0; i < len; i++)
323 tem = argv[bottom + i];
324 argv[bottom + i] = argv[top - (middle - bottom) + i];
325 argv[top - (middle - bottom) + i] = tem;
327 /* Exclude the moved bottom segment from further swapping. */
332 /* Top segment is the short one. */
333 int len = top - middle;
336 /* Swap it with the bottom part of the bottom segment. */
337 for (i = 0; i < len; i++)
339 tem = argv[bottom + i];
340 argv[bottom + i] = argv[middle + i];
341 argv[middle + i] = tem;
343 /* Exclude the moved top segment from further swapping. */
348 /* Update records for the slots the non-options now occupy. */
350 first_nonopt += (optind - last_nonopt);
351 last_nonopt = optind;
354 /* Initialize the internal data when the first call is made. */
356 #if defined (__STDC__) && __STDC__
357 static const char *_getopt_initialize(int, char *const *, const char *);
361 _getopt_initialize(argc, argv, optstring)
364 const char *optstring;
366 /* Start processing options with ARGV-element 1 (since ARGV-element 0
367 is the program name); the sequence of previously skipped
368 non-option ARGV-elements is empty. */
370 first_nonopt = last_nonopt = optind = 1;
374 posixly_correct = getenv("POSIXLY_CORRECT");
376 /* Determine how to handle the ordering of options and nonoptions. */
378 if (optstring[0] == '-')
380 ordering = RETURN_IN_ORDER;
383 else if (optstring[0] == '+')
385 ordering = REQUIRE_ORDER;
388 else if (posixly_correct != NULL)
389 ordering = REQUIRE_ORDER;
394 if (posixly_correct == NULL
395 && argc == original_argc && argv == original_argv)
397 /* Bash 2.0 puts a special variable in the environment for each
398 command it runs, specifying which ARGV elements are the results of
399 file name wildcard expansion and therefore should not be
400 considered as options. */
403 sprintf(var, "_%d_GNU_nonoption_argv_flags_", getpid());
404 nonoption_flags = getenv(var);
405 if (nonoption_flags == NULL)
406 nonoption_flags_len = 0;
408 nonoption_flags_len = strlen(nonoption_flags);
411 nonoption_flags_len = 0;
417 /* Scan elements of ARGV (whose length is ARGC) for option characters
420 If an element of ARGV starts with '-', and is not exactly "-" or "--",
421 then it is an option element. The characters of this element
422 (aside from the initial '-') are option characters. If `getopt'
423 is called repeatedly, it returns successively each of the option characters
424 from each of the option elements.
426 If `getopt' finds another option character, it returns that character,
427 updating `optind' and `nextchar' so that the next call to `getopt' can
428 resume the scan with the following option character or ARGV-element.
430 If there are no more option characters, `getopt' returns -1.
431 Then `optind' is the index in ARGV of the first ARGV-element
432 that is not an option. (The ARGV-elements have been permuted
433 so that those that are not options now come last.)
435 OPTSTRING is a string containing the legitimate option characters.
436 If an option character is seen that is not listed in OPTSTRING,
437 return '?' after printing an error message. If you set `opterr' to
438 zero, the error message is suppressed but we still return '?'.
440 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
441 so the following text in the same ARGV-element, or the text of the following
442 ARGV-element, is returned in `optarg'. Two colons mean an option that
443 wants an optional arg; if there is text in the current ARGV-element,
444 it is returned in `optarg', otherwise `optarg' is set to zero.
446 If OPTSTRING starts with `-' or `+', it requests different methods of
447 handling the non-option ARGV-elements.
448 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
450 Long-named options begin with `--' instead of `-'.
451 Their names may be abbreviated as long as the abbreviation is unique
452 or is an exact match for some defined option. If they have an
453 argument, it follows the option name in the same ARGV-element, separated
454 from the option name by a `=', or else the in next ARGV-element.
455 When `getopt' finds a long-named option, it returns 0 if that option's
456 `flag' field is nonzero, the value of the option's `val' field
457 if the `flag' field is zero.
459 The elements of ARGV aren't really const, because we permute them.
460 But we pretend they're const in the prototype to be compatible
463 LONGOPTS is a vector of `struct option' terminated by an
464 element containing a name which is zero.
466 LONGIND returns the index in LONGOPT of the long-named option found.
467 It is only valid when a long-named option has been found by the most
470 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
471 long-named options. */
474 _getopt_internal(argc, argv, optstring, longopts, longind, long_only)
477 const char *optstring;
478 const struct option *longopts;
484 if (!__getopt_initialized || optind == 0)
486 optstring = _getopt_initialize(argc, argv, optstring);
487 optind = 1; /* Don't scan ARGV[0], the program name. */
488 __getopt_initialized = 1;
491 /* Test whether ARGV[optind] points to a non-option argument.
492 Either it does not have option syntax, or there is an environment flag
493 from the shell indicating it is not an option. The later information
494 is only used when the used in the GNU libc. */
496 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
497 || (optind < nonoption_flags_len \
498 && nonoption_flags[optind] == '1'))
500 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
503 if (nextchar == NULL || *nextchar == '\0')
505 /* Advance to the next ARGV-element. */
507 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
508 moved back by the user (who may also have changed the arguments). */
509 if (last_nonopt > optind)
510 last_nonopt = optind;
511 if (first_nonopt > optind)
512 first_nonopt = optind;
514 if (ordering == PERMUTE)
516 /* If we have just processed some options following some non-options,
517 exchange them so that the options come first. */
519 if (first_nonopt != last_nonopt && last_nonopt != optind)
520 exchange((char **) argv);
521 else if (last_nonopt != optind)
522 first_nonopt = optind;
524 /* Skip any additional non-options
525 and extend the range of non-options previously skipped. */
527 while (optind < argc && NONOPTION_P)
529 last_nonopt = optind;
532 /* The special ARGV-element `--' means premature end of options.
533 Skip it like a null option,
534 then exchange with previous non-options as if it were an option,
535 then skip everything else like a non-option. */
537 if (optind != argc && !strcmp(argv[optind], "--"))
541 if (first_nonopt != last_nonopt && last_nonopt != optind)
542 exchange((char **) argv);
543 else if (first_nonopt == last_nonopt)
544 first_nonopt = optind;
550 /* If we have done all the ARGV-elements, stop the scan
551 and back over any non-options that we skipped and permuted. */
555 /* Set the next-arg-index to point at the non-options
556 that we previously skipped, so the caller will digest them. */
557 if (first_nonopt != last_nonopt)
558 optind = first_nonopt;
562 /* If we have come to a non-option and did not permute it,
563 either stop the scan or describe it to the caller and pass it by. */
567 if (ordering == REQUIRE_ORDER)
569 optarg = argv[optind++];
573 /* We have found another option-ARGV-element.
574 Skip the initial punctuation. */
576 nextchar = (argv[optind] + 1
577 + (longopts != NULL && argv[optind][1] == '-'));
580 /* Decode the current option-ARGV-element. */
582 /* Check whether the ARGV-element is a long option.
584 If long_only and the ARGV-element has the form "-f", where f is
585 a valid short option, don't consider it an abbreviated form of
586 a long option that starts with f. Otherwise there would be no
587 way to give the -f short option.
589 On the other hand, if there's a long option "fubar" and
590 the ARGV-element is "-fu", do consider that an abbreviation of
591 the long option, just like "--fu", and not "-f" with arg "u".
593 This distinction seems to be the most useful approach. */
596 && (argv[optind][1] == '-'
597 || (long_only && (argv[optind][2] || !my_index(optstring, argv[optind][1])))))
600 const struct option *p;
601 const struct option *pfound = NULL;
607 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
610 /* Test all long options for either exact match
611 or abbreviated matches. */
612 for (p = longopts, option_index = 0; p->name; p++, option_index++)
613 if (!strncmp(p->name, nextchar, nameend - nextchar))
615 if ((unsigned int) (nameend - nextchar)
616 == (unsigned int) strlen(p->name))
618 /* Exact match found. */
620 indfound = option_index;
624 else if (pfound == NULL)
626 /* First nonexact match found. */
628 indfound = option_index;
631 /* Second or later nonexact match found. */
638 fprintf(stderr, _("%s: option `%s' is ambiguous\n"),
639 argv[0], argv[optind]);
640 nextchar += strlen(nextchar);
648 option_index = indfound;
652 /* Don't test has_arg with >, because some C compilers don't
653 allow it to be used on enums. */
655 optarg = nameend + 1;
660 if (argv[optind - 1][1] == '-')
663 _("%s: option `--%s' doesn't allow an argument\n"),
664 argv[0], pfound->name);
666 /* +option or -option */
668 _("%s: option `%c%s' doesn't allow an argument\n"),
669 argv[0], argv[optind - 1][0], pfound->name);
672 nextchar += strlen(nextchar);
674 optopt = pfound->val;
678 else if (pfound->has_arg == 1)
681 optarg = argv[optind++];
686 _("%s: option `%s' requires an argument\n"),
687 argv[0], argv[optind - 1]);
688 nextchar += strlen(nextchar);
689 optopt = pfound->val;
690 return optstring[0] == ':' ? ':' : '?';
693 nextchar += strlen(nextchar);
695 *longind = option_index;
698 *(pfound->flag) = pfound->val;
704 /* Can't find it as a long option. If this is not getopt_long_only,
705 or the option starts with '--' or is not a valid short
706 option, then it's an error.
707 Otherwise interpret it as a short option. */
708 if (!long_only || argv[optind][1] == '-'
709 || my_index(optstring, *nextchar) == NULL)
713 if (argv[optind][1] == '-')
715 fprintf(stderr, _("%s: unrecognized option `--%s'\n"),
718 /* +option or -option */
719 fprintf(stderr, _("%s: unrecognized option `%c%s'\n"),
720 argv[0], argv[optind][0], nextchar);
722 nextchar = (char *) "";
729 /* Look at and handle the next short option-character. */
732 char c = *nextchar++;
733 char *temp = my_index(optstring, c);
735 /* Increment `optind' when we start to process its last character. */
736 if (*nextchar == '\0')
739 if (temp == NULL || c == ':')
744 /* 1003.2 specifies the format of this message. */
745 fprintf(stderr, _("%s: illegal option -- %c\n"),
748 fprintf(stderr, _("%s: invalid option -- %c\n"),
754 /* Convenience. Treat POSIX -W foo same as long option --foo */
755 if (temp[0] == 'W' && temp[1] == ';')
758 const struct option *p;
759 const struct option *pfound = NULL;
765 /* This is an option that requires an argument. */
766 if (*nextchar != '\0')
769 /* If we end this ARGV-element by taking the rest as an arg,
770 we must advance to the next element now. */
773 else if (optind == argc)
777 /* 1003.2 specifies the format of this message. */
778 fprintf(stderr, _("%s: option requires an argument -- %c\n"),
782 if (optstring[0] == ':')
789 /* We already incremented `optind' once;
790 increment it again when taking next ARGV-elt as argument. */
791 optarg = argv[optind++];
793 /* optarg is now the argument, see if it's in the
794 table of longopts. */
796 for (nextchar = nameend = optarg; *nameend && *nameend != '='; nameend++)
799 /* Test all long options for either exact match
800 or abbreviated matches. */
801 for (p = longopts, option_index = 0; p->name; p++, option_index++)
802 if (!strncmp(p->name, nextchar, nameend - nextchar))
804 if ((unsigned int) (nameend - nextchar) == strlen(p->name))
806 /* Exact match found. */
808 indfound = option_index;
812 else if (pfound == NULL)
814 /* First nonexact match found. */
816 indfound = option_index;
819 /* Second or later nonexact match found. */
825 fprintf(stderr, _("%s: option `-W %s' is ambiguous\n"),
826 argv[0], argv[optind]);
827 nextchar += strlen(nextchar);
833 option_index = indfound;
836 /* Don't test has_arg with >, because some C compilers don't
837 allow it to be used on enums. */
839 optarg = nameend + 1;
844 %s: option `-W %s' doesn't allow an argument\n"),
845 argv[0], pfound->name);
847 nextchar += strlen(nextchar);
851 else if (pfound->has_arg == 1)
854 optarg = argv[optind++];
859 _("%s: option `%s' requires an argument\n"),
860 argv[0], argv[optind - 1]);
861 nextchar += strlen(nextchar);
862 return optstring[0] == ':' ? ':' : '?';
865 nextchar += strlen(nextchar);
867 *longind = option_index;
870 *(pfound->flag) = pfound->val;
876 return 'W'; /* Let the application handle it. */
882 /* This is an option that accepts an argument optionally. */
883 if (*nextchar != '\0')
894 /* This is an option that requires an argument. */
895 if (*nextchar != '\0')
898 /* If we end this ARGV-element by taking the rest as an arg,
899 we must advance to the next element now. */
902 else if (optind == argc)
906 /* 1003.2 specifies the format of this message. */
908 _("%s: option requires an argument -- %c\n"),
912 if (optstring[0] == ':')
918 /* We already incremented `optind' once;
919 increment it again when taking next ARGV-elt as argument. */
920 optarg = argv[optind++];
929 getopt(argc, argv, optstring)
932 const char *optstring;
934 return _getopt_internal(argc, argv, optstring,
935 (const struct option *) 0,
940 #endif /* Not ELIDE_CODE. */
944 /* Compile with -DTEST to make an executable for use in testing
945 the above definition of `getopt'. */
953 int digit_optind = 0;
957 int this_option_optind = optind ? optind : 1;
959 c = getopt(argc, argv, "abc:d:0123456789");
975 if (digit_optind != 0 && digit_optind != this_option_optind)
976 printf("digits occur in two different argv-elements.\n");
977 digit_optind = this_option_optind;
978 printf("option %c\n", c);
982 printf("option a\n");
986 printf("option b\n");
990 printf("option c with value `%s'\n", optarg);
997 printf("?? getopt returned character code 0%o ??\n", c);
1003 printf("non-option ARGV-elements: ");
1004 while (optind < argc)
1005 printf("%s ", argv[optind++]);