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 /* This is a separate conditional since some stdc systems
26 reject `defined (const)'. */
32 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>. */
39 /* Comment out all this code if we are using the GNU C Library, and are not
40 actually compiling the library itself. This code is part of the GNU C
41 Library, but also included in many other GNU distributions. Compiling
42 and linking in this code is a waste when using the GNU C library
43 (especially if it is a shared library). Rather than having every GNU
44 program understand `configure --with-gnu-libc' and omit the object files,
45 it is simpler to just do this in the source for each such file. */
47 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
50 /* This needs to come after some library #include
51 to get __GNU_LIBRARY__ defined. */
52 #ifdef __GNU_LIBRARY__
53 /* Don't include stdlib.h for non-GNU C libraries because some of them
54 contain conflicting prototypes for getopt. */
56 #endif /* GNU C library. */
58 /* If GETOPT_COMPAT is defined, `+' as well as `--' can introduce a
59 long-named option. Because this is not POSIX.2 compliant, it is
61 /* #define GETOPT_COMPAT */
63 /* This version of `getopt' appears to the caller like standard Unix `getopt'
64 but it behaves differently for the user, since it allows the user
65 to intersperse the options with the other arguments.
67 As `getopt' works, it permutes the elements of ARGV so that,
68 when it is done, all the options precede everything else. Thus
69 all application programs are extended to handle flexible argument order.
71 Setting the environment variable POSIXLY_CORRECT disables permutation.
72 Then the behavior is completely standard.
74 GNU application programs can use a third alternative mode in which
75 they can distinguish the relative order of options and other arguments. */
79 /* For communication from `getopt' to the caller.
80 When `getopt' finds an option that takes an argument,
81 the argument value is returned here.
82 Also, when `ordering' is RETURN_IN_ORDER,
83 each non-option ARGV-element is returned here. */
87 /* Index in ARGV of the next element to be scanned.
88 This is used for communication to and from the caller
89 and for communication between successive calls to `getopt'.
91 On entry to `getopt', zero means this is the first call; initialize.
93 When `getopt' returns EOF, this is the index of the first of the
94 non-option elements that the caller should itself scan.
96 Otherwise, `optind' communicates from one call to the next
97 how much of ARGV has been scanned so far. */
99 /* XXX 1003.2 says this must be 1 before any call. */
102 /* The next char to be scanned in the option-element
103 in which the last option character we returned was found.
104 This allows us to pick up the scan where we left off.
106 If this is zero, or a null string, it means resume the scan
107 by advancing to the next ARGV-element. */
109 static char *nextchar;
111 /* Callers store zero here to inhibit the error message
112 for unrecognized options. */
116 /* Set to an option character which was unrecognized.
117 This must be initialized on some systems to avoid linking in the
118 system's own getopt implementation. */
122 /* Describe how to deal with options that follow non-option ARGV-elements.
124 If the caller did not specify anything,
125 the default is REQUIRE_ORDER if the environment variable
126 POSIXLY_CORRECT is defined, PERMUTE otherwise.
128 REQUIRE_ORDER means don't recognize them as options;
129 stop option processing when the first non-option is seen.
130 This is what Unix does.
131 This mode of operation is selected by either setting the environment
132 variable POSIXLY_CORRECT, or using `+' as the first character
133 of the list of option characters.
135 PERMUTE is the default. We permute the contents of ARGV as we scan,
136 so that eventually all the non-options are at the end. This allows options
137 to be given in any order, even with programs that were not written to
140 RETURN_IN_ORDER is an option available to programs that were written
141 to expect options and other ARGV-elements in any order and that care about
142 the ordering of the two. We describe each non-option ARGV-element
143 as if it were the argument of an option with character code 1.
144 Using `-' as the first character of the list of option characters
145 selects this mode of operation.
147 The special argument `--' forces an end of option-scanning regardless
148 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
149 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
153 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
156 #ifdef __GNU_LIBRARY__
157 /* We want to avoid inclusion of string.h with non-GNU libraries
158 because there are many ways it can cause trouble.
159 On some systems, it contains special magic macros that don't work
162 #define my_index strchr
165 /* Avoid depending on library functions or files
166 whose names are inconsistent. */
184 /* If using GCC, we can safely declare strlen this way.
185 If not using GCC, it is ok not to declare it.
186 (Supposedly there are some machines where it might get a warning,
187 but changing this conditional to __STDC__ is too risky.) */
194 extern size_t strlen (const char *);
197 #endif /* GNU C library. */
199 /* Handle permutation of arguments. */
201 /* Describe the part of ARGV that contains non-options that have
202 been skipped. `first_nonopt' is the index in ARGV of the first of them;
203 `last_nonopt' is the index after the last of them. */
205 static int first_nonopt;
206 static int last_nonopt;
208 /* Exchange two adjacent subsequences of ARGV.
209 One subsequence is elements [first_nonopt,last_nonopt)
210 which contains all the non-options that have been skipped so far.
211 The other is elements [last_nonopt,optind), which contains all
212 the options processed since those non-options were skipped.
214 `first_nonopt' and `last_nonopt' are relocated so that they describe
215 the new indices of the non-options in ARGV after they are moved. */
221 int bottom = first_nonopt;
222 int middle = last_nonopt;
226 /* Exchange the shorter segment with the far end of the longer segment.
227 That puts the shorter segment into the right place.
228 It leaves the longer segment in the right place overall,
229 but it consists of two parts that need to be swapped next. */
231 while (top > middle && middle > bottom)
233 if (top - middle > middle - bottom)
235 /* Bottom segment is the short one. */
236 int len = middle - bottom;
239 /* Swap it with the top part of the top segment. */
240 for (i = 0; i < len; i++)
242 tem = argv[bottom + i];
243 argv[bottom + i] = argv[top - (middle - bottom) + i];
244 argv[top - (middle - bottom) + i] = tem;
246 /* Exclude the moved bottom segment from further swapping. */
251 /* Top segment is the short one. */
252 int len = top - middle;
255 /* Swap it with the bottom part of the bottom segment. */
256 for (i = 0; i < len; i++)
258 tem = argv[bottom + i];
259 argv[bottom + i] = argv[middle + i];
260 argv[middle + i] = tem;
262 /* Exclude the moved top segment from further swapping. */
267 /* Update records for the slots the non-options now occupy. */
269 first_nonopt += (optind - last_nonopt);
270 last_nonopt = optind;
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 '?' after printing an error message. If you set `opterr' to
294 zero, the error message is suppressed but we still return '?'.
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. */
330 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
333 const char *optstring;
334 const struct option *longopts;
342 /* Initialize the internal data when the first call is made.
343 Start processing options with ARGV-element 1 (since ARGV-element 0
344 is the program name); the sequence of previously skipped
345 non-option ARGV-elements is empty. */
349 first_nonopt = last_nonopt = optind = 1;
353 /* Determine how to handle the ordering of options and nonoptions. */
355 if (optstring[0] == '-')
357 ordering = RETURN_IN_ORDER;
360 else if (optstring[0] == '+')
362 ordering = REQUIRE_ORDER;
365 else if (getenv ("POSIXLY_CORRECT") != NULL)
366 ordering = REQUIRE_ORDER;
371 if (nextchar == NULL || *nextchar == '\0')
373 if (ordering == PERMUTE)
375 /* If we have just processed some options following some non-options,
376 exchange them so that the options come first. */
378 if (first_nonopt != last_nonopt && last_nonopt != optind)
379 exchange ((char **) argv);
380 else if (last_nonopt != optind)
381 first_nonopt = optind;
383 /* Now skip any additional non-options
384 and extend the range of non-options previously skipped. */
387 && (argv[optind][0] != '-' || argv[optind][1] == '\0')
390 || argv[optind][0] != '+' || argv[optind][1] == '\0')
391 #endif /* GETOPT_COMPAT */
394 last_nonopt = optind;
397 /* Special ARGV-element `--' means premature end of options.
398 Skip it like a null option,
399 then exchange with previous non-options as if it were an option,
400 then skip everything else like a non-option. */
402 if (optind != argc && !strcmp (argv[optind], "--"))
406 if (first_nonopt != last_nonopt && last_nonopt != optind)
407 exchange ((char **) argv);
408 else if (first_nonopt == last_nonopt)
409 first_nonopt = optind;
415 /* If we have done all the ARGV-elements, stop the scan
416 and back over any non-options that we skipped and permuted. */
420 /* Set the next-arg-index to point at the non-options
421 that we previously skipped, so the caller will digest them. */
422 if (first_nonopt != last_nonopt)
423 optind = first_nonopt;
427 /* If we have come to a non-option and did not permute it,
428 either stop the scan or describe it to the caller and pass it by. */
430 if ((argv[optind][0] != '-' || argv[optind][1] == '\0')
433 || argv[optind][0] != '+' || argv[optind][1] == '\0')
434 #endif /* GETOPT_COMPAT */
437 if (ordering == REQUIRE_ORDER)
439 optarg = argv[optind++];
443 /* We have found another option-ARGV-element.
444 Start decoding its characters. */
446 nextchar = (argv[optind] + 1
447 + (longopts != NULL && argv[optind][1] == '-'));
451 && ((argv[optind][0] == '-'
452 && (argv[optind][1] == '-' || long_only))
454 || argv[optind][0] == '+'
455 #endif /* GETOPT_COMPAT */
458 const struct option *p;
462 const struct option *pfound = NULL;
465 while (*s && *s != '=')
468 /* Test all options for either exact match or abbreviated matches. */
469 for (p = longopts, option_index = 0; p->name;
471 if (!strncmp (p->name, nextchar, s - nextchar))
473 if (s - nextchar == strlen (p->name))
475 /* Exact match found. */
477 indfound = option_index;
481 else if (pfound == NULL)
483 /* First nonexact match found. */
485 indfound = option_index;
488 /* Second nonexact match found. */
495 fprintf (stderr, "%s: option `%s' is ambiguous\n",
496 argv[0], argv[optind]);
497 nextchar += strlen (nextchar);
504 option_index = indfound;
508 /* Don't test has_arg with >, because some C compilers don't
509 allow it to be used on enums. */
516 if (argv[optind - 1][1] == '-')
519 "%s: option `--%s' doesn't allow an argument\n",
520 argv[0], pfound->name);
522 /* +option or -option */
524 "%s: option `%c%s' doesn't allow an argument\n",
525 argv[0], argv[optind - 1][0], pfound->name);
527 nextchar += strlen (nextchar);
531 else if (pfound->has_arg == 1)
534 optarg = argv[optind++];
538 fprintf (stderr, "%s: option `%s' requires an argument\n",
539 argv[0], argv[optind - 1]);
540 nextchar += strlen (nextchar);
541 return optstring[0] == ':' ? ':' : '?';
544 nextchar += strlen (nextchar);
546 *longind = option_index;
549 *(pfound->flag) = pfound->val;
554 /* Can't find it as a long option. If this is not getopt_long_only,
555 or the option starts with '--' or is not a valid short
556 option, then it's an error.
557 Otherwise interpret it as a short option. */
558 if (!long_only || argv[optind][1] == '-'
560 || argv[optind][0] == '+'
561 #endif /* GETOPT_COMPAT */
562 || my_index (optstring, *nextchar) == NULL)
566 if (argv[optind][1] == '-')
568 fprintf (stderr, "%s: unrecognized option `--%s'\n",
571 /* +option or -option */
572 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
573 argv[0], argv[optind][0], nextchar);
575 nextchar = (char *) "";
581 /* Look at and handle the next option-character. */
584 char c = *nextchar++;
585 char *temp = my_index (optstring, c);
587 /* Increment `optind' when we start to process its last character. */
588 if (*nextchar == '\0')
591 if (temp == NULL || c == ':')
596 if (c < 040 || c >= 0177)
597 fprintf (stderr, "%s: unrecognized option, character code 0%o\n",
600 fprintf (stderr, "%s: unrecognized option `-%c'\n", argv[0], c);
602 /* 1003.2 specifies the format of this message. */
603 fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
613 /* This is an option that accepts an argument optionally. */
614 if (*nextchar != '\0')
625 /* This is an option that requires an argument. */
626 if (*nextchar != '\0')
629 /* If we end this ARGV-element by taking the rest as an arg,
630 we must advance to the next element now. */
633 else if (optind == argc)
638 fprintf (stderr, "%s: option `-%c' requires an argument\n",
641 /* 1003.2 specifies the format of this message. */
642 fprintf (stderr, "%s: option requires an argument -- %c\n",
647 if (optstring[0] == ':')
653 /* We already incremented `optind' once;
654 increment it again when taking next ARGV-elt as argument. */
655 optarg = argv[optind++];
664 getopt (argc, argv, optstring)
667 const char *optstring;
669 return _getopt_internal (argc, argv, optstring,
670 (const struct option *) 0,
675 #endif /* _LIBC or not __GNU_LIBRARY__. */
679 /* Compile with -DTEST to make an executable for use in testing
680 the above definition of `getopt'. */
688 int digit_optind = 0;
692 int this_option_optind = optind ? optind : 1;
694 c = getopt (argc, argv, "abc:d:0123456789");
710 if (digit_optind != 0 && digit_optind != this_option_optind)
711 printf ("digits occur in two different argv-elements.\n");
712 digit_optind = this_option_optind;
713 printf ("option %c\n", c);
717 printf ("option a\n");
721 printf ("option b\n");
725 printf ("option c with value `%s'\n", optarg);
732 printf ("?? getopt returned character code 0%o ??\n", c);
738 printf ("non-option ARGV-elements: ");
739 while (optind < argc)
740 printf ("%s ", argv[optind++]);