2 * This file has been modified for the cdrkit suite.
4 * The behaviour and appearence of the program code below can differ to a major
5 * extent from the version distributed by the original author(s).
7 * For details, see Changelog file distributed with the cdrkit package. If you
8 * received this file from another source then ask the distributing person for
9 * a log of modifications.
13 /* @(#)getopt.c 1.6 03/03/09 joerg */
15 NOTE: getopt is now part of the C library, so if you don't know what
16 "Keep this file name-space clean" means, talk to roland@gnu.ai.mit.edu
19 Copyright (C) 1987, 88, 89, 90, 91, 92, 93, 94, 95
20 Free Software Foundation, Inc.
22 This file is part of the libiberty library. This library is free
23 software; you can redistribute it and/or modify it under the
24 terms of the GNU General Public License as published by the
25 Free Software Foundation; either version 2, or (at your option)
28 This library is distributed in the hope that it will be useful,
29 but WITHOUT ANY WARRANTY; without even the implied warranty of
30 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 GNU General Public License for more details.
33 You should have received a copy of the GNU General Public License
34 along with GNU CC; see the file COPYING. If not, write to
35 the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
37 As a special exception, if you link this library with files
38 compiled with a GNU compiler to produce an executable, this does not cause
39 the resulting executable to be covered by the GNU General Public License.
40 This exception does not however invalidate any other reasons why
41 the executable file might be covered by the GNU General Public License. */
43 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
44 Ditto for AIX 3.2 and <stdlib.h>. */
46 * XXX Never do it this way, it is FSF junk
55 #define getopt __nothing__
58 #if defined (emacs) || defined (CONFIG_BROKETS)
59 /* We use <config.h> instead of "config.h" so that a compilation
60 using -I. -I$srcdir will use ./config.h rather than $srcdir/config.h
61 (which it would do because it found this file in $srcdir). */
69 /* This is a separate conditional since some stdc systems
70 reject `defined (const)'. */
78 /* Comment out all this code if we are using the GNU C Library, and are not
79 actually compiling the library itself. This code is part of the GNU C
80 Library, but also included in many other GNU distributions. Compiling
81 and linking in this code is a waste when using the GNU C library
82 (especially if it is a shared library). Rather than having every GNU
83 program understand `configure --with-gnu-libc' and omit the object files,
84 it is simpler to just do this in the source for each such file. */
85 /* Many versions of the Linux C library include older, broken versions
86 of these routines, which will break the linker's command-line
89 #if defined (_LIBC) || !defined (__GNU_LIBRARY__) || defined (__linux__)
92 /* This needs to come after some library #include
93 to get __GNU_LIBRARY__ defined. */
94 #ifdef __GNU_LIBRARY__
95 /* Don't include stdlib.h for non-GNU C libraries because some of them
96 contain conflicting prototypes for getopt. */
98 #define __DID_STDLIB__ /* FSF rubbish compensation */
99 #endif /* GNU C library. */
101 /* This version of `getopt' appears to the caller like standard Unix `getopt'
102 but it behaves differently for the user, since it allows the user
103 to intersperse the options with the other arguments.
105 As `getopt' works, it permutes the elements of ARGV so that,
106 when it is done, all the options precede everything else. Thus
107 all application programs are extended to handle flexible argument order.
109 Setting the environment variable POSIXLY_CORRECT disables permutation.
110 Then the behavior is completely standard.
112 GNU application programs can use a third alternative mode in which
113 they can distinguish the relative order of options and other arguments. */
117 static void exchange(char **argv);
118 static const char *_getopt_initialize(const char *optstring);
120 /* For communication from `getopt' to the caller.
121 When `getopt' finds an option that takes an argument,
122 the argument value is returned here.
123 Also, when `ordering' is RETURN_IN_ORDER,
124 each non-option ARGV-element is returned here. */
128 /* Index in ARGV of the next element to be scanned.
129 This is used for communication to and from the caller
130 and for communication between successive calls to `getopt'.
132 On entry to `getopt', zero means this is the first call; initialize.
134 When `getopt' returns EOF, this is the index of the first of the
135 non-option elements that the caller should itself scan.
137 Otherwise, `optind' communicates from one call to the next
138 how much of ARGV has been scanned so far. */
140 /* XXX 1003.2 says this must be 1 before any call. */
143 /* The next char to be scanned in the option-element
144 in which the last option character we returned was found.
145 This allows us to pick up the scan where we left off.
147 If this is zero, or a null string, it means resume the scan
148 by advancing to the next ARGV-element. */
150 static char *nextchar;
152 /* Callers store zero here to inhibit the error message
153 for unrecognized options. */
157 /* Set to an option character which was unrecognized.
158 This must be initialized on some systems to avoid linking in the
159 system's own getopt implementation. */
163 /* Describe how to deal with options that follow non-option ARGV-elements.
165 If the caller did not specify anything,
166 the default is REQUIRE_ORDER if the environment variable
167 POSIXLY_CORRECT is defined, PERMUTE otherwise.
169 REQUIRE_ORDER means don't recognize them as options;
170 stop option processing when the first non-option is seen.
171 This is what Unix does.
172 This mode of operation is selected by either setting the environment
173 variable POSIXLY_CORRECT, or using `+' as the first character
174 of the list of option characters.
176 PERMUTE is the default. We permute the contents of ARGV as we scan,
177 so that eventually all the non-options are at the end. This allows options
178 to be given in any order, even with programs that were not written to
181 RETURN_IN_ORDER is an option available to programs that were written
182 to expect options and other ARGV-elements in any order and that care about
183 the ordering of the two. We describe each non-option ARGV-element
184 as if it were the argument of an option with character code 1.
185 Using `-' as the first character of the list of option characters
186 selects this mode of operation.
188 The special argument `--' forces an end of option-scanning regardless
189 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
190 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
194 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
197 #ifdef __GNU_LIBRARY__
198 /* We want to avoid inclusion of string.h with non-GNU libraries
199 because there are many ways it can cause trouble.
200 On some systems, it contains special magic macros that don't work
203 #define my_index strchr
206 /* Avoid depending on library functions or files
207 whose names are inconsistent. */
211 static char *my_index(const char *str, int chr);
214 my_index (const char *str, int chr)
225 /* If using GCC, we can safely declare strlen this way.
226 If not using GCC, it is ok not to declare it. */
228 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
229 That was relevant to code that was here before. */
231 /* gcc with -traditional declares the built-in strlen to return int,
232 and has done so at least since version 2.4.5. -- rms. */
233 extern int strlen (const char *);
234 #endif /* not __STDC__ */
235 #endif /* __GNUC__ */
237 #endif /* not __GNU_LIBRARY__ */
239 #ifndef __DID_STDLIB__ /* FSF rubbish compensation */
241 * This is the clean code using Schily constructs...
244 #define getopt __nothing__
249 * FSF rubbish compensation
250 * If GCC has problems with the system include files, it has to be fixed
256 /* Handle permutation of arguments. */
258 /* Describe the part of ARGV that contains non-options that have
259 been skipped. `first_nonopt' is the index in ARGV of the first of them;
260 `last_nonopt' is the index after the last of them. */
262 static int first_nonopt;
263 static int last_nonopt;
265 /* Exchange two adjacent subsequences of ARGV.
266 One subsequence is elements [first_nonopt,last_nonopt)
267 which contains all the non-options that have been skipped so far.
268 The other is elements [last_nonopt,optind), which contains all
269 the options processed since those non-options were skipped.
271 `first_nonopt' and `last_nonopt' are relocated so that they describe
272 the new indices of the non-options in ARGV after they are moved. */
275 exchange (char **argv)
277 int bottom = first_nonopt;
278 int middle = last_nonopt;
282 /* Exchange the shorter segment with the far end of the longer segment.
283 That puts the shorter segment into the right place.
284 It leaves the longer segment in the right place overall,
285 but it consists of two parts that need to be swapped next. */
287 while (top > middle && middle > bottom)
289 if (top - middle > middle - bottom)
291 /* Bottom segment is the short one. */
292 int len = middle - bottom;
295 /* Swap it with the top part of the top segment. */
296 for (i = 0; i < len; i++)
298 tem = argv[bottom + i];
299 argv[bottom + i] = argv[top - (middle - bottom) + i];
300 argv[top - (middle - bottom) + i] = tem;
302 /* Exclude the moved bottom segment from further swapping. */
307 /* Top segment is the short one. */
308 int len = top - middle;
311 /* Swap it with the bottom part of the bottom segment. */
312 for (i = 0; i < len; i++)
314 tem = argv[bottom + i];
315 argv[bottom + i] = argv[middle + i];
316 argv[middle + i] = tem;
318 /* Exclude the moved top segment from further swapping. */
323 /* Update records for the slots the non-options now occupy. */
325 first_nonopt += (optind - last_nonopt);
326 last_nonopt = optind;
329 /* Initialize the internal data when the first call is made. */
332 _getopt_initialize (const char *optstring)
334 /* Start processing options with ARGV-element 1 (since ARGV-element 0
335 is the program name); the sequence of previously skipped
336 non-option ARGV-elements is empty. */
338 first_nonopt = last_nonopt = optind = 1;
342 /* Determine how to handle the ordering of options and nonoptions. */
344 if (optstring[0] == '-')
346 ordering = RETURN_IN_ORDER;
349 else if (optstring[0] == '+')
351 ordering = REQUIRE_ORDER;
354 else if (getenv ("POSIXLY_CORRECT") != NULL)
355 ordering = REQUIRE_ORDER;
362 /* Scan elements of ARGV (whose length is ARGC) for option characters
365 If an element of ARGV starts with '-', and is not exactly "-" or "--",
366 then it is an option element. The characters of this element
367 (aside from the initial '-') are option characters. If `getopt'
368 is called repeatedly, it returns successively each of the option characters
369 from each of the option elements.
371 If `getopt' finds another option character, it returns that character,
372 updating `optind' and `nextchar' so that the next call to `getopt' can
373 resume the scan with the following option character or ARGV-element.
375 If there are no more option characters, `getopt' returns `EOF'.
376 Then `optind' is the index in ARGV of the first ARGV-element
377 that is not an option. (The ARGV-elements have been permuted
378 so that those that are not options now come last.)
380 OPTSTRING is a string containing the legitimate option characters.
381 If an option character is seen that is not listed in OPTSTRING,
382 return '?' after printing an error message. If you set `opterr' to
383 zero, the error message is suppressed but we still return '?'.
385 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
386 so the following text in the same ARGV-element, or the text of the following
387 ARGV-element, is returned in `optarg'. Two colons mean an option that
388 wants an optional arg; if there is text in the current ARGV-element,
389 it is returned in `optarg', otherwise `optarg' is set to zero.
391 If OPTSTRING starts with `-' or `+', it requests different methods of
392 handling the non-option ARGV-elements.
393 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
395 Long-named options begin with `--' instead of `-'.
396 Their names may be abbreviated as long as the abbreviation is unique
397 or is an exact match for some defined option. If they have an
398 argument, it follows the option name in the same ARGV-element, separated
399 from the option name by a `=', or else the in next ARGV-element.
400 When `getopt' finds a long-named option, it returns 0 if that option's
401 `flag' field is nonzero, the value of the option's `val' field
402 if the `flag' field is zero.
404 The elements of ARGV aren't really const, because we permute them.
405 But we pretend they're const in the prototype to be compatible
408 LONGOPTS is a vector of `struct option' terminated by an
409 element containing a name which is zero.
411 LONGIND returns the index in LONGOPT of the long-named option found.
412 It is only valid when a long-named option has been found by the most
415 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
416 long-named options. */
419 _getopt_internal (int argc, char *const *argv, const char *optstring,
420 const struct option *longopts, int *longind, int long_only)
425 optstring = _getopt_initialize (optstring);
430 if (nextchar == NULL || *nextchar == '\0')
432 /* Advance to the next ARGV-element. */
434 if (ordering == PERMUTE)
436 /* If we have just processed some options following some non-options,
437 exchange them so that the options come first. */
439 if (first_nonopt != last_nonopt && last_nonopt != optind)
440 exchange ((char **) argv);
441 else if (last_nonopt != optind)
442 first_nonopt = optind;
444 /* Skip any additional non-options
445 and extend the range of non-options previously skipped. */
448 && (argv[optind][0] != '-' || argv[optind][1] == '\0'))
450 last_nonopt = optind;
453 /* The special ARGV-element `--' means premature end of options.
454 Skip it like a null option,
455 then exchange with previous non-options as if it were an option,
456 then skip everything else like a non-option. */
458 if (optind != argc && !strcmp (argv[optind], "--"))
462 if (first_nonopt != last_nonopt && last_nonopt != optind)
463 exchange ((char **) argv);
464 else if (first_nonopt == last_nonopt)
465 first_nonopt = optind;
471 /* If we have done all the ARGV-elements, stop the scan
472 and back over any non-options that we skipped and permuted. */
476 /* Set the next-arg-index to point at the non-options
477 that we previously skipped, so the caller will digest them. */
478 if (first_nonopt != last_nonopt)
479 optind = first_nonopt;
483 /* If we have come to a non-option and did not permute it,
484 either stop the scan or describe it to the caller and pass it by. */
486 if ((argv[optind][0] != '-' || argv[optind][1] == '\0'))
488 if (ordering == REQUIRE_ORDER)
490 optarg = argv[optind++];
494 /* We have found another option-ARGV-element.
495 Skip the initial punctuation. */
497 nextchar = (argv[optind] + 1
498 + (longopts != NULL && argv[optind][1] == '-'));
501 /* Decode the current option-ARGV-element. */
503 /* Check whether the ARGV-element is a long option.
505 If long_only and the ARGV-element has the form "-f", where f is
506 a valid short option, don't consider it an abbreviated form of
507 a long option that starts with f. Otherwise there would be no
508 way to give the -f short option.
510 On the other hand, if there's a long option "fubar" and
511 the ARGV-element is "-fu", do consider that an abbreviation of
512 the long option, just like "--fu", and not "-f" with arg "u".
514 This distinction seems to be the most useful approach. */
517 && (argv[optind][1] == '-'
518 || (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
521 const struct option *p;
522 const struct option *pfound = NULL;
528 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
531 /* Test all long options for either exact match
532 or abbreviated matches. */
533 for (p = longopts, option_index = 0; p->name; p++, option_index++)
534 if (!strncmp (p->name, nextchar, nameend - nextchar))
536 if (nameend - nextchar == strlen (p->name))
538 /* Exact match found. */
540 indfound = option_index;
544 else if (pfound == NULL)
546 /* First nonexact match found. */
548 indfound = option_index;
551 /* Second or later nonexact match found. */
558 fprintf (stderr, "%s: option `%s' is ambiguous\n",
559 argv[0], argv[optind]);
560 nextchar += strlen (nextchar);
567 option_index = indfound;
571 /* Don't test has_arg with >, because some C compilers don't
572 allow it to be used on enums. */
574 optarg = nameend + 1;
579 if (argv[optind - 1][1] == '-')
582 "%s: option `--%s' doesn't allow an argument\n",
583 argv[0], pfound->name);
585 /* +option or -option */
587 "%s: option `%c%s' doesn't allow an argument\n",
588 argv[0], argv[optind - 1][0], pfound->name);
590 nextchar += strlen (nextchar);
594 else if (pfound->has_arg == 1)
597 optarg = argv[optind++];
601 fprintf (stderr, "%s: option `%s' requires an argument\n",
602 argv[0], argv[optind - 1]);
603 nextchar += strlen (nextchar);
604 return optstring[0] == ':' ? ':' : '?';
607 nextchar += strlen (nextchar);
609 *longind = option_index;
612 *(pfound->flag) = pfound->val;
618 /* Can't find it as a long option. If this is not getopt_long_only,
619 or the option starts with '--' or is not a valid short
620 option, then it's an error.
621 Otherwise interpret it as a short option. */
622 if (!long_only || argv[optind][1] == '-'
623 || my_index (optstring, *nextchar) == NULL)
627 if (argv[optind][1] == '-')
629 fprintf (stderr, "%s: unrecognized option `--%s'\n",
632 /* +option or -option */
633 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
634 argv[0], argv[optind][0], nextchar);
636 nextchar = (char *) "";
642 /* Look at and handle the next short option-character. */
645 char c = *nextchar++;
646 char *temp = my_index (optstring, c);
648 /* Increment `optind' when we start to process its last character. */
649 if (*nextchar == '\0')
652 if (temp == NULL || c == ':')
656 /* 1003.2 specifies the format of this message. */
657 fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
666 /* This is an option that accepts an argument optionally. */
667 if (*nextchar != '\0')
678 /* This is an option that requires an argument. */
679 if (*nextchar != '\0')
682 /* If we end this ARGV-element by taking the rest as an arg,
683 we must advance to the next element now. */
686 else if (optind == argc)
690 /* 1003.2 specifies the format of this message. */
691 fprintf (stderr, "%s: option requires an argument -- %c\n",
695 if (optstring[0] == ':')
701 /* We already incremented `optind' once;
702 increment it again when taking next ARGV-elt as argument. */
703 optarg = argv[optind++];
712 getopt (int argc, char *const *argv, const char *optstring)
714 return _getopt_internal (argc, argv, optstring,
715 (const struct option *) 0,
720 #endif /* _LIBC or not __GNU_LIBRARY__. */
724 /* Compile with -DTEST to make an executable for use in testing
725 the above definition of `getopt'. */
728 main (int argc, char *argv[])
731 int digit_optind = 0;
735 int this_option_optind = optind ? optind : 1;
737 c = getopt (argc, argv, "abc:d:0123456789");
753 if (digit_optind != 0 && digit_optind != this_option_optind)
754 printf ("digits occur in two different argv-elements.\n");
755 digit_optind = this_option_optind;
756 printf ("option %c\n", c);
760 printf ("option a\n");
764 printf ("option b\n");
768 printf ("option c with value `%s'\n", optarg);
775 printf ("?? getopt returned character code 0%o ??\n", c);
781 printf ("non-option ARGV-elements: ");
782 while (optind < argc)
783 printf ("%s ", argv[optind++]);