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. */
25 /* NOTE!!! AIX requires this to be the first thing in the file.
26 Do not put ANYTHING before it! */
30 #endif /* HAVE_CONFIG_H */
33 #if !__STDC__ && !defined(const) && IN_GCC
37 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>. */
49 /* Comment out all this code if we are using the GNU C Library, and are not
50 actually compiling the library itself. This code is part of the GNU C
51 Library, but also included in many other GNU distributions. Compiling
52 and linking in this code is a waste when using the GNU C library
53 (especially if it is a shared library). Rather than having every GNU
54 program understand `configure --with-gnu-libc' and omit the object files,
55 it is simpler to just do this in the source for each such file. */
57 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
62 /* If GETOPT_COMPAT is defined, `+' as well as `--' can introduce a
63 long-named option. Because this is not POSIX.2 compliant, it is
65 /* #define GETOPT_COMPAT */
67 /* This version of `getopt' appears to the caller like standard Unix `getopt'
68 but it behaves differently for the user, since it allows the user
69 to intersperse the options with the other arguments.
71 As `getopt' works, it permutes the elements of ARGV so that,
72 when it is done, all the options precede everything else. Thus
73 all application programs are extended to handle flexible argument order.
75 Setting the environment variable POSIXLY_CORRECT disables permutation.
76 Then the behavior is completely standard.
78 GNU application programs can use a third alternative mode in which
79 they can distinguish the relative order of options and other arguments. */
83 /* For communication from `getopt' to the caller.
84 When `getopt' finds an option that takes an argument,
85 the argument value is returned here.
86 Also, when `ordering' is RETURN_IN_ORDER,
87 each non-option ARGV-element is returned here. */
91 /* Index in ARGV of the next element to be scanned.
92 This is used for communication to and from the caller
93 and for communication between successive calls to `getopt'.
95 On entry to `getopt', zero means this is the first call; initialize.
97 When `getopt' returns EOF, this is the index of the first of the
98 non-option elements that the caller should itself scan.
100 Otherwise, `optind' communicates from one call to the next
101 how much of ARGV has been scanned so far. */
103 /* XXX 1003.2 says this must be 1 before any call. */
106 /* The next char to be scanned in the option-element
107 in which the last option character we returned was found.
108 This allows us to pick up the scan where we left off.
110 If this is zero, or a null string, it means resume the scan
111 by advancing to the next ARGV-element. */
113 static char *nextchar;
115 /* Callers store zero here to inhibit the error message
116 for unrecognized options. */
120 /* Set to an option character which was unrecognized.
121 This must be initialized on some systems to avoid linking in the
122 system's own getopt implementation. */
126 /* Describe how to deal with options that follow non-option ARGV-elements.
128 If the caller did not specify anything,
129 the default is REQUIRE_ORDER if the environment variable
130 POSIXLY_CORRECT is defined, PERMUTE otherwise.
132 REQUIRE_ORDER means don't recognize them as options;
133 stop option processing when the first non-option is seen.
134 This is what Unix does.
135 This mode of operation is selected by either setting the environment
136 variable POSIXLY_CORRECT, or using `+' as the first character
137 of the list of option characters.
139 PERMUTE is the default. We permute the contents of ARGV as we scan,
140 so that eventually all the non-options are at the end. This allows options
141 to be given in any order, even with programs that were not written to
144 RETURN_IN_ORDER is an option available to programs that were written
145 to expect options and other ARGV-elements in any order and that care about
146 the ordering of the two. We describe each non-option ARGV-element
147 as if it were the argument of an option with character code 1.
148 Using `-' as the first character of the list of option characters
149 selects this mode of operation.
151 The special argument `--' forces an end of option-scanning regardless
152 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
153 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
157 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
160 #ifdef __GNU_LIBRARY__
161 /* We want to avoid inclusion of string.h with non-GNU libraries
162 because there are many ways it can cause trouble.
163 On some systems, it contains special magic macros that don't work
166 #define my_index strchr
167 #define my_bcopy(src, dst, n) memcpy ((dst), (src), (n))
170 /* Avoid depending on library functions or files
171 whose names are inconsistent. */
176 my_index (const char *str, int chr)
188 my_bcopy (const char *from, char *to, int size)
191 for (i = 0; i < size; i++)
194 #endif /* GNU C library. */
196 /* Handle permutation of arguments. */
198 /* Describe the part of ARGV that contains non-options that have
199 been skipped. `first_nonopt' is the index in ARGV of the first of them;
200 `last_nonopt' is the index after the last of them. */
202 static int first_nonopt;
203 static int last_nonopt;
205 /* Exchange two adjacent subsequences of ARGV.
206 One subsequence is elements [first_nonopt,last_nonopt)
207 which contains all the non-options that have been skipped so far.
208 The other is elements [last_nonopt,optind), which contains all
209 the options processed since those non-options were skipped.
211 `first_nonopt' and `last_nonopt' are relocated so that they describe
212 the new indices of the non-options in ARGV after they are moved. */
215 exchange (char **argv)
217 int nonopts_size = (last_nonopt - first_nonopt) * sizeof (char *);
218 char **temp = (char **) alloca (nonopts_size);
220 /* Interchange the two blocks of data in ARGV. */
222 my_bcopy ((char *) &argv[first_nonopt], (char *) temp, nonopts_size);
223 my_bcopy ((char *) &argv[last_nonopt], (char *) &argv[first_nonopt],
224 (optind - last_nonopt) * sizeof (char *));
225 my_bcopy ((char *) temp,
226 (char *) &argv[first_nonopt + optind - last_nonopt],
229 /* Update records for the slots the non-options now occupy. */
231 first_nonopt += (optind - last_nonopt);
232 last_nonopt = optind;
235 /* Scan elements of ARGV (whose length is ARGC) for option characters
238 If an element of ARGV starts with '-', and is not exactly "-" or "--",
239 then it is an option element. The characters of this element
240 (aside from the initial '-') are option characters. If `getopt'
241 is called repeatedly, it returns successively each of the option characters
242 from each of the option elements.
244 If `getopt' finds another option character, it returns that character,
245 updating `optind' and `nextchar' so that the next call to `getopt' can
246 resume the scan with the following option character or ARGV-element.
248 If there are no more option characters, `getopt' returns `EOF'.
249 Then `optind' is the index in ARGV of the first ARGV-element
250 that is not an option. (The ARGV-elements have been permuted
251 so that those that are not options now come last.)
253 OPTSTRING is a string containing the legitimate option characters.
254 If an option character is seen that is not listed in OPTSTRING,
255 return '?' after printing an error message. If you set `opterr' to
256 zero, the error message is suppressed but we still return '?'.
258 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
259 so the following text in the same ARGV-element, or the text of the following
260 ARGV-element, is returned in `optarg'. Two colons mean an option that
261 wants an optional arg; if there is text in the current ARGV-element,
262 it is returned in `optarg', otherwise `optarg' is set to zero.
264 If OPTSTRING starts with `-' or `+', it requests different methods of
265 handling the non-option ARGV-elements.
266 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
268 Long-named options begin with `--' instead of `-'.
269 Their names may be abbreviated as long as the abbreviation is unique
270 or is an exact match for some defined option. If they have an
271 argument, it follows the option name in the same ARGV-element, separated
272 from the option name by a `=', or else the in next ARGV-element.
273 When `getopt' finds a long-named option, it returns 0 if that option's
274 `flag' field is nonzero, the value of the option's `val' field
275 if the `flag' field is zero.
277 The elements of ARGV aren't really const, because we permute them.
278 But we pretend they're const in the prototype to be compatible
281 LONGOPTS is a vector of `struct option' terminated by an
282 element containing a name which is zero.
284 LONGIND returns the index in LONGOPT of the long-named option found.
285 It is only valid when a long-named option has been found by the most
288 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
289 long-named options. */
292 _getopt_internal (int argc, char *const *argv, const char *optstring,
293 const struct option *longopts, int *longind, int long_only)
299 /* Initialize the internal data when the first call is made.
300 Start processing options with ARGV-element 1 (since ARGV-element 0
301 is the program name); the sequence of previously skipped
302 non-option ARGV-elements is empty. */
306 first_nonopt = last_nonopt = optind = 1;
310 /* Determine how to handle the ordering of options and nonoptions. */
312 if (optstring[0] == '-')
314 ordering = RETURN_IN_ORDER;
317 else if (optstring[0] == '+')
319 ordering = REQUIRE_ORDER;
322 else if (getenv ("POSIXLY_CORRECT") != NULL)
323 ordering = REQUIRE_ORDER;
328 if (nextchar == NULL || *nextchar == '\0')
330 if (ordering == PERMUTE)
332 /* If we have just processed some options following some non-options,
333 exchange them so that the options come first. */
335 if (first_nonopt != last_nonopt && last_nonopt != optind)
336 exchange ((char **) argv);
337 else if (last_nonopt != optind)
338 first_nonopt = optind;
340 /* Now skip any additional non-options
341 and extend the range of non-options previously skipped. */
344 && (argv[optind][0] != '-' || argv[optind][1] == '\0')
347 || argv[optind][0] != '+' || argv[optind][1] == '\0')
348 #endif /* GETOPT_COMPAT */
351 last_nonopt = optind;
354 /* Special ARGV-element `--' means premature end of options.
355 Skip it like a null option,
356 then exchange with previous non-options as if it were an option,
357 then skip everything else like a non-option. */
359 if (optind != argc && !strcmp (argv[optind], "--"))
363 if (first_nonopt != last_nonopt && last_nonopt != optind)
364 exchange ((char **) argv);
365 else if (first_nonopt == last_nonopt)
366 first_nonopt = optind;
372 /* If we have done all the ARGV-elements, stop the scan
373 and back over any non-options that we skipped and permuted. */
377 /* Set the next-arg-index to point at the non-options
378 that we previously skipped, so the caller will digest them. */
379 if (first_nonopt != last_nonopt)
380 optind = first_nonopt;
384 /* If we have come to a non-option and did not permute it,
385 either stop the scan or describe it to the caller and pass it by. */
387 if ((argv[optind][0] != '-' || argv[optind][1] == '\0')
390 || argv[optind][0] != '+' || argv[optind][1] == '\0')
391 #endif /* GETOPT_COMPAT */
394 if (ordering == REQUIRE_ORDER)
396 optarg = argv[optind++];
400 /* We have found another option-ARGV-element.
401 Start decoding its characters. */
403 nextchar = (argv[optind] + 1
404 + (longopts != NULL && argv[optind][1] == '-'));
408 && ((argv[optind][0] == '-'
409 && (argv[optind][1] == '-' || long_only))
411 || argv[optind][0] == '+'
412 #endif /* GETOPT_COMPAT */
415 const struct option *p;
419 const struct option *pfound = NULL;
422 indfound = 0; /* To silence the compiler. */
424 while (*s && *s != '=')
427 /* Test all options for either exact match or abbreviated matches. */
428 for (p = longopts, option_index = 0; p->name;
430 if (!strncmp (p->name, nextchar, s - nextchar))
432 if (s - nextchar == strlen (p->name))
434 /* Exact match found. */
436 indfound = option_index;
440 else if (pfound == NULL)
442 /* First nonexact match found. */
444 indfound = option_index;
447 /* Second nonexact match found. */
454 fprintf (stderr, _("%s: option `%s' is ambiguous\n"),
455 exec_name, argv[optind]);
456 nextchar += strlen (nextchar);
463 option_index = indfound;
467 /* Don't test has_arg with >, because some C compilers don't
468 allow it to be used on enums. */
475 if (argv[optind - 1][1] == '-')
478 _("%s: option `--%s' doesn't allow an argument\n"),
479 exec_name, pfound->name);
481 /* +option or -option */
483 _("%s: option `%c%s' doesn't allow an argument\n"),
484 exec_name, argv[optind - 1][0], pfound->name);
486 nextchar += strlen (nextchar);
490 else if (pfound->has_arg == 1)
493 optarg = argv[optind++];
498 _("%s: option `%s' requires an argument\n"),
499 exec_name, argv[optind - 1]);
500 nextchar += strlen (nextchar);
501 return optstring[0] == ':' ? ':' : '?';
504 nextchar += strlen (nextchar);
506 *longind = option_index;
509 *(pfound->flag) = pfound->val;
514 /* Can't find it as a long option. If this is not getopt_long_only,
515 or the option starts with '--' or is not a valid short
516 option, then it's an error.
517 Otherwise interpret it as a short option. */
518 if (!long_only || argv[optind][1] == '-'
520 || argv[optind][0] == '+'
521 #endif /* GETOPT_COMPAT */
522 || my_index (optstring, *nextchar) == NULL)
526 if (argv[optind][1] == '-')
528 fprintf (stderr, _("%s: unrecognized option `--%s'\n"),
529 exec_name, nextchar);
531 /* +option or -option */
532 fprintf (stderr, _("%s: unrecognized option `%c%s'\n"),
533 exec_name, argv[optind][0], nextchar);
535 nextchar = (char *) "";
541 /* Look at and handle the next option-character. */
544 char c = *nextchar++;
545 char *temp = my_index (optstring, c);
547 /* Increment `optind' when we start to process its last character. */
548 if (*nextchar == '\0')
551 if (temp == NULL || c == ':')
556 if (c < 040 || c >= 0177)
557 fprintf (stderr, "%s: unrecognized option, character code 0%o\n",
560 fprintf (stderr, "%s: unrecognized option `-%c'\n", exec_name, c);
562 /* 1003.2 specifies the format of this message. */
563 fprintf (stderr, _("%s: illegal option -- %c\n"), exec_name, c);
573 /* This is an option that accepts an argument optionally. */
574 if (*nextchar != '\0')
585 /* This is an option that requires an argument. */
586 if (*nextchar != '\0')
589 /* If we end this ARGV-element by taking the rest as an arg,
590 we must advance to the next element now. */
593 else if (optind == argc)
598 fprintf (stderr, "%s: option `-%c' requires an argument\n",
601 /* 1003.2 specifies the format of this message. */
602 fprintf (stderr, _("%s: option requires an argument -- %c\n"),
607 if (optstring[0] == ':')
613 /* We already incremented `optind' once;
614 increment it again when taking next ARGV-elt as argument. */
615 optarg = argv[optind++];
623 /* Calls internal getopt function to enable long option names. */
625 getopt_long (int argc, char *const *argv, const char *shortopts,
626 const struct option *longopts, int *longind)
628 return _getopt_internal (argc, argv, shortopts, longopts, longind, 0);
632 getopt (int argc, char *const *argv, const char *optstring)
634 return _getopt_internal (argc, argv, optstring,
635 (const struct option *) 0,
640 #endif /* _LIBC or not __GNU_LIBRARY__. */
644 /* Compile with -DTEST to make an executable for use in testing
645 the above definition of `getopt'. */
653 int digit_optind = 0;
657 int this_option_optind = optind ? optind : 1;
659 c = getopt (argc, argv, "abc:d:0123456789");
675 if (digit_optind != 0 && digit_optind != this_option_optind)
676 printf ("digits occur in two different argv-elements.\n");
677 digit_optind = this_option_optind;
678 printf ("option %c\n", c);
682 printf ("option a\n");
686 printf ("option b\n");
690 printf ("option c with value `%s'\n", optarg);
697 printf ("?? getopt returned character code 0%o ??\n", c);
703 printf ("non-option ARGV-elements: ");
704 while (optind < argc)
705 printf ("%s ", argv[optind++]);