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>. */
57 /* Comment out all this code if we are using the GNU C Library, and are not
58 actually compiling the library itself. This code is part of the GNU C
59 Library, but also included in many other GNU distributions. Compiling
60 and linking in this code is a waste when using the GNU C library
61 (especially if it is a shared library). Rather than having every GNU
62 program understand `configure --with-gnu-libc' and omit the object files,
63 it is simpler to just do this in the source for each such file. */
65 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
68 /* This needs to come after some library #include
69 to get __GNU_LIBRARY__ defined. */
70 #ifdef __GNU_LIBRARY__
72 /* Don't include stdlib.h for non-GNU C libraries because some of them
73 contain conflicting prototypes for getopt. */
75 #else /* Not GNU C library. */
76 #define __alloca alloca
77 #endif /* GNU C library. */
79 /* If GETOPT_COMPAT is defined, `+' as well as `--' can introduce a
80 long-named option. Because this is not POSIX.2 compliant, it is
82 /* #define GETOPT_COMPAT */
84 /* This version of `getopt' appears to the caller like standard Unix `getopt'
85 but it behaves differently for the user, since it allows the user
86 to intersperse the options with the other arguments.
88 As `getopt' works, it permutes the elements of ARGV so that,
89 when it is done, all the options precede everything else. Thus
90 all application programs are extended to handle flexible argument order.
92 Setting the environment variable POSIXLY_CORRECT disables permutation.
93 Then the behavior is completely standard.
95 GNU application programs can use a third alternative mode in which
96 they can distinguish the relative order of options and other arguments. */
100 /* For communication from `getopt' to the caller.
101 When `getopt' finds an option that takes an argument,
102 the argument value is returned here.
103 Also, when `ordering' is RETURN_IN_ORDER,
104 each non-option ARGV-element is returned here. */
108 /* Index in ARGV of the next element to be scanned.
109 This is used for communication to and from the caller
110 and for communication between successive calls to `getopt'.
112 On entry to `getopt', zero means this is the first call; initialize.
114 When `getopt' returns EOF, this is the index of the first of the
115 non-option elements that the caller should itself scan.
117 Otherwise, `optind' communicates from one call to the next
118 how much of ARGV has been scanned so far. */
120 /* XXX 1003.2 says this must be 1 before any call. */
123 /* The next char to be scanned in the option-element
124 in which the last option character we returned was found.
125 This allows us to pick up the scan where we left off.
127 If this is zero, or a null string, it means resume the scan
128 by advancing to the next ARGV-element. */
130 static char *nextchar;
132 /* Callers store zero here to inhibit the error message
133 for unrecognized options. */
137 /* Set to an option character which was unrecognized.
138 This must be initialized on some systems to avoid linking in the
139 system's own getopt implementation. */
143 /* Describe how to deal with options that follow non-option ARGV-elements.
145 If the caller did not specify anything,
146 the default is REQUIRE_ORDER if the environment variable
147 POSIXLY_CORRECT is defined, PERMUTE otherwise.
149 REQUIRE_ORDER means don't recognize them as options;
150 stop option processing when the first non-option is seen.
151 This is what Unix does.
152 This mode of operation is selected by either setting the environment
153 variable POSIXLY_CORRECT, or using `+' as the first character
154 of the list of option characters.
156 PERMUTE is the default. We permute the contents of ARGV as we scan,
157 so that eventually all the non-options are at the end. This allows options
158 to be given in any order, even with programs that were not written to
161 RETURN_IN_ORDER is an option available to programs that were written
162 to expect options and other ARGV-elements in any order and that care about
163 the ordering of the two. We describe each non-option ARGV-element
164 as if it were the argument of an option with character code 1.
165 Using `-' as the first character of the list of option characters
166 selects this mode of operation.
168 The special argument `--' forces an end of option-scanning regardless
169 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
170 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
174 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
177 #ifdef __GNU_LIBRARY__
178 /* We want to avoid inclusion of string.h with non-GNU libraries
179 because there are many ways it can cause trouble.
180 On some systems, it contains special magic macros that don't work
183 #define my_index strchr
184 #define my_bcopy(src, dst, n) memcpy ((dst), (src), (n))
187 /* Avoid depending on library functions or files
188 whose names are inconsistent. */
207 my_bcopy (from, to, size)
213 for (i = 0; i < size; i++)
216 #endif /* GNU C library. */
218 /* Handle permutation of arguments. */
220 /* Describe the part of ARGV that contains non-options that have
221 been skipped. `first_nonopt' is the index in ARGV of the first of them;
222 `last_nonopt' is the index after the last of them. */
224 static int first_nonopt;
225 static int last_nonopt;
227 /* Exchange two adjacent subsequences of ARGV.
228 One subsequence is elements [first_nonopt,last_nonopt)
229 which contains all the non-options that have been skipped so far.
230 The other is elements [last_nonopt,optind), which contains all
231 the options processed since those non-options were skipped.
233 `first_nonopt' and `last_nonopt' are relocated so that they describe
234 the new indices of the non-options in ARGV after they are moved. */
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 (argc, argv, optstring, longopts, longind, long_only)
318 const char *optstring;
319 const struct option *longopts;
327 /* Initialize the internal data when the first call is made.
328 Start processing options with ARGV-element 1 (since ARGV-element 0
329 is the program name); the sequence of previously skipped
330 non-option ARGV-elements is empty. */
334 first_nonopt = last_nonopt = optind = 1;
338 /* Determine how to handle the ordering of options and nonoptions. */
340 if (optstring[0] == '-')
342 ordering = RETURN_IN_ORDER;
345 else if (optstring[0] == '+')
347 ordering = REQUIRE_ORDER;
350 else if (getenv ("POSIXLY_CORRECT") != NULL)
351 ordering = REQUIRE_ORDER;
356 if (nextchar == NULL || *nextchar == '\0')
358 if (ordering == PERMUTE)
360 /* If we have just processed some options following some non-options,
361 exchange them so that the options come first. */
363 if (first_nonopt != last_nonopt && last_nonopt != optind)
364 exchange ((char **) argv);
365 else if (last_nonopt != optind)
366 first_nonopt = optind;
368 /* Now skip any additional non-options
369 and extend the range of non-options previously skipped. */
372 && (argv[optind][0] != '-' || argv[optind][1] == '\0')
375 || argv[optind][0] != '+' || argv[optind][1] == '\0')
376 #endif /* GETOPT_COMPAT */
379 last_nonopt = optind;
382 /* Special ARGV-element `--' means premature end of options.
383 Skip it like a null option,
384 then exchange with previous non-options as if it were an option,
385 then skip everything else like a non-option. */
387 if (optind != argc && !strcmp (argv[optind], "--"))
391 if (first_nonopt != last_nonopt && last_nonopt != optind)
392 exchange ((char **) argv);
393 else if (first_nonopt == last_nonopt)
394 first_nonopt = optind;
400 /* If we have done all the ARGV-elements, stop the scan
401 and back over any non-options that we skipped and permuted. */
405 /* Set the next-arg-index to point at the non-options
406 that we previously skipped, so the caller will digest them. */
407 if (first_nonopt != last_nonopt)
408 optind = first_nonopt;
412 /* If we have come to a non-option and did not permute it,
413 either stop the scan or describe it to the caller and pass it by. */
415 if ((argv[optind][0] != '-' || argv[optind][1] == '\0')
418 || argv[optind][0] != '+' || argv[optind][1] == '\0')
419 #endif /* GETOPT_COMPAT */
422 if (ordering == REQUIRE_ORDER)
424 optarg = argv[optind++];
428 /* We have found another option-ARGV-element.
429 Start decoding its characters. */
431 nextchar = (argv[optind] + 1
432 + (longopts != NULL && argv[optind][1] == '-'));
436 && ((argv[optind][0] == '-'
437 && (argv[optind][1] == '-' || long_only))
439 || argv[optind][0] == '+'
440 #endif /* GETOPT_COMPAT */
443 const struct option *p;
447 const struct option *pfound = NULL;
450 while (*s && *s != '=')
453 /* Test all options for either exact match or abbreviated matches. */
454 for (p = longopts, option_index = 0; p->name;
456 if (!strncmp (p->name, nextchar, s - nextchar))
458 if (s - nextchar == strlen (p->name))
460 /* Exact match found. */
462 indfound = option_index;
466 else if (pfound == NULL)
468 /* First nonexact match found. */
470 indfound = option_index;
473 /* Second nonexact match found. */
480 fprintf (stderr, "%s: option `%s' is ambiguous\n",
481 argv[0], argv[optind]);
482 nextchar += strlen (nextchar);
489 option_index = indfound;
493 /* Don't test has_arg with >, because some C compilers don't
494 allow it to be used on enums. */
501 if (argv[optind - 1][1] == '-')
504 "%s: option `--%s' doesn't allow an argument\n",
505 argv[0], pfound->name);
507 /* +option or -option */
509 "%s: option `%c%s' doesn't allow an argument\n",
510 argv[0], argv[optind - 1][0], pfound->name);
512 nextchar += strlen (nextchar);
516 else if (pfound->has_arg == 1)
519 optarg = argv[optind++];
523 fprintf (stderr, "%s: option `%s' requires an argument\n",
524 argv[0], argv[optind - 1]);
525 nextchar += strlen (nextchar);
526 return optstring[0] == ':' ? ':' : '?';
529 nextchar += strlen (nextchar);
531 *longind = option_index;
534 *(pfound->flag) = pfound->val;
539 /* Can't find it as a long option. If this is not getopt_long_only,
540 or the option starts with '--' or is not a valid short
541 option, then it's an error.
542 Otherwise interpret it as a short option. */
543 if (!long_only || argv[optind][1] == '-'
545 || argv[optind][0] == '+'
546 #endif /* GETOPT_COMPAT */
547 || my_index (optstring, *nextchar) == NULL)
551 if (argv[optind][1] == '-')
553 fprintf (stderr, "%s: unrecognized option `--%s'\n",
556 /* +option or -option */
557 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
558 argv[0], argv[optind][0], nextchar);
560 nextchar = (char *) "";
566 /* Look at and handle the next option-character. */
569 char c = *nextchar++;
570 char *temp = my_index (optstring, c);
572 /* Increment `optind' when we start to process its last character. */
573 if (*nextchar == '\0')
576 if (temp == NULL || c == ':')
581 if (c < 040 || c >= 0177)
582 fprintf (stderr, "%s: unrecognized option, character code 0%o\n",
585 fprintf (stderr, "%s: unrecognized option `-%c'\n", argv[0], c);
587 /* 1003.2 specifies the format of this message. */
588 fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
598 /* This is an option that accepts an argument optionally. */
599 if (*nextchar != '\0')
610 /* This is an option that requires an argument. */
611 if (*nextchar != '\0')
614 /* If we end this ARGV-element by taking the rest as an arg,
615 we must advance to the next element now. */
618 else if (optind == argc)
623 fprintf (stderr, "%s: option `-%c' requires an argument\n",
626 /* 1003.2 specifies the format of this message. */
627 fprintf (stderr, "%s: option requires an argument -- %c\n",
632 if (optstring[0] == ':')
638 /* We already incremented `optind' once;
639 increment it again when taking next ARGV-elt as argument. */
640 optarg = argv[optind++];
650 getopt (argc, argv, optstring)
653 const char *optstring;
655 return _getopt_internal (argc, argv, optstring,
656 (const struct option *) 0,
662 #endif /* _LIBC or not __GNU_LIBRARY__. */
666 /* Compile with -DTEST to make an executable for use in testing
667 the above definition of `getopt'. */
675 int digit_optind = 0;
679 int this_option_optind = optind ? optind : 1;
681 c = getopt (argc, argv, "abc:d:0123456789");
697 if (digit_optind != 0 && digit_optind != this_option_optind)
698 printf ("digits occur in two different argv-elements.\n");
699 digit_optind = this_option_optind;
700 printf ("option %c\n", c);
704 printf ("option a\n");
708 printf ("option b\n");
712 printf ("option c with value `%s'\n", optarg);
719 printf ("?? getopt returned character code 0%o ??\n", c);
725 printf ("non-option ARGV-elements: ");
726 while (optind < argc)
727 printf ("%s ", argv[optind++]);