2 #ifndef HAVE_GETOPT_LONG
5 NOTE: getopt is now part of the C library, so if you don't know what
6 "Keep this file name-space clean" means, talk to roland@gnu.ai.mit.edu
9 Copyright (C) 1987, 88, 89, 90, 91, 92, 93, 94
10 Free Software Foundation, Inc.
12 This program is free software; you can redistribute it and/or modify it
13 under the terms of the GNU General Public License as published by the
14 Free Software Foundation; either version 2, or (at your option) any
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
26 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
27 Ditto for AIX 3.2 and <stdlib.h>. */
32 /* Comment out all this code if we are using the GNU C Library, and are not
33 actually compiling the library itself. This code is part of the GNU C
34 Library, but also included in many other GNU distributions. Compiling
35 and linking in this code is a waste when using the GNU C library
36 (especially if it is a shared library). Rather than having every GNU
37 program understand `configure --with-gnu-libc' and omit the object files,
38 it is simpler to just do this in the source for each such file. */
40 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
42 /* This is for other GNU distributions with internationalized messages.
43 The GNU C Library itself does not yet support such messages. */
47 # define gettext(msgid) (msgid)
50 /* This version of `getopt' appears to the caller like standard Unix `getopt'
51 but it behaves differently for the user, since it allows the user
52 to intersperse the options with the other arguments.
54 As `getopt' works, it permutes the elements of ARGV so that,
55 when it is done, all the options precede everything else. Thus
56 all application programs are extended to handle flexible argument order.
58 Setting the environment variable POSIXLY_CORRECT disables permutation.
59 Then the behavior is completely standard.
61 GNU application programs can use a third alternative mode in which
62 they can distinguish the relative order of options and other arguments. */
64 /* For communication from `getopt' to the caller.
65 When `getopt' finds an option that takes an argument,
66 the argument value is returned here.
67 Also, when `ordering' is RETURN_IN_ORDER,
68 each non-option ARGV-element is returned here. */
72 /* Index in ARGV of the next element to be scanned.
73 This is used for communication to and from the caller
74 and for communication between successive calls to `getopt'.
76 On entry to `getopt', zero means this is the first call; initialize.
78 When `getopt' returns EOF, this is the index of the first of the
79 non-option elements that the caller should itself scan.
81 Otherwise, `optind' communicates from one call to the next
82 how much of ARGV has been scanned so far. */
84 /* XXX 1003.2 says this must be 1 before any call. */
87 /* The next char to be scanned in the option-element
88 in which the last option character we returned was found.
89 This allows us to pick up the scan where we left off.
91 If this is zero, or a null string, it means resume the scan
92 by advancing to the next ARGV-element. */
94 static char *nextchar;
96 /* Callers store zero here to inhibit the error message
97 for unrecognized options. */
101 /* Set to an option character which was unrecognized.
102 This must be initialized on some systems to avoid linking in the
103 system's own getopt implementation. */
107 /* Describe how to deal with options that follow non-option ARGV-elements.
109 If the caller did not specify anything,
110 the default is REQUIRE_ORDER if the environment variable
111 POSIXLY_CORRECT is defined, PERMUTE otherwise.
113 REQUIRE_ORDER means don't recognize them as options;
114 stop option processing when the first non-option is seen.
115 This is what Unix does.
116 This mode of operation is selected by either setting the environment
117 variable POSIXLY_CORRECT, or using `+' as the first character
118 of the list of option characters.
120 PERMUTE is the default. We permute the contents of ARGV as we scan,
121 so that eventually all the non-options are at the end. This allows options
122 to be given in any order, even with programs that were not written to
125 RETURN_IN_ORDER is an option available to programs that were written
126 to expect options and other ARGV-elements in any order and that care about
127 the ordering of the two. We describe each non-option ARGV-element
128 as if it were the argument of an option with character code 1.
129 Using `-' as the first character of the list of option characters
130 selects this mode of operation.
132 The special argument `--' forces an end of option-scanning regardless
133 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
134 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
138 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
141 /* Value of POSIXLY_CORRECT environment variable. */
142 static char *posixly_correct;
144 #ifdef __GNU_LIBRARY__
145 /* We want to avoid inclusion of string.h with non-GNU libraries
146 because there are many ways it can cause trouble.
147 On some systems, it contains special magic macros that don't work
150 #define my_index strchr
153 /* Avoid depending on library functions or files
154 whose names are inconsistent. */
172 /* If using GCC, we can safely declare strlen this way.
173 If not using GCC, it is ok not to declare it. */
175 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
176 That was relevant to code that was here before. */
177 #if !defined (__STDC__) || !__STDC__
178 /* gcc with -traditional declares the built-in strlen to return int,
179 and has done so at least since version 2.4.5. -- rms. */
180 extern int strlen (const char *);
181 #endif /* not __STDC__ */
182 #endif /* __GNUC__ */
184 #endif /* not __GNU_LIBRARY__ */
186 /* Handle permutation of arguments. */
188 /* Describe the part of ARGV that contains non-options that have
189 been skipped. `first_nonopt' is the index in ARGV of the first of them;
190 `last_nonopt' is the index after the last of them. */
192 static int first_nonopt;
193 static int last_nonopt;
195 /* Exchange two adjacent subsequences of ARGV.
196 One subsequence is elements [first_nonopt,last_nonopt)
197 which contains all the non-options that have been skipped so far.
198 The other is elements [last_nonopt,optind), which contains all
199 the options processed since those non-options were skipped.
201 `first_nonopt' and `last_nonopt' are relocated so that they describe
202 the new indices of the non-options in ARGV after they are moved. */
208 int bottom = first_nonopt;
209 int middle = last_nonopt;
213 /* Exchange the shorter segment with the far end of the longer segment.
214 That puts the shorter segment into the right place.
215 It leaves the longer segment in the right place overall,
216 but it consists of two parts that need to be swapped next. */
218 while (top > middle && middle > bottom)
220 if (top - middle > middle - bottom)
222 /* Bottom segment is the short one. */
223 int len = middle - bottom;
226 /* Swap it with the top part of the top segment. */
227 for (i = 0; i < len; i++)
229 tem = argv[bottom + i];
230 argv[bottom + i] = argv[top - (middle - bottom) + i];
231 argv[top - (middle - bottom) + i] = tem;
233 /* Exclude the moved bottom segment from further swapping. */
238 /* Top segment is the short one. */
239 int len = top - middle;
242 /* Swap it with the bottom part of the bottom segment. */
243 for (i = 0; i < len; i++)
245 tem = argv[bottom + i];
246 argv[bottom + i] = argv[middle + i];
247 argv[middle + i] = tem;
249 /* Exclude the moved top segment from further swapping. */
254 /* Update records for the slots the non-options now occupy. */
256 first_nonopt += (optind - last_nonopt);
257 last_nonopt = optind;
260 /* Initialize the internal data when the first call is made. */
263 _getopt_initialize (optstring)
264 const char *optstring;
266 /* Start processing options with ARGV-element 1 (since ARGV-element 0
267 is the program name); the sequence of previously skipped
268 non-option ARGV-elements is empty. */
270 first_nonopt = last_nonopt = optind = 1;
274 posixly_correct = getenv ("POSIXLY_CORRECT");
276 /* Determine how to handle the ordering of options and nonoptions. */
278 if (optstring[0] == '-')
280 ordering = RETURN_IN_ORDER;
283 else if (optstring[0] == '+')
285 ordering = REQUIRE_ORDER;
288 else if (posixly_correct != NULL)
289 ordering = REQUIRE_ORDER;
296 /* Scan elements of ARGV (whose length is ARGC) for option characters
299 If an element of ARGV starts with '-', and is not exactly "-" or "--",
300 then it is an option element. The characters of this element
301 (aside from the initial '-') are option characters. If `getopt'
302 is called repeatedly, it returns successively each of the option characters
303 from each of the option elements.
305 If `getopt' finds another option character, it returns that character,
306 updating `optind' and `nextchar' so that the next call to `getopt' can
307 resume the scan with the following option character or ARGV-element.
309 If there are no more option characters, `getopt' returns `EOF'.
310 Then `optind' is the index in ARGV of the first ARGV-element
311 that is not an option. (The ARGV-elements have been permuted
312 so that those that are not options now come last.)
314 OPTSTRING is a string containing the legitimate option characters.
315 If an option character is seen that is not listed in OPTSTRING,
316 return '?' after printing an error message. If you set `opterr' to
317 zero, the error message is suppressed but we still return '?'.
319 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
320 so the following text in the same ARGV-element, or the text of the following
321 ARGV-element, is returned in `optarg'. Two colons mean an option that
322 wants an optional arg; if there is text in the current ARGV-element,
323 it is returned in `optarg', otherwise `optarg' is set to zero.
325 If OPTSTRING starts with `-' or `+', it requests different methods of
326 handling the non-option ARGV-elements.
327 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
329 Long-named options begin with `--' instead of `-'.
330 Their names may be abbreviated as long as the abbreviation is unique
331 or is an exact match for some defined option. If they have an
332 argument, it follows the option name in the same ARGV-element, separated
333 from the option name by a `=', or else the in next ARGV-element.
334 When `getopt' finds a long-named option, it returns 0 if that option's
335 `flag' field is nonzero, the value of the option's `val' field
336 if the `flag' field is zero.
338 The elements of ARGV aren't really const, because we permute them.
339 But we pretend they're const in the prototype to be compatible
342 LONGOPTS is a vector of `struct option' terminated by an
343 element containing a name which is zero.
345 LONGIND returns the index in LONGOPT of the long-named option found.
346 It is only valid when a long-named option has been found by the most
349 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
350 long-named options. */
353 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
356 const char *optstring;
357 const struct option *longopts;
364 optstring = _getopt_initialize (optstring);
366 if (nextchar == NULL || *nextchar == '\0')
368 /* Advance to the next ARGV-element. */
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 /* Skip any additional non-options
381 and extend the range of non-options previously skipped. */
384 && (argv[optind][0] != '-' || argv[optind][1] == '\0'))
386 last_nonopt = optind;
389 /* The special ARGV-element `--' means premature end of options.
390 Skip it like a null option,
391 then exchange with previous non-options as if it were an option,
392 then skip everything else like a non-option. */
394 if (optind != argc && !strcmp (argv[optind], "--"))
398 if (first_nonopt != last_nonopt && last_nonopt != optind)
399 exchange ((char **) argv);
400 else if (first_nonopt == last_nonopt)
401 first_nonopt = optind;
407 /* If we have done all the ARGV-elements, stop the scan
408 and back over any non-options that we skipped and permuted. */
412 /* Set the next-arg-index to point at the non-options
413 that we previously skipped, so the caller will digest them. */
414 if (first_nonopt != last_nonopt)
415 optind = first_nonopt;
419 /* If we have come to a non-option and did not permute it,
420 either stop the scan or describe it to the caller and pass it by. */
422 if ((argv[optind][0] != '-' || argv[optind][1] == '\0'))
424 if (ordering == REQUIRE_ORDER)
426 optarg = argv[optind++];
430 /* We have found another option-ARGV-element.
431 Skip the initial punctuation. */
433 nextchar = (argv[optind] + 1
434 + (longopts != NULL && argv[optind][1] == '-'));
437 /* Decode the current option-ARGV-element. */
439 /* Check whether the ARGV-element is a long option.
441 If long_only and the ARGV-element has the form "-f", where f is
442 a valid short option, don't consider it an abbreviated form of
443 a long option that starts with f. Otherwise there would be no
444 way to give the -f short option.
446 On the other hand, if there's a long option "fubar" and
447 the ARGV-element is "-fu", do consider that an abbreviation of
448 the long option, just like "--fu", and not "-f" with arg "u".
450 This distinction seems to be the most useful approach. */
453 && (argv[optind][1] == '-'
454 || (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
457 const struct option *p;
458 const struct option *pfound = NULL;
464 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
467 /* Test all long options for either exact match
468 or abbreviated matches. */
469 for (p = longopts, option_index = 0; p->name; p++, option_index++)
470 if (!strncmp (p->name, nextchar, nameend - nextchar))
472 if (nameend - nextchar == strlen (p->name))
474 /* Exact match found. */
476 indfound = option_index;
480 else if (pfound == NULL)
482 /* First nonexact match found. */
484 indfound = option_index;
487 /* Second or later nonexact match found. */
494 fprintf (stderr, gettext ("%s: option `%s' is ambiguous\n"),
495 argv[0], argv[optind]);
496 nextchar += strlen (nextchar);
503 option_index = indfound;
507 /* Don't test has_arg with >, because some C compilers don't
508 allow it to be used on enums. */
510 optarg = nameend + 1;
514 if (argv[optind - 1][1] == '-')
517 gettext ("%s: option `--%s' doesn't allow an argument\n"),
518 argv[0], pfound->name);
520 /* +option or -option */
522 gettext ("%s: option `%c%s' doesn't allow an argument\n"),
523 argv[0], argv[optind - 1][0], pfound->name);
525 nextchar += strlen (nextchar);
529 else if (pfound->has_arg == 1)
532 optarg = argv[optind++];
537 gettext ("%s: option `%s' requires an argument\n"),
538 argv[0], argv[optind - 1]);
539 nextchar += strlen (nextchar);
540 return optstring[0] == ':' ? ':' : '?';
543 nextchar += strlen (nextchar);
545 *longind = option_index;
548 *(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] == '-'
559 || my_index (optstring, *nextchar) == NULL)
563 if (argv[optind][1] == '-')
565 fprintf (stderr, gettext ("%s: unrecognized option `--%s'\n"),
568 /* +option or -option */
569 fprintf (stderr, gettext ("%s: unrecognized option `%c%s'\n"),
570 argv[0], argv[optind][0], nextchar);
572 nextchar = (char *) "";
578 /* Look at and handle the next short 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 /* 1003.2 specifies the format of this message. */
594 fprintf (stderr, gettext ("%s: illegal option -- %c\n"),
597 fprintf (stderr, gettext ("%s: invalid option -- %c\n"),
607 /* This is an option that accepts an argument optionally. */
608 if (*nextchar != '\0')
619 /* This is an option that requires an argument. */
620 if (*nextchar != '\0')
623 /* If we end this ARGV-element by taking the rest as an arg,
624 we must advance to the next element now. */
627 else if (optind == argc)
631 /* 1003.2 specifies the format of this message. */
633 gettext ("%s: option requires an argument -- %c\n"),
637 if (optstring[0] == ':')
643 /* We already incremented `optind' once;
644 increment it again when taking next ARGV-elt as argument. */
645 optarg = argv[optind++];
654 getopt (argc, argv, optstring)
657 const char *optstring;
659 return _getopt_internal (argc, argv, optstring,
660 (const struct option *) 0,
666 getopt_long (argc, argv, options, long_options, opt_index)
670 const struct option *long_options;
673 return _getopt_internal (argc, argv, options, long_options, opt_index, 0);
676 #endif /* _LIBC or not __GNU_LIBRARY__. */
680 /* Compile with -DTEST to make an executable for use in testing
681 the above definition of `getopt'. */
689 int digit_optind = 0;
693 int this_option_optind = optind ? optind : 1;
695 c = getopt (argc, argv, "abc:d:0123456789");
711 if (digit_optind != 0 && digit_optind != this_option_optind)
712 printf ("digits occur in two different argv-elements.\n");
713 digit_optind = this_option_optind;
714 printf ("option %c\n", c);
718 printf ("option a\n");
722 printf ("option b\n");
726 printf ("option c with value `%s'\n", optarg);
733 printf ("?? getopt returned character code 0%o ??\n", c);
739 printf ("non-option ARGV-elements: ");
740 while (optind < argc)
741 printf ("%s ", argv[optind++]);
749 #else /* HAVE_GETOPT_LONG */
750 void getopt_dummy(void) {}