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>. */
33 #if !defined (__STDC__) || !__STDC__
34 /* This is a separate conditional since some stdc systems
35 reject `defined (const)'. */
43 #include "../rrd_config.h"
51 /* Comment out all this code if we are using the GNU C Library, and are not
52 actually compiling the library itself. This code is part of the GNU C
53 Library, but also included in many other GNU distributions. Compiling
54 and linking in this code is a waste when using the GNU C library
55 (especially if it is a shared library). Rather than having every GNU
56 program understand `configure --with-gnu-libc' and omit the object files,
57 it is simpler to just do this in the source for each such file. */
59 #define GETOPT_INTERFACE_VERSION 2
60 #if !defined (_LIBC) && defined (__GLIBC__) && __GLIBC__ >= 2
61 #include <gnu-versions.h>
62 #if _GNU_GETOPT_INTERFACE_VERSION == GETOPT_INTERFACE_VERSION
70 /* This needs to come after some library #include
71 to get __GNU_LIBRARY__ defined. */
72 #ifdef __GNU_LIBRARY__
73 /* Don't include stdlib.h for non-GNU C libraries because some of them
74 contain conflicting prototypes for getopt. */
77 #endif /* GNU C library. */
86 #if defined (_WIN32) && !defined (__CYGWIN32__)
87 /* It's not Unix, really. See? Capital letters. */
89 #define getpid() GetCurrentProcessId()
92 /* This version of `getopt' appears to the caller like standard Unix `getopt'
93 but it behaves differently for the user, since it allows the user
94 to intersperse the options with the other arguments.
96 As `getopt' works, it permutes the elements of ARGV so that,
97 when it is done, all the options precede everything else. Thus
98 all application programs are extended to handle flexible argument order.
100 Setting the environment variable POSIXLY_CORRECT disables permutation.
101 Then the behavior is completely standard.
103 GNU application programs can use a third alternative mode in which
104 they can distinguish the relative order of options and other arguments. */
106 #include "rrd_getopt.h"
108 /* For communication from `getopt' to the caller.
109 When `getopt' finds an option that takes an argument,
110 the argument value is returned here.
111 Also, when `ordering' is RETURN_IN_ORDER,
112 each non-option ARGV-element is returned here. */
116 /* Index in ARGV of the next element to be scanned.
117 This is used for communication to and from the caller
118 and for communication between successive calls to `getopt'.
120 On entry to `getopt', zero means this is the first call; initialize.
122 When `getopt' returns -1, this is the index of the first of the
123 non-option elements that the caller should itself scan.
125 Otherwise, `optind' communicates from one call to the next
126 how much of ARGV has been scanned so far. */
128 /* 1003.2 says this must be 1 before any call. */
131 /* Formerly, initialization of getopt depended on optind==0, which
132 causes problems with re-calling getopt as programs generally don't
135 int __getopt_initialized = 0;
137 /* The next char to be scanned in the option-element
138 in which the last option character we returned was found.
139 This allows us to pick up the scan where we left off.
141 If this is zero, or a null string, it means resume the scan
142 by advancing to the next ARGV-element. */
144 static char *nextchar;
146 /* Callers store zero here to inhibit the error message
147 for unrecognized options. */
151 /* Set to an option character which was unrecognized.
152 This must be initialized on some systems to avoid linking in the
153 system's own getopt implementation. */
157 /* Describe how to deal with options that follow non-option ARGV-elements.
159 If the caller did not specify anything,
160 the default is REQUIRE_ORDER if the environment variable
161 POSIXLY_CORRECT is defined, PERMUTE otherwise.
163 REQUIRE_ORDER means don't recognize them as options;
164 stop option processing when the first non-option is seen.
165 This is what Unix does.
166 This mode of operation is selected by either setting the environment
167 variable POSIXLY_CORRECT, or using `+' as the first character
168 of the list of option characters.
170 PERMUTE is the default. We permute the contents of ARGV as we scan,
171 so that eventually all the non-options are at the end. This allows options
172 to be given in any order, even with programs that were not written to
175 RETURN_IN_ORDER is an option available to programs that were written
176 to expect options and other ARGV-elements in any order and that care about
177 the ordering of the two. We describe each non-option ARGV-element
178 as if it were the argument of an option with character code 1.
179 Using `-' as the first character of the list of option characters
180 selects this mode of operation.
182 The special argument `--' forces an end of option-scanning regardless
183 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
184 `--' can cause `getopt' to return -1 with `optind' != ARGC. */
187 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
190 /* Value of POSIXLY_CORRECT environment variable. */
191 static char *posixly_correct;
193 /* we must include string as there are warnings without it ... */
196 #ifdef __GNU_LIBRARY__
197 /* We want to avoid inclusion of string.h with non-GNU libraries
198 because there are many ways it can cause trouble.
199 On some systems, it contains special magic macros that don't work
201 #define my_index strchr
204 /* Avoid depending on library functions or files
205 whose names are inconsistent. */
210 static char *my_index(
224 /* If using GCC, we can safely declare strlen this way.
225 If not using GCC, it is ok not to declare it. */
227 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
228 That was relevant to code that was here before. */
229 #if !defined (__STDC__) || !__STDC__
230 /* gcc with -traditional declares the built-in strlen to return int,
231 and has done so at least since version 2.4.5. -- rms. */
234 #endif /* not __STDC__ */
235 #endif /* __GNUC__ */
237 #endif /* not __GNU_LIBRARY__ */
239 /* Handle permutation of arguments. */
241 /* Describe the part of ARGV that contains non-options that have
242 been skipped. `first_nonopt' is the index in ARGV of the first of them;
243 `last_nonopt' is the index after the last of them. */
245 static int first_nonopt;
246 static int last_nonopt;
249 /* Bash 2.0 gives us an environment variable containing flags
250 indicating ARGV elements that should not be considered arguments. */
252 static const char *nonoption_flags;
253 static int nonoption_flags_len;
255 static int original_argc;
256 static char *const *original_argv;
258 /* Make sure the environment variable bash 2.0 puts in the environment
259 is valid for the getopt call we must make sure that the ARGV passed
260 to getopt is that one passed to the process. */
261 static void store_args(
263 char *const *argv) __attribute__ ((unused));
264 static void store_args(
268 /* XXX This is no good solution. We should rather copy the args so
269 that we can compare them later. But we must not use malloc(3). */
270 original_argc = argc;
271 original_argv = argv;
274 text_set_element(__libc_subinit, store_args);
277 /* Exchange two adjacent subsequences of ARGV.
278 One subsequence is elements [first_nonopt,last_nonopt)
279 which contains all the non-options that have been skipped so far.
280 The other is elements [last_nonopt,optind), which contains all
281 the options processed since those non-options were skipped.
283 `first_nonopt' and `last_nonopt' are relocated so that they describe
284 the new indices of the non-options in ARGV after they are moved. */
286 #if defined (__STDC__) && __STDC__
287 static void exchange(
291 static void exchange(
295 int bottom = first_nonopt;
296 int middle = last_nonopt;
300 /* Exchange the shorter segment with the far end of the longer segment.
301 That puts the shorter segment into the right place.
302 It leaves the longer segment in the right place overall,
303 but it consists of two parts that need to be swapped next. */
305 while (top > middle && middle > bottom) {
306 if (top - middle > middle - bottom) {
307 /* Bottom segment is the short one. */
308 int len = middle - bottom;
311 /* Swap it with the top part of the top segment. */
312 for (i = 0; i < len; i++) {
313 tem = argv[bottom + i];
314 argv[bottom + i] = argv[top - (middle - bottom) + i];
315 argv[top - (middle - bottom) + i] = tem;
317 /* Exclude the moved bottom segment from further swapping. */
320 /* Top segment is the short one. */
321 int len = top - middle;
324 /* Swap it with the bottom part of the bottom segment. */
325 for (i = 0; i < len; i++) {
326 tem = argv[bottom + i];
327 argv[bottom + i] = argv[middle + i];
328 argv[middle + i] = tem;
330 /* Exclude the moved top segment from further swapping. */
335 /* Update records for the slots the non-options now occupy. */
337 first_nonopt += (optind - last_nonopt);
338 last_nonopt = optind;
341 /* Initialize the internal data when the first call is made. */
343 #if defined (__STDC__) && __STDC__
344 static const char *_getopt_initialize(
349 static const char *_getopt_initialize(
355 const char *optstring;
357 /* Start processing options with ARGV-element 1 (since ARGV-element 0
358 is the program name); the sequence of previously skipped
359 non-option ARGV-elements is empty. */
361 first_nonopt = last_nonopt = optind = 1;
365 posixly_correct = getenv("POSIXLY_CORRECT");
367 /* Determine how to handle the ordering of options and nonoptions. */
369 if (optstring[0] == '-') {
370 ordering = RETURN_IN_ORDER;
372 } else if (optstring[0] == '+') {
373 ordering = REQUIRE_ORDER;
375 } else if (posixly_correct != NULL)
376 ordering = REQUIRE_ORDER;
381 if (posixly_correct == NULL
382 && argc == original_argc && argv == original_argv) {
383 /* Bash 2.0 puts a special variable in the environment for each
384 command it runs, specifying which ARGV elements are the results of
385 file name wildcard expansion and therefore should not be
386 considered as options. */
389 sprintf(var, "_%d_GNU_nonoption_argv_flags_", getpid());
390 nonoption_flags = getenv(var);
391 if (nonoption_flags == NULL)
392 nonoption_flags_len = 0;
394 nonoption_flags_len = strlen(nonoption_flags);
396 nonoption_flags_len = 0;
402 /* Scan elements of ARGV (whose length is ARGC) for option characters
405 If an element of ARGV starts with '-', and is not exactly "-" or "--",
406 then it is an option element. The characters of this element
407 (aside from the initial '-') are option characters. If `getopt'
408 is called repeatedly, it returns successively each of the option characters
409 from each of the option elements.
411 If `getopt' finds another option character, it returns that character,
412 updating `optind' and `nextchar' so that the next call to `getopt' can
413 resume the scan with the following option character or ARGV-element.
415 If there are no more option characters, `getopt' returns -1.
416 Then `optind' is the index in ARGV of the first ARGV-element
417 that is not an option. (The ARGV-elements have been permuted
418 so that those that are not options now come last.)
420 OPTSTRING is a string containing the legitimate option characters.
421 If an option character is seen that is not listed in OPTSTRING,
422 return '?' after printing an error message. If you set `opterr' to
423 zero, the error message is suppressed but we still return '?'.
425 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
426 so the following text in the same ARGV-element, or the text of the following
427 ARGV-element, is returned in `optarg'. Two colons mean an option that
428 wants an optional arg; if there is text in the current ARGV-element,
429 it is returned in `optarg', otherwise `optarg' is set to zero.
431 If OPTSTRING starts with `-' or `+', it requests different methods of
432 handling the non-option ARGV-elements.
433 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
435 Long-named options begin with `--' instead of `-'.
436 Their names may be abbreviated as long as the abbreviation is unique
437 or is an exact match for some defined option. If they have an
438 argument, it follows the option name in the same ARGV-element, separated
439 from the option name by a `=', or else the in next ARGV-element.
440 When `getopt' finds a long-named option, it returns 0 if that option's
441 `flag' field is nonzero, the value of the option's `val' field
442 if the `flag' field is zero.
444 The elements of ARGV aren't really const, because we permute them.
445 But we pretend they're const in the prototype to be compatible
448 LONGOPTS is a vector of `struct option' terminated by an
449 element containing a name which is zero.
451 LONGIND returns the index in LONGOPT of the long-named option found.
452 It is only valid when a long-named option has been found by the most
455 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
456 long-named options. */
458 int _getopt_internal(
467 const char *optstring;
468 const struct option *longopts;
474 if (!__getopt_initialized || optind == 0) {
475 optstring = _getopt_initialize(argc, argv, optstring);
476 optind = 1; /* Don't scan ARGV[0], the program name. */
477 __getopt_initialized = 1;
480 /* Test whether ARGV[optind] points to a non-option argument.
481 Either it does not have option syntax, or there is an environment flag
482 from the shell indicating it is not an option. The later information
483 is only used when the used in the GNU libc. */
485 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
486 || (optind < nonoption_flags_len \
487 && nonoption_flags[optind] == '1'))
489 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
492 if (nextchar == NULL || *nextchar == '\0') {
493 /* Advance to the next ARGV-element. */
495 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
496 moved back by the user (who may also have changed the arguments). */
497 if (last_nonopt > optind)
498 last_nonopt = optind;
499 if (first_nonopt > optind)
500 first_nonopt = optind;
502 if (ordering == PERMUTE) {
503 /* If we have just processed some options following some non-options,
504 exchange them so that the options come first. */
506 if (first_nonopt != last_nonopt && last_nonopt != optind)
507 exchange((char **) argv);
508 else if (last_nonopt != optind)
509 first_nonopt = optind;
511 /* Skip any additional non-options
512 and extend the range of non-options previously skipped. */
514 while (optind < argc && NONOPTION_P)
516 last_nonopt = optind;
519 /* The special ARGV-element `--' means premature end of options.
520 Skip it like a null option,
521 then exchange with previous non-options as if it were an option,
522 then skip everything else like a non-option. */
524 if (optind != argc && !strcmp(argv[optind], "--")) {
527 if (first_nonopt != last_nonopt && last_nonopt != optind)
528 exchange((char **) argv);
529 else if (first_nonopt == last_nonopt)
530 first_nonopt = optind;
536 /* If we have done all the ARGV-elements, stop the scan
537 and back over any non-options that we skipped and permuted. */
539 if (optind == argc) {
540 /* Set the next-arg-index to point at the non-options
541 that we previously skipped, so the caller will digest them. */
542 if (first_nonopt != last_nonopt)
543 optind = first_nonopt;
547 /* If we have come to a non-option and did not permute it,
548 either stop the scan or describe it to the caller and pass it by. */
551 if (ordering == REQUIRE_ORDER)
553 optarg = argv[optind++];
557 /* We have found another option-ARGV-element.
558 Skip the initial punctuation. */
560 nextchar = (argv[optind] + 1
561 + (longopts != NULL && argv[optind][1] == '-'));
564 /* Decode the current option-ARGV-element. */
566 /* Check whether the ARGV-element is a long option.
568 If long_only and the ARGV-element has the form "-f", where f is
569 a valid short option, don't consider it an abbreviated form of
570 a long option that starts with f. Otherwise there would be no
571 way to give the -f short option.
573 On the other hand, if there's a long option "fubar" and
574 the ARGV-element is "-fu", do consider that an abbreviation of
575 the long option, just like "--fu", and not "-f" with arg "u".
577 This distinction seems to be the most useful approach. */
580 && (argv[optind][1] == '-' || (long_only && (argv[optind][2]
581 || !my_index(optstring,
585 const struct option *p;
586 const struct option *pfound = NULL;
592 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
595 /* Test all long options for either exact match
596 or abbreviated matches. */
597 for (p = longopts, option_index = 0; p->name; p++, option_index++)
598 if (!strncmp(p->name, nextchar, nameend - nextchar)) {
599 if ((unsigned int) (nameend - nextchar)
600 == (unsigned int) strlen(p->name)) {
601 /* Exact match found. */
603 indfound = option_index;
606 } else if (pfound == NULL) {
607 /* First nonexact match found. */
609 indfound = option_index;
611 /* Second or later nonexact match found. */
615 if (ambig && !exact) {
617 fprintf(stderr, _("%s: option `%s' is ambiguous\n"),
618 argv[0], argv[optind]);
619 nextchar += strlen(nextchar);
625 if (pfound != NULL) {
626 option_index = indfound;
629 /* Don't test has_arg with >, because some C compilers don't
630 allow it to be used on enums. */
632 optarg = nameend + 1;
635 if (argv[optind - 1][1] == '-')
639 ("%s: option `--%s' doesn't allow an argument\n"),
640 argv[0], pfound->name);
642 /* +option or -option */
645 ("%s: option `%c%s' doesn't allow an argument\n"),
646 argv[0], argv[optind - 1][0],
649 nextchar += strlen(nextchar);
651 optopt = pfound->val;
654 } else if (pfound->has_arg == 1) {
656 optarg = argv[optind++];
660 _("%s: option `%s' requires an argument\n"),
661 argv[0], argv[optind - 1]);
662 nextchar += strlen(nextchar);
663 optopt = pfound->val;
664 return optstring[0] == ':' ? ':' : '?';
667 nextchar += strlen(nextchar);
669 *longind = option_index;
671 *(pfound->flag) = pfound->val;
677 /* Can't find it as a long option. If this is not getopt_long_only,
678 or the option starts with '--' or is not a valid short
679 option, then it's an error.
680 Otherwise interpret it as a short option. */
681 if (!long_only || argv[optind][1] == '-'
682 || my_index(optstring, *nextchar) == NULL) {
684 if (argv[optind][1] == '-')
686 fprintf(stderr, _("%s: unrecognized option `--%s'\n"),
689 /* +option or -option */
690 fprintf(stderr, _("%s: unrecognized option `%c%s'\n"),
691 argv[0], argv[optind][0], nextchar);
693 nextchar = (char *) "";
700 /* Look at and handle the next short option-character. */
703 char c = *nextchar++;
704 char *temp = my_index(optstring, c);
706 /* Increment `optind' when we start to process its last character. */
707 if (*nextchar == '\0')
710 if (temp == NULL || c == ':') {
713 /* 1003.2 specifies the format of this message. */
714 fprintf(stderr, _("%s: illegal option -- %c\n"),
717 fprintf(stderr, _("%s: invalid option -- %c\n"),
723 /* Convenience. Treat POSIX -W foo same as long option --foo */
724 if (temp[0] == 'W' && temp[1] == ';') {
726 const struct option *p;
727 const struct option *pfound = NULL;
733 /* This is an option that requires an argument. */
734 if (*nextchar != '\0') {
736 /* If we end this ARGV-element by taking the rest as an arg,
737 we must advance to the next element now. */
739 } else if (optind == argc) {
741 /* 1003.2 specifies the format of this message. */
743 _("%s: option requires an argument -- %c\n"),
747 if (optstring[0] == ':')
753 /* We already incremented `optind' once;
754 increment it again when taking next ARGV-elt as argument. */
755 optarg = argv[optind++];
757 /* optarg is now the argument, see if it's in the
758 table of longopts. */
760 for (nextchar = nameend = optarg; *nameend && *nameend != '=';
764 /* Test all long options for either exact match
765 or abbreviated matches. */
766 for (p = longopts, option_index = 0; p->name; p++, option_index++)
767 if (!strncmp(p->name, nextchar, nameend - nextchar)) {
768 if ((unsigned int) (nameend - nextchar) ==
770 /* Exact match found. */
772 indfound = option_index;
775 } else if (pfound == NULL) {
776 /* First nonexact match found. */
778 indfound = option_index;
780 /* Second or later nonexact match found. */
783 if (ambig && !exact) {
785 fprintf(stderr, _("%s: option `-W %s' is ambiguous\n"),
786 argv[0], argv[optind]);
787 nextchar += strlen(nextchar);
791 if (pfound != NULL) {
792 option_index = indfound;
794 /* Don't test has_arg with >, because some C compilers don't
795 allow it to be used on enums. */
797 optarg = nameend + 1;
801 %s: option `-W %s' doesn't allow an argument\n"), argv[0], pfound->name);
803 nextchar += strlen(nextchar);
806 } else if (pfound->has_arg == 1) {
808 optarg = argv[optind++];
813 ("%s: option `%s' requires an argument\n"),
814 argv[0], argv[optind - 1]);
815 nextchar += strlen(nextchar);
816 return optstring[0] == ':' ? ':' : '?';
819 nextchar += strlen(nextchar);
821 *longind = option_index;
823 *(pfound->flag) = pfound->val;
829 return 'W'; /* Let the application handle it. */
831 if (temp[1] == ':') {
832 if (temp[2] == ':') {
833 /* This is an option that accepts an argument optionally. */
834 if (*nextchar != '\0') {
841 /* This is an option that requires an argument. */
842 if (*nextchar != '\0') {
844 /* If we end this ARGV-element by taking the rest as an arg,
845 we must advance to the next element now. */
847 } else if (optind == argc) {
849 /* 1003.2 specifies the format of this message. */
851 _("%s: option requires an argument -- %c\n"),
855 if (optstring[0] == ':')
860 /* We already incremented `optind' once;
861 increment it again when taking next ARGV-elt as argument. */
862 optarg = argv[optind++];
876 const char *optstring;
878 return _getopt_internal(argc, argv, optstring,
879 (const struct option *) 0, (int *) 0, 0);
882 #endif /* Not ELIDE_CODE. */
886 /* Compile with -DTEST to make an executable for use in testing
887 the above definition of `getopt'. */
896 int digit_optind = 0;
899 int this_option_optind = optind ? optind : 1;
901 c = getopt(argc, argv, "abc:d:0123456789");
916 if (digit_optind != 0 && digit_optind != this_option_optind)
917 printf("digits occur in two different argv-elements.\n");
918 digit_optind = this_option_optind;
919 printf("option %c\n", c);
923 printf("option a\n");
927 printf("option b\n");
931 printf("option c with value `%s'\n", optarg);
938 printf("?? getopt returned character code 0%o ??\n", c);
943 printf("non-option ARGV-elements: ");
944 while (optind < argc)
945 printf("%s ", argv[optind++]);