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 * This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
25 * Ditto for AIX 3.2 and <stdlib.h>.
32 #if defined (emacs) || defined (CONFIG_BROKETS)
33 /* We use <config.h> instead of "config.h" so that a compilation
34 using -I. -I$srcdir will use ./config.h rather than $srcdir/config.h
35 (which it would do because it found this file in $srcdir). */
43 /* This is a separate conditional since some stdc systems
44 reject `defined (const)'. */
52 /* Comment out all this code if we are using the GNU C Library, and are not
53 actually compiling the library itself. This code is part of the GNU C
54 Library, but also included in many other GNU distributions. Compiling
55 and linking in this code is a waste when using the GNU C library
56 (especially if it is a shared library). Rather than having every GNU
57 program understand `configure --with-gnu-libc' and omit the object files,
58 it is simpler to just do this in the source for each such file. */
60 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
63 /* This needs to come after some library #include
64 to get __GNU_LIBRARY__ defined. */
65 #ifdef __GNU_LIBRARY__
66 /* Don't include stdlib.h for non-GNU C libraries because some of them
67 contain conflicting prototypes for getopt. */
69 #endif /* GNU C library. */
71 /* If GETOPT_COMPAT is defined, `+' as well as `--' can introduce a
72 long-named option. Because this is not POSIX.2 compliant, it is
74 /* #define GETOPT_COMPAT */
76 /* This version of `getopt' appears to the caller like standard Unix `getopt'
77 but it behaves differently for the user, since it allows the user
78 to intersperse the options with the other arguments.
80 As `getopt' works, it permutes the elements of ARGV so that,
81 when it is done, all the options precede everything else. Thus
82 all application programs are extended to handle flexible argument order.
84 Setting the environment variable POSIXLY_CORRECT disables permutation.
85 Then the behavior is completely standard.
87 GNU application programs can use a third alternative mode in which
88 they can distinguish the relative order of options and other arguments. */
92 /* For communication from `getopt' to the caller.
93 When `getopt' finds an option that takes an argument,
94 the argument value is returned here.
95 Also, when `ordering' is RETURN_IN_ORDER,
96 each non-option ARGV-element is returned here. */
100 /* Index in ARGV of the next element to be scanned.
101 This is used for communication to and from the caller
102 and for communication between successive calls to `getopt'.
104 On entry to `getopt', zero means this is the first call; initialize.
106 When `getopt' returns EOF, this is the index of the first of the
107 non-option elements that the caller should itself scan.
109 Otherwise, `optind' communicates from one call to the next
110 how much of ARGV has been scanned so far. */
112 /* XXX 1003.2 says this must be 1 before any call. */
115 /* The next char to be scanned in the option-element
116 in which the last option character we returned was found.
117 This allows us to pick up the scan where we left off.
119 If this is zero, or a null string, it means resume the scan
120 by advancing to the next ARGV-element. */
122 static char *nextchar;
124 /* Callers store zero here to inhibit the error message
125 for unrecognized options. */
129 /* Set to an option character which was unrecognized.
130 This must be initialized on some systems to avoid linking in the
131 system's own getopt implementation. */
135 /* Describe how to deal with options that follow non-option ARGV-elements.
137 If the caller did not specify anything,
138 the default is REQUIRE_ORDER if the environment variable
139 POSIXLY_CORRECT is defined, PERMUTE otherwise.
141 REQUIRE_ORDER means don't recognize them as options;
142 stop option processing when the first non-option is seen.
143 This is what Unix does.
144 This mode of operation is selected by either setting the environment
145 variable POSIXLY_CORRECT, or using `+' as the first character
146 of the list of option characters.
148 PERMUTE is the default. We permute the contents of ARGV as we scan,
149 so that eventually all the non-options are at the end. This allows options
150 to be given in any order, even with programs that were not written to
153 RETURN_IN_ORDER is an option available to programs that were written
154 to expect options and other ARGV-elements in any order and that care about
155 the ordering of the two. We describe each non-option ARGV-element
156 as if it were the argument of an option with character code 1.
157 Using `-' as the first character of the list of option characters
158 selects this mode of operation.
160 The special argument `--' forces an end of option-scanning regardless
161 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
162 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
166 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
169 #ifdef __GNU_LIBRARY__
170 /* We want to avoid inclusion of string.h with non-GNU libraries
171 because there are many ways it can cause trouble.
172 On some systems, it contains special magic macros that don't work
175 #define my_index strchr
178 /* Avoid depending on library functions or files
179 whose names are inconsistent. */
197 /* If using GCC, we can safely declare strlen this way.
198 If not using GCC, it is ok not to declare it.
199 (Supposedly there are some machines where it might get a warning,
200 but changing this conditional to __STDC__ is too risky.) */
202 #if ! (defined (emacs) && !defined (__STDC__))
205 #else /* not IN_GCC */
206 /* Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
207 Enable Emacs to compile on it. */
209 #endif /* not IN_GCC */
210 extern size_t strlen (const char *);
211 #endif /* ! (defined (emacs) && !defined (__STDC__)) */
212 #endif /* __GNUC__ */
214 #endif /* not __GNU_LIBRARY__ */
216 /* Handle permutation of arguments. */
218 /* Describe the part of ARGV that contains non-options that have
219 been skipped. `first_nonopt' is the index in ARGV of the first of them;
220 `last_nonopt' is the index after the last of them. */
222 static int first_nonopt;
223 static int last_nonopt;
225 /* Exchange two adjacent subsequences of ARGV.
226 One subsequence is elements [first_nonopt,last_nonopt)
227 which contains all the non-options that have been skipped so far.
228 The other is elements [last_nonopt,optind), which contains all
229 the options processed since those non-options were skipped.
231 `first_nonopt' and `last_nonopt' are relocated so that they describe
232 the new indices of the non-options in ARGV after they are moved. */
238 int bottom = first_nonopt;
239 int middle = last_nonopt;
243 /* Exchange the shorter segment with the far end of the longer segment.
244 That puts the shorter segment into the right place.
245 It leaves the longer segment in the right place overall,
246 but it consists of two parts that need to be swapped next. */
248 while (top > middle && middle > bottom)
250 if (top - middle > middle - bottom)
252 /* Bottom segment is the short one. */
253 int len = middle - bottom;
256 /* Swap it with the top part of the top segment. */
257 for (i = 0; i < len; i++)
259 tem = argv[bottom + i];
260 argv[bottom + i] = argv[top - (middle - bottom) + i];
261 argv[top - (middle - bottom) + i] = tem;
263 /* Exclude the moved bottom segment from further swapping. */
268 /* Top segment is the short one. */
269 int len = top - middle;
272 /* Swap it with the bottom part of the bottom segment. */
273 for (i = 0; i < len; i++)
275 tem = argv[bottom + i];
276 argv[bottom + i] = argv[middle + i];
277 argv[middle + i] = tem;
279 /* Exclude the moved top segment from further swapping. */
284 /* Update records for the slots the non-options now occupy. */
286 first_nonopt += (optind - last_nonopt);
287 last_nonopt = optind;
290 /* Scan elements of ARGV (whose length is ARGC) for option characters
293 If an element of ARGV starts with '-', and is not exactly "-" or "--",
294 then it is an option element. The characters of this element
295 (aside from the initial '-') are option characters. If `getopt'
296 is called repeatedly, it returns successively each of the option characters
297 from each of the option elements.
299 If `getopt' finds another option character, it returns that character,
300 updating `optind' and `nextchar' so that the next call to `getopt' can
301 resume the scan with the following option character or ARGV-element.
303 If there are no more option characters, `getopt' returns `EOF'.
304 Then `optind' is the index in ARGV of the first ARGV-element
305 that is not an option. (The ARGV-elements have been permuted
306 so that those that are not options now come last.)
308 OPTSTRING is a string containing the legitimate option characters.
309 If an option character is seen that is not listed in OPTSTRING,
310 return '?' after printing an error message. If you set `opterr' to
311 zero, the error message is suppressed but we still return '?'.
313 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
314 so the following text in the same ARGV-element, or the text of the following
315 ARGV-element, is returned in `optarg'. Two colons mean an option that
316 wants an optional arg; if there is text in the current ARGV-element,
317 it is returned in `optarg', otherwise `optarg' is set to zero.
319 If OPTSTRING starts with `-' or `+', it requests different methods of
320 handling the non-option ARGV-elements.
321 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
323 Long-named options begin with `--' instead of `-'.
324 Their names may be abbreviated as long as the abbreviation is unique
325 or is an exact match for some defined option. If they have an
326 argument, it follows the option name in the same ARGV-element, separated
327 from the option name by a `=', or else the in next ARGV-element.
328 When `getopt' finds a long-named option, it returns 0 if that option's
329 `flag' field is nonzero, the value of the option's `val' field
330 if the `flag' field is zero.
332 The elements of ARGV aren't really const, because we permute them.
333 But we pretend they're const in the prototype to be compatible
336 LONGOPTS is a vector of `struct option' terminated by an
337 element containing a name which is zero.
339 LONGIND returns the index in LONGOPT of the long-named option found.
340 It is only valid when a long-named option has been found by the most
343 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
344 long-named options. */
347 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
350 const char *optstring;
351 const struct option *longopts;
359 /* Initialize the internal data when the first call is made.
360 Start processing options with ARGV-element 1 (since ARGV-element 0
361 is the program name); the sequence of previously skipped
362 non-option ARGV-elements is empty. */
366 first_nonopt = last_nonopt = optind = 1;
370 /* Determine how to handle the ordering of options and nonoptions. */
372 if (optstring[0] == '-')
374 ordering = RETURN_IN_ORDER;
377 else if (optstring[0] == '+')
379 ordering = REQUIRE_ORDER;
382 else if (getenv ("POSIXLY_CORRECT") != NULL)
383 ordering = REQUIRE_ORDER;
388 if (nextchar == NULL || *nextchar == '\0')
390 if (ordering == PERMUTE)
392 /* If we have just processed some options following some non-options,
393 exchange them so that the options come first. */
395 if (first_nonopt != last_nonopt && last_nonopt != optind)
396 exchange ((char **) argv);
397 else if (last_nonopt != optind)
398 first_nonopt = optind;
400 /* Now skip any additional non-options
401 and extend the range of non-options previously skipped. */
404 && (argv[optind][0] != '-' || argv[optind][1] == '\0')
407 || argv[optind][0] != '+' || argv[optind][1] == '\0')
408 #endif /* GETOPT_COMPAT */
411 last_nonopt = optind;
414 /* Special ARGV-element `--' means premature end of options.
415 Skip it like a null option,
416 then exchange with previous non-options as if it were an option,
417 then skip everything else like a non-option. */
419 if (optind != argc && !strcmp (argv[optind], "--"))
423 if (first_nonopt != last_nonopt && last_nonopt != optind)
424 exchange ((char **) argv);
425 else if (first_nonopt == last_nonopt)
426 first_nonopt = optind;
432 /* If we have done all the ARGV-elements, stop the scan
433 and back over any non-options that we skipped and permuted. */
437 /* Set the next-arg-index to point at the non-options
438 that we previously skipped, so the caller will digest them. */
439 if (first_nonopt != last_nonopt)
440 optind = first_nonopt;
444 /* If we have come to a non-option and did not permute it,
445 either stop the scan or describe it to the caller and pass it by. */
447 if ((argv[optind][0] != '-' || argv[optind][1] == '\0')
450 || argv[optind][0] != '+' || argv[optind][1] == '\0')
451 #endif /* GETOPT_COMPAT */
454 if (ordering == REQUIRE_ORDER)
456 optarg = argv[optind++];
460 /* We have found another option-ARGV-element.
461 Start decoding its characters. */
463 nextchar = (argv[optind] + 1
464 + (longopts != NULL && argv[optind][1] == '-'));
468 && ((argv[optind][0] == '-'
469 && (argv[optind][1] == '-' || long_only))
471 || argv[optind][0] == '+'
472 #endif /* GETOPT_COMPAT */
475 const struct option *p;
479 const struct option *pfound = NULL;
482 while (*s && *s != '=')
485 /* Test all options for either exact match or abbreviated matches. */
486 for (p = longopts, option_index = 0; p->name;
488 if (!strncmp (p->name, nextchar, s - nextchar))
490 if (s - nextchar == strlen (p->name))
492 /* Exact match found. */
494 indfound = option_index;
498 else if (pfound == NULL)
500 /* First nonexact match found. */
502 indfound = option_index;
505 /* Second nonexact match found. */
512 fprintf (stderr, "%s: option `%s' is ambiguous\n",
513 argv[0], argv[optind]);
514 nextchar += strlen (nextchar);
521 option_index = indfound;
525 /* Don't test has_arg with >, because some C compilers don't
526 allow it to be used on enums. */
533 if (argv[optind - 1][1] == '-')
536 "%s: option `--%s' doesn't allow an argument\n",
537 argv[0], pfound->name);
539 /* +option or -option */
541 "%s: option `%c%s' doesn't allow an argument\n",
542 argv[0], argv[optind - 1][0], pfound->name);
544 nextchar += strlen (nextchar);
548 else if (pfound->has_arg == 1)
551 optarg = argv[optind++];
555 fprintf (stderr, "%s: option `%s' requires an argument\n",
556 argv[0], argv[optind - 1]);
557 nextchar += strlen (nextchar);
558 return optstring[0] == ':' ? ':' : '?';
561 nextchar += strlen (nextchar);
563 *longind = option_index;
566 *(pfound->flag) = pfound->val;
571 /* Can't find it as a long option. If this is not getopt_long_only,
572 or the option starts with '--' or is not a valid short
573 option, then it's an error.
574 Otherwise interpret it as a short option. */
575 if (!long_only || argv[optind][1] == '-'
577 || argv[optind][0] == '+'
578 #endif /* GETOPT_COMPAT */
579 || my_index (optstring, *nextchar) == NULL)
583 if (argv[optind][1] == '-')
585 fprintf (stderr, "%s: unrecognized option `--%s'\n",
588 /* +option or -option */
589 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
590 argv[0], argv[optind][0], nextchar);
592 nextchar = (char *) "";
598 /* Look at and handle the next option-character. */
601 char c = *nextchar++;
602 char *temp = my_index (optstring, c);
604 /* Increment `optind' when we start to process its last character. */
605 if (*nextchar == '\0')
608 if (temp == NULL || c == ':')
613 if (c < 040 || c >= 0177)
614 fprintf (stderr, "%s: unrecognized option, character code 0%o\n",
617 fprintf (stderr, "%s: unrecognized option `-%c'\n", argv[0], c);
619 /* 1003.2 specifies the format of this message. */
620 fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
630 /* This is an option that accepts an argument optionally. */
631 if (*nextchar != '\0')
642 /* This is an option that requires an argument. */
643 if (*nextchar != '\0')
646 /* If we end this ARGV-element by taking the rest as an arg,
647 we must advance to the next element now. */
650 else if (optind == argc)
655 fprintf (stderr, "%s: option `-%c' requires an argument\n",
658 /* 1003.2 specifies the format of this message. */
659 fprintf (stderr, "%s: option requires an argument -- %c\n",
664 if (optstring[0] == ':')
670 /* We already incremented `optind' once;
671 increment it again when taking next ARGV-elt as argument. */
672 optarg = argv[optind++];
681 getopt (argc, argv, optstring)
684 const char *optstring;
686 return _getopt_internal (argc, argv, optstring,
687 (const struct option *) 0,
692 #endif /* _LIBC or not __GNU_LIBRARY__. */
696 /* Compile with -DTEST to make an executable for use in testing
697 the above definition of `getopt'. */
705 int digit_optind = 0;
709 int this_option_optind = optind ? optind : 1;
711 c = getopt (argc, argv, "abc:d:0123456789");
727 if (digit_optind != 0 && digit_optind != this_option_optind)
728 printf ("digits occur in two different argv-elements.\n");
729 digit_optind = this_option_optind;
730 printf ("option %c\n", c);
734 printf ("option a\n");
738 printf ("option b\n");
742 printf ("option c with value `%s'\n", optarg);
749 printf ("?? getopt returned character code 0%o ??\n", c);
755 printf ("non-option ARGV-elements: ");
756 while (optind < argc)
757 printf ("%s ", argv[optind++]);