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. */
79 #include <win32/getopt.h>
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. */
156 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
159 #ifdef __GNU_LIBRARY__
160 /* We want to avoid inclusion of string.h with non-GNU libraries
161 because there are many ways it can cause trouble.
162 On some systems, it contains special magic macros that don't work
165 #define my_index strchr
166 #define my_strlen strlen
169 /* Avoid depending on library functions or files
170 whose names are inconsistent. */
172 #if __STDC__ || defined(PROTO)
173 extern char *getenv(const char *name);
174 extern int strcmp (const char *s1, const char *s2);
175 extern int strncmp(const char *s1, const char *s2, int n);
177 static int my_strlen(const char *s);
178 static char *my_index (const char *str, int chr);
180 extern char *getenv ();
207 #endif /* GNU C library. */
209 /* Handle permutation of arguments. */
211 /* Describe the part of ARGV that contains non-options that have
212 been skipped. `first_nonopt' is the index in ARGV of the first of them;
213 `last_nonopt' is the index after the last of them. */
215 static int first_nonopt;
216 static int last_nonopt;
218 /* Exchange two adjacent subsequences of ARGV.
219 One subsequence is elements [first_nonopt,last_nonopt)
220 which contains all the non-options that have been skipped so far.
221 The other is elements [last_nonopt,optind), which contains all
222 the options processed since those non-options were skipped.
224 `first_nonopt' and `last_nonopt' are relocated so that they describe
225 the new indices of the non-options in ARGV after they are moved.
227 To perform the swap, we first reverse the order of all elements. So
228 all options now come before all non options, but they are in the
229 wrong order. So we put back the options and non options in original
230 order by reversing them again. For example:
231 original input: a b c -x -y
232 reverse all: -y -x c b a
233 reverse options: -x -y c b a
234 reverse non options: -x -y a b c
237 #if __STDC__ || defined(PROTO)
238 static void exchange (char **argv);
245 char *temp, **first, **last;
247 /* Reverse all the elements [first_nonopt, optind) */
248 first = &argv[first_nonopt];
249 last = &argv[optind-1];
250 while (first < last) {
251 temp = *first; *first = *last; *last = temp; first++; last--;
253 /* Put back the options in order */
254 first = &argv[first_nonopt];
255 first_nonopt += (optind - last_nonopt);
256 last = &argv[first_nonopt - 1];
257 while (first < last) {
258 temp = *first; *first = *last; *last = temp; first++; last--;
261 /* Put back the non options in order */
262 first = &argv[first_nonopt];
263 last_nonopt = optind;
264 last = &argv[last_nonopt-1];
265 while (first < last) {
266 temp = *first; *first = *last; *last = temp; first++; last--;
270 /* Scan elements of ARGV (whose length is ARGC) for option characters
273 If an element of ARGV starts with '-', and is not exactly "-" or "--",
274 then it is an option element. The characters of this element
275 (aside from the initial '-') are option characters. If `getopt'
276 is called repeatedly, it returns successively each of the option characters
277 from each of the option elements.
279 If `getopt' finds another option character, it returns that character,
280 updating `optind' and `nextchar' so that the next call to `getopt' can
281 resume the scan with the following option character or ARGV-element.
283 If there are no more option characters, `getopt' returns `EOF'.
284 Then `optind' is the index in ARGV of the first ARGV-element
285 that is not an option. (The ARGV-elements have been permuted
286 so that those that are not options now come last.)
288 OPTSTRING is a string containing the legitimate option characters.
289 If an option character is seen that is not listed in OPTSTRING,
290 return BAD_OPTION after printing an error message. If you set `opterr' to
291 zero, the error message is suppressed but we still return BAD_OPTION.
293 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
294 so the following text in the same ARGV-element, or the text of the following
295 ARGV-element, is returned in `optarg'. Two colons mean an option that
296 wants an optional arg; if there is text in the current ARGV-element,
297 it is returned in `optarg', otherwise `optarg' is set to zero.
299 If OPTSTRING starts with `-' or `+', it requests different methods of
300 handling the non-option ARGV-elements.
301 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
303 Long-named options begin with `--' instead of `-'.
304 Their names may be abbreviated as long as the abbreviation is unique
305 or is an exact match for some defined option. If they have an
306 argument, it follows the option name in the same ARGV-element, separated
307 from the option name by a `=', or else the in next ARGV-element.
308 When `getopt' finds a long-named option, it returns 0 if that option's
309 `flag' field is nonzero, the value of the option's `val' field
310 if the `flag' field is zero.
312 The elements of ARGV aren't really const, because we permute them.
313 But we pretend they're const in the prototype to be compatible
316 LONGOPTS is a vector of `struct option' terminated by an
317 element containing a name which is zero.
319 LONGIND returns the index in LONGOPT of the long-named option found.
320 It is only valid when a long-named option has been found by the most
323 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
324 long-named options. */
327 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
330 const char *optstring;
331 const struct option *longopts;
339 /* Initialize the internal data when the first call is made.
340 Start processing options with ARGV-element 1 (since ARGV-element 0
341 is the program name); the sequence of previously skipped
342 non-option ARGV-elements is empty. */
346 first_nonopt = last_nonopt = optind = 1;
350 /* Determine how to handle the ordering of options and nonoptions. */
352 if (optstring[0] == '-')
354 ordering = RETURN_IN_ORDER;
357 else if (optstring[0] == '+')
359 ordering = REQUIRE_ORDER;
362 else if (getenv ("POSIXLY_CORRECT") != NULL)
363 ordering = REQUIRE_ORDER;
368 if (nextchar == NULL || *nextchar == '\0')
370 if (ordering == PERMUTE)
372 /* If we have just processed some options following some non-options,
373 exchange them so that the options come first. */
375 if (first_nonopt != last_nonopt && last_nonopt != optind)
376 exchange ((char **) argv);
377 else if (last_nonopt != optind)
378 first_nonopt = optind;
380 /* Now skip any additional non-options
381 and extend the range of non-options previously skipped. */
384 && (argv[optind][0] != '-' || argv[optind][1] == '\0')
387 || argv[optind][0] != '+' || argv[optind][1] == '\0')
388 #endif /* GETOPT_COMPAT */
391 last_nonopt = optind;
394 /* Special ARGV-element `--' means premature end of options.
395 Skip it like a null option,
396 then exchange with previous non-options as if it were an option,
397 then skip everything else like a non-option. */
399 if (optind != argc && !strcmp (argv[optind], "--"))
403 if (first_nonopt != last_nonopt && last_nonopt != optind)
404 exchange ((char **) argv);
405 else if (first_nonopt == last_nonopt)
406 first_nonopt = optind;
412 /* If we have done all the ARGV-elements, stop the scan
413 and back over any non-options that we skipped and permuted. */
417 /* Set the next-arg-index to point at the non-options
418 that we previously skipped, so the caller will digest them. */
419 if (first_nonopt != last_nonopt)
420 optind = first_nonopt;
424 /* If we have come to a non-option and did not permute it,
425 either stop the scan or describe it to the caller and pass it by. */
427 if ((argv[optind][0] != '-' || argv[optind][1] == '\0')
430 || argv[optind][0] != '+' || argv[optind][1] == '\0')
431 #endif /* GETOPT_COMPAT */
434 if (ordering == REQUIRE_ORDER)
436 optarg = argv[optind++];
440 /* We have found another option-ARGV-element.
441 Start decoding its characters. */
443 nextchar = (argv[optind] + 1
444 + (longopts != NULL && argv[optind][1] == '-'));
448 && ((argv[optind][0] == '-'
449 && (argv[optind][1] == '-' || long_only))
451 || argv[optind][0] == '+'
452 #endif /* GETOPT_COMPAT */
455 const struct option *p;
459 const struct option *pfound = NULL;
462 while (*s && *s != '=')
465 /* Test all options for either exact match or abbreviated matches. */
466 for (p = longopts, option_index = 0; p->name;
468 if (!strncmp (p->name, nextchar, s - nextchar))
470 if (s - nextchar == my_strlen (p->name))
472 /* Exact match found. */
474 indfound = option_index;
478 else if (pfound == NULL)
480 /* First nonexact match found. */
482 indfound = option_index;
485 /* Second nonexact match found. */
492 fprintf (stderr, "%s: option `%s' is ambiguous\n",
493 argv[0], argv[optind]);
494 nextchar += my_strlen (nextchar);
501 option_index = indfound;
505 /* Don't test has_arg with >, because some C compilers don't
506 allow it to be used on enums. */
513 if (argv[optind - 1][1] == '-')
516 "%s: option `--%s' doesn't allow an argument\n",
517 argv[0], pfound->name);
519 /* +option or -option */
521 "%s: option `%c%s' doesn't allow an argument\n",
522 argv[0], argv[optind - 1][0], pfound->name);
524 nextchar += my_strlen (nextchar);
528 else if (pfound->has_arg == 1)
531 optarg = argv[optind++];
535 fprintf (stderr, "%s: option `%s' requires an argument\n",
536 argv[0], argv[optind - 1]);
537 nextchar += my_strlen (nextchar);
538 return optstring[0] == ':' ? ':' : BAD_OPTION;
541 nextchar += my_strlen (nextchar);
543 *longind = option_index;
546 *(pfound->flag) = pfound->val;
551 /* Can't find it as a long option. If this is not getopt_long_only,
552 or the option starts with '--' or is not a valid short
553 option, then it's an error.
554 Otherwise interpret it as a short option. */
555 if (!long_only || argv[optind][1] == '-'
557 || argv[optind][0] == '+'
558 #endif /* GETOPT_COMPAT */
559 || my_index (optstring, *nextchar) == NULL)
563 if (argv[optind][1] == '-')
565 fprintf (stderr, "%s: unrecognized option `--%s'\n",
568 /* +option or -option */
569 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
570 argv[0], argv[optind][0], nextchar);
572 nextchar = (char *) "";
578 /* Look at and handle the next option-character. */
581 char c = *nextchar++;
582 char *temp = my_index (optstring, c);
584 /* Increment `optind' when we start to process its last character. */
585 if (*nextchar == '\0')
588 if (temp == NULL || c == ':')
593 if (c < 040 || c >= 0177)
594 fprintf (stderr, "%s: unrecognized option, character code 0%o\n",
597 fprintf (stderr, "%s: unrecognized option `-%c'\n", argv[0], c);
599 /* 1003.2 specifies the format of this message. */
600 fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
610 /* This is an option that accepts an argument optionally. */
611 if (*nextchar != '\0')
622 /* This is an option that requires an argument. */
623 if (*nextchar != '\0')
626 /* If we end this ARGV-element by taking the rest as an arg,
627 we must advance to the next element now. */
630 else if (optind == argc)
635 fprintf (stderr, "%s: option `-%c' requires an argument\n",
638 /* 1003.2 specifies the format of this message. */
639 fprintf (stderr, "%s: option requires an argument -- %c\n",
644 if (optstring[0] == ':')
650 /* We already incremented `optind' once;
651 increment it again when taking next ARGV-elt as argument. */
652 optarg = argv[optind++];
661 getopt (argc, argv, optstring)
664 const char *optstring;
666 return _getopt_internal (argc, argv, optstring,
667 (const struct option *) 0,
673 getopt_long (argc, argv, options, long_options, opt_index)
677 const struct option *long_options;
680 return _getopt_internal (argc, argv, options, long_options, opt_index, 0);
683 #endif /* _LIBC or not __GNU_LIBRARY__. */
687 /* Compile with -DTEST to make an executable for use in testing
688 the above definition of `getopt'. */
696 int digit_optind = 0;
700 int this_option_optind = optind ? optind : 1;
702 c = getopt (argc, argv, "abc:d:0123456789");
718 if (digit_optind != 0 && digit_optind != this_option_optind)
719 printf ("digits occur in two different argv-elements.\n");
720 digit_optind = this_option_optind;
721 printf ("option %c\n", c);
725 printf ("option a\n");
729 printf ("option b\n");
733 printf ("option c with value `%s'\n", optarg);
740 printf ("?? getopt returned character code 0%o ??\n", c);
746 printf ("non-option ARGV-elements: ");
747 while (optind < argc)
748 printf ("%s ", argv[optind++]);