]>
jfr.im git - irc/evilnet/x3.git/blob - src/getopt.c
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, 93, 94, 95, 96, 97
7 Free Software Foundation, Inc.
9 This file is part of the GNU C Library. Its master source is NOT part of
10 the C library, however. The master source lives in /gd/gnu/lib.
12 The GNU C Library is free software; you can redistribute it and/or
13 modify it under the terms of the GNU Library General Public License as
14 published by the Free Software Foundation; either version 2 of the
15 License, or (at your option) any later version.
17 The GNU C Library 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 GNU
20 Library General Public License for more details.
22 You should have received a copy of the GNU Library General Public
23 License along with the GNU C Library; see the file COPYING.LIB. If not,
24 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 Boston, MA 02111-1307, USA. */
27 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
28 Ditto for AIX 3.2 and <stdlib.h>. */
38 #if !defined (__STDC__) || !__STDC__
39 /* This is a separate conditional since some stdc systems
40 reject `defined (const)'. */
46 /* Comment out all this code if we are using the GNU C Library, and are not
47 actually compiling the library itself. This code is part of the GNU C
48 Library, but also included in many other GNU distributions. Compiling
49 and linking in this code is a waste when using the GNU C library
50 (especially if it is a shared library). Rather than having every GNU
51 program understand `configure --with-gnu-libc' and omit the object files,
52 it is simpler to just do this in the source for each such file. */
54 #define GETOPT_INTERFACE_VERSION 2
55 #if !defined (_LIBC) && defined (__GLIBC__) && __GLIBC__ >= 2
56 #include <gnu-versions.h>
57 #if _GNU_GETOPT_INTERFACE_VERSION == GETOPT_INTERFACE_VERSION
65 /* This needs to come after some library #include
66 to get __GNU_LIBRARY__ defined. */
67 #ifdef __GNU_LIBRARY__
68 /* Don't include stdlib.h for non-GNU C libraries because some of them
69 contain conflicting prototypes for getopt. */
72 #endif /* GNU C library. */
78 #if defined (WIN32) && !defined (__CYGWIN32__)
79 /* It's not Unix, really. See? Capital letters. */
81 #define getpid() GetCurrentProcessId()
85 /* This is for other GNU distributions with internationalized messages.
86 When compiling libc, the _ macro is predefined. */
89 # define _(msgid) gettext (msgid)
91 # define _(msgid) (msgid)
95 /* This version of `getopt' appears to the caller like standard Unix `getopt'
96 but it behaves differently for the user, since it allows the user
97 to intersperse the options with the other arguments.
99 As `getopt' works, it permutes the elements of ARGV so that,
100 when it is done, all the options precede everything else. Thus
101 all application programs are extended to handle flexible argument order.
103 Setting the environment variable POSIXLY_CORRECT disables permutation.
104 Then the behavior is completely standard.
106 GNU application programs can use a third alternative mode in which
107 they can distinguish the relative order of options and other arguments. */
111 /* For communication from `getopt' to the caller.
112 When `getopt' finds an option that takes an argument,
113 the argument value is returned here.
114 Also, when `ordering' is RETURN_IN_ORDER,
115 each non-option ARGV-element is returned here. */
119 /* Index in ARGV of the next element to be scanned.
120 This is used for communication to and from the caller
121 and for communication between successive calls to `getopt'.
123 On entry to `getopt', zero means this is the first call; initialize.
125 When `getopt' returns -1, this is the index of the first of the
126 non-option elements that the caller should itself scan.
128 Otherwise, `optind' communicates from one call to the next
129 how much of ARGV has been scanned so far. */
131 /* 1003.2 says this must be 1 before any call. */
134 /* Formerly, initialization of getopt depended on optind==0, which
135 causes problems with re-calling getopt as programs generally don't
138 int __getopt_initialized
= 0;
140 /* The next char to be scanned in the option-element
141 in which the last option character we returned was found.
142 This allows us to pick up the scan where we left off.
144 If this is zero, or a null string, it means resume the scan
145 by advancing to the next ARGV-element. */
147 static char *nextchar
;
149 /* Callers store zero here to inhibit the error message
150 for unrecognized options. */
154 /* Set to an option character which was unrecognized.
155 This must be initialized on some systems to avoid linking in the
156 system's own getopt implementation. */
160 /* Describe how to deal with options that follow non-option ARGV-elements.
162 If the caller did not specify anything,
163 the default is REQUIRE_ORDER if the environment variable
164 POSIXLY_CORRECT is defined, PERMUTE otherwise.
166 REQUIRE_ORDER means don't recognize them as options;
167 stop option processing when the first non-option is seen.
168 This is what Unix does.
169 This mode of operation is selected by either setting the environment
170 variable POSIXLY_CORRECT, or using `+' as the first character
171 of the list of option characters.
173 PERMUTE is the default. We permute the contents of ARGV as we scan,
174 so that eventually all the non-options are at the end. This allows options
175 to be given in any order, even with programs that were not written to
178 RETURN_IN_ORDER is an option available to programs that were written
179 to expect options and other ARGV-elements in any order and that care about
180 the ordering of the two. We describe each non-option ARGV-element
181 as if it were the argument of an option with character code 1.
182 Using `-' as the first character of the list of option characters
183 selects this mode of operation.
185 The special argument `--' forces an end of option-scanning regardless
186 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
187 `--' can cause `getopt' to return -1 with `optind' != ARGC. */
191 REQUIRE_ORDER
, PERMUTE
, RETURN_IN_ORDER
194 /* Value of POSIXLY_CORRECT environment variable. */
195 static char *posixly_correct
;
198 #ifdef __GNU_LIBRARY__
199 /* We want to avoid inclusion of string.h with non-GNU libraries
200 because there are many ways it can cause trouble.
201 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. */
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. */
230 #if !defined (__STDC__) || !__STDC__
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 /* Handle permutation of arguments. */
241 /* Describe the part of ARGV that contains non-options that have
242 been skipped. `first_nonopt' is the index in ARGV of the first of them;
243 `last_nonopt' is the index after the last of them. */
245 static int first_nonopt
;
246 static int last_nonopt
;
249 /* Bash 2.0 gives us an environment variable containing flags
250 indicating ARGV elements that should not be considered arguments. */
252 static const char *nonoption_flags
;
253 static int nonoption_flags_len
;
255 static int original_argc
;
256 static char *const *original_argv
;
258 /* Make sure the environment variable bash 2.0 puts in the environment
259 is valid for the getopt call we must make sure that the ARGV passed
260 to getopt is that one passed to the process. */
261 static void store_args (int argc
, char *const *argv
) __attribute__ ((unused
));
263 store_args (int argc
, char *const *argv
)
265 /* XXX This is no good solution. We should rather copy the args so
266 that we can compare them later. But we must not use malloc(3). */
267 original_argc
= argc
;
268 original_argv
= argv
;
270 text_set_element (__libc_subinit
, store_args
);
273 /* Exchange two adjacent subsequences of ARGV.
274 One subsequence is elements [first_nonopt,last_nonopt)
275 which contains all the non-options that have been skipped so far.
276 The other is elements [last_nonopt,optind), which contains all
277 the options processed since those non-options were skipped.
279 `first_nonopt' and `last_nonopt' are relocated so that they describe
280 the new indices of the non-options in ARGV after they are moved. */
282 #if defined (__STDC__) && __STDC__
283 static void exchange (char **);
290 int bottom
= first_nonopt
;
291 int middle
= last_nonopt
;
295 /* Exchange the shorter segment with the far end of the longer segment.
296 That puts the shorter segment into the right place.
297 It leaves the longer segment in the right place overall,
298 but it consists of two parts that need to be swapped next. */
300 while (top
> middle
&& middle
> bottom
)
302 if (top
- middle
> middle
- bottom
)
304 /* Bottom segment is the short one. */
305 int len
= middle
- bottom
;
308 /* Swap it with the top part of the top segment. */
309 for (i
= 0; i
< len
; i
++)
311 tem
= argv
[bottom
+ i
];
312 argv
[bottom
+ i
] = argv
[top
- (middle
- bottom
) + i
];
313 argv
[top
- (middle
- bottom
) + i
] = tem
;
315 /* Exclude the moved bottom segment from further swapping. */
320 /* Top segment is the short one. */
321 int len
= top
- middle
;
324 /* Swap it with the bottom part of the bottom segment. */
325 for (i
= 0; i
< len
; i
++)
327 tem
= argv
[bottom
+ i
];
328 argv
[bottom
+ i
] = argv
[middle
+ i
];
329 argv
[middle
+ i
] = tem
;
331 /* Exclude the moved top segment from further swapping. */
336 /* Update records for the slots the non-options now occupy. */
338 first_nonopt
+= (optind
- last_nonopt
);
339 last_nonopt
= optind
;
342 /* Initialize the internal data when the first call is made. */
344 #if defined (__STDC__) && __STDC__
345 static const char *_getopt_initialize (int, char *const *, const char *);
348 _getopt_initialize (argc
, argv
, optstring
)
351 const char *optstring
;
354 (void)argc
; (void)argv
;
356 /* Start processing options with ARGV-element 1 (since ARGV-element 0
357 is the program name); the sequence of previously skipped
358 non-option ARGV-elements is empty. */
360 first_nonopt
= last_nonopt
= optind
= 1;
364 posixly_correct
= getenv ("POSIXLY_CORRECT");
366 /* Determine how to handle the ordering of options and nonoptions. */
368 if (optstring
[0] == '-')
370 ordering
= RETURN_IN_ORDER
;
373 else if (optstring
[0] == '+')
375 ordering
= REQUIRE_ORDER
;
378 else if (posixly_correct
!= NULL
)
379 ordering
= REQUIRE_ORDER
;
384 if (posixly_correct
== NULL
385 && argc
== original_argc
&& argv
== original_argv
)
387 /* Bash 2.0 puts a special variable in the environment for each
388 command it runs, specifying which ARGV elements are the results of
389 file name wildcard expansion and therefore should not be
390 considered as options. */
392 sprintf (var
, "_%d_GNU_nonoption_argv_flags_", getpid ());
393 nonoption_flags
= getenv (var
);
394 if (nonoption_flags
== NULL
)
395 nonoption_flags_len
= 0;
397 nonoption_flags_len
= strlen (nonoption_flags
);
400 nonoption_flags_len
= 0;
406 /* Scan elements of ARGV (whose length is ARGC) for option characters
409 If an element of ARGV starts with '-', and is not exactly "-" or "--",
410 then it is an option element. The characters of this element
411 (aside from the initial '-') are option characters. If `getopt'
412 is called repeatedly, it returns successively each of the option characters
413 from each of the option elements.
415 If `getopt' finds another option character, it returns that character,
416 updating `optind' and `nextchar' so that the next call to `getopt' can
417 resume the scan with the following option character or ARGV-element.
419 If there are no more option characters, `getopt' returns -1.
420 Then `optind' is the index in ARGV of the first ARGV-element
421 that is not an option. (The ARGV-elements have been permuted
422 so that those that are not options now come last.)
424 OPTSTRING is a string containing the legitimate option characters.
425 If an option character is seen that is not listed in OPTSTRING,
426 return '?' after printing an error message. If you set `opterr' to
427 zero, the error message is suppressed but we still return '?'.
429 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
430 so the following text in the same ARGV-element, or the text of the following
431 ARGV-element, is returned in `optarg'. Two colons mean an option that
432 wants an optional arg; if there is text in the current ARGV-element,
433 it is returned in `optarg', otherwise `optarg' is set to zero.
435 If OPTSTRING starts with `-' or `+', it requests different methods of
436 handling the non-option ARGV-elements.
437 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
439 Long-named options begin with `--' instead of `-'.
440 Their names may be abbreviated as long as the abbreviation is unique
441 or is an exact match for some defined option. If they have an
442 argument, it follows the option name in the same ARGV-element, separated
443 from the option name by a `=', or else the in next ARGV-element.
444 When `getopt' finds a long-named option, it returns 0 if that option's
445 `flag' field is nonzero, the value of the option's `val' field
446 if the `flag' field is zero.
448 The elements of ARGV aren't really const, because we permute them.
449 But we pretend they're const in the prototype to be compatible
452 LONGOPTS is a vector of `struct option' terminated by an
453 element containing a name which is zero.
455 LONGIND returns the index in LONGOPT of the long-named option found.
456 It is only valid when a long-named option has been found by the most
459 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
460 long-named options. */
463 _getopt_internal (argc
, argv
, optstring
, longopts
, longind
, long_only
)
466 const char *optstring
;
467 const struct option
*longopts
;
473 if (!__getopt_initialized
|| optind
== 0)
475 optstring
= _getopt_initialize (argc
, argv
, optstring
);
476 optind
= 1; /* Don't scan ARGV[0], the program name. */
477 __getopt_initialized
= 1;
480 /* Test whether ARGV[optind] points to a non-option argument.
481 Either it does not have option syntax, or there is an environment flag
482 from the shell indicating it is not an option. The later information
483 is only used when the used in the GNU libc. */
485 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
486 || (optind < nonoption_flags_len \
487 && nonoption_flags[optind] == '1'))
489 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
492 if (nextchar
== NULL
|| *nextchar
== '\0')
494 /* Advance to the next ARGV-element. */
496 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
497 moved back by the user (who may also have changed the arguments). */
498 if (last_nonopt
> optind
)
499 last_nonopt
= optind
;
500 if (first_nonopt
> optind
)
501 first_nonopt
= optind
;
503 if (ordering
== PERMUTE
)
505 /* If we have just processed some options following some non-options,
506 exchange them so that the options come first. */
508 if (first_nonopt
!= last_nonopt
&& last_nonopt
!= optind
)
509 exchange ((char **) argv
);
510 else if (last_nonopt
!= optind
)
511 first_nonopt
= optind
;
513 /* Skip any additional non-options
514 and extend the range of non-options previously skipped. */
516 while (optind
< argc
&& NONOPTION_P
)
518 last_nonopt
= optind
;
521 /* The special ARGV-element `--' means premature end of options.
522 Skip it like a null option,
523 then exchange with previous non-options as if it were an option,
524 then skip everything else like a non-option. */
526 if (optind
!= argc
&& !strcmp (argv
[optind
], "--"))
530 if (first_nonopt
!= last_nonopt
&& last_nonopt
!= optind
)
531 exchange ((char **) argv
);
532 else if (first_nonopt
== last_nonopt
)
533 first_nonopt
= optind
;
539 /* If we have done all the ARGV-elements, stop the scan
540 and back over any non-options that we skipped and permuted. */
544 /* Set the next-arg-index to point at the non-options
545 that we previously skipped, so the caller will digest them. */
546 if (first_nonopt
!= last_nonopt
)
547 optind
= first_nonopt
;
551 /* If we have come to a non-option and did not permute it,
552 either stop the scan or describe it to the caller and pass it by. */
556 if (ordering
== REQUIRE_ORDER
)
558 optarg
= argv
[optind
++];
562 /* We have found another option-ARGV-element.
563 Skip the initial punctuation. */
565 nextchar
= (argv
[optind
] + 1
566 + (longopts
!= NULL
&& argv
[optind
][1] == '-'));
569 /* Decode the current option-ARGV-element. */
571 /* Check whether the ARGV-element is a long option.
573 If long_only and the ARGV-element has the form "-f", where f is
574 a valid short option, don't consider it an abbreviated form of
575 a long option that starts with f. Otherwise there would be no
576 way to give the -f short option.
578 On the other hand, if there's a long option "fubar" and
579 the ARGV-element is "-fu", do consider that an abbreviation of
580 the long option, just like "--fu", and not "-f" with arg "u".
582 This distinction seems to be the most useful approach. */
585 && (argv
[optind
][1] == '-'
586 || (long_only
&& (argv
[optind
][2] || !my_index (optstring
, argv
[optind
][1])))))
589 const struct option
*p
;
590 const struct option
*pfound
= NULL
;
596 for (nameend
= nextchar
; *nameend
&& *nameend
!= '='; nameend
++)
599 /* Test all long options for either exact match
600 or abbreviated matches. */
601 for (p
= longopts
, option_index
= 0; p
->name
; p
++, option_index
++)
602 if (!strncmp (p
->name
, nextchar
, nameend
- nextchar
))
604 if ((unsigned int) (nameend
- nextchar
)
605 == (unsigned int) strlen (p
->name
))
607 /* Exact match found. */
609 indfound
= option_index
;
613 else if (pfound
== NULL
)
615 /* First nonexact match found. */
617 indfound
= option_index
;
620 /* Second or later nonexact match found. */
627 fprintf (stderr
, _("%s: option `%s' is ambiguous\n"),
628 argv
[0], argv
[optind
]);
629 nextchar
+= strlen (nextchar
);
637 option_index
= indfound
;
641 /* Don't test has_arg with >, because some C compilers don't
642 allow it to be used on enums. */
644 optarg
= nameend
+ 1;
648 if (argv
[optind
- 1][1] == '-')
651 _("%s: option `--%s' doesn't allow an argument\n"),
652 argv
[0], pfound
->name
);
654 /* +option or -option */
656 _("%s: option `%c%s' doesn't allow an argument\n"),
657 argv
[0], argv
[optind
- 1][0], pfound
->name
);
659 nextchar
+= strlen (nextchar
);
661 optopt
= pfound
->val
;
665 else if (pfound
->has_arg
== 1)
668 optarg
= argv
[optind
++];
673 _("%s: option `%s' requires an argument\n"),
674 argv
[0], argv
[optind
- 1]);
675 nextchar
+= strlen (nextchar
);
676 optopt
= pfound
->val
;
677 return optstring
[0] == ':' ? ':' : '?';
680 nextchar
+= strlen (nextchar
);
682 *longind
= option_index
;
685 *(pfound
->flag
) = pfound
->val
;
691 /* Can't find it as a long option. If this is not getopt_long_only,
692 or the option starts with '--' or is not a valid short
693 option, then it's an error.
694 Otherwise interpret it as a short option. */
695 if (!long_only
|| argv
[optind
][1] == '-'
696 || my_index (optstring
, *nextchar
) == NULL
)
700 if (argv
[optind
][1] == '-')
702 fprintf (stderr
, _("%s: unrecognized option `--%s'\n"),
705 /* +option or -option */
706 fprintf (stderr
, _("%s: unrecognized option `%c%s'\n"),
707 argv
[0], argv
[optind
][0], nextchar
);
709 nextchar
= (char *) "";
716 /* Look at and handle the next short option-character. */
719 char c
= *nextchar
++;
720 char *temp
= my_index (optstring
, c
);
722 /* Increment `optind' when we start to process its last character. */
723 if (*nextchar
== '\0')
726 if (temp
== NULL
|| c
== ':')
731 /* 1003.2 specifies the format of this message. */
732 fprintf (stderr
, _("%s: illegal option -- %c\n"),
735 fprintf (stderr
, _("%s: invalid option -- %c\n"),
741 /* Convenience. Treat POSIX -W foo same as long option --foo */
742 if (temp
[0] == 'W' && temp
[1] == ';')
745 const struct option
*p
;
746 const struct option
*pfound
= NULL
;
752 /* This is an option that requires an argument. */
753 if (*nextchar
!= '\0')
756 /* If we end this ARGV-element by taking the rest as an arg,
757 we must advance to the next element now. */
760 else if (optind
== argc
)
764 /* 1003.2 specifies the format of this message. */
765 fprintf (stderr
, _("%s: option requires an argument -- %c\n"),
769 if (optstring
[0] == ':')
776 /* We already incremented `optind' once;
777 increment it again when taking next ARGV-elt as argument. */
778 optarg
= argv
[optind
++];
780 /* optarg is now the argument, see if it's in the
781 table of longopts. */
783 for (nextchar
= nameend
= optarg
; *nameend
&& *nameend
!= '='; nameend
++)
786 /* Test all long options for either exact match
787 or abbreviated matches. */
788 for (p
= longopts
, option_index
= 0; p
->name
; p
++, option_index
++)
789 if (!strncmp (p
->name
, nextchar
, nameend
- nextchar
))
791 if ((size_t) (nameend
- nextchar
) == (size_t) strlen (p
->name
))
793 /* Exact match found. */
795 indfound
= option_index
;
799 else if (pfound
== NULL
)
801 /* First nonexact match found. */
803 indfound
= option_index
;
806 /* Second or later nonexact match found. */
812 fprintf (stderr
, _("%s: option `-W %s' is ambiguous\n"),
813 argv
[0], argv
[optind
]);
814 nextchar
+= strlen (nextchar
);
820 option_index
= indfound
;
823 /* Don't test has_arg with >, because some C compilers don't
824 allow it to be used on enums. */
826 optarg
= nameend
+ 1;
830 fprintf (stderr
, _("\
831 %s: option `-W %s' doesn't allow an argument\n"),
832 argv
[0], pfound
->name
);
834 nextchar
+= strlen (nextchar
);
838 else if (pfound
->has_arg
== 1)
841 optarg
= argv
[optind
++];
846 _("%s: option `%s' requires an argument\n"),
847 argv
[0], argv
[optind
- 1]);
848 nextchar
+= strlen (nextchar
);
849 return optstring
[0] == ':' ? ':' : '?';
852 nextchar
+= strlen (nextchar
);
854 *longind
= option_index
;
857 *(pfound
->flag
) = pfound
->val
;
863 return 'W'; /* Let the application handle it. */
869 /* This is an option that accepts an argument optionally. */
870 if (*nextchar
!= '\0')
881 /* This is an option that requires an argument. */
882 if (*nextchar
!= '\0')
885 /* If we end this ARGV-element by taking the rest as an arg,
886 we must advance to the next element now. */
889 else if (optind
== argc
)
893 /* 1003.2 specifies the format of this message. */
895 _("%s: option requires an argument -- %c\n"),
899 if (optstring
[0] == ':')
905 /* We already incremented `optind' once;
906 increment it again when taking next ARGV-elt as argument. */
907 optarg
= argv
[optind
++];
917 getopt (argc
, argv
, optstring
)
920 const char *optstring
;
922 return _getopt_internal (argc
, argv
, optstring
,
923 (const struct option
*) 0,
927 #endif /* HAVE_GETOPT */
928 #endif /* Not ELIDE_CODE. */
932 /* Compile with -DTEST to make an executable for use in testing
933 the above definition of `getopt'. */
941 int digit_optind
= 0;
947 int this_option_optind
= optind
? optind
: 1;
949 c
= getopt (argc
, argv
, "abc:d:0123456789");
965 if (digit_optind
!= 0 && digit_optind
!= this_option_optind
)
966 printf ("digits occur in two different argv-elements.\n");
967 digit_optind
= this_option_optind
;
968 printf ("option %c\n", c
);
972 printf ("option a\n");
976 printf ("option b\n");
980 printf ("option c with value `%s'\n", optarg
);
987 printf ("?? getopt returned character code 0%o ??\n", c
);
993 printf ("non-option ARGV-elements: ");
994 while (optind
< argc
)
995 printf ("%s ", argv
[optind
++]);
1003 #endif /* IGNORE_GETOPT */