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. */
203 #else /* not IN_GCC */
204 /* Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
205 Enable Emacs to compile on it. */
207 #endif /* not IN_GCC */
208 extern size_t strlen (const char *);
209 #endif /* not __STDC__ */
210 #endif /* __GNUC__ */
212 #endif /* not __GNU_LIBRARY__ */
214 /* Handle permutation of arguments. */
216 /* Describe the part of ARGV that contains non-options that have
217 been skipped. `first_nonopt' is the index in ARGV of the first of them;
218 `last_nonopt' is the index after the last of them. */
220 static int first_nonopt;
221 static int last_nonopt;
223 /* Exchange two adjacent subsequences of ARGV.
224 One subsequence is elements [first_nonopt,last_nonopt)
225 which contains all the non-options that have been skipped so far.
226 The other is elements [last_nonopt,optind), which contains all
227 the options processed since those non-options were skipped.
229 `first_nonopt' and `last_nonopt' are relocated so that they describe
230 the new indices of the non-options in ARGV after they are moved. */
236 int bottom = first_nonopt;
237 int middle = last_nonopt;
241 /* Exchange the shorter segment with the far end of the longer segment.
242 That puts the shorter segment into the right place.
243 It leaves the longer segment in the right place overall,
244 but it consists of two parts that need to be swapped next. */
246 while (top > middle && middle > bottom)
248 if (top - middle > middle - bottom)
250 /* Bottom segment is the short one. */
251 int len = middle - bottom;
254 /* Swap it with the top part of the top segment. */
255 for (i = 0; i < len; i++)
257 tem = argv[bottom + i];
258 argv[bottom + i] = argv[top - (middle - bottom) + i];
259 argv[top - (middle - bottom) + i] = tem;
261 /* Exclude the moved bottom segment from further swapping. */
266 /* Top segment is the short one. */
267 int len = top - middle;
270 /* Swap it with the bottom part of the bottom segment. */
271 for (i = 0; i < len; i++)
273 tem = argv[bottom + i];
274 argv[bottom + i] = argv[middle + i];
275 argv[middle + i] = tem;
277 /* Exclude the moved top segment from further swapping. */
282 /* Update records for the slots the non-options now occupy. */
284 first_nonopt += (optind - last_nonopt);
285 last_nonopt = optind;
288 /* Scan elements of ARGV (whose length is ARGC) for option characters
291 If an element of ARGV starts with '-', and is not exactly "-" or "--",
292 then it is an option element. The characters of this element
293 (aside from the initial '-') are option characters. If `getopt'
294 is called repeatedly, it returns successively each of the option characters
295 from each of the option elements.
297 If `getopt' finds another option character, it returns that character,
298 updating `optind' and `nextchar' so that the next call to `getopt' can
299 resume the scan with the following option character or ARGV-element.
301 If there are no more option characters, `getopt' returns `EOF'.
302 Then `optind' is the index in ARGV of the first ARGV-element
303 that is not an option. (The ARGV-elements have been permuted
304 so that those that are not options now come last.)
306 OPTSTRING is a string containing the legitimate option characters.
307 If an option character is seen that is not listed in OPTSTRING,
308 return '?' after printing an error message. If you set `opterr' to
309 zero, the error message is suppressed but we still return '?'.
311 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
312 so the following text in the same ARGV-element, or the text of the following
313 ARGV-element, is returned in `optarg'. Two colons mean an option that
314 wants an optional arg; if there is text in the current ARGV-element,
315 it is returned in `optarg', otherwise `optarg' is set to zero.
317 If OPTSTRING starts with `-' or `+', it requests different methods of
318 handling the non-option ARGV-elements.
319 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
321 Long-named options begin with `--' instead of `-'.
322 Their names may be abbreviated as long as the abbreviation is unique
323 or is an exact match for some defined option. If they have an
324 argument, it follows the option name in the same ARGV-element, separated
325 from the option name by a `=', or else the in next ARGV-element.
326 When `getopt' finds a long-named option, it returns 0 if that option's
327 `flag' field is nonzero, the value of the option's `val' field
328 if the `flag' field is zero.
330 The elements of ARGV aren't really const, because we permute them.
331 But we pretend they're const in the prototype to be compatible
334 LONGOPTS is a vector of `struct option' terminated by an
335 element containing a name which is zero.
337 LONGIND returns the index in LONGOPT of the long-named option found.
338 It is only valid when a long-named option has been found by the most
341 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
342 long-named options. */
345 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
348 const char *optstring;
349 const struct option *longopts;
357 /* Initialize the internal data when the first call is made.
358 Start processing options with ARGV-element 1 (since ARGV-element 0
359 is the program name); the sequence of previously skipped
360 non-option ARGV-elements is empty. */
364 first_nonopt = last_nonopt = optind = 1;
368 /* Determine how to handle the ordering of options and nonoptions. */
370 if (optstring[0] == '-')
372 ordering = RETURN_IN_ORDER;
375 else if (optstring[0] == '+')
377 ordering = REQUIRE_ORDER;
380 else if (getenv ("POSIXLY_CORRECT") != NULL)
381 ordering = REQUIRE_ORDER;
386 if (nextchar == NULL || *nextchar == '\0')
388 if (ordering == PERMUTE)
390 /* If we have just processed some options following some non-options,
391 exchange them so that the options come first. */
393 if (first_nonopt != last_nonopt && last_nonopt != optind)
394 exchange ((char **) argv);
395 else if (last_nonopt != optind)
396 first_nonopt = optind;
398 /* Now skip any additional non-options
399 and extend the range of non-options previously skipped. */
402 && (argv[optind][0] != '-' || argv[optind][1] == '\0')
405 || argv[optind][0] != '+' || argv[optind][1] == '\0')
406 #endif /* GETOPT_COMPAT */
409 last_nonopt = optind;
412 /* Special ARGV-element `--' means premature end of options.
413 Skip it like a null option,
414 then exchange with previous non-options as if it were an option,
415 then skip everything else like a non-option. */
417 if (optind != argc && !strcmp (argv[optind], "--"))
421 if (first_nonopt != last_nonopt && last_nonopt != optind)
422 exchange ((char **) argv);
423 else if (first_nonopt == last_nonopt)
424 first_nonopt = optind;
430 /* If we have done all the ARGV-elements, stop the scan
431 and back over any non-options that we skipped and permuted. */
435 /* Set the next-arg-index to point at the non-options
436 that we previously skipped, so the caller will digest them. */
437 if (first_nonopt != last_nonopt)
438 optind = first_nonopt;
442 /* If we have come to a non-option and did not permute it,
443 either stop the scan or describe it to the caller and pass it by. */
445 if ((argv[optind][0] != '-' || argv[optind][1] == '\0')
448 || argv[optind][0] != '+' || argv[optind][1] == '\0')
449 #endif /* GETOPT_COMPAT */
452 if (ordering == REQUIRE_ORDER)
454 optarg = argv[optind++];
458 /* We have found another option-ARGV-element.
459 Start decoding its characters. */
461 nextchar = (argv[optind] + 1
462 + (longopts != NULL && argv[optind][1] == '-'));
466 && ((argv[optind][0] == '-'
467 && (argv[optind][1] == '-' || long_only))
469 || argv[optind][0] == '+'
470 #endif /* GETOPT_COMPAT */
473 const struct option *p;
477 const struct option *pfound = NULL;
480 while (*s && *s != '=')
483 /* Test all options for either exact match or abbreviated matches. */
484 for (p = longopts, option_index = 0; p->name;
486 if (!strncmp (p->name, nextchar, s - nextchar))
488 if (s - nextchar == strlen (p->name))
490 /* Exact match found. */
492 indfound = option_index;
496 else if (pfound == NULL)
498 /* First nonexact match found. */
500 indfound = option_index;
503 /* Second nonexact match found. */
510 fprintf (stderr, "%s: option `%s' is ambiguous\n",
511 argv[0], argv[optind]);
512 nextchar += strlen (nextchar);
519 option_index = indfound;
523 /* Don't test has_arg with >, because some C compilers don't
524 allow it to be used on enums. */
531 if (argv[optind - 1][1] == '-')
534 "%s: option `--%s' doesn't allow an argument\n",
535 argv[0], pfound->name);
537 /* +option or -option */
539 "%s: option `%c%s' doesn't allow an argument\n",
540 argv[0], argv[optind - 1][0], pfound->name);
542 nextchar += strlen (nextchar);
546 else if (pfound->has_arg == 1)
549 optarg = argv[optind++];
553 fprintf (stderr, "%s: option `%s' requires an argument\n",
554 argv[0], argv[optind - 1]);
555 nextchar += strlen (nextchar);
556 return optstring[0] == ':' ? ':' : '?';
559 nextchar += strlen (nextchar);
561 *longind = option_index;
564 *(pfound->flag) = pfound->val;
569 /* Can't find it as a long option. If this is not getopt_long_only,
570 or the option starts with '--' or is not a valid short
571 option, then it's an error.
572 Otherwise interpret it as a short option. */
573 if (!long_only || argv[optind][1] == '-'
575 || argv[optind][0] == '+'
576 #endif /* GETOPT_COMPAT */
577 || my_index (optstring, *nextchar) == NULL)
581 if (argv[optind][1] == '-')
583 fprintf (stderr, "%s: unrecognized option `--%s'\n",
586 /* +option or -option */
587 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
588 argv[0], argv[optind][0], nextchar);
590 nextchar = (char *) "";
596 /* Look at and handle the next option-character. */
599 char c = *nextchar++;
600 char *temp = my_index (optstring, c);
602 /* Increment `optind' when we start to process its last character. */
603 if (*nextchar == '\0')
606 if (temp == NULL || c == ':')
611 if (c < 040 || c >= 0177)
612 fprintf (stderr, "%s: unrecognized option, character code 0%o\n",
615 fprintf (stderr, "%s: unrecognized option `-%c'\n", argv[0], c);
617 /* 1003.2 specifies the format of this message. */
618 fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
628 /* This is an option that accepts an argument optionally. */
629 if (*nextchar != '\0')
640 /* This is an option that requires an argument. */
641 if (*nextchar != '\0')
644 /* If we end this ARGV-element by taking the rest as an arg,
645 we must advance to the next element now. */
648 else if (optind == argc)
653 fprintf (stderr, "%s: option `-%c' requires an argument\n",
656 /* 1003.2 specifies the format of this message. */
657 fprintf (stderr, "%s: option requires an argument -- %c\n",
662 if (optstring[0] == ':')
668 /* We already incremented `optind' once;
669 increment it again when taking next ARGV-elt as argument. */
670 optarg = argv[optind++];
679 getopt (argc, argv, optstring)
682 const char *optstring;
684 return _getopt_internal (argc, argv, optstring,
685 (const struct option *) 0,
690 #endif /* _LIBC or not __GNU_LIBRARY__. */
694 /* Compile with -DTEST to make an executable for use in testing
695 the above definition of `getopt'. */
703 int digit_optind = 0;
707 int this_option_optind = optind ? optind : 1;
709 c = getopt (argc, argv, "abc:d:0123456789");
725 if (digit_optind != 0 && digit_optind != this_option_optind)
726 printf ("digits occur in two different argv-elements.\n");
727 digit_optind = this_option_optind;
728 printf ("option %c\n", c);
732 printf ("option a\n");
736 printf ("option b\n");
740 printf ("option c with value `%s'\n", optarg);
747 printf ("?? getopt returned character code 0%o ??\n", c);
753 printf ("non-option ARGV-elements: ");
754 while (optind < argc)
755 printf ("%s ", argv[optind++]);