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. */
196 #else /* not IN_GCC */
197 /* Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
198 Enable Emacs to compile on it. */
200 #endif /* not IN_GCC */
201 extern size_t strlen (const char *);
202 #endif /* not __STDC__ */
203 #endif /* __GNUC__ */
205 #endif /* not __GNU_LIBRARY__ */
207 /* Handle permutation of arguments. */
209 /* Describe the part of ARGV that contains non-options that have
210 been skipped. `first_nonopt' is the index in ARGV of the first of them;
211 `last_nonopt' is the index after the last of them. */
213 static int first_nonopt;
214 static int last_nonopt;
216 /* Exchange two adjacent subsequences of ARGV.
217 One subsequence is elements [first_nonopt,last_nonopt)
218 which contains all the non-options that have been skipped so far.
219 The other is elements [last_nonopt,optind), which contains all
220 the options processed since those non-options were skipped.
222 `first_nonopt' and `last_nonopt' are relocated so that they describe
223 the new indices of the non-options in ARGV after they are moved. */
229 int bottom = first_nonopt;
230 int middle = last_nonopt;
234 /* Exchange the shorter segment with the far end of the longer segment.
235 That puts the shorter segment into the right place.
236 It leaves the longer segment in the right place overall,
237 but it consists of two parts that need to be swapped next. */
239 while (top > middle && middle > bottom)
241 if (top - middle > middle - bottom)
243 /* Bottom segment is the short one. */
244 int len = middle - bottom;
247 /* Swap it with the top part of the top segment. */
248 for (i = 0; i < len; i++)
250 tem = argv[bottom + i];
251 argv[bottom + i] = argv[top - (middle - bottom) + i];
252 argv[top - (middle - bottom) + i] = tem;
254 /* Exclude the moved bottom segment from further swapping. */
259 /* Top segment is the short one. */
260 int len = top - middle;
263 /* Swap it with the bottom part of the bottom segment. */
264 for (i = 0; i < len; i++)
266 tem = argv[bottom + i];
267 argv[bottom + i] = argv[middle + i];
268 argv[middle + i] = tem;
270 /* Exclude the moved top segment from further swapping. */
275 /* Update records for the slots the non-options now occupy. */
277 first_nonopt += (optind - last_nonopt);
278 last_nonopt = optind;
281 /* Initialize the internal data when the first call is made. */
284 _getopt_initialize (optstring)
285 const char *optstring;
287 /* Start processing options with ARGV-element 1 (since ARGV-element 0
288 is the program name); the sequence of previously skipped
289 non-option ARGV-elements is empty. */
291 first_nonopt = last_nonopt = optind = 1;
295 /* Determine how to handle the ordering of options and nonoptions. */
297 if (optstring[0] == '-')
299 ordering = RETURN_IN_ORDER;
302 else if (optstring[0] == '+')
304 ordering = REQUIRE_ORDER;
307 else if (getenv ("POSIXLY_CORRECT") != NULL)
308 ordering = REQUIRE_ORDER;
315 /* Scan elements of ARGV (whose length is ARGC) for option characters
318 If an element of ARGV starts with '-', and is not exactly "-" or "--",
319 then it is an option element. The characters of this element
320 (aside from the initial '-') are option characters. If `getopt'
321 is called repeatedly, it returns successively each of the option characters
322 from each of the option elements.
324 If `getopt' finds another option character, it returns that character,
325 updating `optind' and `nextchar' so that the next call to `getopt' can
326 resume the scan with the following option character or ARGV-element.
328 If there are no more option characters, `getopt' returns `EOF'.
329 Then `optind' is the index in ARGV of the first ARGV-element
330 that is not an option. (The ARGV-elements have been permuted
331 so that those that are not options now come last.)
333 OPTSTRING is a string containing the legitimate option characters.
334 If an option character is seen that is not listed in OPTSTRING,
335 return '?' after printing an error message. If you set `opterr' to
336 zero, the error message is suppressed but we still return '?'.
338 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
339 so the following text in the same ARGV-element, or the text of the following
340 ARGV-element, is returned in `optarg'. Two colons mean an option that
341 wants an optional arg; if there is text in the current ARGV-element,
342 it is returned in `optarg', otherwise `optarg' is set to zero.
344 If OPTSTRING starts with `-' or `+', it requests different methods of
345 handling the non-option ARGV-elements.
346 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
348 Long-named options begin with `--' instead of `-'.
349 Their names may be abbreviated as long as the abbreviation is unique
350 or is an exact match for some defined option. If they have an
351 argument, it follows the option name in the same ARGV-element, separated
352 from the option name by a `=', or else the in next ARGV-element.
353 When `getopt' finds a long-named option, it returns 0 if that option's
354 `flag' field is nonzero, the value of the option's `val' field
355 if the `flag' field is zero.
357 The elements of ARGV aren't really const, because we permute them.
358 But we pretend they're const in the prototype to be compatible
361 LONGOPTS is a vector of `struct option' terminated by an
362 element containing a name which is zero.
364 LONGIND returns the index in LONGOPT of the long-named option found.
365 It is only valid when a long-named option has been found by the most
368 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
369 long-named options. */
372 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
375 const char *optstring;
376 const struct option *longopts;
383 optstring = _getopt_initialize (optstring);
385 if (nextchar == NULL || *nextchar == '\0')
387 /* Advance to the next ARGV-element. */
389 if (ordering == PERMUTE)
391 /* If we have just processed some options following some non-options,
392 exchange them so that the options come first. */
394 if (first_nonopt != last_nonopt && last_nonopt != optind)
395 exchange ((char **) argv);
396 else if (last_nonopt != optind)
397 first_nonopt = optind;
399 /* Skip any additional non-options
400 and extend the range of non-options previously skipped. */
403 && (argv[optind][0] != '-' || argv[optind][1] == '\0'))
405 last_nonopt = optind;
408 /* The special ARGV-element `--' means premature end of options.
409 Skip it like a null option,
410 then exchange with previous non-options as if it were an option,
411 then skip everything else like a non-option. */
413 if (optind != argc && !strcmp (argv[optind], "--"))
417 if (first_nonopt != last_nonopt && last_nonopt != optind)
418 exchange ((char **) argv);
419 else if (first_nonopt == last_nonopt)
420 first_nonopt = optind;
426 /* If we have done all the ARGV-elements, stop the scan
427 and back over any non-options that we skipped and permuted. */
431 /* Set the next-arg-index to point at the non-options
432 that we previously skipped, so the caller will digest them. */
433 if (first_nonopt != last_nonopt)
434 optind = first_nonopt;
438 /* If we have come to a non-option and did not permute it,
439 either stop the scan or describe it to the caller and pass it by. */
441 if ((argv[optind][0] != '-' || argv[optind][1] == '\0'))
443 if (ordering == REQUIRE_ORDER)
445 optarg = argv[optind++];
449 /* We have found another option-ARGV-element.
450 Skip the initial punctuation. */
452 nextchar = (argv[optind] + 1
453 + (longopts != NULL && argv[optind][1] == '-'));
456 /* Decode the current option-ARGV-element. */
458 /* Check whether the ARGV-element is a long option.
460 If long_only and the ARGV-element has the form "-f", where f is
461 a valid short option, don't consider it an abbreviated form of
462 a long option that starts with f. Otherwise there would be no
463 way to give the -f short option.
465 On the other hand, if there's a long option "fubar" and
466 the ARGV-element is "-fu", do consider that an abbreviation of
467 the long option, just like "--fu", and not "-f" with arg "u".
469 This distinction seems to be the most useful approach. */
472 && (argv[optind][1] == '-'
473 || (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
476 const struct option *p;
477 const struct option *pfound = NULL;
483 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
486 /* Test all long options for either exact match
487 or abbreviated matches. */
488 for (p = longopts, option_index = 0; p->name; p++, option_index++)
489 if (!strncmp (p->name, nextchar, nameend - nextchar))
491 if (nameend - nextchar == strlen (p->name))
493 /* Exact match found. */
495 indfound = option_index;
499 else if (pfound == NULL)
501 /* First nonexact match found. */
503 indfound = option_index;
506 /* Second or later nonexact match found. */
513 fprintf (stderr, "%s: option `%s' is ambiguous\n",
514 argv[0], argv[optind]);
515 nextchar += strlen (nextchar);
522 option_index = indfound;
526 /* Don't test has_arg with >, because some C compilers don't
527 allow it to be used on enums. */
529 optarg = nameend + 1;
534 if (argv[optind - 1][1] == '-')
537 "%s: option `--%s' doesn't allow an argument\n",
538 argv[0], pfound->name);
540 /* +option or -option */
542 "%s: option `%c%s' doesn't allow an argument\n",
543 argv[0], argv[optind - 1][0], pfound->name);
545 nextchar += strlen (nextchar);
549 else if (pfound->has_arg == 1)
552 optarg = argv[optind++];
556 fprintf (stderr, "%s: option `%s' requires an argument\n",
557 argv[0], argv[optind - 1]);
558 nextchar += strlen (nextchar);
559 return optstring[0] == ':' ? ':' : '?';
562 nextchar += strlen (nextchar);
564 *longind = option_index;
567 *(pfound->flag) = pfound->val;
573 /* Can't find it as a long option. If this is not getopt_long_only,
574 or the option starts with '--' or is not a valid short
575 option, then it's an error.
576 Otherwise interpret it as a short option. */
577 if (!long_only || argv[optind][1] == '-'
578 || my_index (optstring, *nextchar) == NULL)
582 if (argv[optind][1] == '-')
584 fprintf (stderr, "%s: unrecognized option `--%s'\n",
587 /* +option or -option */
588 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
589 argv[0], argv[optind][0], nextchar);
591 nextchar = (char *) "";
597 /* Look at and handle the next short option-character. */
600 char c = *nextchar++;
601 char *temp = my_index (optstring, c);
603 /* Increment `optind' when we start to process its last character. */
604 if (*nextchar == '\0')
607 if (temp == NULL || c == ':')
611 /* 1003.2 specifies the format of this message. */
612 fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
621 /* This is an option that accepts an argument optionally. */
622 if (*nextchar != '\0')
633 /* This is an option that requires an argument. */
634 if (*nextchar != '\0')
637 /* If we end this ARGV-element by taking the rest as an arg,
638 we must advance to the next element now. */
641 else if (optind == argc)
645 /* 1003.2 specifies the format of this message. */
646 fprintf (stderr, "%s: option requires an argument -- %c\n",
650 if (optstring[0] == ':')
656 /* We already incremented `optind' once;
657 increment it again when taking next ARGV-elt as argument. */
658 optarg = argv[optind++];
667 getopt (argc, argv, optstring)
670 const char *optstring;
672 return _getopt_internal (argc, argv, optstring,
673 (const struct option *) 0,
678 #endif /* _LIBC or not __GNU_LIBRARY__. */
682 /* Compile with -DTEST to make an executable for use in testing
683 the above definition of `getopt'. */
691 int digit_optind = 0;
695 int this_option_optind = optind ? optind : 1;
697 c = getopt (argc, argv, "abc:d:0123456789");
713 if (digit_optind != 0 && digit_optind != this_option_optind)
714 printf ("digits occur in two different argv-elements.\n");
715 digit_optind = this_option_optind;
716 printf ("option %c\n", c);
720 printf ("option a\n");
724 printf ("option b\n");
728 printf ("option c with value `%s'\n", optarg);
735 printf ("?? getopt returned character code 0%o ??\n", c);
741 printf ("non-option ARGV-elements: ");
742 while (optind < argc)
743 printf ("%s ", argv[optind++]);