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)'. */
47 /* Comment out all this code if we are using the GNU C Library, and are not
48 actually compiling the library itself. This code is part of the GNU C
49 Library, but also included in many other GNU distributions. Compiling
50 and linking in this code is a waste when using the GNU C library
51 (especially if it is a shared library). Rather than having every GNU
52 program understand `configure --with-gnu-libc' and omit the object files,
53 it is simpler to just do this in the source for each such file. */
55 #define GETOPT_INTERFACE_VERSION 2
56 #if !defined (_LIBC) && defined (__GLIBC__) && __GLIBC__ >= 2
57 #include <gnu-versions.h>
58 #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()
88 /* This version of `getopt' appears to the caller like standard Unix `getopt'
89 but it behaves differently for the user, since it allows the user
90 to intersperse the options with the other arguments.
92 As `getopt' works, it permutes the elements of ARGV so that,
93 when it is done, all the options precede everything else. Thus
94 all application programs are extended to handle flexible argument order.
96 Setting the environment variable POSIXLY_CORRECT disables permutation.
97 Then the behavior is completely standard.
99 GNU application programs can use a third alternative mode in which
100 they can distinguish the relative order of options and other arguments. */
104 /* For communication from `getopt' to the caller.
105 When `getopt' finds an option that takes an argument,
106 the argument value is returned here.
107 Also, when `ordering' is RETURN_IN_ORDER,
108 each non-option ARGV-element is returned here. */
112 /* Index in ARGV of the next element to be scanned.
113 This is used for communication to and from the caller
114 and for communication between successive calls to `getopt'.
116 On entry to `getopt', zero means this is the first call; initialize.
118 When `getopt' returns -1, this is the index of the first of the
119 non-option elements that the caller should itself scan.
121 Otherwise, `optind' communicates from one call to the next
122 how much of ARGV has been scanned so far. */
124 /* 1003.2 says this must be 1 before any call. */
127 /* Formerly, initialization of getopt depended on optind==0, which
128 causes problems with re-calling getopt as programs generally don't
131 int __getopt_initialized = 0;
133 /* The next char to be scanned in the option-element
134 in which the last option character we returned was found.
135 This allows us to pick up the scan where we left off.
137 If this is zero, or a null string, it means resume the scan
138 by advancing to the next ARGV-element. */
140 static char *nextchar;
142 /* Callers store zero here to inhibit the error message
143 for unrecognized options. */
147 /* Set to an option character which was unrecognized.
148 This must be initialized on some systems to avoid linking in the
149 system's own getopt implementation. */
153 /* Describe how to deal with options that follow non-option ARGV-elements.
155 If the caller did not specify anything,
156 the default is REQUIRE_ORDER if the environment variable
157 POSIXLY_CORRECT is defined, PERMUTE otherwise.
159 REQUIRE_ORDER means don't recognize them as options;
160 stop option processing when the first non-option is seen.
161 This is what Unix does.
162 This mode of operation is selected by either setting the environment
163 variable POSIXLY_CORRECT, or using `+' as the first character
164 of the list of option characters.
166 PERMUTE is the default. We permute the contents of ARGV as we scan,
167 so that eventually all the non-options are at the end. This allows options
168 to be given in any order, even with programs that were not written to
171 RETURN_IN_ORDER is an option available to programs that were written
172 to expect options and other ARGV-elements in any order and that care about
173 the ordering of the two. We describe each non-option ARGV-element
174 as if it were the argument of an option with character code 1.
175 Using `-' as the first character of the list of option characters
176 selects this mode of operation.
178 The special argument `--' forces an end of option-scanning regardless
179 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
180 `--' can cause `getopt' to return -1 with `optind' != ARGC. */
184 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
187 /* Value of POSIXLY_CORRECT environment variable. */
188 static char *posixly_correct;
190 #ifdef __GNU_LIBRARY__
191 /* We want to avoid inclusion of string.h with non-GNU libraries
192 because there are many ways it can cause trouble.
193 On some systems, it contains special magic macros that don't work
196 #define my_index strchr
199 /* Avoid depending on library functions or files
200 whose names are inconsistent. */
218 /* If using GCC, we can safely declare strlen this way.
219 If not using GCC, it is ok not to declare it. */
221 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
222 That was relevant to code that was here before. */
223 #if !defined (__STDC__) || !__STDC__
224 /* gcc with -traditional declares the built-in strlen to return int,
225 and has done so at least since version 2.4.5. -- rms. */
226 extern int strlen (const char *);
227 #endif /* not __STDC__ */
228 #endif /* __GNUC__ */
230 #endif /* not __GNU_LIBRARY__ */
232 /* Handle permutation of arguments. */
234 /* Describe the part of ARGV that contains non-options that have
235 been skipped. `first_nonopt' is the index in ARGV of the first of them;
236 `last_nonopt' is the index after the last of them. */
238 static int first_nonopt;
239 static int last_nonopt;
242 /* Bash 2.0 gives us an environment variable containing flags
243 indicating ARGV elements that should not be considered arguments. */
245 /* Defined in getopt_init.c */
246 extern char *__getopt_nonoption_flags;
248 static int nonoption_flags_max_len;
249 static int nonoption_flags_len;
251 static int original_argc;
252 static char *const *original_argv;
254 extern pid_t __libc_pid;
256 /* Make sure the environment variable bash 2.0 puts in the environment
257 is valid for the getopt call we must make sure that the ARGV passed
258 to getopt is that one passed to the process. */
260 __attribute__ ((__unused__))
261 store_args_and_env (int argc, char *const *argv)
263 /* XXX This is no good solution. We should rather copy the args so
264 that we can compare them later. But we must not use malloc(3). */
265 original_argc = argc;
266 original_argv = argv;
268 text_set_element (__libc_subinit, store_args_and_env);
270 # define SWAP_FLAGS(ch1, ch2) \
271 if (nonoption_flags_len > 0) \
273 char __tmp = __getopt_nonoption_flags[ch1]; \
274 __getopt_nonoption_flags[ch1] = __getopt_nonoption_flags[ch2]; \
275 __getopt_nonoption_flags[ch2] = __tmp; \
278 # define SWAP_FLAGS(ch1, ch2)
281 /* Exchange two adjacent subsequences of ARGV.
282 One subsequence is elements [first_nonopt,last_nonopt)
283 which contains all the non-options that have been skipped so far.
284 The other is elements [last_nonopt,optind), which contains all
285 the options processed since those non-options were skipped.
287 `first_nonopt' and `last_nonopt' are relocated so that they describe
288 the new indices of the non-options in ARGV after they are moved. */
290 #if defined (__STDC__) && __STDC__
291 static void exchange (char **);
298 int bottom = first_nonopt;
299 int middle = last_nonopt;
303 /* Exchange the shorter segment with the far end of the longer segment.
304 That puts the shorter segment into the right place.
305 It leaves the longer segment in the right place overall,
306 but it consists of two parts that need to be swapped next. */
309 /* First make sure the handling of the `__getopt_nonoption_flags'
310 string can work normally. Our top argument must be in the range
312 if (nonoption_flags_len > 0 && top >= nonoption_flags_max_len)
314 /* We must extend the array. The user plays games with us and
315 presents new arguments. */
316 char *new_str = malloc (top + 1);
318 nonoption_flags_len = nonoption_flags_max_len = 0;
321 memcpy (new_str, __getopt_nonoption_flags, nonoption_flags_max_len);
322 memset (&new_str[nonoption_flags_max_len], '\0',
323 top + 1 - nonoption_flags_max_len);
324 nonoption_flags_max_len = top + 1;
325 __getopt_nonoption_flags = new_str;
330 while (top > middle && middle > bottom)
332 if (top - middle > middle - bottom)
334 /* Bottom segment is the short one. */
335 int len = middle - bottom;
338 /* Swap it with the top part of the top segment. */
339 for (i = 0; i < len; i++)
341 tem = argv[bottom + i];
342 argv[bottom + i] = argv[top - (middle - bottom) + i];
343 argv[top - (middle - bottom) + i] = tem;
344 SWAP_FLAGS (bottom + i, top - (middle - bottom) + i);
346 /* Exclude the moved bottom segment from further swapping. */
351 /* Top segment is the short one. */
352 int len = top - middle;
355 /* Swap it with the bottom part of the bottom segment. */
356 for (i = 0; i < len; i++)
358 tem = argv[bottom + i];
359 argv[bottom + i] = argv[middle + i];
360 argv[middle + i] = tem;
361 SWAP_FLAGS (bottom + i, middle + i);
363 /* Exclude the moved top segment from further swapping. */
368 /* Update records for the slots the non-options now occupy. */
370 first_nonopt += (optind - last_nonopt);
371 last_nonopt = optind;
374 /* Initialize the internal data when the first call is made. */
376 #if defined (__STDC__) && __STDC__
377 static const char *_getopt_initialize (int, char *const *, const char *);
380 _getopt_initialize (argc, argv, optstring)
383 const char *optstring;
385 /* Start processing options with ARGV-element 1 (since ARGV-element 0
386 is the program name); the sequence of previously skipped
387 non-option ARGV-elements is empty. */
389 first_nonopt = last_nonopt = optind;
393 posixly_correct = getenv ("POSIXLY_CORRECT");
395 /* Determine how to handle the ordering of options and nonoptions. */
397 if (optstring[0] == '-')
399 ordering = RETURN_IN_ORDER;
402 else if (optstring[0] == '+')
404 ordering = REQUIRE_ORDER;
407 else if (posixly_correct != NULL)
408 ordering = REQUIRE_ORDER;
413 if (posixly_correct == NULL
414 && argc == original_argc && argv == original_argv)
416 if (nonoption_flags_max_len == 0)
418 if (__getopt_nonoption_flags == NULL
419 || __getopt_nonoption_flags[0] == '\0')
420 nonoption_flags_max_len = -1;
423 const char *orig_str = __getopt_nonoption_flags;
424 int len = nonoption_flags_max_len = strlen (orig_str);
425 if (nonoption_flags_max_len < argc)
426 nonoption_flags_max_len = argc;
427 __getopt_nonoption_flags =
428 (char *) malloc (nonoption_flags_max_len);
429 if (__getopt_nonoption_flags == NULL)
430 nonoption_flags_max_len = -1;
433 memcpy (__getopt_nonoption_flags, orig_str, len);
434 memset (&__getopt_nonoption_flags[len], '\0',
435 nonoption_flags_max_len - len);
439 nonoption_flags_len = nonoption_flags_max_len;
442 nonoption_flags_len = 0;
448 /* Scan elements of ARGV (whose length is ARGC) for option characters
451 If an element of ARGV starts with '-', and is not exactly "-" or "--",
452 then it is an option element. The characters of this element
453 (aside from the initial '-') are option characters. If `getopt'
454 is called repeatedly, it returns successively each of the option characters
455 from each of the option elements.
457 If `getopt' finds another option character, it returns that character,
458 updating `optind' and `nextchar' so that the next call to `getopt' can
459 resume the scan with the following option character or ARGV-element.
461 If there are no more option characters, `getopt' returns -1.
462 Then `optind' is the index in ARGV of the first ARGV-element
463 that is not an option. (The ARGV-elements have been permuted
464 so that those that are not options now come last.)
466 OPTSTRING is a string containing the legitimate option characters.
467 If an option character is seen that is not listed in OPTSTRING,
468 return '?' after printing an error message. If you set `opterr' to
469 zero, the error message is suppressed but we still return '?'.
471 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
472 so the following text in the same ARGV-element, or the text of the following
473 ARGV-element, is returned in `optarg'. Two colons mean an option that
474 wants an optional arg; if there is text in the current ARGV-element,
475 it is returned in `optarg', otherwise `optarg' is set to zero.
477 If OPTSTRING starts with `-' or `+', it requests different methods of
478 handling the non-option ARGV-elements.
479 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
481 Long-named options begin with `--' instead of `-'.
482 Their names may be abbreviated as long as the abbreviation is unique
483 or is an exact match for some defined option. If they have an
484 argument, it follows the option name in the same ARGV-element, separated
485 from the option name by a `=', or else the in next ARGV-element.
486 When `getopt' finds a long-named option, it returns 0 if that option's
487 `flag' field is nonzero, the value of the option's `val' field
488 if the `flag' field is zero.
490 The elements of ARGV aren't really const, because we permute them.
491 But we pretend they're const in the prototype to be compatible
494 LONGOPTS is a vector of `struct option' terminated by an
495 element containing a name which is zero.
497 LONGIND returns the index in LONGOPT of the long-named option found.
498 It is only valid when a long-named option has been found by the most
501 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
502 long-named options. */
505 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
508 const char *optstring;
509 const struct option *longopts;
515 if (optind == 0 || !__getopt_initialized)
518 optind = 1; /* Don't scan ARGV[0], the program name. */
519 optstring = _getopt_initialize (argc, argv, optstring);
520 __getopt_initialized = 1;
523 /* Test whether ARGV[optind] points to a non-option argument.
524 Either it does not have option syntax, or there is an environment flag
525 from the shell indicating it is not an option. The later information
526 is only used when the used in the GNU libc. */
528 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
529 || (optind < nonoption_flags_len \
530 && __getopt_nonoption_flags[optind] == '1'))
532 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
535 if (nextchar == NULL || *nextchar == '\0')
537 /* Advance to the next ARGV-element. */
539 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
540 moved back by the user (who may also have changed the arguments). */
541 if (last_nonopt > optind)
542 last_nonopt = optind;
543 if (first_nonopt > optind)
544 first_nonopt = optind;
546 if (ordering == PERMUTE)
548 /* If we have just processed some options following some non-options,
549 exchange them so that the options come first. */
551 if (first_nonopt != last_nonopt && last_nonopt != optind)
552 exchange ((char **) argv);
553 else if (last_nonopt != optind)
554 first_nonopt = optind;
556 /* Skip any additional non-options
557 and extend the range of non-options previously skipped. */
559 while (optind < argc && NONOPTION_P)
561 last_nonopt = optind;
564 /* The special ARGV-element `--' means premature end of options.
565 Skip it like a null option,
566 then exchange with previous non-options as if it were an option,
567 then skip everything else like a non-option. */
569 if (optind != argc && !strcmp (argv[optind], "--"))
573 if (first_nonopt != last_nonopt && last_nonopt != optind)
574 exchange ((char **) argv);
575 else if (first_nonopt == last_nonopt)
576 first_nonopt = optind;
582 /* If we have done all the ARGV-elements, stop the scan
583 and back over any non-options that we skipped and permuted. */
587 /* Set the next-arg-index to point at the non-options
588 that we previously skipped, so the caller will digest them. */
589 if (first_nonopt != last_nonopt)
590 optind = first_nonopt;
594 /* If we have come to a non-option and did not permute it,
595 either stop the scan or describe it to the caller and pass it by. */
599 if (ordering == REQUIRE_ORDER)
601 optarg = argv[optind++];
605 /* We have found another option-ARGV-element.
606 Skip the initial punctuation. */
608 nextchar = (argv[optind] + 1
609 + (longopts != NULL && argv[optind][1] == '-'));
612 /* Decode the current option-ARGV-element. */
614 /* Check whether the ARGV-element is a long option.
616 If long_only and the ARGV-element has the form "-f", where f is
617 a valid short option, don't consider it an abbreviated form of
618 a long option that starts with f. Otherwise there would be no
619 way to give the -f short option.
621 On the other hand, if there's a long option "fubar" and
622 the ARGV-element is "-fu", do consider that an abbreviation of
623 the long option, just like "--fu", and not "-f" with arg "u".
625 This distinction seems to be the most useful approach. */
628 && (argv[optind][1] == '-'
629 || (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
632 const struct option *p;
633 const struct option *pfound = NULL;
639 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
642 /* Test all long options for either exact match
643 or abbreviated matches. */
644 for (p = longopts, option_index = 0; p->name; p++, option_index++)
645 if (!strncmp (p->name, nextchar, nameend - nextchar))
647 if ((unsigned int) (nameend - nextchar)
648 == (unsigned int) strlen (p->name))
650 /* Exact match found. */
652 indfound = option_index;
656 else if (pfound == NULL)
658 /* First nonexact match found. */
660 indfound = option_index;
663 /* Second or later nonexact match found. */
670 fprintf (stderr, "%s: option `%s' is ambiguous\n",
671 argv[0], argv[optind]);
672 nextchar += strlen (nextchar);
680 option_index = indfound;
684 /* Don't test has_arg with >, because some C compilers don't
685 allow it to be used on enums. */
687 optarg = nameend + 1;
691 if (argv[optind - 1][1] == '-')
694 "%s: option `--%s' doesn't allow an argument\n",
695 argv[0], pfound->name);
697 /* +option or -option */
699 "%s: option `%c%s' doesn't allow an argument\n",
700 argv[0], argv[optind - 1][0], pfound->name);
702 nextchar += strlen (nextchar);
704 optopt = pfound->val;
708 else if (pfound->has_arg == 1)
711 optarg = argv[optind++];
716 "%s: option `%s' requires an argument\n",
717 argv[0], argv[optind - 1]);
718 nextchar += strlen (nextchar);
719 optopt = pfound->val;
720 return optstring[0] == ':' ? ':' : '?';
723 nextchar += strlen (nextchar);
725 *longind = option_index;
728 *(pfound->flag) = pfound->val;
734 /* Can't find it as a long option. If this is not getopt_long_only,
735 or the option starts with '--' or is not a valid short
736 option, then it's an error.
737 Otherwise interpret it as a short option. */
738 if (!long_only || argv[optind][1] == '-'
739 || my_index (optstring, *nextchar) == NULL)
743 if (argv[optind][1] == '-')
745 fprintf (stderr, "%s: unrecognized option `--%s'\n",
748 /* +option or -option */
749 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
750 argv[0], argv[optind][0], nextchar);
752 nextchar = (char *) "";
759 /* Look at and handle the next short option-character. */
762 char c = *nextchar++;
763 char *temp = my_index (optstring, c);
765 /* Increment `optind' when we start to process its last character. */
766 if (*nextchar == '\0')
769 if (temp == NULL || c == ':')
774 /* 1003.2 specifies the format of this message. */
775 fprintf (stderr, "%s: illegal option -- %c\n",
778 fprintf (stderr, "%s: invalid option -- %c\n",
784 /* Convenience. Treat POSIX -W foo same as long option --foo */
785 if (temp[0] == 'W' && temp[1] == ';')
788 const struct option *p;
789 const struct option *pfound = NULL;
795 /* This is an option that requires an argument. */
796 if (*nextchar != '\0')
799 /* If we end this ARGV-element by taking the rest as an arg,
800 we must advance to the next element now. */
803 else if (optind == argc)
807 /* 1003.2 specifies the format of this message. */
808 fprintf (stderr, "%s: option requires an argument -- %c\n",
812 if (optstring[0] == ':')
819 /* We already incremented `optind' once;
820 increment it again when taking next ARGV-elt as argument. */
821 optarg = argv[optind++];
823 /* optarg is now the argument, see if it's in the
824 table of longopts. */
826 for (nextchar = nameend = optarg; *nameend && *nameend != '='; nameend++)
829 /* Test all long options for either exact match
830 or abbreviated matches. */
831 for (p = longopts, option_index = 0; p->name; p++, option_index++)
832 if (!strncmp (p->name, nextchar, nameend - nextchar))
834 if ((unsigned int) (nameend - nextchar) == strlen (p->name))
836 /* Exact match found. */
838 indfound = option_index;
842 else if (pfound == NULL)
844 /* First nonexact match found. */
846 indfound = option_index;
849 /* Second or later nonexact match found. */
855 fprintf (stderr, "%s: option `-W %s' is ambiguous\n",
856 argv[0], argv[optind]);
857 nextchar += strlen (nextchar);
863 option_index = indfound;
866 /* Don't test has_arg with >, because some C compilers don't
867 allow it to be used on enums. */
869 optarg = nameend + 1;
874 "%s: option `-W %s' doesn't allow an argument\n",
875 argv[0], pfound->name);
877 nextchar += strlen (nextchar);
881 else if (pfound->has_arg == 1)
884 optarg = argv[optind++];
889 "%s: option `%s' requires an argument\n",
890 argv[0], argv[optind - 1]);
891 nextchar += strlen (nextchar);
892 return optstring[0] == ':' ? ':' : '?';
895 nextchar += strlen (nextchar);
897 *longind = option_index;
900 *(pfound->flag) = pfound->val;
906 return 'W'; /* Let the application handle it. */
912 /* This is an option that accepts an argument optionally. */
913 if (*nextchar != '\0')
924 /* This is an option that requires an argument. */
925 if (*nextchar != '\0')
928 /* If we end this ARGV-element by taking the rest as an arg,
929 we must advance to the next element now. */
932 else if (optind == argc)
936 /* 1003.2 specifies the format of this message. */
938 "%s: option requires an argument -- %c\n",
942 if (optstring[0] == ':')
948 /* We already incremented `optind' once;
949 increment it again when taking next ARGV-elt as argument. */
950 optarg = argv[optind++];
959 getopt (argc, argv, optstring)
962 const char *optstring;
964 return _getopt_internal (argc, argv, optstring,
965 (const struct option *) 0,
970 #endif /* Not ELIDE_CODE. */
974 /* Compile with -DTEST to make an executable for use in testing
975 the above definition of `getopt'. */
983 int digit_optind = 0;
987 int this_option_optind = optind ? optind : 1;
989 c = getopt (argc, argv, "abc:d:0123456789");
1005 if (digit_optind != 0 && digit_optind != this_option_optind)
1006 printf ("digits occur in two different argv-elements.\n");
1007 digit_optind = this_option_optind;
1008 printf ("option %c\n", c);
1012 printf ("option a\n");
1016 printf ("option b\n");
1020 printf ("option c with value `%s'\n", optarg);
1027 printf ("?? getopt returned character code 0%o ??\n", c);
1033 printf ("non-option ARGV-elements: ");
1034 while (optind < argc)
1035 printf ("%s ", argv[optind++]);