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, 1996
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
24 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
25 Cambridge, MA 02139, 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>. */
37 #if !defined (__STDC__) || !__STDC__
38 /* This is a separate conditional since some stdc systems
39 reject `defined (const)'. */
47 /* Comment out all this code if we are using the GNU C Library, and are not
48 actually compiling the library itself. This code is part of the GNU C
49 Library, but also included in many other GNU distributions. Compiling
50 and linking in this code is a waste when using the GNU C library
51 (especially if it is a shared library). Rather than having every GNU
52 program understand `configure --with-gnu-libc' and omit the object files,
53 it is simpler to just do this in the source for each such file. */
55 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
58 /* This needs to come after some library #include
59 to get __GNU_LIBRARY__ defined. */
60 #ifdef __GNU_LIBRARY__
61 /* Don't include stdlib.h for non-GNU C libraries because some of them
62 contain conflicting prototypes for getopt. */
65 #endif /* GNU C library. */
74 #if defined (WIN32) && !defined (__CYGWIN32__)
75 /* It's not Unix, really. See? Capital letters. */
77 #define getpid() GetCurrentProcessId()
81 /* This is for other GNU distributions with internationalized messages.
82 When compiling libc, the _ macro is predefined. */
85 # define _(msgid) gettext (msgid)
87 # define _(msgid) (msgid)
91 /* This version of `getopt' appears to the caller like standard Unix `getopt'
92 but it behaves differently for the user, since it allows the user
93 to intersperse the options with the other arguments.
95 As `getopt' works, it permutes the elements of ARGV so that,
96 when it is done, all the options precede everything else. Thus
97 all application programs are extended to handle flexible argument order.
99 Setting the environment variable POSIXLY_CORRECT disables permutation.
100 Then the behavior is completely standard.
102 GNU application programs can use a third alternative mode in which
103 they can distinguish the relative order of options and other arguments. */
107 /* For communication from `getopt' to the caller.
108 When `getopt' finds an option that takes an argument,
109 the argument value is returned here.
110 Also, when `ordering' is RETURN_IN_ORDER,
111 each non-option ARGV-element is returned here. */
115 /* Index in ARGV of the next element to be scanned.
116 This is used for communication to and from the caller
117 and for communication between successive calls to `getopt'.
119 On entry to `getopt', zero means this is the first call; initialize.
121 When `getopt' returns EOF, this is the index of the first of the
122 non-option elements that the caller should itself scan.
124 Otherwise, `optind' communicates from one call to the next
125 how much of ARGV has been scanned so far. */
127 /* XXX 1003.2 says this must be 1 before any call. */
130 /* The next char to be scanned in the option-element
131 in which the last option character we returned was found.
132 This allows us to pick up the scan where we left off.
134 If this is zero, or a null string, it means resume the scan
135 by advancing to the next ARGV-element. */
137 static char *nextchar
;
139 /* Callers store zero here to inhibit the error message
140 for unrecognized options. */
144 /* Set to an option character which was unrecognized.
145 This must be initialized on some systems to avoid linking in the
146 system's own getopt implementation. */
150 /* Describe how to deal with options that follow non-option ARGV-elements.
152 If the caller did not specify anything,
153 the default is REQUIRE_ORDER if the environment variable
154 POSIXLY_CORRECT is defined, PERMUTE otherwise.
156 REQUIRE_ORDER means don't recognize them as options;
157 stop option processing when the first non-option is seen.
158 This is what Unix does.
159 This mode of operation is selected by either setting the environment
160 variable POSIXLY_CORRECT, or using `+' as the first character
161 of the list of option characters.
163 PERMUTE is the default. We permute the contents of ARGV as we scan,
164 so that eventually all the non-options are at the end. This allows options
165 to be given in any order, even with programs that were not written to
168 RETURN_IN_ORDER is an option available to programs that were written
169 to expect options and other ARGV-elements in any order and that care about
170 the ordering of the two. We describe each non-option ARGV-element
171 as if it were the argument of an option with character code 1.
172 Using `-' as the first character of the list of option characters
173 selects this mode of operation.
175 The special argument `--' forces an end of option-scanning regardless
176 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
177 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
181 REQUIRE_ORDER
, PERMUTE
, RETURN_IN_ORDER
184 /* Value of POSIXLY_CORRECT environment variable. */
185 static char *posixly_correct
;
187 #ifdef __GNU_LIBRARY__
188 /* We want to avoid inclusion of string.h with non-GNU libraries
189 because there are many ways it can cause trouble.
190 On some systems, it contains special magic macros that don't work
193 #define my_index strchr
196 /* Avoid depending on library functions or files
197 whose names are inconsistent. */
215 /* If using GCC, we can safely declare strlen this way.
216 If not using GCC, it is ok not to declare it. */
218 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
219 That was relevant to code that was here before. */
220 #if !defined (__STDC__) || !__STDC__
221 /* gcc with -traditional declares the built-in strlen to return int,
222 and has done so at least since version 2.4.5. -- rms. */
223 extern int strlen (const char *);
224 #endif /* not __STDC__ */
225 #endif /* __GNUC__ */
227 #endif /* not __GNU_LIBRARY__ */
229 /* Handle permutation of arguments. */
231 /* Describe the part of ARGV that contains non-options that have
232 been skipped. `first_nonopt' is the index in ARGV of the first of them;
233 `last_nonopt' is the index after the last of them. */
235 static int first_nonopt
;
236 static int last_nonopt
;
238 /* Bash 2.0 gives us an environment variable containing flags
239 indicating ARGV elements that should not be considered arguments. */
241 static const char *nonoption_flags
;
242 static int nonoption_flags_len
;
244 /* Exchange two adjacent subsequences of ARGV.
245 One subsequence is elements [first_nonopt,last_nonopt)
246 which contains all the non-options that have been skipped so far.
247 The other is elements [last_nonopt,optind), which contains all
248 the options processed since those non-options were skipped.
250 `first_nonopt' and `last_nonopt' are relocated so that they describe
251 the new indices of the non-options in ARGV after they are moved. */
253 #if defined (__STDC__) && __STDC__
254 static void exchange (char **);
261 int bottom
= first_nonopt
;
262 int middle
= last_nonopt
;
266 /* Exchange the shorter segment with the far end of the longer segment.
267 That puts the shorter segment into the right place.
268 It leaves the longer segment in the right place overall,
269 but it consists of two parts that need to be swapped next. */
271 while (top
> middle
&& middle
> bottom
)
273 if (top
- middle
> middle
- bottom
)
275 /* Bottom segment is the short one. */
276 int len
= middle
- bottom
;
279 /* Swap it with the top part of the top segment. */
280 for (i
= 0; i
< len
; i
++)
282 tem
= argv
[bottom
+ i
];
283 argv
[bottom
+ i
] = argv
[top
- (middle
- bottom
) + i
];
284 argv
[top
- (middle
- bottom
) + i
] = tem
;
286 /* Exclude the moved bottom segment from further swapping. */
291 /* Top segment is the short one. */
292 int len
= top
- middle
;
295 /* Swap it with the bottom part of the bottom segment. */
296 for (i
= 0; i
< len
; i
++)
298 tem
= argv
[bottom
+ i
];
299 argv
[bottom
+ i
] = argv
[middle
+ i
];
300 argv
[middle
+ i
] = tem
;
302 /* Exclude the moved top segment from further swapping. */
307 /* Update records for the slots the non-options now occupy. */
309 first_nonopt
+= (optind
- last_nonopt
);
310 last_nonopt
= optind
;
313 /* Initialize the internal data when the first call is made. */
315 #if defined (__STDC__) && __STDC__
316 static const char *_getopt_initialize (const char *);
319 _getopt_initialize (optstring
)
320 const char *optstring
;
322 /* Start processing options with ARGV-element 1 (since ARGV-element 0
323 is the program name); the sequence of previously skipped
324 non-option ARGV-elements is empty. */
326 first_nonopt
= last_nonopt
= optind
= 1;
330 posixly_correct
= getenv ("POSIXLY_CORRECT");
332 /* Determine how to handle the ordering of options and nonoptions. */
334 if (optstring
[0] == '-')
336 ordering
= RETURN_IN_ORDER
;
339 else if (optstring
[0] == '+')
341 ordering
= REQUIRE_ORDER
;
344 else if (posixly_correct
!= NULL
)
345 ordering
= REQUIRE_ORDER
;
349 if (posixly_correct
== NULL
)
351 /* Bash 2.0 puts a special variable in the environment for each
352 command it runs, specifying which ARGV elements are the results of
353 file name wildcard expansion and therefore should not be
354 considered as options. */
356 sprintf (var
, "_%d_GNU_nonoption_argv_flags_", getpid ());
357 nonoption_flags
= getenv (var
);
358 if (nonoption_flags
== NULL
)
359 nonoption_flags_len
= 0;
361 nonoption_flags_len
= strlen (nonoption_flags
);
367 /* Scan elements of ARGV (whose length is ARGC) for option characters
370 If an element of ARGV starts with '-', and is not exactly "-" or "--",
371 then it is an option element. The characters of this element
372 (aside from the initial '-') are option characters. If `getopt'
373 is called repeatedly, it returns successively each of the option characters
374 from each of the option elements.
376 If `getopt' finds another option character, it returns that character,
377 updating `optind' and `nextchar' so that the next call to `getopt' can
378 resume the scan with the following option character or ARGV-element.
380 If there are no more option characters, `getopt' returns `EOF'.
381 Then `optind' is the index in ARGV of the first ARGV-element
382 that is not an option. (The ARGV-elements have been permuted
383 so that those that are not options now come last.)
385 OPTSTRING is a string containing the legitimate option characters.
386 If an option character is seen that is not listed in OPTSTRING,
387 return '?' after printing an error message. If you set `opterr' to
388 zero, the error message is suppressed but we still return '?'.
390 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
391 so the following text in the same ARGV-element, or the text of the following
392 ARGV-element, is returned in `optarg'. Two colons mean an option that
393 wants an optional arg; if there is text in the current ARGV-element,
394 it is returned in `optarg', otherwise `optarg' is set to zero.
396 If OPTSTRING starts with `-' or `+', it requests different methods of
397 handling the non-option ARGV-elements.
398 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
400 Long-named options begin with `--' instead of `-'.
401 Their names may be abbreviated as long as the abbreviation is unique
402 or is an exact match for some defined option. If they have an
403 argument, it follows the option name in the same ARGV-element, separated
404 from the option name by a `=', or else the in next ARGV-element.
405 When `getopt' finds a long-named option, it returns 0 if that option's
406 `flag' field is nonzero, the value of the option's `val' field
407 if the `flag' field is zero.
409 The elements of ARGV aren't really const, because we permute them.
410 But we pretend they're const in the prototype to be compatible
413 LONGOPTS is a vector of `struct option' terminated by an
414 element containing a name which is zero.
416 LONGIND returns the index in LONGOPT of the long-named option found.
417 It is only valid when a long-named option has been found by the most
420 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
421 long-named options. */
424 _getopt_internal (argc
, argv
, optstring
, longopts
, longind
, long_only
)
427 const char *optstring
;
428 const struct option
*longopts
;
436 optstring
= _getopt_initialize (optstring
);
437 optind
= 1; /* Don't scan ARGV[0], the program name. */
440 /* Test whether ARGV[optind] points to a non-option argument.
441 Either it does not have option syntax, or there is an environment flag
442 from the shell indicating it is not an option. */
443 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
444 || (optind < nonoption_flags_len \
445 && nonoption_flags[optind] == '1'))
447 if (nextchar
== NULL
|| *nextchar
== '\0')
449 /* Advance to the next ARGV-element. */
451 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
452 moved back by the user (who may also have changed the arguments). */
453 if (last_nonopt
> optind
)
454 last_nonopt
= optind
;
455 if (first_nonopt
> optind
)
456 first_nonopt
= optind
;
458 if (ordering
== PERMUTE
)
460 /* If we have just processed some options following some non-options,
461 exchange them so that the options come first. */
463 if (first_nonopt
!= last_nonopt
&& last_nonopt
!= optind
)
464 exchange ((char **) argv
);
465 else if (last_nonopt
!= optind
)
466 first_nonopt
= optind
;
468 /* Skip any additional non-options
469 and extend the range of non-options previously skipped. */
471 while (optind
< argc
&& NONOPTION_P
)
473 last_nonopt
= optind
;
476 /* The special ARGV-element `--' means premature end of options.
477 Skip it like a null option,
478 then exchange with previous non-options as if it were an option,
479 then skip everything else like a non-option. */
481 if (optind
!= argc
&& !strcmp (argv
[optind
], "--"))
485 if (first_nonopt
!= last_nonopt
&& last_nonopt
!= optind
)
486 exchange ((char **) argv
);
487 else if (first_nonopt
== last_nonopt
)
488 first_nonopt
= optind
;
494 /* If we have done all the ARGV-elements, stop the scan
495 and back over any non-options that we skipped and permuted. */
499 /* Set the next-arg-index to point at the non-options
500 that we previously skipped, so the caller will digest them. */
501 if (first_nonopt
!= last_nonopt
)
502 optind
= first_nonopt
;
506 /* If we have come to a non-option and did not permute it,
507 either stop the scan or describe it to the caller and pass it by. */
511 if (ordering
== REQUIRE_ORDER
)
513 optarg
= argv
[optind
++];
517 /* We have found another option-ARGV-element.
518 Skip the initial punctuation. */
520 nextchar
= (argv
[optind
] + 1
521 + (longopts
!= NULL
&& argv
[optind
][1] == '-'));
524 /* Decode the current option-ARGV-element. */
526 /* Check whether the ARGV-element is a long option.
528 If long_only and the ARGV-element has the form "-f", where f is
529 a valid short option, don't consider it an abbreviated form of
530 a long option that starts with f. Otherwise there would be no
531 way to give the -f short option.
533 On the other hand, if there's a long option "fubar" and
534 the ARGV-element is "-fu", do consider that an abbreviation of
535 the long option, just like "--fu", and not "-f" with arg "u".
537 This distinction seems to be the most useful approach. */
540 && (argv
[optind
][1] == '-'
541 || (long_only
&& (argv
[optind
][2] || !my_index (optstring
, argv
[optind
][1])))))
544 const struct option
*p
;
545 const struct option
*pfound
= NULL
;
551 for (nameend
= nextchar
; *nameend
&& *nameend
!= '='; nameend
++)
554 /* Test all long options for either exact match
555 or abbreviated matches. */
556 for (p
= longopts
, option_index
= 0; p
->name
; p
++, option_index
++)
557 if (!strncmp (p
->name
, nextchar
, nameend
- nextchar
))
559 if ((unsigned int) (nameend
- nextchar
)
560 == (unsigned int) strlen (p
->name
))
562 /* Exact match found. */
564 indfound
= option_index
;
568 else if (pfound
== NULL
)
570 /* First nonexact match found. */
572 indfound
= option_index
;
575 /* Second or later nonexact match found. */
582 fprintf (stderr
, _("%s: option `%s' is ambiguous\n"),
583 argv
[0], argv
[optind
]);
584 nextchar
+= strlen (nextchar
);
592 option_index
= indfound
;
596 /* Don't test has_arg with >, because some C compilers don't
597 allow it to be used on enums. */
599 optarg
= nameend
+ 1;
603 if (argv
[optind
- 1][1] == '-')
606 _("%s: option `--%s' doesn't allow an argument\n"),
607 argv
[0], pfound
->name
);
609 /* +option or -option */
611 _("%s: option `%c%s' doesn't allow an argument\n"),
612 argv
[0], argv
[optind
- 1][0], pfound
->name
);
614 nextchar
+= strlen (nextchar
);
616 optopt
= pfound
->val
;
620 else if (pfound
->has_arg
== 1)
623 optarg
= argv
[optind
++];
628 _("%s: option `%s' requires an argument\n"),
629 argv
[0], argv
[optind
- 1]);
630 nextchar
+= strlen (nextchar
);
631 optopt
= pfound
->val
;
632 return optstring
[0] == ':' ? ':' : '?';
635 nextchar
+= strlen (nextchar
);
637 *longind
= option_index
;
640 *(pfound
->flag
) = pfound
->val
;
646 /* Can't find it as a long option. If this is not getopt_long_only,
647 or the option starts with '--' or is not a valid short
648 option, then it's an error.
649 Otherwise interpret it as a short option. */
650 if (!long_only
|| argv
[optind
][1] == '-'
651 || my_index (optstring
, *nextchar
) == NULL
)
655 if (argv
[optind
][1] == '-')
657 fprintf (stderr
, _("%s: unrecognized option `--%s'\n"),
660 /* +option or -option */
661 fprintf (stderr
, _("%s: unrecognized option `%c%s'\n"),
662 argv
[0], argv
[optind
][0], nextchar
);
664 nextchar
= (char *) "";
671 /* Look at and handle the next short option-character. */
674 char c
= *nextchar
++;
675 char *temp
= my_index (optstring
, c
);
677 /* Increment `optind' when we start to process its last character. */
678 if (*nextchar
== '\0')
681 if (temp
== NULL
|| c
== ':')
686 /* 1003.2 specifies the format of this message. */
687 fprintf (stderr
, _("%s: illegal option -- %c\n"),
690 fprintf (stderr
, _("%s: invalid option -- %c\n"),
696 /* Convenience. Treat POSIX -W foo same as long option --foo */
697 if (temp
[0] == 'W' && temp
[1] == ';')
700 const struct option
*p
;
701 const struct option
*pfound
= NULL
;
707 /* This is an option that requires an argument. */
708 if (*nextchar
!= '\0')
711 /* If we end this ARGV-element by taking the rest as an arg,
712 we must advance to the next element now. */
715 else if (optind
== argc
)
719 /* 1003.2 specifies the format of this message. */
721 gettext ("%s: option requires an argument -- %c\n"),
725 if (optstring
[0] == ':')
731 /* We already incremented `optind' once;
732 increment it again when taking next ARGV-elt as argument. */
733 optarg
= argv
[optind
++];
735 /* optarg is now the argument, see if it's in the
736 table of longopts. */
738 for (nextchar
= nameend
= optarg
; *nameend
&& *nameend
!= '='; nameend
++)
741 /* Test all long options for either exact match
742 or abbreviated matches. */
743 for (p
= longopts
, option_index
= 0; p
->name
; p
++, option_index
++)
744 if (!strncmp (p
->name
, nextchar
, nameend
- nextchar
))
746 if ((unsigned int) (nameend
- nextchar
) == strlen (p
->name
))
748 /* Exact match found. */
750 indfound
= option_index
;
754 else if (pfound
== NULL
)
756 /* First nonexact match found. */
758 indfound
= option_index
;
761 /* Second or later nonexact match found. */
767 fprintf (stderr
, gettext ("%s: option `-W %s' is ambiguous\n"),
768 argv
[0], argv
[optind
]);
769 nextchar
+= strlen (nextchar
);
775 option_index
= indfound
;
778 /* Don't test has_arg with >, because some C compilers don't
779 allow it to be used on enums. */
781 optarg
= nameend
+ 1;
786 gettext ("%s: option `-W %s' doesn't allow an argument\n"),
787 argv
[0], pfound
->name
);
789 nextchar
+= strlen (nextchar
);
793 else if (pfound
->has_arg
== 1)
796 optarg
= argv
[optind
++];
801 gettext ("%s: option `%s' requires an argument\n"),
802 argv
[0], argv
[optind
- 1]);
803 nextchar
+= strlen (nextchar
);
804 return optstring
[0] == ':' ? ':' : '?';
807 nextchar
+= strlen (nextchar
);
809 *longind
= option_index
;
812 *(pfound
->flag
) = pfound
->val
;
818 return 'W'; /* Let the application handle it. */
824 /* This is an option that accepts an argument optionally. */
825 if (*nextchar
!= '\0')
836 /* This is an option that requires an argument. */
837 if (*nextchar
!= '\0')
840 /* If we end this ARGV-element by taking the rest as an arg,
841 we must advance to the next element now. */
844 else if (optind
== argc
)
848 /* 1003.2 specifies the format of this message. */
850 _("%s: option requires an argument -- %c\n"),
854 if (optstring
[0] == ':')
860 /* We already incremented `optind' once;
861 increment it again when taking next ARGV-elt as argument. */
862 optarg
= argv
[optind
++];
871 getopt (argc
, argv
, optstring
)
874 const char *optstring
;
876 return _getopt_internal (argc
, argv
, optstring
,
877 (const struct option
*) 0,
882 #endif /* _LIBC or not __GNU_LIBRARY__. */
886 /* Compile with -DTEST to make an executable for use in testing
887 the above definition of `getopt'. */
895 int digit_optind
= 0;
899 int this_option_optind
= optind
? optind
: 1;
901 c
= getopt (argc
, argv
, "abc:d:0123456789");
917 if (digit_optind
!= 0 && digit_optind
!= this_option_optind
)
918 printf ("digits occur in two different argv-elements.\n");
919 digit_optind
= this_option_optind
;
920 printf ("option %c\n", c
);
924 printf ("option a\n");
928 printf ("option b\n");
932 printf ("option c with value `%s'\n", optarg
);
939 printf ("?? getopt returned character code 0%o ??\n", c
);
945 printf ("non-option ARGV-elements: ");
946 while (optind
< argc
)
947 printf ("%s ", argv
[optind
++]);