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, 93, 94
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 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
24 Ditto for AIX 3.2 and <stdlib.h>. */
30 #if defined (emacs) || defined (CONFIG_BROKETS)
31 /* We use <config.h> instead of "config.h" so that a compilation
32 using -I. -I$srcdir will use ./config.h rather than $srcdir/config.h
33 (which it would do because it found this file in $srcdir). */
41 /* This is a separate conditional since some stdc systems
42 reject `defined (const)'. */
50 /* Comment out all this code if we are using the GNU C Library, and are not
51 actually compiling the library itself. This code is part of the GNU C
52 Library, but also included in many other GNU distributions. Compiling
53 and linking in this code is a waste when using the GNU C library
54 (especially if it is a shared library). Rather than having every GNU
55 program understand `configure --with-gnu-libc' and omit the object files,
56 it is simpler to just do this in the source for each such file. */
58 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
61 /* This needs to come after some library #include
62 to get __GNU_LIBRARY__ defined. */
63 #ifdef __GNU_LIBRARY__
64 /* Don't include stdlib.h for non-GNU C libraries because some of them
65 contain conflicting prototypes for getopt. */
67 #endif /* GNU C library. */
69 /* This version of `getopt' appears to the caller like standard Unix `getopt'
70 but it behaves differently for the user, since it allows the user
71 to intersperse the options with the other arguments.
73 As `getopt' works, it permutes the elements of ARGV so that,
74 when it is done, all the options precede everything else. Thus
75 all application programs are extended to handle flexible argument order.
77 Setting the environment variable POSIXLY_CORRECT disables permutation.
78 Then the behavior is completely standard.
80 GNU application programs can use a third alternative mode in which
81 they can distinguish the relative order of options and other arguments. */
85 /* For communication from `getopt' to the caller.
86 When `getopt' finds an option that takes an argument,
87 the argument value is returned here.
88 Also, when `ordering' is RETURN_IN_ORDER,
89 each non-option ARGV-element is returned here. */
93 /* Index in ARGV of the next element to be scanned.
94 This is used for communication to and from the caller
95 and for communication between successive calls to `getopt'.
97 On entry to `getopt', zero means this is the first call; initialize.
99 When `getopt' returns EOF, this is the index of the first of the
100 non-option elements that the caller should itself scan.
102 Otherwise, `optind' communicates from one call to the next
103 how much of ARGV has been scanned so far. */
105 /* XXX 1003.2 says this must be 1 before any call. */
108 /* The next char to be scanned in the option-element
109 in which the last option character we returned was found.
110 This allows us to pick up the scan where we left off.
112 If this is zero, or a null string, it means resume the scan
113 by advancing to the next ARGV-element. */
115 static char *nextchar;
117 /* Callers store zero here to inhibit the error message
118 for unrecognized options. */
122 /* Set to an option character which was unrecognized.
123 This must be initialized on some systems to avoid linking in the
124 system's own getopt implementation. */
128 /* Describe how to deal with options that follow non-option ARGV-elements.
130 If the caller did not specify anything,
131 the default is REQUIRE_ORDER if the environment variable
132 POSIXLY_CORRECT is defined, PERMUTE otherwise.
134 REQUIRE_ORDER means don't recognize them as options;
135 stop option processing when the first non-option is seen.
136 This is what Unix does.
137 This mode of operation is selected by either setting the environment
138 variable POSIXLY_CORRECT, or using `+' as the first character
139 of the list of option characters.
141 PERMUTE is the default. We permute the contents of ARGV as we scan,
142 so that eventually all the non-options are at the end. This allows options
143 to be given in any order, even with programs that were not written to
146 RETURN_IN_ORDER is an option available to programs that were written
147 to expect options and other ARGV-elements in any order and that care about
148 the ordering of the two. We describe each non-option ARGV-element
149 as if it were the argument of an option with character code 1.
150 Using `-' as the first character of the list of option characters
151 selects this mode of operation.
153 The special argument `--' forces an end of option-scanning regardless
154 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
155 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
159 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
162 #ifdef __GNU_LIBRARY__
163 /* We want to avoid inclusion of string.h with non-GNU libraries
164 because there are many ways it can cause trouble.
165 On some systems, it contains special magic macros that don't work
168 #define my_index strchr
171 /* Avoid depending on library functions or files
172 whose names are inconsistent. */
190 /* If using GCC, we can safely declare strlen this way.
191 If not using GCC, it is ok not to declare it. */
194 /* Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
195 Enable Emacs to compile on it. */
197 extern size_t strlen (const char *);
198 #endif /* not __STDC__ */
199 #endif /* __GNUC__ */
201 #endif /* not __GNU_LIBRARY__ */
203 /* Handle permutation of arguments. */
205 /* Describe the part of ARGV that contains non-options that have
206 been skipped. `first_nonopt' is the index in ARGV of the first of them;
207 `last_nonopt' is the index after the last of them. */
209 static int first_nonopt;
210 static int last_nonopt;
212 /* Exchange two adjacent subsequences of ARGV.
213 One subsequence is elements [first_nonopt,last_nonopt)
214 which contains all the non-options that have been skipped so far.
215 The other is elements [last_nonopt,optind), which contains all
216 the options processed since those non-options were skipped.
218 `first_nonopt' and `last_nonopt' are relocated so that they describe
219 the new indices of the non-options in ARGV after they are moved. */
225 int bottom = first_nonopt;
226 int middle = last_nonopt;
230 /* Exchange the shorter segment with the far end of the longer segment.
231 That puts the shorter segment into the right place.
232 It leaves the longer segment in the right place overall,
233 but it consists of two parts that need to be swapped next. */
235 while (top > middle && middle > bottom)
237 if (top - middle > middle - bottom)
239 /* Bottom segment is the short one. */
240 int len = middle - bottom;
243 /* Swap it with the top part of the top segment. */
244 for (i = 0; i < len; i++)
246 tem = argv[bottom + i];
247 argv[bottom + i] = argv[top - (middle - bottom) + i];
248 argv[top - (middle - bottom) + i] = tem;
250 /* Exclude the moved bottom segment from further swapping. */
255 /* Top segment is the short one. */
256 int len = top - middle;
259 /* Swap it with the bottom part of the bottom segment. */
260 for (i = 0; i < len; i++)
262 tem = argv[bottom + i];
263 argv[bottom + i] = argv[middle + i];
264 argv[middle + i] = tem;
266 /* Exclude the moved top segment from further swapping. */
271 /* Update records for the slots the non-options now occupy. */
273 first_nonopt += (optind - last_nonopt);
274 last_nonopt = optind;
277 /* Initialize the internal data when the first call is made. */
280 _getopt_initialize (optstring)
281 const char *optstring;
283 /* Start processing options with ARGV-element 1 (since ARGV-element 0
284 is the program name); the sequence of previously skipped
285 non-option ARGV-elements is empty. */
287 first_nonopt = last_nonopt = optind = 1;
291 /* Determine how to handle the ordering of options and nonoptions. */
293 if (optstring[0] == '-')
295 ordering = RETURN_IN_ORDER;
298 else if (optstring[0] == '+')
300 ordering = REQUIRE_ORDER;
303 else if (getenv ("POSIXLY_CORRECT") != NULL)
304 ordering = REQUIRE_ORDER;
311 /* Scan elements of ARGV (whose length is ARGC) for option characters
314 If an element of ARGV starts with '-', and is not exactly "-" or "--",
315 then it is an option element. The characters of this element
316 (aside from the initial '-') are option characters. If `getopt'
317 is called repeatedly, it returns successively each of the option characters
318 from each of the option elements.
320 If `getopt' finds another option character, it returns that character,
321 updating `optind' and `nextchar' so that the next call to `getopt' can
322 resume the scan with the following option character or ARGV-element.
324 If there are no more option characters, `getopt' returns `EOF'.
325 Then `optind' is the index in ARGV of the first ARGV-element
326 that is not an option. (The ARGV-elements have been permuted
327 so that those that are not options now come last.)
329 OPTSTRING is a string containing the legitimate option characters.
330 If an option character is seen that is not listed in OPTSTRING,
331 return '?' after printing an error message. If you set `opterr' to
332 zero, the error message is suppressed but we still return '?'.
334 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
335 so the following text in the same ARGV-element, or the text of the following
336 ARGV-element, is returned in `optarg'. Two colons mean an option that
337 wants an optional arg; if there is text in the current ARGV-element,
338 it is returned in `optarg', otherwise `optarg' is set to zero.
340 If OPTSTRING starts with `-' or `+', it requests different methods of
341 handling the non-option ARGV-elements.
342 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
344 Long-named options begin with `--' instead of `-'.
345 Their names may be abbreviated as long as the abbreviation is unique
346 or is an exact match for some defined option. If they have an
347 argument, it follows the option name in the same ARGV-element, separated
348 from the option name by a `=', or else the in next ARGV-element.
349 When `getopt' finds a long-named option, it returns 0 if that option's
350 `flag' field is nonzero, the value of the option's `val' field
351 if the `flag' field is zero.
353 The elements of ARGV aren't really const, because we permute them.
354 But we pretend they're const in the prototype to be compatible
357 LONGOPTS is a vector of `struct option' terminated by an
358 element containing a name which is zero.
360 LONGIND returns the index in LONGOPT of the long-named option found.
361 It is only valid when a long-named option has been found by the most
364 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
365 long-named options. */
368 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
371 const char *optstring;
372 const struct option *longopts;
379 optstring = _getopt_initialize (optstring);
381 if (nextchar == NULL || *nextchar == '\0')
383 /* Advance to the next ARGV-element. */
385 if (ordering == PERMUTE)
387 /* If we have just processed some options following some non-options,
388 exchange them so that the options come first. */
390 if (first_nonopt != last_nonopt && last_nonopt != optind)
391 exchange ((char **) argv);
392 else if (last_nonopt != optind)
393 first_nonopt = optind;
395 /* Skip any additional non-options
396 and extend the range of non-options previously skipped. */
399 && (argv[optind][0] != '-' || argv[optind][1] == '\0'))
401 last_nonopt = optind;
404 /* The special ARGV-element `--' means premature end of options.
405 Skip it like a null option,
406 then exchange with previous non-options as if it were an option,
407 then skip everything else like a non-option. */
409 if (optind != argc && !strcmp (argv[optind], "--"))
413 if (first_nonopt != last_nonopt && last_nonopt != optind)
414 exchange ((char **) argv);
415 else if (first_nonopt == last_nonopt)
416 first_nonopt = optind;
422 /* If we have done all the ARGV-elements, stop the scan
423 and back over any non-options that we skipped and permuted. */
427 /* Set the next-arg-index to point at the non-options
428 that we previously skipped, so the caller will digest them. */
429 if (first_nonopt != last_nonopt)
430 optind = first_nonopt;
434 /* If we have come to a non-option and did not permute it,
435 either stop the scan or describe it to the caller and pass it by. */
437 if ((argv[optind][0] != '-' || argv[optind][1] == '\0'))
439 if (ordering == REQUIRE_ORDER)
441 optarg = argv[optind++];
445 /* We have found another option-ARGV-element.
446 Skip the initial punctuation. */
448 nextchar = (argv[optind] + 1
449 + (longopts != NULL && argv[optind][1] == '-'));
452 /* Decode the current option-ARGV-element. */
454 /* Check whether the ARGV-element is a long option.
456 If long_only and the ARGV-element has the form "-f", where f is
457 a valid short option, don't consider it an abbreviated form of
458 a long option that starts with f. Otherwise there would be no
459 way to give the -f short option.
461 On the other hand, if there's a long option "fubar" and
462 the ARGV-element is "-fu", do consider that an abbreviation of
463 the long option, just like "--fu", and not "-f" with arg "u".
465 This distinction seems to be the most useful approach. */
468 && (argv[optind][1] == '-'
469 || (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
472 const struct option *p;
473 const struct option *pfound = NULL;
479 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
482 /* Test all long options for either exact match
483 or abbreviated matches. */
484 for (p = longopts, option_index = 0; p->name; p++, option_index++)
485 if (!strncmp (p->name, nextchar, nameend - nextchar))
487 if (nameend - nextchar == strlen (p->name))
489 /* Exact match found. */
491 indfound = option_index;
495 else if (pfound == NULL)
497 /* First nonexact match found. */
499 indfound = option_index;
502 /* Second or later nonexact match found. */
509 fprintf (stderr, "%s: option `%s' is ambiguous\n",
510 argv[0], argv[optind]);
511 nextchar += strlen (nextchar);
518 option_index = indfound;
522 /* Don't test has_arg with >, because some C compilers don't
523 allow it to be used on enums. */
525 optarg = nameend + 1;
530 if (argv[optind - 1][1] == '-')
533 "%s: option `--%s' doesn't allow an argument\n",
534 argv[0], pfound->name);
536 /* +option or -option */
538 "%s: option `%c%s' doesn't allow an argument\n",
539 argv[0], argv[optind - 1][0], pfound->name);
541 nextchar += strlen (nextchar);
545 else if (pfound->has_arg == 1)
548 optarg = argv[optind++];
552 fprintf (stderr, "%s: option `%s' requires an argument\n",
553 argv[0], argv[optind - 1]);
554 nextchar += strlen (nextchar);
555 return optstring[0] == ':' ? ':' : '?';
558 nextchar += strlen (nextchar);
560 *longind = option_index;
563 *(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] == '-'
574 || my_index (optstring, *nextchar) == NULL)
578 if (argv[optind][1] == '-')
580 fprintf (stderr, "%s: unrecognized option `--%s'\n",
583 /* +option or -option */
584 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
585 argv[0], argv[optind][0], nextchar);
587 nextchar = (char *) "";
593 /* Look at and handle the next short option-character. */
596 char c = *nextchar++;
597 char *temp = my_index (optstring, c);
599 /* Increment `optind' when we start to process its last character. */
600 if (*nextchar == '\0')
603 if (temp == NULL || c == ':')
607 /* 1003.2 specifies the format of this message. */
608 fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
617 /* This is an option that accepts an argument optionally. */
618 if (*nextchar != '\0')
629 /* This is an option that requires an argument. */
630 if (*nextchar != '\0')
633 /* If we end this ARGV-element by taking the rest as an arg,
634 we must advance to the next element now. */
637 else if (optind == argc)
641 /* 1003.2 specifies the format of this message. */
642 fprintf (stderr, "%s: option requires an argument -- %c\n",
646 if (optstring[0] == ':')
652 /* We already incremented `optind' once;
653 increment it again when taking next ARGV-elt as argument. */
654 optarg = argv[optind++];
663 getopt (argc, argv, optstring)
666 const char *optstring;
668 return _getopt_internal (argc, argv, optstring,
669 (const struct option *) 0,
674 #endif /* _LIBC or not __GNU_LIBRARY__. */
678 /* Compile with -DTEST to make an executable for use in testing
679 the above definition of `getopt'. */
687 int digit_optind = 0;
691 int this_option_optind = optind ? optind : 1;
693 c = getopt (argc, argv, "abc:d:0123456789");
709 if (digit_optind != 0 && digit_optind != this_option_optind)
710 printf ("digits occur in two different argv-elements.\n");
711 digit_optind = this_option_optind;
712 printf ("option %c\n", c);
716 printf ("option a\n");
720 printf ("option b\n");
724 printf ("option c with value `%s'\n", optarg);
731 printf ("?? getopt returned character code 0%o ??\n", c);
737 printf ("non-option ARGV-elements: ");
738 while (optind < argc)
739 printf ("%s ", argv[optind++]);