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>. */
37 #if !defined (__STDC__) || !__STDC__
38 /* This is a separate conditional since some stdc systems
39 reject `defined (const)'. */
48 /* Comment out all this code if we are using the GNU C Library, and are not
49 actually compiling the library itself. This code is part of the GNU C
50 Library, but also included in many other GNU distributions. Compiling
51 and linking in this code is a waste when using the GNU C library
52 (especially if it is a shared library). Rather than having every GNU
53 program understand `configure --with-gnu-libc' and omit the object files,
54 it is simpler to just do this in the source for each such file. */
56 #define GETOPT_INTERFACE_VERSION 2
57 #if !defined (_LIBC) && defined (__GLIBC__) && __GLIBC__ >= 2
58 #include <gnu-versions.h>
59 #if _GNU_GETOPT_INTERFACE_VERSION == GETOPT_INTERFACE_VERSION
66 /* This needs to come after some library #include
67 to get __GNU_LIBRARY__ defined. */
68 #ifdef __GNU_LIBRARY__
69 /* Don't include stdlib.h for non-GNU C libraries because some of them
70 contain conflicting prototypes for getopt. */
73 #endif /* GNU C library. */
82 #if defined (WIN32) && !defined (__CYGWIN32__)
83 /* It's not Unix, really. See? Capital letters. */
85 #define getpid() GetCurrentProcessId()
89 /* This is for other GNU distributions with internationalized messages.
90 When compiling libc, the _ macro is predefined. */
93 #define _(msgid) gettext (msgid)
95 #define _(msgid) (msgid)
99 /* This version of `getopt' appears to the caller like standard Unix `getopt'
100 but it behaves differently for the user, since it allows the user
101 to intersperse the options with the other arguments.
103 As `getopt' works, it permutes the elements of ARGV so that,
104 when it is done, all the options precede everything else. Thus
105 all application programs are extended to handle flexible argument order.
107 Setting the environment variable POSIXLY_CORRECT disables permutation.
108 Then the behavior is completely standard.
110 GNU application programs can use a third alternative mode in which
111 they can distinguish the relative order of options and other arguments. */
115 /* For communication from `getopt' to the caller.
116 When `getopt' finds an option that takes an argument,
117 the argument value is returned here.
118 Also, when `ordering' is RETURN_IN_ORDER,
119 each non-option ARGV-element is returned here. */
123 /* Index in ARGV of the next element to be scanned.
124 This is used for communication to and from the caller
125 and for communication between successive calls to `getopt'.
127 On entry to `getopt', zero means this is the first call; initialize.
129 When `getopt' returns -1, this is the index of the first of the
130 non-option elements that the caller should itself scan.
132 Otherwise, `optind' communicates from one call to the next
133 how much of ARGV has been scanned so far. */
135 /* 1003.2 says this must be 1 before any call. */
138 /* Formerly, initialization of getopt depended on optind==0, which
139 causes problems with re-calling getopt as programs generally don't
142 int __getopt_initialized = 0;
144 /* The next char to be scanned in the option-element
145 in which the last option character we returned was found.
146 This allows us to pick up the scan where we left off.
148 If this is zero, or a null string, it means resume the scan
149 by advancing to the next ARGV-element. */
151 static char *nextchar;
153 /* Callers store zero here to inhibit the error message
154 for unrecognized options. */
158 /* Set to an option character which was unrecognized.
159 This must be initialized on some systems to avoid linking in the
160 system's own getopt implementation. */
164 /* Describe how to deal with options that follow non-option ARGV-elements.
166 If the caller did not specify anything,
167 the default is REQUIRE_ORDER if the environment variable
168 POSIXLY_CORRECT is defined, PERMUTE otherwise.
170 REQUIRE_ORDER means don't recognize them as options;
171 stop option processing when the first non-option is seen.
172 This is what Unix does.
173 This mode of operation is selected by either setting the environment
174 variable POSIXLY_CORRECT, or using `+' as the first character
175 of the list of option characters.
177 PERMUTE is the default. We permute the contents of ARGV as we scan,
178 so that eventually all the non-options are at the end. This allows options
179 to be given in any order, even with programs that were not written to
182 RETURN_IN_ORDER is an option available to programs that were written
183 to expect options and other ARGV-elements in any order and that care about
184 the ordering of the two. We describe each non-option ARGV-element
185 as if it were the argument of an option with character code 1.
186 Using `-' as the first character of the list of option characters
187 selects this mode of operation.
189 The special argument `--' forces an end of option-scanning regardless
190 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
191 `--' can cause `getopt' to return -1 with `optind' != ARGC. */
195 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
199 /* Value of POSIXLY_CORRECT environment variable. */
200 static char *posixly_correct;
202 #ifdef __GNU_LIBRARY__
203 /* We want to avoid inclusion of string.h with non-GNU libraries
204 because there are many ways it can cause trouble.
205 On some systems, it contains special magic macros that don't work
208 #define my_index strchr
211 /* Avoid depending on library functions or files
212 whose names are inconsistent. */
230 /* If using GCC, we can safely declare strlen this way.
231 If not using GCC, it is ok not to declare it. */
233 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
234 That was relevant to code that was here before. */
235 #if !defined (__STDC__) || !__STDC__
236 /* gcc with -traditional declares the built-in strlen to return int,
237 and has done so at least since version 2.4.5. -- rms. */
238 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 **);
297 int bottom = first_nonopt;
298 int middle = last_nonopt;
302 /* Exchange the shorter segment with the far end of the longer segment.
303 That puts the shorter segment into the right place.
304 It leaves the longer segment in the right place overall,
305 but it consists of two parts that need to be swapped next. */
307 while (top > middle && middle > bottom)
309 if (top - middle > middle - bottom)
311 /* Bottom segment is the short one. */
312 int len = middle - bottom;
315 /* Swap it with the top part of the top segment. */
316 for (i = 0; i < len; i++)
318 tem = argv[bottom + i];
319 argv[bottom + i] = argv[top - (middle - bottom) + i];
320 argv[top - (middle - bottom) + i] = tem;
322 /* Exclude the moved bottom segment from further swapping. */
327 /* Top segment is the short one. */
328 int len = top - middle;
331 /* Swap it with the bottom part of the bottom segment. */
332 for (i = 0; i < len; i++)
334 tem = argv[bottom + i];
335 argv[bottom + i] = argv[middle + i];
336 argv[middle + i] = tem;
338 /* Exclude the moved top segment from further swapping. */
343 /* Update records for the slots the non-options now occupy. */
345 first_nonopt += (optind - last_nonopt);
346 last_nonopt = optind;
349 /* Initialize the internal data when the first call is made. */
351 #if defined (__STDC__) && __STDC__
352 static const char *_getopt_initialize(int, char *const *, const char *);
356 _getopt_initialize(argc, argv, optstring)
359 const char *optstring;
361 /* Start processing options with ARGV-element 1 (since ARGV-element 0
362 is the program name); the sequence of previously skipped
363 non-option ARGV-elements is empty. */
365 first_nonopt = last_nonopt = optind = 1;
369 posixly_correct = getenv("POSIXLY_CORRECT");
371 /* Determine how to handle the ordering of options and nonoptions. */
373 if (optstring[0] == '-')
375 ordering = RETURN_IN_ORDER;
378 else if (optstring[0] == '+')
380 ordering = REQUIRE_ORDER;
383 else if (posixly_correct != NULL)
384 ordering = REQUIRE_ORDER;
389 if (posixly_correct == NULL
390 && argc == original_argc && argv == original_argv)
392 /* Bash 2.0 puts a special variable in the environment for each
393 command it runs, specifying which ARGV elements are the results of
394 file name wildcard expansion and therefore should not be
395 considered as options. */
398 sprintf(var, "_%d_GNU_nonoption_argv_flags_", getpid());
399 nonoption_flags = getenv(var);
400 if (nonoption_flags == NULL)
401 nonoption_flags_len = 0;
403 nonoption_flags_len = strlen(nonoption_flags);
406 nonoption_flags_len = 0;
412 /* Scan elements of ARGV (whose length is ARGC) for option characters
415 If an element of ARGV starts with '-', and is not exactly "-" or "--",
416 then it is an option element. The characters of this element
417 (aside from the initial '-') are option characters. If `getopt'
418 is called repeatedly, it returns successively each of the option characters
419 from each of the option elements.
421 If `getopt' finds another option character, it returns that character,
422 updating `optind' and `nextchar' so that the next call to `getopt' can
423 resume the scan with the following option character or ARGV-element.
425 If there are no more option characters, `getopt' returns -1.
426 Then `optind' is the index in ARGV of the first ARGV-element
427 that is not an option. (The ARGV-elements have been permuted
428 so that those that are not options now come last.)
430 OPTSTRING is a string containing the legitimate option characters.
431 If an option character is seen that is not listed in OPTSTRING,
432 return '?' after printing an error message. If you set `opterr' to
433 zero, the error message is suppressed but we still return '?'.
435 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
436 so the following text in the same ARGV-element, or the text of the following
437 ARGV-element, is returned in `optarg'. Two colons mean an option that
438 wants an optional arg; if there is text in the current ARGV-element,
439 it is returned in `optarg', otherwise `optarg' is set to zero.
441 If OPTSTRING starts with `-' or `+', it requests different methods of
442 handling the non-option ARGV-elements.
443 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
445 Long-named options begin with `--' instead of `-'.
446 Their names may be abbreviated as long as the abbreviation is unique
447 or is an exact match for some defined option. If they have an
448 argument, it follows the option name in the same ARGV-element, separated
449 from the option name by a `=', or else the in next ARGV-element.
450 When `getopt' finds a long-named option, it returns 0 if that option's
451 `flag' field is nonzero, the value of the option's `val' field
452 if the `flag' field is zero.
454 The elements of ARGV aren't really const, because we permute them.
455 But we pretend they're const in the prototype to be compatible
458 LONGOPTS is a vector of `struct option' terminated by an
459 element containing a name which is zero.
461 LONGIND returns the index in LONGOPT of the long-named option found.
462 It is only valid when a long-named option has been found by the most
465 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
466 long-named options. */
469 _getopt_internal(argc, argv, optstring, longopts, longind, long_only)
472 const char *optstring;
473 const struct option *longopts;
479 if (!__getopt_initialized || optind == 0)
481 optstring = _getopt_initialize(argc, argv, optstring);
482 optind = 1; /* Don't scan ARGV[0], the program name. */
483 __getopt_initialized = 1;
486 /* Test whether ARGV[optind] points to a non-option argument.
487 Either it does not have option syntax, or there is an environment flag
488 from the shell indicating it is not an option. The later information
489 is only used when the used in the GNU libc. */
491 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
492 || (optind < nonoption_flags_len \
493 && nonoption_flags[optind] == '1'))
495 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
498 if (nextchar == NULL || *nextchar == '\0')
500 /* Advance to the next ARGV-element. */
502 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
503 moved back by the user (who may also have changed the arguments). */
504 if (last_nonopt > optind)
505 last_nonopt = optind;
506 if (first_nonopt > optind)
507 first_nonopt = optind;
509 if (ordering == PERMUTE)
511 /* If we have just processed some options following some non-options,
512 exchange them so that the options come first. */
514 if (first_nonopt != last_nonopt && last_nonopt != optind)
515 exchange((char **) argv);
516 else if (last_nonopt != optind)
517 first_nonopt = optind;
519 /* Skip any additional non-options
520 and extend the range of non-options previously skipped. */
522 while (optind < argc && NONOPTION_P)
524 last_nonopt = optind;
527 /* The special ARGV-element `--' means premature end of options.
528 Skip it like a null option,
529 then exchange with previous non-options as if it were an option,
530 then skip everything else like a non-option. */
532 if (optind != argc && !strcmp(argv[optind], "--"))
536 if (first_nonopt != last_nonopt && last_nonopt != optind)
537 exchange((char **) argv);
538 else if (first_nonopt == last_nonopt)
539 first_nonopt = optind;
545 /* If we have done all the ARGV-elements, stop the scan
546 and back over any non-options that we skipped and permuted. */
550 /* Set the next-arg-index to point at the non-options
551 that we previously skipped, so the caller will digest them. */
552 if (first_nonopt != last_nonopt)
553 optind = first_nonopt;
557 /* If we have come to a non-option and did not permute it,
558 either stop the scan or describe it to the caller and pass it by. */
562 if (ordering == REQUIRE_ORDER)
564 optarg = argv[optind++];
568 /* We have found another option-ARGV-element.
569 Skip the initial punctuation. */
571 nextchar = (argv[optind] + 1
572 + (longopts != NULL && argv[optind][1] == '-'));
575 /* Decode the current option-ARGV-element. */
577 /* Check whether the ARGV-element is a long option.
579 If long_only and the ARGV-element has the form "-f", where f is
580 a valid short option, don't consider it an abbreviated form of
581 a long option that starts with f. Otherwise there would be no
582 way to give the -f short option.
584 On the other hand, if there's a long option "fubar" and
585 the ARGV-element is "-fu", do consider that an abbreviation of
586 the long option, just like "--fu", and not "-f" with arg "u".
588 This distinction seems to be the most useful approach. */
591 && (argv[optind][1] == '-'
592 || (long_only && (argv[optind][2] || !my_index(optstring, argv[optind][1])))))
595 const struct option *p;
596 const struct option *pfound = NULL;
602 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
605 /* Test all long options for either exact match
606 or abbreviated matches. */
607 for (p = longopts, option_index = 0; p->name; p++, option_index++)
608 if (!strncmp(p->name, nextchar, nameend - nextchar))
610 if ((unsigned int) (nameend - nextchar)
611 == (unsigned int) strlen(p->name))
613 /* Exact match found. */
615 indfound = option_index;
619 else if (pfound == NULL)
621 /* First nonexact match found. */
623 indfound = option_index;
626 /* Second or later nonexact match found. */
633 fprintf(stderr, _("%s: option `%s' is ambiguous\n"),
634 argv[0], argv[optind]);
635 nextchar += strlen(nextchar);
643 option_index = indfound;
647 /* Don't test has_arg with >, because some C compilers don't
648 allow it to be used on enums. */
650 optarg = nameend + 1;
655 if (argv[optind - 1][1] == '-')
658 _("%s: option `--%s' doesn't allow an argument\n"),
659 argv[0], pfound->name);
661 /* +option or -option */
663 _("%s: option `%c%s' doesn't allow an argument\n"),
664 argv[0], argv[optind - 1][0], pfound->name);
667 nextchar += strlen(nextchar);
669 optopt = pfound->val;
673 else if (pfound->has_arg == 1)
676 optarg = argv[optind++];
681 _("%s: option `%s' requires an argument\n"),
682 argv[0], argv[optind - 1]);
683 nextchar += strlen(nextchar);
684 optopt = pfound->val;
685 return optstring[0] == ':' ? ':' : '?';
688 nextchar += strlen(nextchar);
690 *longind = option_index;
693 *(pfound->flag) = pfound->val;
699 /* Can't find it as a long option. If this is not getopt_long_only,
700 or the option starts with '--' or is not a valid short
701 option, then it's an error.
702 Otherwise interpret it as a short option. */
703 if (!long_only || argv[optind][1] == '-'
704 || my_index(optstring, *nextchar) == NULL)
708 if (argv[optind][1] == '-')
710 fprintf(stderr, _("%s: unrecognized option `--%s'\n"),
713 /* +option or -option */
714 fprintf(stderr, _("%s: unrecognized option `%c%s'\n"),
715 argv[0], argv[optind][0], nextchar);
717 nextchar = (char *) "";
724 /* Look at and handle the next short option-character. */
727 char c = *nextchar++;
728 char *temp = my_index(optstring, c);
730 /* Increment `optind' when we start to process its last character. */
731 if (*nextchar == '\0')
734 if (temp == NULL || c == ':')
739 /* 1003.2 specifies the format of this message. */
740 fprintf(stderr, _("%s: illegal option -- %c\n"),
743 fprintf(stderr, _("%s: invalid option -- %c\n"),
749 /* Convenience. Treat POSIX -W foo same as long option --foo */
750 if (temp[0] == 'W' && temp[1] == ';')
753 const struct option *p;
754 const struct option *pfound = NULL;
760 /* This is an option that requires an argument. */
761 if (*nextchar != '\0')
764 /* If we end this ARGV-element by taking the rest as an arg,
765 we must advance to the next element now. */
768 else if (optind == argc)
772 /* 1003.2 specifies the format of this message. */
773 fprintf(stderr, _("%s: option requires an argument -- %c\n"),
777 if (optstring[0] == ':')
784 /* We already incremented `optind' once;
785 increment it again when taking next ARGV-elt as argument. */
786 optarg = argv[optind++];
788 /* optarg is now the argument, see if it's in the
789 table of longopts. */
791 for (nextchar = nameend = optarg; *nameend && *nameend != '='; nameend++)
794 /* Test all long options for either exact match
795 or abbreviated matches. */
796 for (p = longopts, option_index = 0; p->name; p++, option_index++)
797 if (!strncmp(p->name, nextchar, nameend - nextchar))
799 if ((unsigned int) (nameend - nextchar) == strlen(p->name))
801 /* Exact match found. */
803 indfound = option_index;
807 else if (pfound == NULL)
809 /* First nonexact match found. */
811 indfound = option_index;
814 /* Second or later nonexact match found. */
820 fprintf(stderr, _("%s: option `-W %s' is ambiguous\n"),
821 argv[0], argv[optind]);
822 nextchar += strlen(nextchar);
828 option_index = indfound;
831 /* Don't test has_arg with >, because some C compilers don't
832 allow it to be used on enums. */
834 optarg = nameend + 1;
839 %s: option `-W %s' doesn't allow an argument\n"),
840 argv[0], pfound->name);
842 nextchar += strlen(nextchar);
846 else if (pfound->has_arg == 1)
849 optarg = argv[optind++];
854 _("%s: option `%s' requires an argument\n"),
855 argv[0], argv[optind - 1]);
856 nextchar += strlen(nextchar);
857 return optstring[0] == ':' ? ':' : '?';
860 nextchar += strlen(nextchar);
862 *longind = option_index;
865 *(pfound->flag) = pfound->val;
871 return 'W'; /* Let the application handle it. */
877 /* This is an option that accepts an argument optionally. */
878 if (*nextchar != '\0')
889 /* This is an option that requires an argument. */
890 if (*nextchar != '\0')
893 /* If we end this ARGV-element by taking the rest as an arg,
894 we must advance to the next element now. */
897 else if (optind == argc)
901 /* 1003.2 specifies the format of this message. */
903 _("%s: option requires an argument -- %c\n"),
907 if (optstring[0] == ':')
913 /* We already incremented `optind' once;
914 increment it again when taking next ARGV-elt as argument. */
915 optarg = argv[optind++];
924 getopt(argc, argv, optstring)
927 const char *optstring;
929 return _getopt_internal(argc, argv, optstring,
930 (const struct option *) 0,
935 #endif /* Not ELIDE_CODE. */
939 /* Compile with -DTEST to make an executable for use in testing
940 the above definition of `getopt'. */
948 int digit_optind = 0;
952 int this_option_optind = optind ? optind : 1;
954 c = getopt(argc, argv, "abc:d:0123456789");
970 if (digit_optind != 0 && digit_optind != this_option_optind)
971 printf("digits occur in two different argv-elements.\n");
972 digit_optind = this_option_optind;
973 printf("option %c\n", c);
977 printf("option a\n");
981 printf("option b\n");
985 printf("option c with value `%s'\n", optarg);
992 printf("?? getopt returned character code 0%o ??\n", c);
998 printf("non-option ARGV-elements: ");
999 while (optind < argc)
1000 printf("%s ", argv[optind++]);