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. */
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)
29 #include <string.h> //for strncmp
39 #define alloca __builtin_alloca
40 #else /* not __GNUC__ */
41 #if defined (HAVE_ALLOCA_H) || (defined(sparc) && (defined(sun) || (!defined(USG) && !defined(SVR4) && !defined(__svr4__))))
44 #if !defined (_AIX) && !defined (WIN32)
48 #endif /* not __GNUC__ */
50 #if !__STDC__ && !defined(const) && IN_GCC
54 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>. */
61 /* Comment out all this code if we are using the GNU C Library, and are not
62 actually compiling the library itself. This code is part of the GNU C
63 Library, but also included in many other GNU distributions. Compiling
64 and linking in this code is a waste when using the GNU C library
65 (especially if it is a shared library). Rather than having every GNU
66 program understand `configure --with-gnu-libc' and omit the object files,
67 it is simpler to just do this in the source for each such file. */
69 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
72 /* This needs to come after some library #include
73 to get __GNU_LIBRARY__ defined. */
74 #ifdef __GNU_LIBRARY__
76 /* Don't include stdlib.h for non-GNU C libraries because some of them
77 contain conflicting prototypes for getopt. */
79 #else /* Not GNU C library. */
80 #define __alloca alloca
81 #endif /* GNU C library. */
83 /* If GETOPT_COMPAT is defined, `+' as well as `--' can introduce a
84 long-named option. Because this is not POSIX.2 compliant, it is
86 /* #define GETOPT_COMPAT */
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 #ifdef __GNU_LIBRARY__
182 /* We want to avoid inclusion of string.h with non-GNU libraries
183 because there are many ways it can cause trouble.
184 On some systems, it contains special magic macros that don't work
187 #define my_index strchr
188 #define my_bcopy(src, dst, n) memcpy ((dst), (src), (n))
191 /* Avoid depending on library functions or files
192 whose names are inconsistent. */
211 my_bcopy (from, to, size)
217 for (i = 0; i < size; i++)
220 #endif /* GNU C library. */
222 /* Handle permutation of arguments. */
224 /* Describe the part of ARGV that contains non-options that have
225 been skipped. `first_nonopt' is the index in ARGV of the first of them;
226 `last_nonopt' is the index after the last of them. */
228 static int first_nonopt;
229 static int last_nonopt;
231 /* Exchange two adjacent subsequences of ARGV.
232 One subsequence is elements [first_nonopt,last_nonopt)
233 which contains all the non-options that have been skipped so far.
234 The other is elements [last_nonopt,optind), which contains all
235 the options processed since those non-options were skipped.
237 `first_nonopt' and `last_nonopt' are relocated so that they describe
238 the new indices of the non-options in ARGV after they are moved. */
244 int nonopts_size = (last_nonopt - first_nonopt) * sizeof (char *);
245 char **temp = (char **) __alloca (nonopts_size);
247 /* Interchange the two blocks of data in ARGV. */
249 my_bcopy ((char *) &argv[first_nonopt], (char *) temp, nonopts_size);
250 my_bcopy ((char *) &argv[last_nonopt], (char *) &argv[first_nonopt],
251 (optind - last_nonopt) * sizeof (char *));
252 my_bcopy ((char *) temp,
253 (char *) &argv[first_nonopt + optind - last_nonopt],
256 /* Update records for the slots the non-options now occupy. */
258 first_nonopt += (optind - last_nonopt);
259 last_nonopt = optind;
262 /* Scan elements of ARGV (whose length is ARGC) for option characters
265 If an element of ARGV starts with '-', and is not exactly "-" or "--",
266 then it is an option element. The characters of this element
267 (aside from the initial '-') are option characters. If `getopt'
268 is called repeatedly, it returns successively each of the option characters
269 from each of the option elements.
271 If `getopt' finds another option character, it returns that character,
272 updating `optind' and `nextchar' so that the next call to `getopt' can
273 resume the scan with the following option character or ARGV-element.
275 If there are no more option characters, `getopt' returns `EOF'.
276 Then `optind' is the index in ARGV of the first ARGV-element
277 that is not an option. (The ARGV-elements have been permuted
278 so that those that are not options now come last.)
280 OPTSTRING is a string containing the legitimate option characters.
281 If an option character is seen that is not listed in OPTSTRING,
282 return '?' after printing an error message. If you set `opterr' to
283 zero, the error message is suppressed but we still return '?'.
285 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
286 so the following text in the same ARGV-element, or the text of the following
287 ARGV-element, is returned in `optarg'. Two colons mean an option that
288 wants an optional arg; if there is text in the current ARGV-element,
289 it is returned in `optarg', otherwise `optarg' is set to zero.
291 If OPTSTRING starts with `-' or `+', it requests different methods of
292 handling the non-option ARGV-elements.
293 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
295 Long-named options begin with `--' instead of `-'.
296 Their names may be abbreviated as long as the abbreviation is unique
297 or is an exact match for some defined option. If they have an
298 argument, it follows the option name in the same ARGV-element, separated
299 from the option name by a `=', or else the in next ARGV-element.
300 When `getopt' finds a long-named option, it returns 0 if that option's
301 `flag' field is nonzero, the value of the option's `val' field
302 if the `flag' field is zero.
304 The elements of ARGV aren't really const, because we permute them.
305 But we pretend they're const in the prototype to be compatible
308 LONGOPTS is a vector of `struct option' terminated by an
309 element containing a name which is zero.
311 LONGIND returns the index in LONGOPT of the long-named option found.
312 It is only valid when a long-named option has been found by the most
315 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
316 long-named options. */
319 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
322 const char *optstring;
323 const struct option *longopts;
331 /* Initialize the internal data when the first call is made.
332 Start processing options with ARGV-element 1 (since ARGV-element 0
333 is the program name); the sequence of previously skipped
334 non-option ARGV-elements is empty. */
338 first_nonopt = last_nonopt = optind = 1;
342 /* Determine how to handle the ordering of options and nonoptions. */
344 if (optstring[0] == '-')
346 ordering = RETURN_IN_ORDER;
349 else if (optstring[0] == '+')
351 ordering = REQUIRE_ORDER;
354 else if (getenv ("POSIXLY_CORRECT") != NULL)
355 ordering = REQUIRE_ORDER;
360 if (nextchar == NULL || *nextchar == '\0')
362 if (ordering == PERMUTE)
364 /* If we have just processed some options following some non-options,
365 exchange them so that the options come first. */
367 if (first_nonopt != last_nonopt && last_nonopt != optind)
368 exchange ((char **) argv);
369 else if (last_nonopt != optind)
370 first_nonopt = optind;
372 /* Now skip any additional non-options
373 and extend the range of non-options previously skipped. */
376 && (argv[optind][0] != '-' || argv[optind][1] == '\0')
379 || argv[optind][0] != '+' || argv[optind][1] == '\0')
380 #endif /* GETOPT_COMPAT */
383 last_nonopt = optind;
386 /* Special ARGV-element `--' means premature end of options.
387 Skip it like a null option,
388 then exchange with previous non-options as if it were an option,
389 then skip everything else like a non-option. */
391 if (optind != argc && !strcmp (argv[optind], "--"))
395 if (first_nonopt != last_nonopt && last_nonopt != optind)
396 exchange ((char **) argv);
397 else if (first_nonopt == last_nonopt)
398 first_nonopt = optind;
404 /* If we have done all the ARGV-elements, stop the scan
405 and back over any non-options that we skipped and permuted. */
409 /* Set the next-arg-index to point at the non-options
410 that we previously skipped, so the caller will digest them. */
411 if (first_nonopt != last_nonopt)
412 optind = first_nonopt;
416 /* If we have come to a non-option and did not permute it,
417 either stop the scan or describe it to the caller and pass it by. */
419 if ((argv[optind][0] != '-' || argv[optind][1] == '\0')
422 || argv[optind][0] != '+' || argv[optind][1] == '\0')
423 #endif /* GETOPT_COMPAT */
426 if (ordering == REQUIRE_ORDER)
428 optarg = argv[optind++];
432 /* We have found another option-ARGV-element.
433 Start decoding its characters. */
435 nextchar = (argv[optind] + 1
436 + (longopts != NULL && argv[optind][1] == '-'));
440 && ((argv[optind][0] == '-'
441 && (argv[optind][1] == '-' || long_only))
443 || argv[optind][0] == '+'
444 #endif /* GETOPT_COMPAT */
447 const struct option *p;
451 const struct option *pfound = NULL;
454 while (*s && *s != '=')
457 /* Test all options for either exact match or abbreviated matches. */
458 for (p = longopts, option_index = 0; p->name;
460 if (!strncmp (p->name, nextchar, s - nextchar))
462 if ((size_t)(s - nextchar) == strlen (p->name))
464 /* Exact match found. */
466 indfound = option_index;
470 else if (pfound == NULL)
472 /* First nonexact match found. */
474 indfound = option_index;
477 /* Second nonexact match found. */
484 fprintf (stderr, "%s: option `%s' is ambiguous\n",
485 argv[0], argv[optind]);
486 nextchar += strlen (nextchar);
493 option_index = indfound;
497 /* Don't test has_arg with >, because some C compilers don't
498 allow it to be used on enums. */
505 if (argv[optind - 1][1] == '-')
508 "%s: option `--%s' doesn't allow an argument\n",
509 argv[0], pfound->name);
511 /* +option or -option */
513 "%s: option `%c%s' doesn't allow an argument\n",
514 argv[0], argv[optind - 1][0], pfound->name);
516 nextchar += strlen (nextchar);
520 else if (pfound->has_arg == 1)
523 optarg = argv[optind++];
527 fprintf (stderr, "%s: option `%s' requires an argument\n",
528 argv[0], argv[optind - 1]);
529 nextchar += strlen (nextchar);
530 return optstring[0] == ':' ? ':' : '?';
533 nextchar += strlen (nextchar);
535 *longind = option_index;
538 *(pfound->flag) = pfound->val;
543 /* Can't find it as a long option. If this is not getopt_long_only,
544 or the option starts with '--' or is not a valid short
545 option, then it's an error.
546 Otherwise interpret it as a short option. */
547 if (!long_only || argv[optind][1] == '-'
549 || argv[optind][0] == '+'
550 #endif /* GETOPT_COMPAT */
551 || my_index (optstring, *nextchar) == NULL)
555 if (argv[optind][1] == '-')
557 fprintf (stderr, "%s: unrecognized option `--%s'\n",
560 /* +option or -option */
561 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
562 argv[0], argv[optind][0], nextchar);
564 nextchar = (char *) "";
570 /* Look at and handle the next option-character. */
573 char c = *nextchar++;
574 char *temp = my_index (optstring, c);
576 /* Increment `optind' when we start to process its last character. */
577 if (*nextchar == '\0')
580 if (temp == NULL || c == ':')
585 if (c < 040 || c >= 0177)
586 fprintf (stderr, "%s: unrecognized option, character code 0%o\n",
589 fprintf (stderr, "%s: unrecognized option `-%c'\n", argv[0], c);
591 /* 1003.2 specifies the format of this message. */
592 fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
602 /* This is an option that accepts an argument optionally. */
603 if (*nextchar != '\0')
614 /* This is an option that requires an argument. */
615 if (*nextchar != '\0')
618 /* If we end this ARGV-element by taking the rest as an arg,
619 we must advance to the next element now. */
622 else if (optind == argc)
627 fprintf (stderr, "%s: option `-%c' requires an argument\n",
630 /* 1003.2 specifies the format of this message. */
631 fprintf (stderr, "%s: option requires an argument -- %c\n",
636 if (optstring[0] == ':')
642 /* We already incremented `optind' once;
643 increment it again when taking next ARGV-elt as argument. */
644 optarg = argv[optind++];
653 getopt (argc, argv, optstring)
656 const char *optstring;
658 return _getopt_internal (argc, argv, optstring,
659 (const struct option *) 0,
664 #endif /* _LIBC or not __GNU_LIBRARY__. */
668 /* Compile with -DTEST to make an executable for use in testing
669 the above definition of `getopt'. */
677 int digit_optind = 0;
681 int this_option_optind = optind ? optind : 1;
683 c = getopt (argc, argv, "abc:d:0123456789");
699 if (digit_optind != 0 && digit_optind != this_option_optind)
700 printf ("digits occur in two different argv-elements.\n");
701 digit_optind = this_option_optind;
702 printf ("option %c\n", c);
706 printf ("option a\n");
710 printf ("option b\n");
714 printf ("option c with value `%s'\n", optarg);
721 printf ("?? getopt returned character code 0%o ??\n", c);
727 printf ("non-option ARGV-elements: ");
728 while (optind < argc)
729 printf ("%s ", argv[optind++]);