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>. */
34 #if !defined WIN32 && (!defined (__STDC__) || !__STDC__)
35 /* This is a separate conditional since some stdc systems
36 reject `defined (const)'. */
44 #include "../rrd_config.h"
52 /* Comment out all this code if we are using the GNU C Library, and are not
53 actually compiling the library itself. This code is part of the GNU C
54 Library, but also included in many other GNU distributions. Compiling
55 and linking in this code is a waste when using the GNU C library
56 (especially if it is a shared library). Rather than having every GNU
57 program understand `configure --with-gnu-libc' and omit the object files,
58 it is simpler to just do this in the source for each such file. */
60 #define GETOPT_INTERFACE_VERSION 2
61 #if !defined (_LIBC) && defined (__GLIBC__) && __GLIBC__ >= 2
62 #include <gnu-versions.h>
63 #if _GNU_GETOPT_INTERFACE_VERSION == GETOPT_INTERFACE_VERSION
71 /* This needs to come after some library #include
72 to get __GNU_LIBRARY__ defined. */
73 #ifdef __GNU_LIBRARY__
74 /* Don't include stdlib.h for non-GNU C libraries because some of them
75 contain conflicting prototypes for getopt. */
78 #endif /* GNU C library. */
87 #if defined (_WIN32) && !defined (__CYGWIN32__)
88 /* It's not Unix, really. See? Capital letters. */
90 #define getpid() GetCurrentProcessId()
93 /* This version of `getopt' appears to the caller like standard Unix `getopt'
94 but it behaves differently for the user, since it allows the user
95 to intersperse the options with the other arguments.
97 As `getopt' works, it permutes the elements of ARGV so that,
98 when it is done, all the options precede everything else. Thus
99 all application programs are extended to handle flexible argument order.
101 Setting the environment variable POSIXLY_CORRECT disables permutation.
102 Then the behavior is completely standard.
104 GNU application programs can use a third alternative mode in which
105 they can distinguish the relative order of options and other arguments. */
107 #include "rrd_getopt.h"
109 /* For communication from `getopt' to the caller.
110 When `getopt' finds an option that takes an argument,
111 the argument value is returned here.
112 Also, when `ordering' is RETURN_IN_ORDER,
113 each non-option ARGV-element is returned here. */
116 * On some versions of Solaris, opterr and friends are defined in core libc
117 * rather than in a separate getopt module. Define these variables only
118 * if configure found they aren't there by default. (We assume that testing
119 * opterr is sufficient for all of these except optreset.)
121 #ifndef HAVE_INT_OPTERR
125 /* Index in ARGV of the next element to be scanned.
126 This is used for communication to and from the caller
127 and for communication between successive calls to `getopt'.
129 On entry to `getopt', zero means this is the first call; initialize.
131 When `getopt' returns -1, this is the index of the first of the
132 non-option elements that the caller should itself scan.
134 Otherwise, `optind' communicates from one call to the next
135 how much of ARGV has been scanned so far. */
137 /* Callers store zero here to inhibit the error message
138 for unrecognized options. */
142 /* Set to an option character which was unrecognized.
143 This must be initialized on some systems to avoid linking in the
144 system's own getopt implementation. */
148 /* 1003.2 says this must be 1 before any call. */
159 /* Formerly, initialization of getopt depended on optind==0, which
160 causes problems with re-calling getopt as programs generally don't
163 int __getopt_initialized = 0;
165 /* The next char to be scanned in the option-element
166 in which the last option character we returned was found.
167 This allows us to pick up the scan where we left off.
169 If this is zero, or a null string, it means resume the scan
170 by advancing to the next ARGV-element. */
172 static char *nextchar;
175 /* Describe how to deal with options that follow non-option ARGV-elements.
177 If the caller did not specify anything,
178 the default is REQUIRE_ORDER if the environment variable
179 POSIXLY_CORRECT is defined, PERMUTE otherwise.
181 REQUIRE_ORDER means don't recognize them as options;
182 stop option processing when the first non-option is seen.
183 This is what Unix does.
184 This mode of operation is selected by either setting the environment
185 variable POSIXLY_CORRECT, or using `+' as the first character
186 of the list of option characters.
188 PERMUTE is the default. We permute the contents of ARGV as we scan,
189 so that eventually all the non-options are at the end. This allows options
190 to be given in any order, even with programs that were not written to
193 RETURN_IN_ORDER is an option available to programs that were written
194 to expect options and other ARGV-elements in any order and that care about
195 the ordering of the two. We describe each non-option ARGV-element
196 as if it were the argument of an option with character code 1.
197 Using `-' as the first character of the list of option characters
198 selects this mode of operation.
200 The special argument `--' forces an end of option-scanning regardless
201 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
202 `--' can cause `getopt' to return -1 with `optind' != ARGC. */
205 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
208 /* Value of POSIXLY_CORRECT environment variable. */
209 static char *posixly_correct;
211 /* we must include string as there are warnings without it ... */
214 #ifdef __GNU_LIBRARY__
215 /* We want to avoid inclusion of string.h with non-GNU libraries
216 because there are many ways it can cause trouble.
217 On some systems, it contains special magic macros that don't work
219 #define my_index strchr
222 /* Avoid depending on library functions or files
223 whose names are inconsistent. */
228 static char* my_index(const char* str, int chr)
238 /* If using GCC, we can safely declare strlen this way.
239 If not using GCC, it is ok not to declare it. */
241 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
242 That was relevant to code that was here before. */
243 #if !defined (__STDC__) || !__STDC__
244 /* gcc with -traditional declares the built-in strlen to return int,
245 and has done so at least since version 2.4.5. -- rms. */
248 #endif /* not __STDC__ */
249 #endif /* __GNUC__ */
251 #endif /* not __GNU_LIBRARY__ */
253 /* Handle permutation of arguments. */
255 /* Describe the part of ARGV that contains non-options that have
256 been skipped. `first_nonopt' is the index in ARGV of the first of them;
257 `last_nonopt' is the index after the last of them. */
259 static int first_nonopt;
260 static int last_nonopt;
263 /* Bash 2.0 gives us an environment variable containing flags
264 indicating ARGV elements that should not be considered arguments. */
266 static const char *nonoption_flags;
267 static int nonoption_flags_len;
269 static int original_argc;
270 static char *const *original_argv;
272 /* Make sure the environment variable bash 2.0 puts in the environment
273 is valid for the getopt call we must make sure that the ARGV passed
274 to getopt is that one passed to the process. */
275 static void store_args(
277 char *const *argv) __attribute__ ((unused));
278 static void store_args(
282 /* XXX This is no good solution. We should rather copy the args so
283 that we can compare them later. But we must not use malloc(3). */
284 original_argc = argc;
285 original_argv = argv;
288 text_set_element(__libc_subinit, store_args);
291 /* Exchange two adjacent subsequences of ARGV.
292 One subsequence is elements [first_nonopt,last_nonopt)
293 which contains all the non-options that have been skipped so far.
294 The other is elements [last_nonopt,optind), which contains all
295 the options processed since those non-options were skipped.
297 `first_nonopt' and `last_nonopt' are relocated so that they describe
298 the new indices of the non-options in ARGV after they are moved. */
300 #if defined (__STDC__) && __STDC__
301 static void exchange(
305 static void exchange(char** argv)
307 int bottom = first_nonopt;
308 int middle = last_nonopt;
312 /* Exchange the shorter segment with the far end of the longer segment.
313 That puts the shorter segment into the right place.
314 It leaves the longer segment in the right place overall,
315 but it consists of two parts that need to be swapped next. */
317 while (top > middle && middle > bottom) {
318 if (top - middle > middle - bottom) {
319 /* Bottom segment is the short one. */
320 int len = middle - bottom;
323 /* Swap it with the top part of the top segment. */
324 for (i = 0; i < len; i++) {
325 tem = argv[bottom + i];
326 argv[bottom + i] = argv[top - (middle - bottom) + i];
327 argv[top - (middle - bottom) + i] = tem;
329 /* Exclude the moved bottom segment from further swapping. */
332 /* Top segment is the short one. */
333 int len = top - middle;
336 /* Swap it with the bottom part of the bottom segment. */
337 for (i = 0; i < len; i++) {
338 tem = argv[bottom + i];
339 argv[bottom + i] = argv[middle + i];
340 argv[middle + i] = tem;
342 /* Exclude the moved top segment from further swapping. */
347 /* Update records for the slots the non-options now occupy. */
349 first_nonopt += (optind - last_nonopt);
350 last_nonopt = optind;
353 /* Initialize the internal data when the first call is made. */
355 #if defined (__STDC__) && __STDC__
356 static const char *_getopt_initialize(
361 static const char* _getopt_initialize(int argc,
363 const char* optstring)
365 /* Start processing options with ARGV-element 1 (since ARGV-element 0
366 is the program name); the sequence of previously skipped
367 non-option ARGV-elements is empty. */
369 first_nonopt = last_nonopt = optind = 1;
373 posixly_correct = getenv("POSIXLY_CORRECT");
375 /* Determine how to handle the ordering of options and nonoptions. */
377 if (optstring[0] == '-') {
378 ordering = RETURN_IN_ORDER;
380 } else if (optstring[0] == '+') {
381 ordering = REQUIRE_ORDER;
383 } else if (posixly_correct != NULL)
384 ordering = REQUIRE_ORDER;
389 if (posixly_correct == NULL
390 && argc == original_argc && argv == original_argv) {
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. */
397 sprintf(var, "_%d_GNU_nonoption_argv_flags_", getpid());
398 nonoption_flags = getenv(var);
399 if (nonoption_flags == NULL)
400 nonoption_flags_len = 0;
402 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. */
466 int _getopt_internal(int argc,
468 const char *optstring,
469 const struct option *longopts,
475 if (!__getopt_initialized || optind == 0) {
476 optstring = _getopt_initialize(argc, argv, optstring);
477 optind = 1; /* Don't scan ARGV[0], the program name. */
478 __getopt_initialized = 1;
481 /* Test whether ARGV[optind] points to a non-option argument.
482 Either it does not have option syntax, or there is an environment flag
483 from the shell indicating it is not an option. The later information
484 is only used when the used in the GNU libc. */
486 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
487 || (optind < nonoption_flags_len \
488 && nonoption_flags[optind] == '1'))
490 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
493 if (nextchar == NULL || *nextchar == '\0') {
494 /* Advance to the next ARGV-element. */
496 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
497 moved back by the user (who may also have changed the arguments). */
498 if (last_nonopt > optind)
499 last_nonopt = optind;
500 if (first_nonopt > optind)
501 first_nonopt = optind;
503 if (ordering == PERMUTE) {
504 /* If we have just processed some options following some non-options,
505 exchange them so that the options come first. */
507 if (first_nonopt != last_nonopt && last_nonopt != optind)
508 exchange((char **) argv);
509 else if (last_nonopt != optind)
510 first_nonopt = optind;
512 /* Skip any additional non-options
513 and extend the range of non-options previously skipped. */
515 while (optind < argc && NONOPTION_P)
517 last_nonopt = optind;
520 /* The special ARGV-element `--' means premature end of options.
521 Skip it like a null option,
522 then exchange with previous non-options as if it were an option,
523 then skip everything else like a non-option. */
525 if (optind != argc && !strcmp(argv[optind], "--")) {
528 if (first_nonopt != last_nonopt && last_nonopt != optind)
529 exchange((char **) argv);
530 else if (first_nonopt == last_nonopt)
531 first_nonopt = optind;
537 /* If we have done all the ARGV-elements, stop the scan
538 and back over any non-options that we skipped and permuted. */
540 if (optind == argc) {
541 /* Set the next-arg-index to point at the non-options
542 that we previously skipped, so the caller will digest them. */
543 if (first_nonopt != last_nonopt)
544 optind = first_nonopt;
548 /* If we have come to a non-option and did not permute it,
549 either stop the scan or describe it to the caller and pass it by. */
552 if (ordering == REQUIRE_ORDER)
554 optarg = argv[optind++];
558 /* We have found another option-ARGV-element.
559 Skip the initial punctuation. */
561 nextchar = (argv[optind] + 1
562 + (longopts != NULL && argv[optind][1] == '-'));
565 /* Decode the current option-ARGV-element. */
567 /* Check whether the ARGV-element is a long option.
569 If long_only and the ARGV-element has the form "-f", where f is
570 a valid short option, don't consider it an abbreviated form of
571 a long option that starts with f. Otherwise there would be no
572 way to give the -f short option.
574 On the other hand, if there's a long option "fubar" and
575 the ARGV-element is "-fu", do consider that an abbreviation of
576 the long option, just like "--fu", and not "-f" with arg "u".
578 This distinction seems to be the most useful approach. */
581 && (argv[optind][1] == '-' || (long_only && (argv[optind][2]
582 || !my_index(optstring,
586 const struct option *p;
587 const struct option *pfound = NULL;
593 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
596 /* Test all long options for either exact match
597 or abbreviated matches. */
598 for (p = longopts, option_index = 0; p->name; p++, option_index++)
599 if (!strncmp(p->name, nextchar, nameend - nextchar)) {
600 if ((unsigned int) (nameend - nextchar)
601 == (unsigned int) strlen(p->name)) {
602 /* Exact match found. */
604 indfound = option_index;
607 } else if (pfound == NULL) {
608 /* First nonexact match found. */
610 indfound = option_index;
612 /* Second or later nonexact match found. */
616 if (ambig && !exact) {
618 fprintf(stderr, _("%s: option `%s' is ambiguous\n"),
619 argv[0], argv[optind]);
620 nextchar += strlen(nextchar);
626 if (pfound != NULL) {
627 option_index = indfound;
630 /* Don't test has_arg with >, because some C compilers don't
631 allow it to be used on enums. */
633 optarg = nameend + 1;
636 if (argv[optind - 1][1] == '-')
640 ("%s: option `--%s' doesn't allow an argument\n"),
641 argv[0], pfound->name);
643 /* +option or -option */
646 ("%s: option `%c%s' doesn't allow an argument\n"),
647 argv[0], argv[optind - 1][0],
650 nextchar += strlen(nextchar);
652 optopt = pfound->val;
655 } else if (pfound->has_arg == 1) {
657 optarg = argv[optind++];
661 _("%s: option `%s' requires an argument\n"),
662 argv[0], argv[optind - 1]);
663 nextchar += strlen(nextchar);
664 optopt = pfound->val;
665 return optstring[0] == ':' ? ':' : '?';
668 nextchar += strlen(nextchar);
670 *longind = option_index;
672 *(pfound->flag) = pfound->val;
678 /* Can't find it as a long option. If this is not getopt_long_only,
679 or the option starts with '--' or is not a valid short
680 option, then it's an error.
681 Otherwise interpret it as a short option. */
682 if (!long_only || argv[optind][1] == '-'
683 || my_index(optstring, *nextchar) == NULL) {
685 if (argv[optind][1] == '-')
687 fprintf(stderr, _("%s: unrecognized option `--%s'\n"),
690 /* +option or -option */
691 fprintf(stderr, _("%s: unrecognized option `%c%s'\n"),
692 argv[0], argv[optind][0], nextchar);
694 nextchar = (char *) "";
701 /* Look at and handle the next short option-character. */
704 char c = *nextchar++;
705 char *temp = my_index(optstring, c);
707 /* Increment `optind' when we start to process its last character. */
708 if (*nextchar == '\0')
711 if (temp == NULL || c == ':') {
714 /* 1003.2 specifies the format of this message. */
715 fprintf(stderr, _("%s: illegal option -- %c\n"),
718 fprintf(stderr, _("%s: invalid option -- %c\n"),
724 /* Convenience. Treat POSIX -W foo same as long option --foo */
725 if (temp[0] == 'W' && temp[1] == ';') {
727 const struct option *p;
728 const struct option *pfound = NULL;
734 /* This is an option that requires an argument. */
735 if (*nextchar != '\0') {
737 /* If we end this ARGV-element by taking the rest as an arg,
738 we must advance to the next element now. */
740 } else if (optind == argc) {
742 /* 1003.2 specifies the format of this message. */
744 _("%s: option requires an argument -- %c\n"),
748 if (optstring[0] == ':')
754 /* We already incremented `optind' once;
755 increment it again when taking next ARGV-elt as argument. */
756 optarg = argv[optind++];
758 /* optarg is now the argument, see if it's in the
759 table of longopts. */
761 for (nextchar = nameend = optarg; *nameend && *nameend != '=';
765 /* Test all long options for either exact match
766 or abbreviated matches. */
767 for (p = longopts, option_index = 0; p->name; p++, option_index++)
768 if (!strncmp(p->name, nextchar, nameend - nextchar)) {
769 if ((unsigned int) (nameend - nextchar) ==
771 /* Exact match found. */
773 indfound = option_index;
776 } else if (pfound == NULL) {
777 /* First nonexact match found. */
779 indfound = option_index;
781 /* Second or later nonexact match found. */
784 if (ambig && !exact) {
786 fprintf(stderr, _("%s: option `-W %s' is ambiguous\n"),
787 argv[0], argv[optind]);
788 nextchar += strlen(nextchar);
792 if (pfound != NULL) {
793 option_index = indfound;
795 /* Don't test has_arg with >, because some C compilers don't
796 allow it to be used on enums. */
798 optarg = nameend + 1;
802 %s: option `-W %s' doesn't allow an argument\n"), argv[0], pfound->name);
804 nextchar += strlen(nextchar);
807 } else if (pfound->has_arg == 1) {
809 optarg = argv[optind++];
814 ("%s: option `%s' requires an argument\n"),
815 argv[0], argv[optind - 1]);
816 nextchar += strlen(nextchar);
817 return optstring[0] == ':' ? ':' : '?';
820 nextchar += strlen(nextchar);
822 *longind = option_index;
824 *(pfound->flag) = pfound->val;
830 return 'W'; /* Let the application handle it. */
832 if (temp[1] == ':') {
833 if (temp[2] == ':') {
834 /* This is an option that accepts an argument optionally. */
835 if (*nextchar != '\0') {
842 /* This is an option that requires an argument. */
843 if (*nextchar != '\0') {
845 /* If we end this ARGV-element by taking the rest as an arg,
846 we must advance to the next element now. */
848 } else if (optind == argc) {
850 /* 1003.2 specifies the format of this message. */
852 _("%s: option requires an argument -- %c\n"),
856 if (optstring[0] == ':')
861 /* We already incremented `optind' once;
862 increment it again when taking next ARGV-elt as argument. */
863 optarg = argv[optind++];
874 const char* optstring)
876 return _getopt_internal(argc, argv, optstring,
877 (const struct option *) 0, (int *) 0, 0);
880 #endif /* Not ELIDE_CODE. */
884 /* Compile with -DTEST to make an executable for use in testing
885 the above definition of `getopt'. */
894 int digit_optind = 0;
897 int this_option_optind = optind ? optind : 1;
899 c = getopt(argc, argv, "abc:d:0123456789");
914 if (digit_optind != 0 && digit_optind != this_option_optind)
915 printf("digits occur in two different argv-elements.\n");
916 digit_optind = this_option_optind;
917 printf("option %c\n", c);
921 printf("option a\n");
925 printf("option b\n");
929 printf("option c with value `%s'\n", optarg);
936 printf("?? getopt returned character code 0%o ??\n", c);
941 printf("non-option ARGV-elements: ");
942 while (optind < argc)
943 printf("%s ", argv[optind++]);