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 3, 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. */
23 /* NOTE!!! AIX requires this to be the first thing in the file.
24 Do not put ANYTHING before it! */
25 #if !defined (__GNUC__) && defined (_AIX)
34 #define alloca __builtin_alloca
35 #else /* not __GNUC__ */
36 #if defined (HAVE_ALLOCA_H) || (defined(sparc) && (defined(sun) || (!defined(USG) && !defined(SVR4) && !defined(__svr4__))))
43 #endif /* not __GNUC__ */
45 #if !__STDC__ && !defined(const) && IN_GCC
49 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>. */
56 /* Comment out all this code if we are using the GNU C Library, and are not
57 actually compiling the library itself. This code is part of the GNU C
58 Library, but also included in many other GNU distributions. Compiling
59 and linking in this code is a waste when using the GNU C library
60 (especially if it is a shared library). Rather than having every GNU
61 program understand `configure --with-gnu-libc' and omit the object files,
62 it is simpler to just do this in the source for each such file. */
64 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
67 /* This needs to come after some library #include
68 to get __GNU_LIBRARY__ defined. */
69 #ifdef __GNU_LIBRARY__
71 /* Don't include stdlib.h for non-GNU C libraries because some of them
72 contain conflicting prototypes for getopt. */
74 #else /* Not GNU C library. */
75 #define __alloca alloca
76 #endif /* GNU C library. */
78 /* If GETOPT_COMPAT is defined, `+' as well as `--' can introduce a
79 long-named option. Because this is not POSIX.2 compliant, it is
81 /* #define GETOPT_COMPAT */
83 /* This version of `getopt' appears to the caller like standard Unix `getopt'
84 but it behaves differently for the user, since it allows the user
85 to intersperse the options with the other arguments.
87 As `getopt' works, it permutes the elements of ARGV so that,
88 when it is done, all the options precede everything else. Thus
89 all application programs are extended to handle flexible argument order.
91 Setting the environment variable POSIXLY_CORRECT disables permutation.
92 Then the behavior is completely standard.
94 GNU application programs can use a third alternative mode in which
95 they can distinguish the relative order of options and other arguments. */
99 /* For communication from `getopt' to the caller.
100 When `getopt' finds an option that takes an argument,
101 the argument value is returned here.
102 Also, when `ordering' is RETURN_IN_ORDER,
103 each non-option ARGV-element is returned here. */
107 /* Index in ARGV of the next element to be scanned.
108 This is used for communication to and from the caller
109 and for communication between successive calls to `getopt'.
111 On entry to `getopt', zero means this is the first call; initialize.
113 When `getopt' returns EOF, this is the index of the first of the
114 non-option elements that the caller should itself scan.
116 Otherwise, `optind' communicates from one call to the next
117 how much of ARGV has been scanned so far. */
119 /* XXX 1003.2 says this must be 1 before any call. */
122 /* The next char to be scanned in the option-element
123 in which the last option character we returned was found.
124 This allows us to pick up the scan where we left off.
126 If this is zero, or a null string, it means resume the scan
127 by advancing to the next ARGV-element. */
129 static char *nextchar;
131 /* Callers store zero here to inhibit the error message
132 for unrecognized options. */
136 /* Set to an option character which was unrecognized.
137 This must be initialized on some systems to avoid linking in the
138 system's own getopt implementation. */
142 /* Describe how to deal with options that follow non-option ARGV-elements.
144 If the caller did not specify anything,
145 the default is REQUIRE_ORDER if the environment variable
146 POSIXLY_CORRECT is defined, PERMUTE otherwise.
148 REQUIRE_ORDER means don't recognize them as options;
149 stop option processing when the first non-option is seen.
150 This is what Unix does.
151 This mode of operation is selected by either setting the environment
152 variable POSIXLY_CORRECT, or using `+' as the first character
153 of the list of option characters.
155 PERMUTE is the default. We permute the contents of ARGV as we scan,
156 so that eventually all the non-options are at the end. This allows options
157 to be given in any order, even with programs that were not written to
160 RETURN_IN_ORDER is an option available to programs that were written
161 to expect options and other ARGV-elements in any order and that care about
162 the ordering of the two. We describe each non-option ARGV-element
163 as if it were the argument of an option with character code 1.
164 Using `-' as the first character of the list of option characters
165 selects this mode of operation.
167 The special argument `--' forces an end of option-scanning regardless
168 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
169 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
173 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
176 #ifdef __GNU_LIBRARY__
177 /* We want to avoid inclusion of string.h with non-GNU libraries
178 because there are many ways it can cause trouble.
179 On some systems, it contains special magic macros that don't work
182 #define my_index strchr
183 #define my_bcopy(src, dst, n) memcpy ((dst), (src), (n))
186 /* Avoid depending on library functions or files
187 whose names are inconsistent. */
206 my_bcopy (from, to, size)
212 for (i = 0; i < size; i++)
215 #endif /* GNU C library. */
217 /* Handle permutation of arguments. */
219 /* Describe the part of ARGV that contains non-options that have
220 been skipped. `first_nonopt' is the index in ARGV of the first of them;
221 `last_nonopt' is the index after the last of them. */
223 static int first_nonopt;
224 static int last_nonopt;
226 /* Exchange two adjacent subsequences of ARGV.
227 One subsequence is elements [first_nonopt,last_nonopt)
228 which contains all the non-options that have been skipped so far.
229 The other is elements [last_nonopt,optind), which contains all
230 the options processed since those non-options were skipped.
232 `first_nonopt' and `last_nonopt' are relocated so that they describe
233 the new indices of the non-options in ARGV after they are moved. */
239 int nonopts_size = (last_nonopt - first_nonopt) * sizeof (char *);
240 char **temp = (char **) __alloca (nonopts_size);
242 /* Interchange the two blocks of data in ARGV. */
244 my_bcopy ((char *) &argv[first_nonopt], (char *) temp, nonopts_size);
245 my_bcopy ((char *) &argv[last_nonopt], (char *) &argv[first_nonopt],
246 (optind - last_nonopt) * sizeof (char *));
247 my_bcopy ((char *) temp,
248 (char *) &argv[first_nonopt + optind - last_nonopt],
251 /* Update records for the slots the non-options now occupy. */
253 first_nonopt += (optind - last_nonopt);
254 last_nonopt = optind;
257 /* Scan elements of ARGV (whose length is ARGC) for option characters
260 If an element of ARGV starts with '-', and is not exactly "-" or "--",
261 then it is an option element. The characters of this element
262 (aside from the initial '-') are option characters. If `getopt'
263 is called repeatedly, it returns successively each of the option characters
264 from each of the option elements.
266 If `getopt' finds another option character, it returns that character,
267 updating `optind' and `nextchar' so that the next call to `getopt' can
268 resume the scan with the following option character or ARGV-element.
270 If there are no more option characters, `getopt' returns `EOF'.
271 Then `optind' is the index in ARGV of the first ARGV-element
272 that is not an option. (The ARGV-elements have been permuted
273 so that those that are not options now come last.)
275 OPTSTRING is a string containing the legitimate option characters.
276 If an option character is seen that is not listed in OPTSTRING,
277 return '?' after printing an error message. If you set `opterr' to
278 zero, the error message is suppressed but we still return '?'.
280 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
281 so the following text in the same ARGV-element, or the text of the following
282 ARGV-element, is returned in `optarg'. Two colons mean an option that
283 wants an optional arg; if there is text in the current ARGV-element,
284 it is returned in `optarg', otherwise `optarg' is set to zero.
286 If OPTSTRING starts with `-' or `+', it requests different methods of
287 handling the non-option ARGV-elements.
288 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
290 Long-named options begin with `--' instead of `-'.
291 Their names may be abbreviated as long as the abbreviation is unique
292 or is an exact match for some defined option. If they have an
293 argument, it follows the option name in the same ARGV-element, separated
294 from the option name by a `=', or else the in next ARGV-element.
295 When `getopt' finds a long-named option, it returns 0 if that option's
296 `flag' field is nonzero, the value of the option's `val' field
297 if the `flag' field is zero.
299 The elements of ARGV aren't really const, because we permute them.
300 But we pretend they're const in the prototype to be compatible
303 LONGOPTS is a vector of `struct option' terminated by an
304 element containing a name which is zero.
306 LONGIND returns the index in LONGOPT of the long-named option found.
307 It is only valid when a long-named option has been found by the most
310 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
311 long-named options. */
314 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
317 const char *optstring;
318 const struct option *longopts;
326 /* Initialize the internal data when the first call is made.
327 Start processing options with ARGV-element 1 (since ARGV-element 0
328 is the program name); the sequence of previously skipped
329 non-option ARGV-elements is empty. */
333 first_nonopt = last_nonopt = optind = 1;
337 /* Determine how to handle the ordering of options and nonoptions. */
339 if (optstring[0] == '-')
341 ordering = RETURN_IN_ORDER;
344 else if (optstring[0] == '+')
346 ordering = REQUIRE_ORDER;
349 else if (getenv ("POSIXLY_CORRECT") != NULL)
350 ordering = REQUIRE_ORDER;
355 if (nextchar == NULL || *nextchar == '\0')
357 if (ordering == PERMUTE)
359 /* If we have just processed some options following some non-options,
360 exchange them so that the options come first. */
362 if (first_nonopt != last_nonopt && last_nonopt != optind)
363 exchange ((char **) argv);
364 else if (last_nonopt != optind)
365 first_nonopt = optind;
367 /* Now skip any additional non-options
368 and extend the range of non-options previously skipped. */
371 && (argv[optind][0] != '-' || argv[optind][1] == '\0')
374 || argv[optind][0] != '+' || argv[optind][1] == '\0')
375 #endif /* GETOPT_COMPAT */
378 last_nonopt = optind;
381 /* Special ARGV-element `--' means premature end of options.
382 Skip it like a null option,
383 then exchange with previous non-options as if it were an option,
384 then skip everything else like a non-option. */
386 if (optind != argc && !strcmp (argv[optind], "--"))
390 if (first_nonopt != last_nonopt && last_nonopt != optind)
391 exchange ((char **) argv);
392 else if (first_nonopt == last_nonopt)
393 first_nonopt = optind;
399 /* If we have done all the ARGV-elements, stop the scan
400 and back over any non-options that we skipped and permuted. */
404 /* Set the next-arg-index to point at the non-options
405 that we previously skipped, so the caller will digest them. */
406 if (first_nonopt != last_nonopt)
407 optind = first_nonopt;
411 /* If we have come to a non-option and did not permute it,
412 either stop the scan or describe it to the caller and pass it by. */
414 if ((argv[optind][0] != '-' || argv[optind][1] == '\0')
417 || argv[optind][0] != '+' || argv[optind][1] == '\0')
418 #endif /* GETOPT_COMPAT */
421 if (ordering == REQUIRE_ORDER)
423 optarg = argv[optind++];
427 /* We have found another option-ARGV-element.
428 Start decoding its characters. */
430 nextchar = (argv[optind] + 1
431 + (longopts != NULL && argv[optind][1] == '-'));
435 && ((argv[optind][0] == '-'
436 && (argv[optind][1] == '-' || long_only))
438 || argv[optind][0] == '+'
439 #endif /* GETOPT_COMPAT */
442 const struct option *p;
446 const struct option *pfound = NULL;
449 while (*s && *s != '=')
452 /* Test all options for either exact match or abbreviated matches. */
453 for (p = longopts, option_index = 0; p->name;
455 if (!strncmp (p->name, nextchar, s - nextchar))
457 if (s - nextchar == strlen (p->name))
459 /* Exact match found. */
461 indfound = option_index;
465 else if (pfound == NULL)
467 /* First nonexact match found. */
469 indfound = option_index;
472 /* Second nonexact match found. */
479 fprintf (stderr, "%s: option `%s' is ambiguous\n",
480 argv[0], argv[optind]);
481 nextchar += strlen (nextchar);
488 option_index = indfound;
492 /* Don't test has_arg with >, because some C compilers don't
493 allow it to be used on enums. */
500 if (argv[optind - 1][1] == '-')
503 "%s: option `--%s' doesn't allow an argument\n",
504 argv[0], pfound->name);
506 /* +option or -option */
508 "%s: option `%c%s' doesn't allow an argument\n",
509 argv[0], argv[optind - 1][0], pfound->name);
511 nextchar += strlen (nextchar);
515 else if (pfound->has_arg == 1)
518 optarg = argv[optind++];
522 fprintf (stderr, "%s: option `%s' requires an argument\n",
523 argv[0], argv[optind - 1]);
524 nextchar += strlen (nextchar);
525 return optstring[0] == ':' ? ':' : '?';
528 nextchar += strlen (nextchar);
530 *longind = option_index;
533 *(pfound->flag) = pfound->val;
538 /* Can't find it as a long option. If this is not getopt_long_only,
539 or the option starts with '--' or is not a valid short
540 option, then it's an error.
541 Otherwise interpret it as a short option. */
542 if (!long_only || argv[optind][1] == '-'
544 || argv[optind][0] == '+'
545 #endif /* GETOPT_COMPAT */
546 || my_index (optstring, *nextchar) == NULL)
550 if (argv[optind][1] == '-')
552 fprintf (stderr, "%s: unrecognized option `--%s'\n",
555 /* +option or -option */
556 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
557 argv[0], argv[optind][0], nextchar);
559 nextchar = (char *) "";
565 /* Look at and handle the next option-character. */
568 char c = *nextchar++;
569 char *temp = my_index (optstring, c);
571 /* Increment `optind' when we start to process its last character. */
572 if (*nextchar == '\0')
575 if (temp == NULL || c == ':')
580 if (c < 040 || c >= 0177)
581 fprintf (stderr, "%s: unrecognized option, character code 0%o\n",
584 fprintf (stderr, "%s: unrecognized option `-%c'\n", argv[0], c);
586 /* 1003.2 specifies the format of this message. */
587 fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
597 /* This is an option that accepts an argument optionally. */
598 if (*nextchar != '\0')
609 /* This is an option that requires an argument. */
610 if (*nextchar != '\0')
613 /* If we end this ARGV-element by taking the rest as an arg,
614 we must advance to the next element now. */
617 else if (optind == argc)
622 fprintf (stderr, "%s: option `-%c' requires an argument\n",
625 /* 1003.2 specifies the format of this message. */
626 fprintf (stderr, "%s: option requires an argument -- %c\n",
631 if (optstring[0] == ':')
637 /* We already incremented `optind' once;
638 increment it again when taking next ARGV-elt as argument. */
639 optarg = argv[optind++];
649 getopt (argc, argv, optstring)
652 const char *optstring;
654 return _getopt_internal (argc, argv, optstring,
655 (const struct option *) 0,
661 #endif /* _LIBC or not __GNU_LIBRARY__. */
665 /* Compile with -DTEST to make an executable for use in testing
666 the above definition of `getopt'. */
674 int digit_optind = 0;
678 int this_option_optind = optind ? optind : 1;
680 c = getopt (argc, argv, "abc:d:0123456789");
696 if (digit_optind != 0 && digit_optind != this_option_optind)
697 printf ("digits occur in two different argv-elements.\n");
698 digit_optind = this_option_optind;
699 printf ("option %c\n", c);
703 printf ("option a\n");
707 printf ("option b\n");
711 printf ("option c with value `%s'\n", optarg);
718 printf ("?? getopt returned character code 0%o ??\n", c);
724 printf ("non-option ARGV-elements: ");
725 while (optind < argc)
726 printf ("%s ", argv[optind++]);