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 NOTE: The canonical source of this file is maintained with the GNU C Library.
10 Bugs can be reported to bug-glibc@prep.ai.mit.edu.
12 This program is free software; you can redistribute it and/or modify it
13 under the terms of the GNU General Public License as published by the
14 Free Software Foundation; either version 2, or (at your option) any
17 This program 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
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License along
23 with this program; if not, write to the Free Software Foundation, Inc.,
24 51 Franklin Street, Fifth Floor, 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>. */
37 #if !defined (__STDC__) || !__STDC__
38 /* This is a separate conditional since some stdc systems
39 reject `defined (const)'. */
51 /* Comment out all this code if we are using the GNU C Library, and are not
52 actually compiling the library itself. This code is part of the GNU C
53 Library, but also included in many other GNU distributions. Compiling
54 and linking in this code is a waste when using the GNU C library
55 (especially if it is a shared library). Rather than having every GNU
56 program understand `configure --with-gnu-libc' and omit the object files,
57 it is simpler to just do this in the source for each such file. */
59 #define GETOPT_INTERFACE_VERSION 2
60 #if !defined (_LIBC) && defined (__GLIBC__) && __GLIBC__ >= 2
61 #include <gnu-versions.h>
62 #if _GNU_GETOPT_INTERFACE_VERSION == GETOPT_INTERFACE_VERSION
70 /* This needs to come after some library #include
71 to get __GNU_LIBRARY__ defined. */
72 #ifdef __GNU_LIBRARY__
73 /* Don't include stdlib.h for non-GNU C libraries because some of them
74 contain conflicting prototypes for getopt. */
77 #endif /* GNU C library. */
86 #if defined (WIN32) && !defined (__CYGWIN32__)
87 /* It's not Unix, really. See? Capital letters. */
89 #define getpid() GetCurrentProcessId()
92 /* This version of `getopt' appears to the caller like standard Unix `getopt'
93 but it behaves differently for the user, since it allows the user
94 to intersperse the options with the other arguments.
96 As `getopt' works, it permutes the elements of ARGV so that,
97 when it is done, all the options precede everything else. Thus
98 all application programs are extended to handle flexible argument order.
100 Setting the environment variable POSIXLY_CORRECT disables permutation.
101 Then the behavior is completely standard.
103 GNU application programs can use a third alternative mode in which
104 they can distinguish the relative order of options and other arguments. */
108 /* For communication from `getopt' to the caller.
109 When `getopt' finds an option that takes an argument,
110 the argument value is returned here.
111 Also, when `ordering' is RETURN_IN_ORDER,
112 each non-option ARGV-element is returned here. */
116 /* Index in ARGV of the next element to be scanned.
117 This is used for communication to and from the caller
118 and for communication between successive calls to `getopt'.
120 On entry to `getopt', zero means this is the first call; initialize.
122 When `getopt' returns -1, this is the index of the first of the
123 non-option elements that the caller should itself scan.
125 Otherwise, `optind' communicates from one call to the next
126 how much of ARGV has been scanned so far. */
128 /* 1003.2 says this must be 1 before any call. */
131 /* Formerly, initialization of getopt depended on optind==0, which
132 causes problems with re-calling getopt as programs generally don't
135 int __getopt_initialized = 0;
137 /* The next char to be scanned in the option-element
138 in which the last option character we returned was found.
139 This allows us to pick up the scan where we left off.
141 If this is zero, or a null string, it means resume the scan
142 by advancing to the next ARGV-element. */
144 static char *nextchar;
146 /* Callers store zero here to inhibit the error message
147 for unrecognized options. */
151 /* Set to an option character which was unrecognized.
152 This must be initialized on some systems to avoid linking in the
153 system's own getopt implementation. */
157 /* Describe how to deal with options that follow non-option ARGV-elements.
159 If the caller did not specify anything,
160 the default is REQUIRE_ORDER if the environment variable
161 POSIXLY_CORRECT is defined, PERMUTE otherwise.
163 REQUIRE_ORDER means don't recognize them as options;
164 stop option processing when the first non-option is seen.
165 This is what Unix does.
166 This mode of operation is selected by either setting the environment
167 variable POSIXLY_CORRECT, or using `+' as the first character
168 of the list of option characters.
170 PERMUTE is the default. We permute the contents of ARGV as we scan,
171 so that eventually all the non-options are at the end. This allows options
172 to be given in any order, even with programs that were not written to
175 RETURN_IN_ORDER is an option available to programs that were written
176 to expect options and other ARGV-elements in any order and that care about
177 the ordering of the two. We describe each non-option ARGV-element
178 as if it were the argument of an option with character code 1.
179 Using `-' as the first character of the list of option characters
180 selects this mode of operation.
182 The special argument `--' forces an end of option-scanning regardless
183 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
184 `--' can cause `getopt' to return -1 with `optind' != ARGC. */
188 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
191 /* Value of POSIXLY_CORRECT environment variable. */
192 static char *posixly_correct;
194 #ifdef __GNU_LIBRARY__
195 /* We want to avoid inclusion of string.h with non-GNU libraries
196 because there are many ways it can cause trouble.
197 On some systems, it contains special magic macros that don't work
200 #define my_index strchr
203 /* Avoid depending on library functions or files
204 whose names are inconsistent. */
222 /* If using GCC, we can safely declare strlen this way.
223 If not using GCC, it is ok not to declare it. */
225 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
226 That was relevant to code that was here before. */
227 #if !defined (__STDC__) || !__STDC__
228 /* gcc with -traditional declares the built-in strlen to return int,
229 and has done so at least since version 2.4.5. -- rms. */
230 extern int strlen (const char *);
231 #endif /* not __STDC__ */
232 #endif /* __GNUC__ */
234 #endif /* not __GNU_LIBRARY__ */
236 /* Handle permutation of arguments. */
238 /* Describe the part of ARGV that contains non-options that have
239 been skipped. `first_nonopt' is the index in ARGV of the first of them;
240 `last_nonopt' is the index after the last of them. */
242 static int first_nonopt;
243 static int last_nonopt;
246 /* Bash 2.0 gives us an environment variable containing flags
247 indicating ARGV elements that should not be considered arguments. */
249 /* Defined in getopt_init.c */
250 extern char *__getopt_nonoption_flags;
252 static int nonoption_flags_max_len;
253 static int nonoption_flags_len;
255 static int original_argc;
256 static char *const *original_argv;
258 extern pid_t __libc_pid;
260 /* Make sure the environment variable bash 2.0 puts in the environment
261 is valid for the getopt call we must make sure that the ARGV passed
262 to getopt is that one passed to the process. */
264 __attribute__ ((__unused__))
265 store_args_and_env (int argc, char *const *argv)
267 /* XXX This is no good solution. We should rather copy the args so
268 that we can compare them later. But we must not use malloc(3). */
269 original_argc = argc;
270 original_argv = argv;
272 text_set_element (__libc_subinit, store_args_and_env);
274 # define SWAP_FLAGS(ch1, ch2) \
275 if (nonoption_flags_len > 0) \
277 char __tmp = __getopt_nonoption_flags[ch1]; \
278 __getopt_nonoption_flags[ch1] = __getopt_nonoption_flags[ch2]; \
279 __getopt_nonoption_flags[ch2] = __tmp; \
282 # define SWAP_FLAGS(ch1, ch2)
285 /* Exchange two adjacent subsequences of ARGV.
286 One subsequence is elements [first_nonopt,last_nonopt)
287 which contains all the non-options that have been skipped so far.
288 The other is elements [last_nonopt,optind), which contains all
289 the options processed since those non-options were skipped.
291 `first_nonopt' and `last_nonopt' are relocated so that they describe
292 the new indices of the non-options in ARGV after they are moved. */
294 #if defined (__STDC__) && __STDC__
295 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. */
313 /* First make sure the handling of the `__getopt_nonoption_flags'
314 string can work normally. Our top argument must be in the range
316 if (nonoption_flags_len > 0 && top >= nonoption_flags_max_len)
318 /* We must extend the array. The user plays games with us and
319 presents new arguments. */
320 char *new_str = malloc (top + 1);
322 nonoption_flags_len = nonoption_flags_max_len = 0;
325 memcpy (new_str, __getopt_nonoption_flags, nonoption_flags_max_len);
326 memset (&new_str[nonoption_flags_max_len], '\0',
327 top + 1 - nonoption_flags_max_len);
328 nonoption_flags_max_len = top + 1;
329 __getopt_nonoption_flags = new_str;
334 while (top > middle && middle > bottom)
336 if (top - middle > middle - bottom)
338 /* Bottom segment is the short one. */
339 int len = middle - bottom;
342 /* Swap it with the top part of the top segment. */
343 for (i = 0; i < len; i++)
345 tem = argv[bottom + i];
346 argv[bottom + i] = argv[top - (middle - bottom) + i];
347 argv[top - (middle - bottom) + i] = tem;
348 SWAP_FLAGS (bottom + i, top - (middle - bottom) + i);
350 /* Exclude the moved bottom segment from further swapping. */
355 /* Top segment is the short one. */
356 int len = top - middle;
359 /* Swap it with the bottom part of the bottom segment. */
360 for (i = 0; i < len; i++)
362 tem = argv[bottom + i];
363 argv[bottom + i] = argv[middle + i];
364 argv[middle + i] = tem;
365 SWAP_FLAGS (bottom + i, middle + i);
367 /* Exclude the moved top segment from further swapping. */
372 /* Update records for the slots the non-options now occupy. */
374 first_nonopt += (optind - last_nonopt);
375 last_nonopt = optind;
378 /* Initialize the internal data when the first call is made. */
380 #if defined (__STDC__) && __STDC__
381 static const char *_getopt_initialize (int, char *const *, const char *);
384 _getopt_initialize (argc, argv, optstring)
387 const char *optstring;
389 /* Start processing options with ARGV-element 1 (since ARGV-element 0
390 is the program name); the sequence of previously skipped
391 non-option ARGV-elements is empty. */
393 first_nonopt = last_nonopt = optind;
397 posixly_correct = getenv ("POSIXLY_CORRECT");
399 /* Determine how to handle the ordering of options and nonoptions. */
401 if (optstring[0] == '-')
403 ordering = RETURN_IN_ORDER;
406 else if (optstring[0] == '+')
408 ordering = REQUIRE_ORDER;
411 else if (posixly_correct != NULL)
412 ordering = REQUIRE_ORDER;
417 if (posixly_correct == NULL
418 && argc == original_argc && argv == original_argv)
420 if (nonoption_flags_max_len == 0)
422 if (__getopt_nonoption_flags == NULL
423 || __getopt_nonoption_flags[0] == '\0')
424 nonoption_flags_max_len = -1;
427 const char *orig_str = __getopt_nonoption_flags;
428 int len = nonoption_flags_max_len = strlen (orig_str);
429 if (nonoption_flags_max_len < argc)
430 nonoption_flags_max_len = argc;
431 __getopt_nonoption_flags =
432 (char *) malloc (nonoption_flags_max_len);
433 if (__getopt_nonoption_flags == NULL)
434 nonoption_flags_max_len = -1;
437 memcpy (__getopt_nonoption_flags, orig_str, len);
438 memset (&__getopt_nonoption_flags[len], '\0',
439 nonoption_flags_max_len - len);
443 nonoption_flags_len = nonoption_flags_max_len;
446 nonoption_flags_len = 0;
452 /* Scan elements of ARGV (whose length is ARGC) for option characters
455 If an element of ARGV starts with '-', and is not exactly "-" or "--",
456 then it is an option element. The characters of this element
457 (aside from the initial '-') are option characters. If `getopt'
458 is called repeatedly, it returns successively each of the option characters
459 from each of the option elements.
461 If `getopt' finds another option character, it returns that character,
462 updating `optind' and `nextchar' so that the next call to `getopt' can
463 resume the scan with the following option character or ARGV-element.
465 If there are no more option characters, `getopt' returns -1.
466 Then `optind' is the index in ARGV of the first ARGV-element
467 that is not an option. (The ARGV-elements have been permuted
468 so that those that are not options now come last.)
470 OPTSTRING is a string containing the legitimate option characters.
471 If an option character is seen that is not listed in OPTSTRING,
472 return '?' after printing an error message. If you set `opterr' to
473 zero, the error message is suppressed but we still return '?'.
475 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
476 so the following text in the same ARGV-element, or the text of the following
477 ARGV-element, is returned in `optarg'. Two colons mean an option that
478 wants an optional arg; if there is text in the current ARGV-element,
479 it is returned in `optarg', otherwise `optarg' is set to zero.
481 If OPTSTRING starts with `-' or `+', it requests different methods of
482 handling the non-option ARGV-elements.
483 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
485 Long-named options begin with `--' instead of `-'.
486 Their names may be abbreviated as long as the abbreviation is unique
487 or is an exact match for some defined option. If they have an
488 argument, it follows the option name in the same ARGV-element, separated
489 from the option name by a `=', or else the in next ARGV-element.
490 When `getopt' finds a long-named option, it returns 0 if that option's
491 `flag' field is nonzero, the value of the option's `val' field
492 if the `flag' field is zero.
494 The elements of ARGV aren't really const, because we permute them.
495 But we pretend they're const in the prototype to be compatible
498 LONGOPTS is a vector of `struct option' terminated by an
499 element containing a name which is zero.
501 LONGIND returns the index in LONGOPT of the long-named option found.
502 It is only valid when a long-named option has been found by the most
505 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
506 long-named options. */
509 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
512 const char *optstring;
513 const struct option *longopts;
519 if (optind == 0 || !__getopt_initialized)
522 optind = 1; /* Don't scan ARGV[0], the program name. */
523 optstring = _getopt_initialize (argc, argv, optstring);
524 __getopt_initialized = 1;
527 /* Test whether ARGV[optind] points to a non-option argument.
528 Either it does not have option syntax, or there is an environment flag
529 from the shell indicating it is not an option. The later information
530 is only used when the used in the GNU libc. */
532 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
533 || (optind < nonoption_flags_len \
534 && __getopt_nonoption_flags[optind] == '1'))
536 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
539 if (nextchar == NULL || *nextchar == '\0')
541 /* Advance to the next ARGV-element. */
543 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
544 moved back by the user (who may also have changed the arguments). */
545 if (last_nonopt > optind)
546 last_nonopt = optind;
547 if (first_nonopt > optind)
548 first_nonopt = optind;
550 if (ordering == PERMUTE)
552 /* If we have just processed some options following some non-options,
553 exchange them so that the options come first. */
555 if (first_nonopt != last_nonopt && last_nonopt != optind)
556 exchange ((char **) argv);
557 else if (last_nonopt != optind)
558 first_nonopt = optind;
560 /* Skip any additional non-options
561 and extend the range of non-options previously skipped. */
563 while (optind < argc && NONOPTION_P)
565 last_nonopt = optind;
568 /* The special ARGV-element `--' means premature end of options.
569 Skip it like a null option,
570 then exchange with previous non-options as if it were an option,
571 then skip everything else like a non-option. */
573 if (optind != argc && !strcmp (argv[optind], "--"))
577 if (first_nonopt != last_nonopt && last_nonopt != optind)
578 exchange ((char **) argv);
579 else if (first_nonopt == last_nonopt)
580 first_nonopt = optind;
586 /* If we have done all the ARGV-elements, stop the scan
587 and back over any non-options that we skipped and permuted. */
591 /* Set the next-arg-index to point at the non-options
592 that we previously skipped, so the caller will digest them. */
593 if (first_nonopt != last_nonopt)
594 optind = first_nonopt;
598 /* If we have come to a non-option and did not permute it,
599 either stop the scan or describe it to the caller and pass it by. */
603 if (ordering == REQUIRE_ORDER)
605 optarg = argv[optind++];
609 /* We have found another option-ARGV-element.
610 Skip the initial punctuation. */
612 nextchar = (argv[optind] + 1
613 + (longopts != NULL && argv[optind][1] == '-'));
616 /* Decode the current option-ARGV-element. */
618 /* Check whether the ARGV-element is a long option.
620 If long_only and the ARGV-element has the form "-f", where f is
621 a valid short option, don't consider it an abbreviated form of
622 a long option that starts with f. Otherwise there would be no
623 way to give the -f short option.
625 On the other hand, if there's a long option "fubar" and
626 the ARGV-element is "-fu", do consider that an abbreviation of
627 the long option, just like "--fu", and not "-f" with arg "u".
629 This distinction seems to be the most useful approach. */
632 && (argv[optind][1] == '-'
633 || (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
636 const struct option *p;
637 const struct option *pfound = NULL;
643 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
646 /* Test all long options for either exact match
647 or abbreviated matches. */
648 for (p = longopts, option_index = 0; p->name; p++, option_index++)
649 if (!strncmp (p->name, nextchar, nameend - nextchar))
651 if ((unsigned int) (nameend - nextchar)
652 == (unsigned int) strlen (p->name))
654 /* Exact match found. */
656 indfound = option_index;
660 else if (pfound == NULL)
662 /* First nonexact match found. */
664 indfound = option_index;
667 /* Second or later nonexact match found. */
674 fprintf (stderr, "%s: option `%s' is ambiguous\n",
675 argv[0], argv[optind]);
676 nextchar += strlen (nextchar);
684 option_index = indfound;
688 /* Don't test has_arg with >, because some C compilers don't
689 allow it to be used on enums. */
691 optarg = nameend + 1;
696 if (argv[optind - 1][1] == '-')
699 "%s: option `--%s' doesn't allow an argument\n",
700 argv[0], pfound->name);
702 /* +option or -option */
704 "%s: option `%c%s' doesn't allow an argument\n",
705 argv[0], argv[optind - 1][0], pfound->name);
708 nextchar += strlen (nextchar);
710 optopt = pfound->val;
714 else if (pfound->has_arg == 1)
717 optarg = argv[optind++];
722 "%s: option `%s' requires an argument\n",
723 argv[0], argv[optind - 1]);
724 nextchar += strlen (nextchar);
725 optopt = pfound->val;
726 return optstring[0] == ':' ? ':' : '?';
729 nextchar += strlen (nextchar);
731 *longind = option_index;
734 *(pfound->flag) = pfound->val;
740 /* Can't find it as a long option. If this is not getopt_long_only,
741 or the option starts with '--' or is not a valid short
742 option, then it's an error.
743 Otherwise interpret it as a short option. */
744 if (!long_only || argv[optind][1] == '-'
745 || my_index (optstring, *nextchar) == NULL)
749 if (argv[optind][1] == '-')
751 fprintf (stderr, "%s: unrecognized option `--%s'\n",
754 /* +option or -option */
755 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
756 argv[0], argv[optind][0], nextchar);
758 nextchar = (char *) "";
765 /* Look at and handle the next short option-character. */
768 char c = *nextchar++;
769 char *temp = my_index (optstring, c);
771 /* Increment `optind' when we start to process its last character. */
772 if (*nextchar == '\0')
775 if (temp == NULL || c == ':')
780 /* 1003.2 specifies the format of this message. */
781 fprintf (stderr, "%s: illegal option -- %c\n",
784 fprintf (stderr, "%s: invalid option -- %c\n",
790 /* Convenience. Treat POSIX -W foo same as long option --foo */
791 if (temp[0] == 'W' && temp[1] == ';')
794 const struct option *p;
795 const struct option *pfound = NULL;
801 /* This is an option that requires an argument. */
802 if (*nextchar != '\0')
805 /* If we end this ARGV-element by taking the rest as an arg,
806 we must advance to the next element now. */
809 else if (optind == argc)
813 /* 1003.2 specifies the format of this message. */
814 fprintf (stderr, "%s: option requires an argument -- %c\n",
818 if (optstring[0] == ':')
825 /* We already incremented `optind' once;
826 increment it again when taking next ARGV-elt as argument. */
827 optarg = argv[optind++];
829 /* optarg is now the argument, see if it's in the
830 table of longopts. */
832 for (nextchar = nameend = optarg; *nameend && *nameend != '='; nameend++)
835 /* Test all long options for either exact match
836 or abbreviated matches. */
837 for (p = longopts, option_index = 0; p->name; p++, option_index++)
838 if (!strncmp (p->name, nextchar, nameend - nextchar))
840 if ((unsigned int) (nameend - nextchar) == strlen (p->name))
842 /* Exact match found. */
844 indfound = option_index;
848 else if (pfound == NULL)
850 /* First nonexact match found. */
852 indfound = option_index;
855 /* Second or later nonexact match found. */
861 fprintf (stderr, "%s: option `-W %s' is ambiguous\n",
862 argv[0], argv[optind]);
863 nextchar += strlen (nextchar);
869 option_index = indfound;
872 /* Don't test has_arg with >, because some C compilers don't
873 allow it to be used on enums. */
875 optarg = nameend + 1;
880 "%s: option `-W %s' doesn't allow an argument\n",
881 argv[0], pfound->name);
883 nextchar += strlen (nextchar);
887 else if (pfound->has_arg == 1)
890 optarg = argv[optind++];
895 "%s: option `%s' requires an argument\n",
896 argv[0], argv[optind - 1]);
897 nextchar += strlen (nextchar);
898 return optstring[0] == ':' ? ':' : '?';
901 nextchar += strlen (nextchar);
903 *longind = option_index;
906 *(pfound->flag) = pfound->val;
912 return 'W'; /* Let the application handle it. */
918 /* This is an option that accepts an argument optionally. */
919 if (*nextchar != '\0')
930 /* This is an option that requires an argument. */
931 if (*nextchar != '\0')
934 /* If we end this ARGV-element by taking the rest as an arg,
935 we must advance to the next element now. */
938 else if (optind == argc)
942 /* 1003.2 specifies the format of this message. */
944 "%s: option requires an argument -- %c\n",
948 if (optstring[0] == ':')
954 /* We already incremented `optind' once;
955 increment it again when taking next ARGV-elt as argument. */
956 optarg = argv[optind++];
965 getopt (argc, argv, optstring)
968 const char *optstring;
970 return _getopt_internal (argc, argv, optstring,
971 (const struct option *) 0,
976 #endif /* Not ELIDE_CODE. */
980 /* Compile with -DTEST to make an executable for use in testing
981 the above definition of `getopt'. */
989 int digit_optind = 0;
993 int this_option_optind = optind ? optind : 1;
995 c = getopt (argc, argv, "abc:d:0123456789");
1011 if (digit_optind != 0 && digit_optind != this_option_optind)
1012 printf ("digits occur in two different argv-elements.\n");
1013 digit_optind = this_option_optind;
1014 printf ("option %c\n", c);
1018 printf ("option a\n");
1022 printf ("option b\n");
1026 printf ("option c with value `%s'\n", optarg);
1033 printf ("?? getopt returned character code 0%o ??\n", c);
1039 printf ("non-option ARGV-elements: ");
1040 while (optind < argc)
1041 printf ("%s ", argv[optind++]);