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, 1993
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, 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <sys/cdefs.h>
25 __FBSDID("$FreeBSD$");
\f
26 /* NOTE!!! AIX requires this to be the first thing in the file.
27 Do not put ANYTHING before it! */
28 #if !defined (__GNUC__) && defined (_AIX)
37 #define alloca __builtin_alloca
38 #else /* not __GNUC__ */
39 #if defined (HAVE_ALLOCA_H) || (defined(sparc) && (defined(sun) || (!defined(USG) && !defined(SVR4) && !defined(__svr4__))))
46 #endif /* not __GNUC__ */
48 #if !__STDC__ && !defined(const) && IN_GCC
52 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>. */
60 /* Comment out all this code if we are using the GNU C Library, and are not
61 actually compiling the library itself. This code is part of the GNU C
62 Library, but also included in many other GNU distributions. Compiling
63 and linking in this code is a waste when using the GNU C library
64 (especially if it is a shared library). Rather than having every GNU
65 program understand `configure --with-gnu-libc' and omit the object files,
66 it is simpler to just do this in the source for each such file. */
68 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
71 /* This needs to come after some library #include
72 to get __GNU_LIBRARY__ defined. */
73 #ifdef __GNU_LIBRARY__
75 /* Don't include stdlib.h for non-GNU C libraries because some of them
76 contain conflicting prototypes for getopt. */
78 #else /* Not GNU C library. */
79 #define __alloca alloca
80 #endif /* GNU C library. */
82 /* If GETOPT_COMPAT is defined, `+' as well as `--' can introduce a
83 long-named option. Because this is not POSIX.2 compliant, it is
85 /* #define GETOPT_COMPAT */
87 /* This version of `getopt' appears to the caller like standard Unix `getopt'
88 but it behaves differently for the user, since it allows the user
89 to intersperse the options with the other arguments.
91 As `getopt' works, it permutes the elements of ARGV so that,
92 when it is done, all the options precede everything else. Thus
93 all application programs are extended to handle flexible argument order.
95 Setting the environment variable POSIXLY_CORRECT disables permutation.
96 Then the behavior is completely standard.
98 GNU application programs can use a third alternative mode in which
99 they can distinguish the relative order of options and other arguments. */
103 /* For communication from `getopt' to the caller.
104 When `getopt' finds an option that takes an argument,
105 the argument value is returned here.
106 Also, when `ordering' is RETURN_IN_ORDER,
107 each non-option ARGV-element is returned here. */
111 /* Index in ARGV of the next element to be scanned.
112 This is used for communication to and from the caller
113 and for communication between successive calls to `getopt'.
115 On entry to `getopt', zero means this is the first call; initialize.
117 When `getopt' returns EOF, this is the index of the first of the
118 non-option elements that the caller should itself scan.
120 Otherwise, `optind' communicates from one call to the next
121 how much of ARGV has been scanned so far. */
123 /* XXX 1003.2 says this must be 1 before any call. */
126 /* The next char to be scanned in the option-element
127 in which the last option character we returned was found.
128 This allows us to pick up the scan where we left off.
130 If this is zero, or a null string, it means resume the scan
131 by advancing to the next ARGV-element. */
133 static char *nextchar;
135 /* Callers store zero here to inhibit the error message
136 for unrecognized options. */
140 /* Set to an option character which was unrecognized.
141 This must be initialized on some systems to avoid linking in the
142 system's own getopt implementation. */
146 /* Describe how to deal with options that follow non-option ARGV-elements.
148 If the caller did not specify anything,
149 the default is REQUIRE_ORDER if the environment variable
150 POSIXLY_CORRECT is defined, PERMUTE otherwise.
152 REQUIRE_ORDER means don't recognize them as options;
153 stop option processing when the first non-option is seen.
154 This is what Unix does.
155 This mode of operation is selected by either setting the environment
156 variable POSIXLY_CORRECT, or using `+' as the first character
157 of the list of option characters.
159 PERMUTE is the default. We permute the contents of ARGV as we scan,
160 so that eventually all the non-options are at the end. This allows options
161 to be given in any order, even with programs that were not written to
164 RETURN_IN_ORDER is an option available to programs that were written
165 to expect options and other ARGV-elements in any order and that care about
166 the ordering of the two. We describe each non-option ARGV-element
167 as if it were the argument of an option with character code 1.
168 Using `-' as the first character of the list of option characters
169 selects this mode of operation.
171 The special argument `--' forces an end of option-scanning regardless
172 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
173 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
177 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
180 #ifdef __GNU_LIBRARY__
181 /* We want to avoid inclusion of string.h with non-GNU libraries
182 because there are many ways it can cause trouble.
183 On some systems, it contains special magic macros that don't work
186 #define my_index strchr
187 #define my_bcopy(src, dst, n) memcpy ((dst), (src), (n))
190 /* Avoid depending on library functions or files
191 whose names are inconsistent. */
193 char *getenv(const char *_name);
196 my_index(const char *str, int chr)
208 my_bcopy (from, to, size)
214 for (i = 0; i < size; i++)
217 #endif /* GNU C library. */
219 /* Handle permutation of arguments. */
221 /* Describe the part of ARGV that contains non-options that have
222 been skipped. `first_nonopt' is the index in ARGV of the first of them;
223 `last_nonopt' is the index after the last of them. */
225 static int first_nonopt;
226 static int last_nonopt;
228 /* Exchange two adjacent subsequences of ARGV.
229 One subsequence is elements [first_nonopt,last_nonopt)
230 which contains all the non-options that have been skipped so far.
231 The other is elements [last_nonopt,optind), which contains all
232 the options processed since those non-options were skipped.
234 `first_nonopt' and `last_nonopt' are relocated so that they describe
235 the new indices of the non-options in ARGV after they are moved. */
238 exchange(char **argv)
240 int nonopts_size = (last_nonopt - first_nonopt) * sizeof (char *);
241 char **temp = (char **) __alloca (nonopts_size);
243 /* Interchange the two blocks of data in ARGV. */
245 my_bcopy ((char *) &argv[first_nonopt], (char *) temp, nonopts_size);
246 my_bcopy ((char *) &argv[last_nonopt], (char *) &argv[first_nonopt],
247 (optind - last_nonopt) * sizeof (char *));
248 my_bcopy ((char *) temp,
249 (char *) &argv[first_nonopt + optind - last_nonopt],
252 /* Update records for the slots the non-options now occupy. */
254 first_nonopt += (optind - last_nonopt);
255 last_nonopt = optind;
258 /* Scan elements of ARGV (whose length is ARGC) for option characters
261 If an element of ARGV starts with '-', and is not exactly "-" or "--",
262 then it is an option element. The characters of this element
263 (aside from the initial '-') are option characters. If `getopt'
264 is called repeatedly, it returns successively each of the option characters
265 from each of the option elements.
267 If `getopt' finds another option character, it returns that character,
268 updating `optind' and `nextchar' so that the next call to `getopt' can
269 resume the scan with the following option character or ARGV-element.
271 If there are no more option characters, `getopt' returns `EOF'.
272 Then `optind' is the index in ARGV of the first ARGV-element
273 that is not an option. (The ARGV-elements have been permuted
274 so that those that are not options now come last.)
276 OPTSTRING is a string containing the legitimate option characters.
277 If an option character is seen that is not listed in OPTSTRING,
278 return '?' after printing an error message. If you set `opterr' to
279 zero, the error message is suppressed but we still return '?'.
281 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
282 so the following text in the same ARGV-element, or the text of the following
283 ARGV-element, is returned in `optarg'. Two colons mean an option that
284 wants an optional arg; if there is text in the current ARGV-element,
285 it is returned in `optarg', otherwise `optarg' is set to zero.
287 If OPTSTRING starts with `-' or `+', it requests different methods of
288 handling the non-option ARGV-elements.
289 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
291 Long-named options begin with `--' instead of `-'.
292 Their names may be abbreviated as long as the abbreviation is unique
293 or is an exact match for some defined option. If they have an
294 argument, it follows the option name in the same ARGV-element, separated
295 from the option name by a `=', or else the in next ARGV-element.
296 When `getopt' finds a long-named option, it returns 0 if that option's
297 `flag' field is nonzero, the value of the option's `val' field
298 if the `flag' field is zero.
300 The elements of ARGV aren't really const, because we permute them.
301 But we pretend they're const in the prototype to be compatible
304 LONGOPTS is a vector of `struct option' terminated by an
305 element containing a name which is zero.
307 LONGIND returns the index in LONGOPT of the long-named option found.
308 It is only valid when a long-named option has been found by the most
311 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
312 long-named options. */
315 _getopt_internal(int argc, char *const *argv, const char *optstring,
316 const struct option *longopts, int *longind, int long_only)
322 /* Initialize the internal data when the first call is made.
323 Start processing options with ARGV-element 1 (since ARGV-element 0
324 is the program name); the sequence of previously skipped
325 non-option ARGV-elements is empty. */
329 first_nonopt = last_nonopt = optind = 1;
333 /* Determine how to handle the ordering of options and nonoptions. */
335 if (optstring[0] == '-')
337 ordering = RETURN_IN_ORDER;
340 else if (optstring[0] == '+')
342 ordering = REQUIRE_ORDER;
345 else if (getenv ("POSIXLY_CORRECT") != NULL)
346 ordering = REQUIRE_ORDER;
351 if (nextchar == NULL || *nextchar == '\0')
353 if (ordering == PERMUTE)
355 /* If we have just processed some options following some non-options,
356 exchange them so that the options come first. */
358 if (first_nonopt != last_nonopt && last_nonopt != optind)
359 exchange ((char **) argv);
360 else if (last_nonopt != optind)
361 first_nonopt = optind;
363 /* Now skip any additional non-options
364 and extend the range of non-options previously skipped. */
367 && (argv[optind][0] != '-' || argv[optind][1] == '\0')
370 || argv[optind][0] != '+' || argv[optind][1] == '\0')
371 #endif /* GETOPT_COMPAT */
374 last_nonopt = optind;
377 /* Special ARGV-element `--' means premature end of options.
378 Skip it like a null option,
379 then exchange with previous non-options as if it were an option,
380 then skip everything else like a non-option. */
382 if (optind != argc && !strcmp (argv[optind], "--"))
386 if (first_nonopt != last_nonopt && last_nonopt != optind)
387 exchange ((char **) argv);
388 else if (first_nonopt == last_nonopt)
389 first_nonopt = optind;
395 /* If we have done all the ARGV-elements, stop the scan
396 and back over any non-options that we skipped and permuted. */
400 /* Set the next-arg-index to point at the non-options
401 that we previously skipped, so the caller will digest them. */
402 if (first_nonopt != last_nonopt)
403 optind = first_nonopt;
407 /* If we have come to a non-option and did not permute it,
408 either stop the scan or describe it to the caller and pass it by. */
410 if ((argv[optind][0] != '-' || argv[optind][1] == '\0')
413 || argv[optind][0] != '+' || argv[optind][1] == '\0')
414 #endif /* GETOPT_COMPAT */
417 if (ordering == REQUIRE_ORDER)
419 optarg = argv[optind++];
423 /* We have found another option-ARGV-element.
424 Start decoding its characters. */
426 nextchar = (argv[optind] + 1
427 + (longopts != NULL && argv[optind][1] == '-'));
431 && ((argv[optind][0] == '-'
432 && (argv[optind][1] == '-' || long_only))
434 || argv[optind][0] == '+'
435 #endif /* GETOPT_COMPAT */
438 const struct option *p;
442 const struct option *pfound = NULL;
445 while (*s && *s != '=')
448 /* Test all options for either exact match or abbreviated matches. */
449 for (p = longopts, option_index = 0; p->name;
451 if (!strncmp (p->name, nextchar, s - nextchar))
453 if (s - nextchar == strlen (p->name))
455 /* Exact match found. */
457 indfound = option_index;
461 else if (pfound == NULL)
463 /* First nonexact match found. */
465 indfound = option_index;
468 /* Second nonexact match found. */
475 fprintf (stderr, "%s: option `%s' is ambiguous\n",
476 argv[0], argv[optind]);
477 nextchar += strlen (nextchar);
484 option_index = indfound;
488 /* Don't test has_arg with >, because some C compilers don't
489 allow it to be used on enums. */
496 if (argv[optind - 1][1] == '-')
499 "%s: option `--%s' doesn't allow an argument\n",
500 argv[0], pfound->name);
502 /* +option or -option */
504 "%s: option `%c%s' doesn't allow an argument\n",
505 argv[0], argv[optind - 1][0], pfound->name);
507 nextchar += strlen (nextchar);
511 else if (pfound->has_arg == 1)
514 optarg = argv[optind++];
518 fprintf (stderr, "%s: option `%s' requires an argument\n",
519 argv[0], argv[optind - 1]);
520 nextchar += strlen (nextchar);
521 return optstring[0] == ':' ? ':' : '?';
524 nextchar += strlen (nextchar);
526 *longind = option_index;
529 *(pfound->flag) = pfound->val;
534 /* Can't find it as a long option. If this is not getopt_long_only,
535 or the option starts with '--' or is not a valid short
536 option, then it's an error.
537 Otherwise interpret it as a short option. */
538 if (!long_only || argv[optind][1] == '-'
540 || argv[optind][0] == '+'
541 #endif /* GETOPT_COMPAT */
542 || my_index (optstring, *nextchar) == NULL)
546 if (argv[optind][1] == '-')
548 fprintf (stderr, "%s: unrecognized option `--%s'\n",
551 /* +option or -option */
552 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
553 argv[0], argv[optind][0], nextchar);
555 nextchar = (char *) "";
561 /* Look at and handle the next option-character. */
564 char c = *nextchar++;
565 char *temp = my_index (optstring, c);
567 /* Increment `optind' when we start to process its last character. */
568 if (*nextchar == '\0')
571 if (temp == NULL || c == ':')
576 if (c < 040 || c >= 0177)
577 fprintf (stderr, "%s: unrecognized option, character code 0%o\n",
580 fprintf (stderr, "%s: unrecognized option `-%c'\n", argv[0], c);
582 /* 1003.2 specifies the format of this message. */
583 fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
593 /* This is an option that accepts an argument optionally. */
594 if (*nextchar != '\0')
605 /* This is an option that requires an argument. */
606 if (*nextchar != '\0')
609 /* If we end this ARGV-element by taking the rest as an arg,
610 we must advance to the next element now. */
613 else if (optind == argc)
618 fprintf (stderr, "%s: option `-%c' requires an argument\n",
621 /* 1003.2 specifies the format of this message. */
622 fprintf (stderr, "%s: option requires an argument -- %c\n",
627 if (optstring[0] == ':')
633 /* We already incremented `optind' once;
634 increment it again when taking next ARGV-elt as argument. */
635 optarg = argv[optind++];
644 getopt(int argc, char *const *argv, const char *optstring)
646 return _getopt_internal (argc, argv, optstring,
647 (const struct option *) 0,
652 #endif /* _LIBC or not __GNU_LIBRARY__. */
656 /* Compile with -DTEST to make an executable for use in testing
657 the above definition of `getopt'. */
665 int digit_optind = 0;
669 int this_option_optind = optind ? optind : 1;
671 c = getopt (argc, argv, "abc:d:0123456789");
687 if (digit_optind != 0 && digit_optind != this_option_optind)
688 printf ("digits occur in two different argv-elements.\n");
689 digit_optind = this_option_optind;
690 printf ("option %c\n", c);
694 printf ("option a\n");
698 printf ("option b\n");
702 printf ("option c with value `%s'\n", optarg);
709 printf ("?? getopt returned character code 0%o ??\n", c);
715 printf ("non-option ARGV-elements: ");
716 while (optind < argc)
717 printf ("%s ", argv[optind++]);