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>. */
36 #include <vlc_common.h>
38 #if !defined (__STDC__) || !__STDC__
39 /* This is a separate conditional since some stdc systems
40 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. */
79 #ifdef STRNCASECMP_IN_STRINGS_H
85 #if defined (WIN32) && !defined (__CYGWIN32__) || defined(UNDER_CE)
86 /* 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
202 /* Value of POSIXLY_CORRECT environment variable. */
203 static char *posixly_correct;
205 #ifdef __GNU_LIBRARY__
206 /* We want to avoid inclusion of string.h with non-GNU libraries
207 because there are many ways it can cause trouble.
208 On some systems, it contains special magic macros that don't work
211 #define my_index strchr
214 /* Avoid depending on library functions or files
215 whose names are inconsistent. */
231 /* If using GCC, we can safely declare strlen this way.
232 If not using GCC, it is ok not to declare it. */
234 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
235 That was relevant to code that was here before. */
236 #if !defined (__STDC__) || !__STDC__
237 /* gcc with -traditional declares the built-in strlen to return int,
238 and has done so at least since version 2.4.5. -- rms. */
239 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 **);
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. */
308 while (top > middle && middle > bottom)
310 if (top - middle > middle - bottom)
312 /* Bottom segment is the short one. */
313 int len = middle - bottom;
316 /* Swap it with the top part of the top segment. */
317 for (i = 0; i < len; i++)
319 tem = argv[bottom + i];
320 argv[bottom + i] = argv[top - (middle - bottom) + i];
321 argv[top - (middle - bottom) + i] = tem;
323 /* Exclude the moved bottom segment from further swapping. */
328 /* Top segment is the short one. */
329 int len = top - middle;
332 /* Swap it with the bottom part of the bottom segment. */
333 for (i = 0; i < len; i++)
335 tem = argv[bottom + i];
336 argv[bottom + i] = argv[middle + i];
337 argv[middle + i] = tem;
339 /* Exclude the moved top segment from further swapping. */
344 /* Update records for the slots the non-options now occupy. */
346 first_nonopt += (optind - last_nonopt);
347 last_nonopt = optind;
350 /* Initialize the internal data when the first call is made. */
352 #if defined (__STDC__) && __STDC__
353 static const char *_getopt_initialize(int, char *const *, const char *);
357 _getopt_initialize(argc, argv, optstring)
360 const char *optstring;
362 /* Start processing options with ARGV-element 1 (since ARGV-element 0
363 is the program name); the sequence of previously skipped
364 non-option ARGV-elements is empty. */
366 first_nonopt = last_nonopt = optind = 1;
370 posixly_correct = getenv("POSIXLY_CORRECT");
372 /* Determine how to handle the ordering of options and nonoptions. */
374 if (optstring[0] == '-')
376 ordering = RETURN_IN_ORDER;
379 else if (optstring[0] == '+')
381 ordering = REQUIRE_ORDER;
384 else if (posixly_correct != NULL)
385 ordering = REQUIRE_ORDER;
390 if (posixly_correct == NULL
391 && argc == original_argc && argv == original_argv)
393 /* Bash 2.0 puts a special variable in the environment for each
394 command it runs, specifying which ARGV elements are the results of
395 file name wildcard expansion and therefore should not be
396 considered as options. */
399 sprintf(var, "_%d_GNU_nonoption_argv_flags_", getpid());
400 nonoption_flags = getenv(var);
401 if (nonoption_flags == NULL)
402 nonoption_flags_len = 0;
404 nonoption_flags_len = strlen(nonoption_flags);
407 nonoption_flags_len = 0;
413 /* Scan elements of ARGV (whose length is ARGC) for option characters
416 If an element of ARGV starts with '-', and is not exactly "-" or "--",
417 then it is an option element. The characters of this element
418 (aside from the initial '-') are option characters. If `getopt'
419 is called repeatedly, it returns successively each of the option characters
420 from each of the option elements.
422 If `getopt' finds another option character, it returns that character,
423 updating `optind' and `nextchar' so that the next call to `getopt' can
424 resume the scan with the following option character or ARGV-element.
426 If there are no more option characters, `getopt' returns -1.
427 Then `optind' is the index in ARGV of the first ARGV-element
428 that is not an option. (The ARGV-elements have been permuted
429 so that those that are not options now come last.)
431 OPTSTRING is a string containing the legitimate option characters.
432 If an option character is seen that is not listed in OPTSTRING,
433 return '?' after printing an error message. If you set `opterr' to
434 zero, the error message is suppressed but we still return '?'.
436 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
437 so the following text in the same ARGV-element, or the text of the following
438 ARGV-element, is returned in `optarg'. Two colons mean an option that
439 wants an optional arg; if there is text in the current ARGV-element,
440 it is returned in `optarg', otherwise `optarg' is set to zero.
442 If OPTSTRING starts with `-' or `+', it requests different methods of
443 handling the non-option ARGV-elements.
444 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
446 Long-named options begin with `--' instead of `-'.
447 Their names may be abbreviated as long as the abbreviation is unique
448 or is an exact match for some defined option. If they have an
449 argument, it follows the option name in the same ARGV-element, separated
450 from the option name by a `=', or else the in next ARGV-element.
451 When `getopt' finds a long-named option, it returns 0 if that option's
452 `flag' field is nonzero, the value of the option's `val' field
453 if the `flag' field is zero.
455 The elements of ARGV aren't really const, because we permute them.
456 But we pretend they're const in the prototype to be compatible
459 LONGOPTS is a vector of `struct option' terminated by an
460 element containing a name which is zero.
462 LONGIND returns the index in LONGOPT of the long-named option found.
463 It is only valid when a long-named option has been found by the most
466 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
467 long-named options. */
470 _getopt_internal(argc, argv, optstring, longopts, longind, long_only)
473 const char *optstring;
474 const struct option *longopts;
480 if (!__getopt_initialized || optind == 0)
482 optstring = _getopt_initialize(argc, argv, optstring);
483 optind = 1; /* Don't scan ARGV[0], the program name. */
484 __getopt_initialized = 1;
487 /* Test whether ARGV[optind] points to a non-option argument.
488 Either it does not have option syntax, or there is an environment flag
489 from the shell indicating it is not an option. The later information
490 is only used when the used in the GNU libc. */
492 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
493 || (optind < nonoption_flags_len \
494 && nonoption_flags[optind] == '1'))
496 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
499 if (nextchar == NULL || *nextchar == '\0')
501 /* Advance to the next ARGV-element. */
503 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
504 moved back by the user (who may also have changed the arguments). */
505 if (last_nonopt > optind)
506 last_nonopt = optind;
507 if (first_nonopt > optind)
508 first_nonopt = optind;
510 if (ordering == PERMUTE)
512 /* If we have just processed some options following some non-options,
513 exchange them so that the options come first. */
515 if (first_nonopt != last_nonopt && last_nonopt != optind)
516 exchange((char **) argv);
517 else if (last_nonopt != optind)
518 first_nonopt = optind;
520 /* Skip any additional non-options
521 and extend the range of non-options previously skipped. */
523 while (optind < argc && NONOPTION_P)
525 last_nonopt = optind;
528 /* The special ARGV-element `--' means premature end of options.
529 Skip it like a null option,
530 then exchange with previous non-options as if it were an option,
531 then skip everything else like a non-option. */
533 if (optind != argc && !strcmp(argv[optind], "--"))
537 if (first_nonopt != last_nonopt && last_nonopt != optind)
538 exchange((char **) argv);
539 else if (first_nonopt == last_nonopt)
540 first_nonopt = optind;
546 /* If we have done all the ARGV-elements, stop the scan
547 and back over any non-options that we skipped and permuted. */
551 /* Set the next-arg-index to point at the non-options
552 that we previously skipped, so the caller will digest them. */
553 if (first_nonopt != last_nonopt)
554 optind = first_nonopt;
558 /* If we have come to a non-option and did not permute it,
559 either stop the scan or describe it to the caller and pass it by. */
563 if (ordering == REQUIRE_ORDER)
565 optarg = argv[optind++];
569 /* We have found another option-ARGV-element.
570 Skip the initial punctuation. */
572 nextchar = (argv[optind] + 1
573 + (longopts != NULL && argv[optind][1] == '-'));
576 /* Decode the current option-ARGV-element. */
578 /* Check whether the ARGV-element is a long option.
580 If long_only and the ARGV-element has the form "-f", where f is
581 a valid short option, don't consider it an abbreviated form of
582 a long option that starts with f. Otherwise there would be no
583 way to give the -f short option.
585 On the other hand, if there's a long option "fubar" and
586 the ARGV-element is "-fu", do consider that an abbreviation of
587 the long option, just like "--fu", and not "-f" with arg "u".
589 This distinction seems to be the most useful approach. */
592 && (argv[optind][1] == '-'
593 || (long_only && (argv[optind][2] || !my_index(optstring, argv[optind][1])))))
596 const struct option *p;
597 const struct option *pfound = NULL;
603 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
606 /* Test all long options for either exact match
607 or abbreviated matches. */
608 for (p = longopts, option_index = 0; p->name; p++, option_index++)
609 if (!strncmp(p->name, nextchar, nameend - nextchar))
611 if ((unsigned int) (nameend - nextchar)
612 == (unsigned int) strlen(p->name))
614 /* Exact match found. */
616 indfound = option_index;
620 else if (pfound == NULL)
622 /* First nonexact match found. */
624 indfound = option_index;
627 /* Second or later nonexact match found. */
634 fprintf(stderr, _("%s: option `%s' is ambiguous\n"),
635 argv[0], argv[optind]);
636 nextchar += strlen(nextchar);
644 option_index = indfound;
648 /* Don't test has_arg with >, because some C compilers don't
649 allow it to be used on enums. */
651 optarg = nameend + 1;
656 if (argv[optind - 1][1] == '-')
659 _("%s: option `--%s' doesn't allow an argument\n"),
660 argv[0], pfound->name);
662 /* +option or -option */
664 _("%s: option `%c%s' doesn't allow an argument\n"),
665 argv[0], argv[optind - 1][0], pfound->name);
668 nextchar += strlen(nextchar);
670 optopt = pfound->val;
674 else if (pfound->has_arg == 1)
677 optarg = argv[optind++];
682 _("%s: option `%s' requires an argument\n"),
683 argv[0], argv[optind - 1]);
684 nextchar += strlen(nextchar);
685 optopt = pfound->val;
686 return optstring[0] == ':' ? ':' : '?';
689 nextchar += strlen(nextchar);
691 *longind = option_index;
694 *(pfound->flag) = pfound->val;
700 /* Can't find it as a long option. If this is not getopt_long_only,
701 or the option starts with '--' or is not a valid short
702 option, then it's an error.
703 Otherwise interpret it as a short option. */
704 if (!long_only || argv[optind][1] == '-'
705 || my_index(optstring, *nextchar) == NULL)
709 if (argv[optind][1] == '-')
711 fprintf(stderr, _("%s: unrecognized option `%s%s'\n"),
712 "--", argv[0], nextchar);
715 char t[2] = { argv[optind][0], '\0' };
716 /* +option or -option */
717 fprintf(stderr, _("%s: unrecognized option `%s%s'\n"),
718 argv[0], t, nextchar);
721 nextchar = (char *) "";
728 /* Look at and handle the next short option-character. */
731 char c = *nextchar++;
732 char *temp = my_index(optstring, c);
734 /* Increment `optind' when we start to process its last character. */
735 if (*nextchar == '\0')
738 if (temp == NULL || c == ':')
743 /* 1003.2 specifies the format of this message. */
744 fprintf(stderr, _("%s: illegal option -- %c\n"),
747 fprintf(stderr, _("%s: invalid option -- %c\n"),
753 /* Convenience. Treat POSIX -W foo same as long option --foo */
754 if (temp[0] == 'W' && temp[1] == ';')
757 const struct option *p;
758 const struct option *pfound = NULL;
764 /* This is an option that requires an argument. */
765 if (*nextchar != '\0')
768 /* If we end this ARGV-element by taking the rest as an arg,
769 we must advance to the next element now. */
772 else if (optind == argc)
776 /* 1003.2 specifies the format of this message. */
777 fprintf(stderr, _("%s: option requires an argument -- %c\n"),
781 if (optstring[0] == ':')
788 /* We already incremented `optind' once;
789 increment it again when taking next ARGV-elt as argument. */
790 optarg = argv[optind++];
792 /* optarg is now the argument, see if it's in the
793 table of longopts. */
795 for (nextchar = nameend = optarg; *nameend && *nameend != '='; nameend++)
798 /* Test all long options for either exact match
799 or abbreviated matches. */
800 for (p = longopts, option_index = 0; p->name; p++, option_index++)
801 if (!strncmp(p->name, nextchar, nameend - nextchar))
803 if ((unsigned int) (nameend - nextchar) == strlen(p->name))
805 /* Exact match found. */
807 indfound = option_index;
811 else if (pfound == NULL)
813 /* First nonexact match found. */
815 indfound = option_index;
818 /* Second or later nonexact match found. */
824 fprintf(stderr, _("%s: option `-W %s' is ambiguous\n"),
825 argv[0], argv[optind]);
826 nextchar += strlen(nextchar);
832 option_index = indfound;
835 /* Don't test has_arg with >, because some C compilers don't
836 allow it to be used on enums. */
838 optarg = nameend + 1;
843 %s: option `-W %s' doesn't allow an argument\n"),
844 argv[0], pfound->name);
846 nextchar += strlen(nextchar);
850 else if (pfound->has_arg == 1)
853 optarg = argv[optind++];
858 _("%s: option `%s' requires an argument\n"),
859 argv[0], argv[optind - 1]);
860 nextchar += strlen(nextchar);
861 return optstring[0] == ':' ? ':' : '?';
864 nextchar += strlen(nextchar);
866 *longind = option_index;
869 *(pfound->flag) = pfound->val;
875 return 'W'; /* Let the application handle it. */
881 /* This is an option that accepts an argument optionally. */
882 if (*nextchar != '\0')
893 /* This is an option that requires an argument. */
894 if (*nextchar != '\0')
897 /* If we end this ARGV-element by taking the rest as an arg,
898 we must advance to the next element now. */
901 else if (optind == argc)
905 /* 1003.2 specifies the format of this message. */
907 _("%s: option requires an argument -- %c\n"),
911 if (optstring[0] == ':')
917 /* We already incremented `optind' once;
918 increment it again when taking next ARGV-elt as argument. */
919 optarg = argv[optind++];
928 getopt(argc, argv, optstring)
931 const char *optstring;
933 return _getopt_internal(argc, argv, optstring,
934 (const struct option *) 0,
939 #endif /* Not ELIDE_CODE. */
943 /* Compile with -DTEST to make an executable for use in testing
944 the above definition of `getopt'. */
952 int digit_optind = 0;
956 int this_option_optind = optind ? optind : 1;
958 c = getopt(argc, argv, "abc:d:0123456789");
974 if (digit_optind != 0 && digit_optind != this_option_optind)
975 printf("digits occur in two different argv-elements.\n");
976 digit_optind = this_option_optind;
977 printf("option %c\n", c);
981 printf("option a\n");
985 printf("option b\n");
989 printf("option c with value `%s'\n", optarg);
996 printf("?? getopt returned character code 0%o ??\n", c);
1002 printf("non-option ARGV-elements: ");
1003 while (optind < argc)
1004 printf("%s ", argv[optind++]);