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 program is free software; you can redistribute it and/or modify it
10 under the terms of the GNU General Public License as published by the
11 Free Software Foundation; either version 2, or (at your option) any
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
24 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
25 Ditto for AIX 3.2 and <stdlib.h>. */
34 #if !defined (__STDC__) || !__STDC__
35 /* This is a separate conditional since some stdc systems
36 reject `defined (const)'. */
44 /* Comment out all this code if we are using the GNU C Library, and are not
45 actually compiling the library itself. This code is part of the GNU C
46 Library, but also included in many other GNU distributions. Compiling
47 and linking in this code is a waste when using the GNU C library
48 (especially if it is a shared library). Rather than having every GNU
49 program understand `configure --with-gnu-libc' and omit the object files,
50 it is simpler to just do this in the source for each such file. */
52 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
55 /* This needs to come after some library #include
56 to get __GNU_LIBRARY__ defined. */
57 #ifdef __GNU_LIBRARY__
58 /* Don't include stdlib.h for non-GNU C libraries because some of them
59 contain conflicting prototypes for getopt. */
62 #endif /* GNU C library. */
71 #if defined (WIN32) && !defined (__CYGWIN32__)
72 /* It's not Unix, really. See? Capital letters. */
74 #define getpid() GetCurrentProcessId()
78 /* This is for other GNU distributions with internationalized messages.
79 When compiling libc, the _ macro is predefined. */
82 # define _(msgid) gettext (msgid)
84 # define _(msgid) (msgid)
88 /* This version of `getopt' appears to the caller like standard Unix `getopt'
89 but it behaves differently for the user, since it allows the user
90 to intersperse the options with the other arguments.
92 As `getopt' works, it permutes the elements of ARGV so that,
93 when it is done, all the options precede everything else. Thus
94 all application programs are extended to handle flexible argument order.
96 Setting the environment variable POSIXLY_CORRECT disables permutation.
97 Then the behavior is completely standard.
99 GNU application programs can use a third alternative mode in which
100 they can distinguish the relative order of options and other arguments. */
104 /* For communication from `getopt' to the caller.
105 When `getopt' finds an option that takes an argument,
106 the argument value is returned here.
107 Also, when `ordering' is RETURN_IN_ORDER,
108 each non-option ARGV-element is returned here. */
112 /* Index in ARGV of the next element to be scanned.
113 This is used for communication to and from the caller
114 and for communication between successive calls to `getopt'.
116 On entry to `getopt', zero means this is the first call; initialize.
118 When `getopt' returns EOF, this is the index of the first of the
119 non-option elements that the caller should itself scan.
121 Otherwise, `optind' communicates from one call to the next
122 how much of ARGV has been scanned so far. */
124 /* XXX 1003.2 says this must be 1 before any call. */
127 /* The next char to be scanned in the option-element
128 in which the last option character we returned was found.
129 This allows us to pick up the scan where we left off.
131 If this is zero, or a null string, it means resume the scan
132 by advancing to the next ARGV-element. */
134 static char *nextchar;
136 /* Callers store zero here to inhibit the error message
137 for unrecognized options. */
141 /* Set to an option character which was unrecognized.
142 This must be initialized on some systems to avoid linking in the
143 system's own getopt implementation. */
147 /* Describe how to deal with options that follow non-option ARGV-elements.
149 If the caller did not specify anything,
150 the default is REQUIRE_ORDER if the environment variable
151 POSIXLY_CORRECT is defined, PERMUTE otherwise.
153 REQUIRE_ORDER means don't recognize them as options;
154 stop option processing when the first non-option is seen.
155 This is what Unix does.
156 This mode of operation is selected by either setting the environment
157 variable POSIXLY_CORRECT, or using `+' as the first character
158 of the list of option characters.
160 PERMUTE is the default. We permute the contents of ARGV as we scan,
161 so that eventually all the non-options are at the end. This allows options
162 to be given in any order, even with programs that were not written to
165 RETURN_IN_ORDER is an option available to programs that were written
166 to expect options and other ARGV-elements in any order and that care about
167 the ordering of the two. We describe each non-option ARGV-element
168 as if it were the argument of an option with character code 1.
169 Using `-' as the first character of the list of option characters
170 selects this mode of operation.
172 The special argument `--' forces an end of option-scanning regardless
173 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
174 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
178 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
181 /* Value of POSIXLY_CORRECT environment variable. */
182 static char *posixly_correct;
184 #ifdef __GNU_LIBRARY__
185 /* We want to avoid inclusion of string.h with non-GNU libraries
186 because there are many ways it can cause trouble.
187 On some systems, it contains special magic macros that don't work
190 #define my_index strchr
193 /* Avoid depending on library functions or files
194 whose names are inconsistent. */
212 /* If using GCC, we can safely declare strlen this way.
213 If not using GCC, it is ok not to declare it. */
215 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
216 That was relevant to code that was here before. */
217 #if !defined (__STDC__) || !__STDC__
218 /* gcc with -traditional declares the built-in strlen to return int,
219 and has done so at least since version 2.4.5. -- rms. */
220 extern int strlen (const char *);
221 #endif /* not __STDC__ */
222 #endif /* __GNUC__ */
224 #endif /* not __GNU_LIBRARY__ */
226 /* Handle permutation of arguments. */
228 /* Describe the part of ARGV that contains non-options that have
229 been skipped. `first_nonopt' is the index in ARGV of the first of them;
230 `last_nonopt' is the index after the last of them. */
232 static int first_nonopt;
233 static int last_nonopt;
235 /* Bash 2.0 gives us an environment variable containing flags
236 indicating ARGV elements that should not be considered arguments. */
238 static const char *nonoption_flags;
239 static int nonoption_flags_len;
241 /* Exchange two adjacent subsequences of ARGV.
242 One subsequence is elements [first_nonopt,last_nonopt)
243 which contains all the non-options that have been skipped so far.
244 The other is elements [last_nonopt,optind), which contains all
245 the options processed since those non-options were skipped.
247 `first_nonopt' and `last_nonopt' are relocated so that they describe
248 the new indices of the non-options in ARGV after they are moved. */
250 #if defined (__STDC__) && __STDC__
251 static void exchange (char **);
258 int bottom = first_nonopt;
259 int middle = last_nonopt;
263 /* Exchange the shorter segment with the far end of the longer segment.
264 That puts the shorter segment into the right place.
265 It leaves the longer segment in the right place overall,
266 but it consists of two parts that need to be swapped next. */
268 while (top > middle && middle > bottom)
270 if (top - middle > middle - bottom)
272 /* Bottom segment is the short one. */
273 int len = middle - bottom;
276 /* Swap it with the top part of the top segment. */
277 for (i = 0; i < len; i++)
279 tem = argv[bottom + i];
280 argv[bottom + i] = argv[top - (middle - bottom) + i];
281 argv[top - (middle - bottom) + i] = tem;
283 /* Exclude the moved bottom segment from further swapping. */
288 /* Top segment is the short one. */
289 int len = top - middle;
292 /* Swap it with the bottom part of the bottom segment. */
293 for (i = 0; i < len; i++)
295 tem = argv[bottom + i];
296 argv[bottom + i] = argv[middle + i];
297 argv[middle + i] = tem;
299 /* Exclude the moved top segment from further swapping. */
304 /* Update records for the slots the non-options now occupy. */
306 first_nonopt += (optind - last_nonopt);
307 last_nonopt = optind;
310 /* Initialize the internal data when the first call is made. */
312 #if defined (__STDC__) && __STDC__
313 static const char *_getopt_initialize (const char *);
316 _getopt_initialize (optstring)
317 const char *optstring;
319 /* Start processing options with ARGV-element 1 (since ARGV-element 0
320 is the program name); the sequence of previously skipped
321 non-option ARGV-elements is empty. */
323 first_nonopt = last_nonopt = optind = 1;
327 posixly_correct = getenv ("POSIXLY_CORRECT");
329 /* Determine how to handle the ordering of options and nonoptions. */
331 if (optstring[0] == '-')
333 ordering = RETURN_IN_ORDER;
336 else if (optstring[0] == '+')
338 ordering = REQUIRE_ORDER;
341 else if (posixly_correct != NULL)
342 ordering = REQUIRE_ORDER;
346 if (posixly_correct == NULL)
348 /* Bash 2.0 puts a special variable in the environment for each
349 command it runs, specifying which ARGV elements are the results of
350 file name wildcard expansion and therefore should not be
351 considered as options. */
353 sprintf (var, "_%d_GNU_nonoption_argv_flags_", getpid ());
354 nonoption_flags = getenv (var);
355 if (nonoption_flags == NULL)
356 nonoption_flags_len = 0;
358 nonoption_flags_len = strlen (nonoption_flags);
364 /* Scan elements of ARGV (whose length is ARGC) for option characters
367 If an element of ARGV starts with '-', and is not exactly "-" or "--",
368 then it is an option element. The characters of this element
369 (aside from the initial '-') are option characters. If `getopt'
370 is called repeatedly, it returns successively each of the option characters
371 from each of the option elements.
373 If `getopt' finds another option character, it returns that character,
374 updating `optind' and `nextchar' so that the next call to `getopt' can
375 resume the scan with the following option character or ARGV-element.
377 If there are no more option characters, `getopt' returns `EOF'.
378 Then `optind' is the index in ARGV of the first ARGV-element
379 that is not an option. (The ARGV-elements have been permuted
380 so that those that are not options now come last.)
382 OPTSTRING is a string containing the legitimate option characters.
383 If an option character is seen that is not listed in OPTSTRING,
384 return '?' after printing an error message. If you set `opterr' to
385 zero, the error message is suppressed but we still return '?'.
387 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
388 so the following text in the same ARGV-element, or the text of the following
389 ARGV-element, is returned in `optarg'. Two colons mean an option that
390 wants an optional arg; if there is text in the current ARGV-element,
391 it is returned in `optarg', otherwise `optarg' is set to zero.
393 If OPTSTRING starts with `-' or `+', it requests different methods of
394 handling the non-option ARGV-elements.
395 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
397 Long-named options begin with `--' instead of `-'.
398 Their names may be abbreviated as long as the abbreviation is unique
399 or is an exact match for some defined option. If they have an
400 argument, it follows the option name in the same ARGV-element, separated
401 from the option name by a `=', or else the in next ARGV-element.
402 When `getopt' finds a long-named option, it returns 0 if that option's
403 `flag' field is nonzero, the value of the option's `val' field
404 if the `flag' field is zero.
406 The elements of ARGV aren't really const, because we permute them.
407 But we pretend they're const in the prototype to be compatible
410 LONGOPTS is a vector of `struct option' terminated by an
411 element containing a name which is zero.
413 LONGIND returns the index in LONGOPT of the long-named option found.
414 It is only valid when a long-named option has been found by the most
417 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
418 long-named options. */
421 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
424 const char *optstring;
425 const struct option *longopts;
433 optstring = _getopt_initialize (optstring);
434 optind = 1; /* Don't scan ARGV[0], the program name. */
437 /* Test whether ARGV[optind] points to a non-option argument.
438 Either it does not have option syntax, or there is an environment flag
439 from the shell indicating it is not an option. */
440 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
441 || (optind < nonoption_flags_len \
442 && nonoption_flags[optind] == '1'))
444 if (nextchar == NULL || *nextchar == '\0')
446 /* Advance to the next ARGV-element. */
448 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
449 moved back by the user (who may also have changed the arguments). */
450 if (last_nonopt > optind)
451 last_nonopt = optind;
452 if (first_nonopt > optind)
453 first_nonopt = optind;
455 if (ordering == PERMUTE)
457 /* If we have just processed some options following some non-options,
458 exchange them so that the options come first. */
460 if (first_nonopt != last_nonopt && last_nonopt != optind)
461 exchange ((char **) argv);
462 else if (last_nonopt != optind)
463 first_nonopt = optind;
465 /* Skip any additional non-options
466 and extend the range of non-options previously skipped. */
468 while (optind < argc && NONOPTION_P)
470 last_nonopt = optind;
473 /* The special ARGV-element `--' means premature end of options.
474 Skip it like a null option,
475 then exchange with previous non-options as if it were an option,
476 then skip everything else like a non-option. */
478 if (optind != argc && !strcmp (argv[optind], "--"))
482 if (first_nonopt != last_nonopt && last_nonopt != optind)
483 exchange ((char **) argv);
484 else if (first_nonopt == last_nonopt)
485 first_nonopt = optind;
491 /* If we have done all the ARGV-elements, stop the scan
492 and back over any non-options that we skipped and permuted. */
496 /* Set the next-arg-index to point at the non-options
497 that we previously skipped, so the caller will digest them. */
498 if (first_nonopt != last_nonopt)
499 optind = first_nonopt;
503 /* If we have come to a non-option and did not permute it,
504 either stop the scan or describe it to the caller and pass it by. */
508 if (ordering == REQUIRE_ORDER)
510 optarg = argv[optind++];
514 /* We have found another option-ARGV-element.
515 Skip the initial punctuation. */
517 nextchar = (argv[optind] + 1
518 + (longopts != NULL && argv[optind][1] == '-'));
521 /* Decode the current option-ARGV-element. */
523 /* Check whether the ARGV-element is a long option.
525 If long_only and the ARGV-element has the form "-f", where f is
526 a valid short option, don't consider it an abbreviated form of
527 a long option that starts with f. Otherwise there would be no
528 way to give the -f short option.
530 On the other hand, if there's a long option "fubar" and
531 the ARGV-element is "-fu", do consider that an abbreviation of
532 the long option, just like "--fu", and not "-f" with arg "u".
534 This distinction seems to be the most useful approach. */
537 && (argv[optind][1] == '-'
538 || (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
541 const struct option *p;
542 const struct option *pfound = NULL;
548 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
551 /* Test all long options for either exact match
552 or abbreviated matches. */
553 for (p = longopts, option_index = 0; p->name; p++, option_index++)
554 if (!strncmp (p->name, nextchar, nameend - nextchar))
556 if (nameend - nextchar == strlen (p->name))
558 /* Exact match found. */
560 indfound = option_index;
564 else if (pfound == NULL)
566 /* First nonexact match found. */
568 indfound = option_index;
571 /* Second or later nonexact match found. */
578 fprintf (stderr, _("%s: option `%s' is ambiguous\n"),
579 argv[0], argv[optind]);
580 nextchar += strlen (nextchar);
588 option_index = indfound;
592 /* Don't test has_arg with >, because some C compilers don't
593 allow it to be used on enums. */
595 optarg = nameend + 1;
599 if (argv[optind - 1][1] == '-')
602 _("%s: option `--%s' doesn't allow an argument\n"),
603 argv[0], pfound->name);
605 /* +option or -option */
607 _("%s: option `%c%s' doesn't allow an argument\n"),
608 argv[0], argv[optind - 1][0], pfound->name);
610 nextchar += strlen (nextchar);
612 optopt = pfound->val;
616 else if (pfound->has_arg == 1)
619 optarg = argv[optind++];
624 _("%s: option `%s' requires an argument\n"),
625 argv[0], argv[optind - 1]);
626 nextchar += strlen (nextchar);
627 optopt = pfound->val;
628 return optstring[0] == ':' ? ':' : '?';
631 nextchar += strlen (nextchar);
633 *longind = option_index;
636 *(pfound->flag) = pfound->val;
642 /* Can't find it as a long option. If this is not getopt_long_only,
643 or the option starts with '--' or is not a valid short
644 option, then it's an error.
645 Otherwise interpret it as a short option. */
646 if (!long_only || argv[optind][1] == '-'
647 || my_index (optstring, *nextchar) == NULL)
651 if (argv[optind][1] == '-')
653 fprintf (stderr, _("%s: unrecognized option `--%s'\n"),
656 /* +option or -option */
657 fprintf (stderr, _("%s: unrecognized option `%c%s'\n"),
658 argv[0], argv[optind][0], nextchar);
660 nextchar = (char *) "";
667 /* Look at and handle the next short option-character. */
670 char c = *nextchar++;
671 char *temp = my_index (optstring, c);
673 /* Increment `optind' when we start to process its last character. */
674 if (*nextchar == '\0')
677 if (temp == NULL || c == ':')
682 /* 1003.2 specifies the format of this message. */
683 fprintf (stderr, _("%s: illegal option -- %c\n"),
686 fprintf (stderr, _("%s: invalid option -- %c\n"),
696 /* This is an option that accepts an argument optionally. */
697 if (*nextchar != '\0')
708 /* This is an option that requires an argument. */
709 if (*nextchar != '\0')
712 /* If we end this ARGV-element by taking the rest as an arg,
713 we must advance to the next element now. */
716 else if (optind == argc)
720 /* 1003.2 specifies the format of this message. */
722 _("%s: option requires an argument -- %c\n"),
726 if (optstring[0] == ':')
732 /* We already incremented `optind' once;
733 increment it again when taking next ARGV-elt as argument. */
734 optarg = argv[optind++];
743 getopt (argc, argv, optstring)
746 const char *optstring;
748 return _getopt_internal (argc, argv, optstring,
749 (const struct option *) 0,
754 #endif /* _LIBC or not __GNU_LIBRARY__. */
758 /* Compile with -DTEST to make an executable for use in testing
759 the above definition of `getopt'. */
767 int digit_optind = 0;
771 int this_option_optind = optind ? optind : 1;
773 c = getopt (argc, argv, "abc:d:0123456789");
789 if (digit_optind != 0 && digit_optind != this_option_optind)
790 printf ("digits occur in two different argv-elements.\n");
791 digit_optind = this_option_optind;
792 printf ("option %c\n", c);
796 printf ("option a\n");
800 printf ("option b\n");
804 printf ("option c with value `%s'\n", optarg);
811 printf ("?? getopt returned character code 0%o ??\n", c);
817 printf ("non-option ARGV-elements: ");
818 while (optind < argc)
819 printf ("%s ", argv[optind++]);