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. */
33 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>. */
41 /* Comment out all this code if we are using the GNU C Library, and are not
42 actually compiling the library itself. This code is part of the GNU C
43 Library, but also included in many other GNU distributions. Compiling
44 and linking in this code is a waste when using the GNU C library
45 (especially if it is a shared library). Rather than having every GNU
46 program understand `configure --with-gnu-libc' and omit the object files,
47 it is simpler to just do this in the source for each such file. */
49 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
52 /* This needs to come after some library #include
53 to get __GNU_LIBRARY__ defined. */
54 #ifdef __GNU_LIBRARY__
55 /* Don't include stdlib.h for non-GNU C libraries because some of them
56 contain conflicting prototypes for getopt. */
58 #endif /* GNU C library. */
60 /* If GETOPT_COMPAT is defined, `+' as well as `--' can introduce a
61 long-named option. Because this is not POSIX.2 compliant, it is
63 /* #define GETOPT_COMPAT */
65 /* This version of `getopt' appears to the caller like standard Unix `getopt'
66 but it behaves differently for the user, since it allows the user
67 to intersperse the options with the other arguments.
69 As `getopt' works, it permutes the elements of ARGV so that,
70 when it is done, all the options precede everything else. Thus
71 all application programs are extended to handle flexible argument order.
73 Setting the environment variable POSIXLY_CORRECT disables permutation.
74 Then the behavior is completely standard.
76 GNU application programs can use a third alternative mode in which
77 they can distinguish the relative order of options and other arguments. */
81 /* For communication from `getopt' to the caller.
82 When `getopt' finds an option that takes an argument,
83 the argument value is returned here.
84 Also, when `ordering' is RETURN_IN_ORDER,
85 each non-option ARGV-element is returned here. */
89 /* Index in ARGV of the next element to be scanned.
90 This is used for communication to and from the caller
91 and for communication between successive calls to `getopt'.
93 On entry to `getopt', zero means this is the first call; initialize.
95 When `getopt' returns EOF, this is the index of the first of the
96 non-option elements that the caller should itself scan.
98 Otherwise, `optind' communicates from one call to the next
99 how much of ARGV has been scanned so far. */
101 /* XXX 1003.2 says this must be 1 before any call. */
104 /* The next char to be scanned in the option-element
105 in which the last option character we returned was found.
106 This allows us to pick up the scan where we left off.
108 If this is zero, or a null string, it means resume the scan
109 by advancing to the next ARGV-element. */
111 static char *nextchar;
113 /* Callers store zero here to inhibit the error message
114 for unrecognized options. */
118 /* Set to an option character which was unrecognized.
119 This must be initialized on some systems to avoid linking in the
120 system's own getopt implementation. */
122 #define BAD_OPTION '\0'
123 int optopt = BAD_OPTION;
125 /* Describe how to deal with options that follow non-option ARGV-elements.
127 If the caller did not specify anything,
128 the default is REQUIRE_ORDER if the environment variable
129 POSIXLY_CORRECT is defined, PERMUTE otherwise.
131 REQUIRE_ORDER means don't recognize them as options;
132 stop option processing when the first non-option is seen.
133 This is what Unix does.
134 This mode of operation is selected by either setting the environment
135 variable POSIXLY_CORRECT, or using `+' as the first character
136 of the list of option characters.
138 PERMUTE is the default. We permute the contents of ARGV as we scan,
139 so that eventually all the non-options are at the end. This allows options
140 to be given in any order, even with programs that were not written to
143 RETURN_IN_ORDER is an option available to programs that were written
144 to expect options and other ARGV-elements in any order and that care about
145 the ordering of the two. We describe each non-option ARGV-element
146 as if it were the argument of an option with character code 1.
147 Using `-' as the first character of the list of option characters
148 selects this mode of operation.
150 The special argument `--' forces an end of option-scanning regardless
151 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
152 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
155 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
158 #ifdef __GNU_LIBRARY__
159 /* We want to avoid inclusion of string.h with non-GNU libraries
160 because there are many ways it can cause trouble.
161 On some systems, it contains special magic macros that don't work
164 #define my_index strchr
165 #define my_strlen strlen
168 /* Avoid depending on library functions or files
169 whose names are inconsistent. */
171 #if __STDC__ || defined(PROTO)
172 extern char *getenv(const char *name);
173 extern int strcmp(const char *s1, const char *s2);
174 extern int strncmp(const char *s1, const char *s2, int n);
176 static int my_strlen(const char *s);
177 static char *my_index(const char *str, int chr);
179 extern char *getenv();
182 static int my_strlen(const char *str)
190 static char *my_index(const char *str, int chr)
200 #endif /* GNU C library. */
202 /* Handle permutation of arguments. */
204 /* Describe the part of ARGV that contains non-options that have
205 been skipped. `first_nonopt' is the index in ARGV of the first of them;
206 `last_nonopt' is the index after the last of them. */
208 static int first_nonopt;
209 static int last_nonopt;
211 /* Exchange two adjacent subsequences of ARGV.
212 One subsequence is elements [first_nonopt,last_nonopt)
213 which contains all the non-options that have been skipped so far.
214 The other is elements [last_nonopt,optind), which contains all
215 the options processed since those non-options were skipped.
217 `first_nonopt' and `last_nonopt' are relocated so that they describe
218 the new indices of the non-options in ARGV after they are moved.
220 To perform the swap, we first reverse the order of all elements. So
221 all options now come before all non options, but they are in the
222 wrong order. So we put back the options and non options in original
223 order by reversing them again. For example:
224 original input: a b c -x -y
225 reverse all: -y -x c b a
226 reverse options: -x -y c b a
227 reverse non options: -x -y a b c
230 #if __STDC__ || defined(PROTO)
231 static void exchange(char **argv);
234 static void exchange(char **argv)
236 char *temp, **first, **last;
238 /* Reverse all the elements [first_nonopt, optind) */
239 first = &argv[first_nonopt];
240 last = &argv[optind - 1];
241 while (first < last) {
248 /* Put back the options in order */
249 first = &argv[first_nonopt];
250 first_nonopt += (optind - last_nonopt);
251 last = &argv[first_nonopt - 1];
252 while (first < last) {
260 /* Put back the non options in order */
261 first = &argv[first_nonopt];
262 last_nonopt = optind;
263 last = &argv[last_nonopt - 1];
264 while (first < last) {
273 /* Scan elements of ARGV (whose length is ARGC) for option characters
276 If an element of ARGV starts with '-', and is not exactly "-" or "--",
277 then it is an option element. The characters of this element
278 (aside from the initial '-') are option characters. If `getopt'
279 is called repeatedly, it returns successively each of the option characters
280 from each of the option elements.
282 If `getopt' finds another option character, it returns that character,
283 updating `optind' and `nextchar' so that the next call to `getopt' can
284 resume the scan with the following option character or ARGV-element.
286 If there are no more option characters, `getopt' returns `EOF'.
287 Then `optind' is the index in ARGV of the first ARGV-element
288 that is not an option. (The ARGV-elements have been permuted
289 so that those that are not options now come last.)
291 OPTSTRING is a string containing the legitimate option characters.
292 If an option character is seen that is not listed in OPTSTRING,
293 return BAD_OPTION after printing an error message. If you set `opterr' to
294 zero, the error message is suppressed but we still return BAD_OPTION.
296 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
297 so the following text in the same ARGV-element, or the text of the following
298 ARGV-element, is returned in `optarg'. Two colons mean an option that
299 wants an optional arg; if there is text in the current ARGV-element,
300 it is returned in `optarg', otherwise `optarg' is set to zero.
302 If OPTSTRING starts with `-' or `+', it requests different methods of
303 handling the non-option ARGV-elements.
304 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
306 Long-named options begin with `--' instead of `-'.
307 Their names may be abbreviated as long as the abbreviation is unique
308 or is an exact match for some defined option. If they have an
309 argument, it follows the option name in the same ARGV-element, separated
310 from the option name by a `=', or else the in next ARGV-element.
311 When `getopt' finds a long-named option, it returns 0 if that option's
312 `flag' field is nonzero, the value of the option's `val' field
313 if the `flag' field is zero.
315 The elements of ARGV aren't really const, because we permute them.
316 But we pretend they're const in the prototype to be compatible
319 LONGOPTS is a vector of `struct option' terminated by an
320 element containing a name which is zero.
322 LONGIND returns the index in LONGOPT of the long-named option found.
323 It is only valid when a long-named option has been found by the most
326 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
327 long-named options. */
329 int _getopt_internal(int argc, char *const *argv, const char *optstring,
330 const struct option *longopts, int *longind, int long_only)
336 /* Initialize the internal data when the first call is made.
337 Start processing options with ARGV-element 1 (since ARGV-element 0
338 is the program name); the sequence of previously skipped
339 non-option ARGV-elements is empty. */
342 first_nonopt = last_nonopt = optind = 1;
346 /* Determine how to handle the ordering of options and nonoptions. */
348 if (optstring[0] == '-') {
349 ordering = RETURN_IN_ORDER;
351 } else if (optstring[0] == '+') {
352 ordering = REQUIRE_ORDER;
354 } else if (getenv("POSIXLY_CORRECT") != NULL)
355 ordering = REQUIRE_ORDER;
360 if (nextchar == NULL || *nextchar == '\0') {
361 if (ordering == PERMUTE) {
362 /* If we have just processed some options following some non-options,
363 exchange them so that the options come first. */
365 if (first_nonopt != last_nonopt && last_nonopt != optind)
366 exchange((char **) argv);
367 else if (last_nonopt != optind)
368 first_nonopt = optind;
370 /* Now skip any additional non-options
371 and extend the range of non-options previously skipped. */
373 while (optind < argc && (argv[optind][0] != '-' || argv[optind][1] == '\0')
376 || argv[optind][0] != '+' || argv[optind][1] == '\0')
377 #endif /* GETOPT_COMPAT */
380 last_nonopt = optind;
383 /* Special ARGV-element `--' means premature end of options.
384 Skip it like a null option,
385 then exchange with previous non-options as if it were an option,
386 then skip everything else like a non-option. */
388 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. */
403 if (optind == argc) {
404 /* Set the next-arg-index to point at the non-options
405 that we previously skipped, so the caller will digest them. */
406 if (first_nonopt != last_nonopt)
407 optind = first_nonopt;
411 /* If we have come to a non-option and did not permute it,
412 either stop the scan or describe it to the caller and pass it by. */
414 if ((argv[optind][0] != '-' || argv[optind][1] == '\0')
416 && (longopts == NULL || argv[optind][0] != '+' || argv[optind][1] == '\0')
417 #endif /* GETOPT_COMPAT */
419 if (ordering == REQUIRE_ORDER)
421 optarg = argv[optind++];
425 /* We have found another option-ARGV-element.
426 Start decoding its characters. */
428 nextchar = (argv[optind] + 1 + (longopts != NULL && argv[optind][1] == '-'));
431 if (longopts != NULL && ((argv[optind][0] == '-' && (argv[optind][1] == '-' || long_only))
433 || argv[optind][0] == '+'
434 #endif /* GETOPT_COMPAT */
436 const struct option *p;
440 const struct option *pfound = NULL;
443 while (*s && *s != '=')
446 /* Test all options for either exact match or abbreviated matches. */
447 for (p = longopts, option_index = 0; p->name; p++, option_index++)
448 if (!strncmp(p->name, nextchar, s - nextchar)) {
449 if (s - nextchar == my_strlen(p->name)) {
450 /* Exact match found. */
452 indfound = option_index;
455 } else if (pfound == NULL) {
456 /* First nonexact match found. */
458 indfound = option_index;
460 /* Second nonexact match found. */
464 if (ambig && !exact) {
466 fprintf(stderr, "%s: option `%s' is ambiguous\n",
467 argv[0], argv[optind]);
468 nextchar += my_strlen(nextchar);
473 if (pfound != NULL) {
474 option_index = indfound;
477 /* Don't test has_arg with >, because some C compilers don't
478 allow it to be used on enums. */
483 if (argv[optind - 1][1] == '-')
486 "%s: option `--%s' doesn't allow an argument\n",
487 argv[0], pfound->name);
489 /* +option or -option */
491 "%s: option `%c%s' doesn't allow an argument\n",
492 argv[0], argv[optind - 1][0],
495 nextchar += my_strlen(nextchar);
498 } else if (pfound->has_arg == 1) {
500 optarg = argv[optind++];
504 "%s: option `%s' requires an argument\n",
505 argv[0], argv[optind - 1]);
506 nextchar += my_strlen(nextchar);
507 return optstring[0] == ':' ? ':' : BAD_OPTION;
510 nextchar += my_strlen(nextchar);
512 *longind = option_index;
514 *(pfound->flag) = pfound->val;
519 /* Can't find it as a long option. If this is not getopt_long_only,
520 or the option starts with '--' or is not a valid short
521 option, then it's an error.
522 Otherwise interpret it as a short option. */
523 if (!long_only || argv[optind][1] == '-'
525 || argv[optind][0] == '+'
526 #endif /* GETOPT_COMPAT */
527 || my_index(optstring, *nextchar) == NULL) {
529 if (argv[optind][1] == '-')
531 fprintf(stderr, "%s: unrecognized option `--%s'\n",
534 /* +option or -option */
535 fprintf(stderr, "%s: unrecognized option `%c%s'\n",
536 argv[0], argv[optind][0], nextchar);
538 nextchar = (char *) "";
544 /* Look at and handle the next option-character. */
547 char c = *nextchar++;
548 char *temp = my_index(optstring, c);
550 /* Increment `optind' when we start to process its last character. */
551 if (*nextchar == '\0')
554 if (temp == NULL || c == ':') {
557 if (c < 040 || c >= 0177)
559 "%s: unrecognized option, character code 0%o\n",
562 fprintf(stderr, "%s: unrecognized option `-%c'\n", argv[0],
565 /* 1003.2 specifies the format of this message. */
566 fprintf(stderr, "%s: illegal option -- %c\n", argv[0], c);
572 if (temp[1] == ':') {
573 if (temp[2] == ':') {
574 /* This is an option that accepts an argument optionally. */
575 if (*nextchar != '\0') {
582 /* This is an option that requires an argument. */
583 if (*nextchar != '\0') {
585 /* If we end this ARGV-element by taking the rest as an arg,
586 we must advance to the next element now. */
588 } else if (optind == argc) {
592 "%s: option `-%c' requires an argument\n",
595 /* 1003.2 specifies the format of this message. */
597 "%s: option requires an argument -- %c\n",
602 if (optstring[0] == ':')
607 /* We already incremented `optind' once;
608 increment it again when taking next ARGV-elt as argument. */
609 optarg = argv[optind++];
617 int getopt(int argc, char *const *argv, const char *optstring)
619 return _getopt_internal(argc, argv, optstring, (const struct option *) 0, (int *) 0, 0);
622 int getopt_long(int argc, char *const *argv, const char *options, const struct option long_options, int *opt_index)
624 return _getopt_internal(argc, argv, options, long_options, opt_index, 0);
627 #endif /* _LIBC or not __GNU_LIBRARY__. */
631 /* Compile with -DTEST to make an executable for use in testing
632 the above definition of `getopt'. */
634 int main(int argc, char **argv)
637 int digit_optind = 0;
640 int this_option_optind = optind ? optind : 1;
642 c = getopt(argc, argv, "abc:d:0123456789");
657 if (digit_optind != 0 && digit_optind != this_option_optind)
658 printf("digits occur in two different argv-elements.\n");
659 digit_optind = this_option_optind;
660 printf("option %c\n", c);
664 printf("option a\n");
668 printf("option b\n");
672 printf("option c with value `%s'\n", optarg);
679 printf("?? getopt returned character code 0%o ??\n", c);
684 printf("non-option ARGV-elements: ");
685 while (optind < argc)
686 printf("%s ", argv[optind++]);