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(
279 static void store_args(
283 /* XXX This is no good solution. We should rather copy the args so
284 that we can compare them later. But we must not use malloc(3). */
285 original_argc = argc;
286 original_argv = argv;
289 text_set_element(__libc_subinit, store_args);
292 /* Exchange two adjacent subsequences of ARGV.
293 One subsequence is elements [first_nonopt,last_nonopt)
294 which contains all the non-options that have been skipped so far.
295 The other is elements [last_nonopt,optind), which contains all
296 the options processed since those non-options were skipped.
298 `first_nonopt' and `last_nonopt' are relocated so that they describe
299 the new indices of the non-options in ARGV after they are moved. */
301 #if defined (__STDC__) && __STDC__
302 static void exchange(
306 static void exchange(char** argv)
308 int bottom = first_nonopt;
309 int middle = last_nonopt;
313 /* Exchange the shorter segment with the far end of the longer segment.
314 That puts the shorter segment into the right place.
315 It leaves the longer segment in the right place overall,
316 but it consists of two parts that need to be swapped next. */
318 while (top > middle && middle > bottom) {
319 if (top - middle > middle - bottom) {
320 /* Bottom segment is the short one. */
321 int len = middle - bottom;
324 /* Swap it with the top part of the top segment. */
325 for (i = 0; i < len; i++) {
326 tem = argv[bottom + i];
327 argv[bottom + i] = argv[top - (middle - bottom) + i];
328 argv[top - (middle - bottom) + i] = tem;
330 /* Exclude the moved bottom segment from further swapping. */
333 /* Top segment is the short one. */
334 int len = top - middle;
337 /* Swap it with the bottom part of the bottom segment. */
338 for (i = 0; i < len; i++) {
339 tem = argv[bottom + i];
340 argv[bottom + i] = argv[middle + i];
341 argv[middle + i] = tem;
343 /* Exclude the moved top segment from further swapping. */
348 /* Update records for the slots the non-options now occupy. */
350 first_nonopt += (optind - last_nonopt);
351 last_nonopt = optind;
354 /* Initialize the internal data when the first call is made. */
356 #if defined (__STDC__) && __STDC__
357 static const char *_getopt_initialize(
362 static const char* _getopt_initialize(int argc,
364 const char* optstring)
366 /* Start processing options with ARGV-element 1 (since ARGV-element 0
367 is the program name); the sequence of previously skipped
368 non-option ARGV-elements is empty. */
370 first_nonopt = last_nonopt = optind = 1;
374 posixly_correct = getenv("POSIXLY_CORRECT");
376 /* Determine how to handle the ordering of options and nonoptions. */
378 if (optstring[0] == '-') {
379 ordering = RETURN_IN_ORDER;
381 } else if (optstring[0] == '+') {
382 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) {
392 /* Bash 2.0 puts a special variable in the environment for each
393 command it runs, specifying which ARGV elements are the results of
394 file name wildcard expansion and therefore should not be
395 considered as options. */
398 sprintf(var, "_%d_GNU_nonoption_argv_flags_", getpid());
399 nonoption_flags = getenv(var);
400 if (nonoption_flags == NULL)
401 nonoption_flags_len = 0;
403 nonoption_flags_len = strlen(nonoption_flags);
405 nonoption_flags_len = 0;
411 /* Scan elements of ARGV (whose length is ARGC) for option characters
414 If an element of ARGV starts with '-', and is not exactly "-" or "--",
415 then it is an option element. The characters of this element
416 (aside from the initial '-') are option characters. If `getopt'
417 is called repeatedly, it returns successively each of the option characters
418 from each of the option elements.
420 If `getopt' finds another option character, it returns that character,
421 updating `optind' and `nextchar' so that the next call to `getopt' can
422 resume the scan with the following option character or ARGV-element.
424 If there are no more option characters, `getopt' returns -1.
425 Then `optind' is the index in ARGV of the first ARGV-element
426 that is not an option. (The ARGV-elements have been permuted
427 so that those that are not options now come last.)
429 OPTSTRING is a string containing the legitimate option characters.
430 If an option character is seen that is not listed in OPTSTRING,
431 return '?' after printing an error message. If you set `opterr' to
432 zero, the error message is suppressed but we still return '?'.
434 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
435 so the following text in the same ARGV-element, or the text of the following
436 ARGV-element, is returned in `optarg'. Two colons mean an option that
437 wants an optional arg; if there is text in the current ARGV-element,
438 it is returned in `optarg', otherwise `optarg' is set to zero.
440 If OPTSTRING starts with `-' or `+', it requests different methods of
441 handling the non-option ARGV-elements.
442 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
444 Long-named options begin with `--' instead of `-'.
445 Their names may be abbreviated as long as the abbreviation is unique
446 or is an exact match for some defined option. If they have an
447 argument, it follows the option name in the same ARGV-element, separated
448 from the option name by a `=', or else the in next ARGV-element.
449 When `getopt' finds a long-named option, it returns 0 if that option's
450 `flag' field is nonzero, the value of the option's `val' field
451 if the `flag' field is zero.
453 The elements of ARGV aren't really const, because we permute them.
454 But we pretend they're const in the prototype to be compatible
457 LONGOPTS is a vector of `struct option' terminated by an
458 element containing a name which is zero.
460 LONGIND returns the index in LONGOPT of the long-named option found.
461 It is only valid when a long-named option has been found by the most
464 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
465 long-named options. */
467 int _getopt_internal(int argc,
473 const char *optstring,
474 const struct option *longopts,
480 if (!__getopt_initialized || optind == 0) {
481 optstring = _getopt_initialize(argc, argv, optstring);
482 optind = 1; /* Don't scan ARGV[0], the program name. */
483 __getopt_initialized = 1;
486 /* Test whether ARGV[optind] points to a non-option argument.
487 Either it does not have option syntax, or there is an environment flag
488 from the shell indicating it is not an option. The later information
489 is only used when the used in the GNU libc. */
491 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
492 || (optind < nonoption_flags_len \
493 && nonoption_flags[optind] == '1'))
495 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
498 if (nextchar == NULL || *nextchar == '\0') {
499 /* Advance to the next ARGV-element. */
501 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
502 moved back by the user (who may also have changed the arguments). */
503 if (last_nonopt > optind)
504 last_nonopt = optind;
505 if (first_nonopt > optind)
506 first_nonopt = optind;
508 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], "--")) {
533 if (first_nonopt != last_nonopt && last_nonopt != optind)
534 exchange((char **) argv);
535 else if (first_nonopt == last_nonopt)
536 first_nonopt = optind;
542 /* If we have done all the ARGV-elements, stop the scan
543 and back over any non-options that we skipped and permuted. */
545 if (optind == argc) {
546 /* Set the next-arg-index to point at the non-options
547 that we previously skipped, so the caller will digest them. */
548 if (first_nonopt != last_nonopt)
549 optind = first_nonopt;
553 /* If we have come to a non-option and did not permute it,
554 either stop the scan or describe it to the caller and pass it by. */
557 if (ordering == REQUIRE_ORDER)
559 optarg = argv[optind++];
563 /* We have found another option-ARGV-element.
564 Skip the initial punctuation. */
566 nextchar = (argv[optind] + 1
567 + (longopts != NULL && argv[optind][1] == '-'));
570 /* Decode the current option-ARGV-element. */
572 /* Check whether the ARGV-element is a long option.
574 If long_only and the ARGV-element has the form "-f", where f is
575 a valid short option, don't consider it an abbreviated form of
576 a long option that starts with f. Otherwise there would be no
577 way to give the -f short option.
579 On the other hand, if there's a long option "fubar" and
580 the ARGV-element is "-fu", do consider that an abbreviation of
581 the long option, just like "--fu", and not "-f" with arg "u".
583 This distinction seems to be the most useful approach. */
586 && (argv[optind][1] == '-' || (long_only && (argv[optind][2]
587 || !my_index(optstring,
591 const struct option *p;
592 const struct option *pfound = NULL;
598 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
601 /* Test all long options for either exact match
602 or abbreviated matches. */
603 for (p = longopts, option_index = 0; p->name; p++, option_index++)
604 if (!strncmp(p->name, nextchar, nameend - nextchar)) {
605 if ((unsigned int) (nameend - nextchar)
606 == (unsigned int) strlen(p->name)) {
607 /* Exact match found. */
609 indfound = option_index;
612 } else if (pfound == NULL) {
613 /* First nonexact match found. */
615 indfound = option_index;
617 /* Second or later nonexact match found. */
621 if (ambig && !exact) {
623 fprintf(stderr, _("%s: option `%s' is ambiguous\n"),
624 argv[0], argv[optind]);
625 nextchar += strlen(nextchar);
631 if (pfound != NULL) {
632 option_index = indfound;
635 /* Don't test has_arg with >, because some C compilers don't
636 allow it to be used on enums. */
638 optarg = nameend + 1;
641 if (argv[optind - 1][1] == '-')
645 ("%s: option `--%s' doesn't allow an argument\n"),
646 argv[0], pfound->name);
648 /* +option or -option */
651 ("%s: option `%c%s' doesn't allow an argument\n"),
652 argv[0], argv[optind - 1][0],
655 nextchar += strlen(nextchar);
657 optopt = pfound->val;
660 } else if (pfound->has_arg == 1) {
662 optarg = argv[optind++];
666 _("%s: option `%s' requires an argument\n"),
667 argv[0], argv[optind - 1]);
668 nextchar += strlen(nextchar);
669 optopt = pfound->val;
670 return optstring[0] == ':' ? ':' : '?';
673 nextchar += strlen(nextchar);
675 *longind = option_index;
677 *(pfound->flag) = pfound->val;
683 /* Can't find it as a long option. If this is not getopt_long_only,
684 or the option starts with '--' or is not a valid short
685 option, then it's an error.
686 Otherwise interpret it as a short option. */
687 if (!long_only || argv[optind][1] == '-'
688 || my_index(optstring, *nextchar) == NULL) {
690 if (argv[optind][1] == '-')
692 fprintf(stderr, _("%s: unrecognized option `--%s'\n"),
695 /* +option or -option */
696 fprintf(stderr, _("%s: unrecognized option `%c%s'\n"),
697 argv[0], argv[optind][0], nextchar);
699 nextchar = (char *) "";
706 /* Look at and handle the next short option-character. */
709 char c = *nextchar++;
710 char *temp = my_index(optstring, c);
712 /* Increment `optind' when we start to process its last character. */
713 if (*nextchar == '\0')
716 if (temp == NULL || c == ':') {
719 /* 1003.2 specifies the format of this message. */
720 fprintf(stderr, _("%s: illegal option -- %c\n"),
723 fprintf(stderr, _("%s: invalid option -- %c\n"),
729 /* Convenience. Treat POSIX -W foo same as long option --foo */
730 if (temp[0] == 'W' && temp[1] == ';') {
732 const struct option *p;
733 const struct option *pfound = NULL;
739 /* This is an option that requires an argument. */
740 if (*nextchar != '\0') {
742 /* If we end this ARGV-element by taking the rest as an arg,
743 we must advance to the next element now. */
745 } else if (optind == argc) {
747 /* 1003.2 specifies the format of this message. */
749 _("%s: option requires an argument -- %c\n"),
753 if (optstring[0] == ':')
759 /* We already incremented `optind' once;
760 increment it again when taking next ARGV-elt as argument. */
761 optarg = argv[optind++];
763 /* optarg is now the argument, see if it's in the
764 table of longopts. */
766 for (nextchar = nameend = optarg; *nameend && *nameend != '=';
770 /* Test all long options for either exact match
771 or abbreviated matches. */
772 for (p = longopts, option_index = 0; p->name; p++, option_index++)
773 if (!strncmp(p->name, nextchar, nameend - nextchar)) {
774 if ((unsigned int) (nameend - nextchar) ==
776 /* Exact match found. */
778 indfound = option_index;
781 } else if (pfound == NULL) {
782 /* First nonexact match found. */
784 indfound = option_index;
786 /* Second or later nonexact match found. */
789 if (ambig && !exact) {
791 fprintf(stderr, _("%s: option `-W %s' is ambiguous\n"),
792 argv[0], argv[optind]);
793 nextchar += strlen(nextchar);
797 if (pfound != NULL) {
798 option_index = indfound;
800 /* Don't test has_arg with >, because some C compilers don't
801 allow it to be used on enums. */
803 optarg = nameend + 1;
807 %s: option `-W %s' doesn't allow an argument\n"), argv[0], pfound->name);
809 nextchar += strlen(nextchar);
812 } else if (pfound->has_arg == 1) {
814 optarg = argv[optind++];
819 ("%s: option `%s' requires an argument\n"),
820 argv[0], argv[optind - 1]);
821 nextchar += strlen(nextchar);
822 return optstring[0] == ':' ? ':' : '?';
825 nextchar += strlen(nextchar);
827 *longind = option_index;
829 *(pfound->flag) = pfound->val;
835 return 'W'; /* Let the application handle it. */
837 if (temp[1] == ':') {
838 if (temp[2] == ':') {
839 /* This is an option that accepts an argument optionally. */
840 if (*nextchar != '\0') {
847 /* This is an option that requires an argument. */
848 if (*nextchar != '\0') {
850 /* If we end this ARGV-element by taking the rest as an arg,
851 we must advance to the next element now. */
853 } else if (optind == argc) {
855 /* 1003.2 specifies the format of this message. */
857 _("%s: option requires an argument -- %c\n"),
861 if (optstring[0] == ':')
866 /* We already incremented `optind' once;
867 increment it again when taking next ARGV-elt as argument. */
868 optarg = argv[optind++];
876 #endif /* Not ELIDE_CODE. */
880 /* Compile with -DTEST to make an executable for use in testing
881 the above definition of `getopt'. */
890 int digit_optind = 0;
893 int this_option_optind = optind ? optind : 1;
895 c = getopt(argc, argv, "abc:d:0123456789");
910 if (digit_optind != 0 && digit_optind != this_option_optind)
911 printf("digits occur in two different argv-elements.\n");
912 digit_optind = this_option_optind;
913 printf("option %c\n", c);
917 printf("option a\n");
921 printf("option b\n");
925 printf("option c with value `%s'\n", optarg);
932 printf("?? getopt returned character code 0%o ??\n", c);
937 printf("non-option ARGV-elements: ");
938 while (optind < argc)
939 printf("%s ", argv[optind++]);