3 Copyright 2008 Karl Berry.
4 Copyright (C) 1987, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 2000
5 Free Software Foundation, Inc.
7 The original version of this file was part of the GNU C Library.
8 Its master source is NOT part of the C library, however.
9 The master source lives in libc.
10 This version has been modified for use with libkpathsea.
12 This library is free software; you can redistribute it and/or
13 modify it under the terms of the GNU Lesser General Public
14 License as published by the Free Software Foundation; either
15 version 2.1 of the License, or (at your option) any later version.
17 This 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 Lesser General Public License for more details.
22 You should have received a copy of the GNU Lesser General Public License
23 along with this library; if not, see <http://www.gnu.org/licenses/>. */
26 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
27 Ditto for AIX 3.2 and <stdlib.h>. */
36 #if !defined (__STDC__) || !__STDC__
37 /* This is a separate conditional since some stdc systems
38 reject `defined (const)'. */
46 /* Comment out all this code if we are using the GNU C Library, and are not
47 actually compiling the library itself. This code is part of the GNU C
48 Library, but also included in many other GNU distributions. Compiling
49 and linking in this code is a waste when using the GNU C library
50 (especially if it is a shared library). Rather than having every GNU
51 program understand `configure --with-gnu-libc' and omit the object files,
52 it is simpler to just do this in the source for each such file. */
54 #define GETOPT_INTERFACE_VERSION 2
55 #if !defined (_LIBC) && defined (__GLIBC__) && __GLIBC__ >= 2
56 #include <gnu-versions.h>
57 #if _GNU_GETOPT_INTERFACE_VERSION == GETOPT_INTERFACE_VERSION
65 /* This needs to come after some library #include
66 to get __GNU_LIBRARY__ defined. */
67 #ifdef __GNU_LIBRARY__
68 /* Don't include stdlib.h for non-GNU C libraries because some of them
69 contain conflicting prototypes for getopt. */
72 #endif /* GNU C library. */
81 #if defined (WIN32) && !defined (__CYGWIN32__)
82 /* It's not Unix, really. See? Capital letters. */
88 #define getpid() GetCurrentProcessId()
92 /* This is for other GNU distributions with internationalized messages.
93 When compiling libc, the _ macro is predefined. */
96 # define _(msgid) gettext (msgid)
98 # define _(msgid) (msgid)
102 /* This version of `getopt' appears to the caller like standard Unix `getopt'
103 but it behaves differently for the user, since it allows the user
104 to intersperse the options with the other arguments.
106 As `getopt' works, it permutes the elements of ARGV so that,
107 when it is done, all the options precede everything else. Thus
108 all application programs are extended to handle flexible argument order.
110 Setting the environment variable POSIXLY_CORRECT disables permutation.
111 Then the behavior is completely standard.
113 GNU application programs can use a third alternative mode in which
114 they can distinguish the relative order of options and other arguments. */
118 /* For communication from `getopt' to the caller.
119 When `getopt' finds an option that takes an argument,
120 the argument value is returned here.
121 Also, when `ordering' is RETURN_IN_ORDER,
122 each non-option ARGV-element is returned here. */
126 /* Index in ARGV of the next element to be scanned.
127 This is used for communication to and from the caller
128 and for communication between successive calls to `getopt'.
130 On entry to `getopt', zero means this is the first call; initialize.
132 When `getopt' returns -1, this is the index of the first of the
133 non-option elements that the caller should itself scan.
135 Otherwise, `optind' communicates from one call to the next
136 how much of ARGV has been scanned so far. */
138 /* 1003.2 says this must be 1 before any call. */
141 /* Formerly, initialization of getopt depended on optind==0, which
142 causes problems with re-calling getopt as programs generally don't
145 int __getopt_initialized = 0;
147 /* The next char to be scanned in the option-element
148 in which the last option character we returned was found.
149 This allows us to pick up the scan where we left off.
151 If this is zero, or a null string, it means resume the scan
152 by advancing to the next ARGV-element. */
154 static char *nextchar;
156 /* Callers store zero here to inhibit the error message
157 for unrecognized options. */
161 /* Set to an option character which was unrecognized.
162 This must be initialized on some systems to avoid linking in the
163 system's own getopt implementation. */
167 /* Describe how to deal with options that follow non-option ARGV-elements.
169 If the caller did not specify anything,
170 the default is REQUIRE_ORDER if the environment variable
171 POSIXLY_CORRECT is defined, PERMUTE otherwise.
173 REQUIRE_ORDER means don't recognize them as options;
174 stop option processing when the first non-option is seen.
175 This is what Unix does.
176 This mode of operation is selected by either setting the environment
177 variable POSIXLY_CORRECT, or using `+' as the first character
178 of the list of option characters.
180 PERMUTE is the default. We permute the contents of ARGV as we scan,
181 so that eventually all the non-options are at the end. This allows options
182 to be given in any order, even with programs that were not written to
185 RETURN_IN_ORDER is an option available to programs that were written
186 to expect options and other ARGV-elements in any order and that care about
187 the ordering of the two. We describe each non-option ARGV-element
188 as if it were the argument of an option with character code 1.
189 Using `-' as the first character of the list of option characters
190 selects this mode of operation.
192 The special argument `--' forces an end of option-scanning regardless
193 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
194 `--' can cause `getopt' to return -1 with `optind' != ARGC. */
198 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
201 /* Value of POSIXLY_CORRECT environment variable. */
202 static char *posixly_correct;
204 #if defined(__GNU_LIBRARY__) || defined(WIN32)
205 /* We want to avoid inclusion of string.h with non-GNU libraries
206 because there are many ways it can cause trouble.
207 On some systems, it contains special magic macros that don't work
210 #define my_index strchr
213 /* Avoid depending on library functions or files
214 whose names are inconsistent. */
232 /* If using GCC, we can safely declare strlen this way.
233 If not using GCC, it is ok not to declare it. */
235 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
236 That was relevant to code that was here before. */
237 #if !defined (__STDC__) || !__STDC__
238 /* gcc with -traditional declares the built-in strlen to return int,
239 and has done so at least since version 2.4.5. -- rms. */
240 extern int strlen (const char *);
241 #endif /* not __STDC__ */
242 #endif /* __GNUC__ */
244 #endif /* not __GNU_LIBRARY__ */
246 /* Handle permutation of arguments. */
248 /* Describe the part of ARGV that contains non-options that have
249 been skipped. `first_nonopt' is the index in ARGV of the first of them;
250 `last_nonopt' is the index after the last of them. */
252 static int first_nonopt;
253 static int last_nonopt;
256 /* Bash 2.0 gives us an environment variable containing flags
257 indicating ARGV elements that should not be considered arguments. */
259 static const char *nonoption_flags;
260 static int nonoption_flags_len;
262 static int original_argc;
263 static char *const *original_argv;
265 /* Make sure the environment variable bash 2.0 puts in the environment
266 is valid for the getopt call we must make sure that the ARGV passed
267 to getopt is that one passed to the process. */
268 static void store_args (int argc, char *const *argv) __attribute__ ((unused));
270 store_args (int argc, char *const *argv)
272 /* XXX This is no good solution. We should rather copy the args so
273 that we can compare them later. But we must not use malloc(3). */
274 original_argc = argc;
275 original_argv = argv;
277 text_set_element (__libc_subinit, store_args);
280 /* Exchange two adjacent subsequences of ARGV.
281 One subsequence is elements [first_nonopt,last_nonopt)
282 which contains all the non-options that have been skipped so far.
283 The other is elements [last_nonopt,optind), which contains all
284 the options processed since those non-options were skipped.
286 `first_nonopt' and `last_nonopt' are relocated so that they describe
287 the new indices of the non-options in ARGV after they are moved. */
289 #if defined (__STDC__) && __STDC__
290 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 *);
355 _getopt_initialize (argc, argv, optstring)
358 const char *optstring;
360 /* Start processing options with ARGV-element 1 (since ARGV-element 0
361 is the program name); the sequence of previously skipped
362 non-option ARGV-elements is empty. */
364 first_nonopt = last_nonopt = optind = 1;
368 posixly_correct = getenv ("POSIXLY_CORRECT");
370 /* Determine how to handle the ordering of options and nonoptions. */
372 if (optstring[0] == '-')
374 ordering = RETURN_IN_ORDER;
377 else if (optstring[0] == '+')
379 ordering = REQUIRE_ORDER;
382 else if (posixly_correct != NULL)
383 ordering = REQUIRE_ORDER;
388 if (posixly_correct == NULL
389 && argc == original_argc && argv == original_argv)
391 /* Bash 2.0 puts a special variable in the environment for each
392 command it runs, specifying which ARGV elements are the results of
393 file name wildcard expansion and therefore should not be
394 considered as options. */
396 sprintf (var, "_%d_GNU_nonoption_argv_flags_", getpid ());
397 nonoption_flags = getenv (var);
398 if (nonoption_flags == NULL)
399 nonoption_flags_len = 0;
401 nonoption_flags_len = strlen (nonoption_flags);
404 nonoption_flags_len = 0;
410 /* Scan elements of ARGV (whose length is ARGC) for option characters
413 If an element of ARGV starts with '-', and is not exactly "-" or "--",
414 then it is an option element. The characters of this element
415 (aside from the initial '-') are option characters. If `getopt'
416 is called repeatedly, it returns successively each of the option characters
417 from each of the option elements.
419 If `getopt' finds another option character, it returns that character,
420 updating `optind' and `nextchar' so that the next call to `getopt' can
421 resume the scan with the following option character or ARGV-element.
423 If there are no more option characters, `getopt' returns -1.
424 Then `optind' is the index in ARGV of the first ARGV-element
425 that is not an option. (The ARGV-elements have been permuted
426 so that those that are not options now come last.)
428 OPTSTRING is a string containing the legitimate option characters.
429 If an option character is seen that is not listed in OPTSTRING,
430 return '?' after printing an error message. If you set `opterr' to
431 zero, the error message is suppressed but we still return '?'.
433 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
434 so the following text in the same ARGV-element, or the text of the following
435 ARGV-element, is returned in `optarg'. Two colons mean an option that
436 wants an optional arg; if there is text in the current ARGV-element,
437 it is returned in `optarg', otherwise `optarg' is set to zero.
439 If OPTSTRING starts with `-' or `+', it requests different methods of
440 handling the non-option ARGV-elements.
441 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
443 Long-named options begin with `--' instead of `-'.
444 Their names may be abbreviated as long as the abbreviation is unique
445 or is an exact match for some defined option. If they have an
446 argument, it follows the option name in the same ARGV-element, separated
447 from the option name by a `=', or else the in next ARGV-element.
448 When `getopt' finds a long-named option, it returns 0 if that option's
449 `flag' field is nonzero, the value of the option's `val' field
450 if the `flag' field is zero.
452 The elements of ARGV aren't really const, because we permute them.
453 But we pretend they're const in the prototype to be compatible
456 LONGOPTS is a vector of `struct option' terminated by an
457 element containing a name which is zero.
459 LONGIND returns the index in LONGOPT of the long-named option found.
460 It is only valid when a long-named option has been found by the most
463 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
464 long-named options. */
467 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
470 const char *optstring;
471 const struct option *longopts;
477 if (!__getopt_initialized || optind == 0)
479 optstring = _getopt_initialize (argc, argv, optstring);
480 optind = 1; /* Don't scan ARGV[0], the program name. */
481 __getopt_initialized = 1;
484 /* Test whether ARGV[optind] points to a non-option argument.
485 Either it does not have option syntax, or there is an environment flag
486 from the shell indicating it is not an option. The later information
487 is only used when the used in the GNU libc. */
489 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
490 || (optind < nonoption_flags_len \
491 && nonoption_flags[optind] == '1'))
493 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
496 if (nextchar == NULL || *nextchar == '\0')
498 /* Advance to the next ARGV-element. */
500 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
501 moved back by the user (who may also have changed the arguments). */
502 if (last_nonopt > optind)
503 last_nonopt = optind;
504 if (first_nonopt > optind)
505 first_nonopt = optind;
507 if (ordering == PERMUTE)
509 /* If we have just processed some options following some non-options,
510 exchange them so that the options come first. */
512 if (first_nonopt != last_nonopt && last_nonopt != optind)
513 exchange ((char **) argv);
514 else if (last_nonopt != optind)
515 first_nonopt = optind;
517 /* Skip any additional non-options
518 and extend the range of non-options previously skipped. */
520 while (optind < argc && NONOPTION_P)
522 last_nonopt = optind;
525 /* The special ARGV-element `--' means premature end of options.
526 Skip it like a null option,
527 then exchange with previous non-options as if it were an option,
528 then skip everything else like a non-option. */
530 if (optind != argc && !strcmp (argv[optind], "--"))
534 if (first_nonopt != last_nonopt && last_nonopt != optind)
535 exchange ((char **) argv);
536 else if (first_nonopt == last_nonopt)
537 first_nonopt = optind;
543 /* If we have done all the ARGV-elements, stop the scan
544 and back over any non-options that we skipped and permuted. */
548 /* Set the next-arg-index to point at the non-options
549 that we previously skipped, so the caller will digest them. */
550 if (first_nonopt != last_nonopt)
551 optind = first_nonopt;
555 /* If we have come to a non-option and did not permute it,
556 either stop the scan or describe it to the caller and pass it by. */
560 if (ordering == REQUIRE_ORDER)
562 optarg = argv[optind++];
566 /* We have found another option-ARGV-element.
567 Skip the initial punctuation. */
569 nextchar = (argv[optind] + 1
570 + (longopts != NULL && argv[optind][1] == '-'));
573 /* Decode the current option-ARGV-element. */
575 /* Check whether the ARGV-element is a long option.
577 If long_only and the ARGV-element has the form "-f", where f is
578 a valid short option, don't consider it an abbreviated form of
579 a long option that starts with f. Otherwise there would be no
580 way to give the -f short option.
582 On the other hand, if there's a long option "fubar" and
583 the ARGV-element is "-fu", do consider that an abbreviation of
584 the long option, just like "--fu", and not "-f" with arg "u".
586 This distinction seems to be the most useful approach. */
589 && (argv[optind][1] == '-'
590 || (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
593 const struct option *p;
594 const struct option *pfound = NULL;
600 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
603 /* Test all long options for either exact match
604 or abbreviated matches. */
605 for (p = longopts, option_index = 0; p->name; p++, option_index++)
606 if (!strncmp (p->name, nextchar, nameend - nextchar))
608 if ((unsigned int) (nameend - nextchar)
609 == (unsigned int) strlen (p->name))
611 /* Exact match found. */
613 indfound = option_index;
617 else if (pfound == NULL)
619 /* First nonexact match found. */
621 indfound = option_index;
624 /* Second or later nonexact match found. */
631 fprintf (stderr, _("%s: option `%s' is ambiguous\n"),
632 argv[0], argv[optind]);
633 nextchar += strlen (nextchar);
641 option_index = indfound;
645 /* Don't test has_arg with >, because some C compilers don't
646 allow it to be used on enums. */
648 optarg = nameend + 1;
652 if (argv[optind - 1][1] == '-')
655 _("%s: option `--%s' doesn't allow an argument\n"),
656 argv[0], pfound->name);
658 /* +option or -option */
660 _("%s: option `%c%s' doesn't allow an argument\n"),
661 argv[0], argv[optind - 1][0], pfound->name);
663 nextchar += strlen (nextchar);
665 optopt = pfound->val;
669 else if (pfound->has_arg == 1)
672 optarg = argv[optind++];
677 _("%s: option `%s' requires an argument\n"),
678 argv[0], argv[optind - 1]);
679 nextchar += strlen (nextchar);
680 optopt = pfound->val;
681 return optstring[0] == ':' ? ':' : '?';
684 nextchar += strlen (nextchar);
686 *longind = option_index;
689 *(pfound->flag) = pfound->val;
695 /* Can't find it as a long option. If this is not getopt_long_only,
696 or the option starts with '--' or is not a valid short
697 option, then it's an error.
698 Otherwise interpret it as a short option. */
699 if (!long_only || argv[optind][1] == '-'
700 || my_index (optstring, *nextchar) == NULL)
704 if (argv[optind][1] == '-')
706 fprintf (stderr, _("%s: unrecognized option `--%s'\n"),
709 /* +option or -option */
710 fprintf (stderr, _("%s: unrecognized option `%c%s'\n"),
711 argv[0], argv[optind][0], nextchar);
713 nextchar = (char *) "";
720 /* Look at and handle the next short option-character. */
723 char c = *nextchar++;
724 char *temp = my_index (optstring, c);
726 /* Increment `optind' when we start to process its last character. */
727 if (*nextchar == '\0')
730 if (temp == NULL || c == ':')
735 /* 1003.2 specifies the format of this message. */
736 fprintf (stderr, _("%s: illegal option -- %c\n"),
739 fprintf (stderr, _("%s: invalid option -- %c\n"),
745 /* Convenience. Treat POSIX -W foo same as long option --foo */
746 if (temp[0] == 'W' && temp[1] == ';')
749 const struct option *p;
750 const struct option *pfound = NULL;
756 /* This is an option that requires an argument. */
757 if (*nextchar != '\0')
760 /* If we end this ARGV-element by taking the rest as an arg,
761 we must advance to the next element now. */
764 else if (optind == argc)
768 /* 1003.2 specifies the format of this message. */
769 fprintf (stderr, _("%s: option requires an argument -- %c\n"),
773 if (optstring[0] == ':')
780 /* We already incremented `optind' once;
781 increment it again when taking next ARGV-elt as argument. */
782 optarg = argv[optind++];
784 /* optarg is now the argument, see if it's in the
785 table of longopts. */
787 for (nextchar = nameend = optarg; *nameend && *nameend != '='; nameend++)
790 /* Test all long options for either exact match
791 or abbreviated matches. */
792 for (p = longopts, option_index = 0; p->name; p++, option_index++)
793 if (!strncmp (p->name, nextchar, nameend - nextchar))
795 if ((unsigned int) (nameend - nextchar) == strlen (p->name))
797 /* Exact match found. */
799 indfound = option_index;
803 else if (pfound == NULL)
805 /* First nonexact match found. */
807 indfound = option_index;
810 /* Second or later nonexact match found. */
816 fprintf (stderr, _("%s: option `-W %s' is ambiguous\n"),
817 argv[0], argv[optind]);
818 nextchar += strlen (nextchar);
824 option_index = indfound;
827 /* Don't test has_arg with >, because some C compilers don't
828 allow it to be used on enums. */
830 optarg = nameend + 1;
834 fprintf (stderr, _("\
835 %s: option `-W %s' doesn't allow an argument\n"),
836 argv[0], pfound->name);
838 nextchar += strlen (nextchar);
842 else if (pfound->has_arg == 1)
845 optarg = argv[optind++];
850 _("%s: option `%s' requires an argument\n"),
851 argv[0], argv[optind - 1]);
852 nextchar += strlen (nextchar);
853 return optstring[0] == ':' ? ':' : '?';
856 nextchar += strlen (nextchar);
858 *longind = option_index;
861 *(pfound->flag) = pfound->val;
867 return 'W'; /* Let the application handle it. */
873 /* This is an option that accepts an argument optionally. */
874 if (*nextchar != '\0')
885 /* This is an option that requires an argument. */
886 if (*nextchar != '\0')
889 /* If we end this ARGV-element by taking the rest as an arg,
890 we must advance to the next element now. */
893 else if (optind == argc)
897 /* 1003.2 specifies the format of this message. */
899 _("%s: option requires an argument -- %c\n"),
903 if (optstring[0] == ':')
909 /* We already incremented `optind' once;
910 increment it again when taking next ARGV-elt as argument. */
911 optarg = argv[optind++];
920 getopt (argc, argv, optstring)
923 const char *optstring;
925 return _getopt_internal (argc, argv, optstring,
926 (const struct option *) 0,
931 #endif /* Not ELIDE_CODE. */
935 /* Compile with -DTEST to make an executable for use in testing
936 the above definition of `getopt'. */
944 int digit_optind = 0;
948 int this_option_optind = optind ? optind : 1;
950 c = getopt (argc, argv, "abc:d:0123456789");
966 if (digit_optind != 0 && digit_optind != this_option_optind)
967 printf ("digits occur in two different argv-elements.\n");
968 digit_optind = this_option_optind;
969 printf ("option %c\n", c);
973 printf ("option a\n");
977 printf ("option b\n");
981 printf ("option c with value `%s'\n", optarg);
988 printf ("?? getopt returned character code 0%o ??\n", c);
994 printf ("non-option ARGV-elements: ");
995 while (optind < argc)
996 printf ("%s ", argv[optind++]);