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 drepper@gnu.org
6
Copyright (C) 1987, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98
7
Free Software Foundation, Inc.
9
The GNU C Library is free software; you can redistribute it and/or
10
modify it under the terms of the GNU Library General Public License as
11
published by the Free Software Foundation; either version 2 of the
12
License, or (at your option) any later version.
14
The GNU C Library 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 GNU
17
Library General Public License for more details.
19
You should have received a copy of the GNU Library General Public
20
License along with the GNU C Library; see the file COPYING.LIB. If not,
21
write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22
Boston, MA 02111-1307, USA. */
24
/* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
25
Ditto for AIX 3.2 and <stdlib.h>. */
34
#if !defined __STDC__ || !__STDC__
35
/* This is a separate conditional since some stdc systems
36
reject `defined (const)'. */
44
/* Comment out all this code if we are using the GNU C Library, and are not
45
actually compiling the library itself. This code is part of the GNU C
46
Library, but also included in many other GNU distributions. Compiling
47
and linking in this code is a waste when using the GNU C library
48
(especially if it is a shared library). Rather than having every GNU
49
program understand `configure --with-gnu-libc' and omit the object files,
50
it is simpler to just do this in the source for each such file. */
52
#define GETOPT_INTERFACE_VERSION 2
53
#if !defined _LIBC && defined __GLIBC__ && __GLIBC__ >= 2
54
# include <gnu-versions.h>
55
# if _GNU_GETOPT_INTERFACE_VERSION == GETOPT_INTERFACE_VERSION
63
/* This needs to come after some library #include
64
to get __GNU_LIBRARY__ defined. */
65
#ifdef __GNU_LIBRARY__
66
/* Don't include stdlib.h for non-GNU C libraries because some of them
67
contain conflicting prototypes for getopt. */
70
#endif /* GNU C library. */
74
# if HAVE_STRING_H - 0
80
/* This is for other GNU distributions with internationalized messages.
81
When compiling libc, the _ macro is predefined. */
82
# ifdef HAVE_LIBINTL_H
84
# define _(msgid) gettext (msgid)
86
# define _(msgid) (msgid)
90
/* This version of `getopt' appears to the caller like standard Unix `getopt'
91
but it behaves differently for the user, since it allows the user
92
to intersperse the options with the other arguments.
94
As `getopt' works, it permutes the elements of ARGV so that,
95
when it is done, all the options precede everything else. Thus
96
all application programs are extended to handle flexible argument order.
98
Setting the environment variable POSIXLY_CORRECT disables permutation.
99
Then the behavior is completely standard.
101
GNU application programs can use a third alternative mode in which
102
they can distinguish the relative order of options and other arguments. */
106
/* For communication from `getopt' to the caller.
107
When `getopt' finds an option that takes an argument,
108
the argument value is returned here.
109
Also, when `ordering' is RETURN_IN_ORDER,
110
each non-option ARGV-element is returned here. */
114
/* Index in ARGV of the next element to be scanned.
115
This is used for communication to and from the caller
116
and for communication between successive calls to `getopt'.
118
On entry to `getopt', zero means this is the first call; initialize.
120
When `getopt' returns -1, this is the index of the first of the
121
non-option elements that the caller should itself scan.
123
Otherwise, `optind' communicates from one call to the next
124
how much of ARGV has been scanned so far. */
126
/* 1003.2 says this must be 1 before any call. */
129
/* Formerly, initialization of getopt depended on optind==0, which
130
causes problems with re-calling getopt as programs generally don't
133
int __getopt_initialized = 0;
135
/* The next char to be scanned in the option-element
136
in which the last option character we returned was found.
137
This allows us to pick up the scan where we left off.
139
If this is zero, or a null string, it means resume the scan
140
by advancing to the next ARGV-element. */
142
static char *nextchar;
144
/* Callers store zero here to inhibit the error message
145
for unrecognized options. */
149
/* Set to an option character which was unrecognized.
150
This must be initialized on some systems to avoid linking in the
151
system's own getopt implementation. */
155
/* Describe how to deal with options that follow non-option ARGV-elements.
157
If the caller did not specify anything,
158
the default is REQUIRE_ORDER if the environment variable
159
POSIXLY_CORRECT is defined, PERMUTE otherwise.
161
REQUIRE_ORDER means don't recognize them as options;
162
stop option processing when the first non-option is seen.
163
This is what Unix does.
164
This mode of operation is selected by either setting the environment
165
variable POSIXLY_CORRECT, or using `+' as the first character
166
of the list of option characters.
168
PERMUTE is the default. We permute the contents of ARGV as we scan,
169
so that eventually all the non-options are at the end. This allows options
170
to be given in any order, even with programs that were not written to
173
RETURN_IN_ORDER is an option available to programs that were written
174
to expect options and other ARGV-elements in any order and that care about
175
the ordering of the two. We describe each non-option ARGV-element
176
as if it were the argument of an option with character code 1.
177
Using `-' as the first character of the list of option characters
178
selects this mode of operation.
180
The special argument `--' forces an end of option-scanning regardless
181
of the value of `ordering'. In the case of RETURN_IN_ORDER, only
182
`--' can cause `getopt' to return -1 with `optind' != ARGC. */
186
REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
189
/* Value of POSIXLY_CORRECT environment variable. */
190
static char *posixly_correct;
192
#ifdef __GNU_LIBRARY__
193
/* We want to avoid inclusion of string.h with non-GNU libraries
194
because there are many ways it can cause trouble.
195
On some systems, it contains special magic macros that don't work
198
# define my_index strchr
204
# include <strings.h>
207
/* Avoid depending on library functions or files
208
whose names are inconsistent. */
211
extern char *getenv ();
228
/* If using GCC, we can safely declare strlen this way.
229
If not using GCC, it is ok not to declare it. */
231
/* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
232
That was relevant to code that was here before. */
233
# if (!defined __STDC__ || !__STDC__) && !defined strlen
234
/* gcc with -traditional declares the built-in strlen to return int,
235
and has done so at least since version 2.4.5. -- rms. */
236
extern int strlen (const char *);
237
# endif /* not __STDC__ */
238
#endif /* __GNUC__ */
240
#endif /* not __GNU_LIBRARY__ */
242
/* Handle permutation of arguments. */
244
/* Describe the part of ARGV that contains non-options that have
245
been skipped. `first_nonopt' is the index in ARGV of the first of them;
246
`last_nonopt' is the index after the last of them. */
248
static int first_nonopt;
249
static int last_nonopt;
252
/* Bash 2.0 gives us an environment variable containing flags
253
indicating ARGV elements that should not be considered arguments. */
255
/* Defined in getopt_init.c */
256
extern char *__getopt_nonoption_flags;
258
static int nonoption_flags_max_len;
259
static int nonoption_flags_len;
261
static int original_argc;
262
static char *const *original_argv;
264
/* Make sure the environment variable bash 2.0 puts in the environment
265
is valid for the getopt call we must make sure that the ARGV passed
266
to getopt is that one passed to the process. */
268
__attribute__ ((unused))
269
store_args_and_env (int argc, char *const *argv)
271
/* XXX This is no good solution. We should rather copy the args so
272
that we can compare them later. But we must not use malloc(3). */
273
original_argc = argc;
274
original_argv = argv;
276
# ifdef text_set_element
277
text_set_element (__libc_subinit, store_args_and_env);
278
# endif /* text_set_element */
280
# define SWAP_FLAGS(ch1, ch2) \
281
if (nonoption_flags_len > 0) \
283
char __tmp = __getopt_nonoption_flags[ch1]; \
284
__getopt_nonoption_flags[ch1] = __getopt_nonoption_flags[ch2]; \
285
__getopt_nonoption_flags[ch2] = __tmp; \
288
# define SWAP_FLAGS(ch1, ch2)
291
/* Exchange two adjacent subsequences of ARGV.
292
One subsequence is elements [first_nonopt,last_nonopt)
293
which contains all the non-options that have been skipped so far.
294
The other is elements [last_nonopt,optind), which contains all
295
the options processed since those non-options were skipped.
297
`first_nonopt' and `last_nonopt' are relocated so that they describe
298
the new indices of the non-options in ARGV after they are moved. */
300
#if defined __STDC__ && __STDC__
301
static void exchange (char **);
308
int bottom = first_nonopt;
309
int middle = last_nonopt;
313
/* Exchange the shorter segment with the far end of the longer segment.
314
That puts the shorter segment into the right place.
315
It leaves the longer segment in the right place overall,
316
but it consists of two parts that need to be swapped next. */
319
/* First make sure the handling of the `__getopt_nonoption_flags'
320
string can work normally. Our top argument must be in the range
322
if (nonoption_flags_len > 0 && top >= nonoption_flags_max_len)
324
/* We must extend the array. The user plays games with us and
325
presents new arguments. */
326
char *new_str = malloc (top + 1);
328
nonoption_flags_len = nonoption_flags_max_len = 0;
331
memset (__mempcpy (new_str, __getopt_nonoption_flags,
332
nonoption_flags_max_len),
333
'\0', top + 1 - nonoption_flags_max_len);
334
nonoption_flags_max_len = top + 1;
335
__getopt_nonoption_flags = new_str;
340
while (top > middle && middle > bottom)
342
if (top - middle > middle - bottom)
344
/* Bottom segment is the short one. */
345
int len = middle - bottom;
348
/* Swap it with the top part of the top segment. */
349
for (i = 0; i < len; i++)
351
tem = argv[bottom + i];
352
argv[bottom + i] = argv[top - (middle - bottom) + i];
353
argv[top - (middle - bottom) + i] = tem;
354
SWAP_FLAGS (bottom + i, top - (middle - bottom) + i);
356
/* Exclude the moved bottom segment from further swapping. */
361
/* Top segment is the short one. */
362
int len = top - middle;
365
/* Swap it with the bottom part of the bottom segment. */
366
for (i = 0; i < len; i++)
368
tem = argv[bottom + i];
369
argv[bottom + i] = argv[middle + i];
370
argv[middle + i] = tem;
371
SWAP_FLAGS (bottom + i, middle + i);
373
/* Exclude the moved top segment from further swapping. */
378
/* Update records for the slots the non-options now occupy. */
380
first_nonopt += (optind - last_nonopt);
381
last_nonopt = optind;
384
/* Initialize the internal data when the first call is made. */
386
#if defined __STDC__ && __STDC__
387
static const char *_getopt_initialize (int, char *const *, const char *);
390
_getopt_initialize (argc, argv, optstring)
393
const char *optstring;
395
/* Start processing options with ARGV-element 1 (since ARGV-element 0
396
is the program name); the sequence of previously skipped
397
non-option ARGV-elements is empty. */
399
first_nonopt = last_nonopt = optind;
403
posixly_correct = getenv ("POSIXLY_CORRECT");
405
/* Determine how to handle the ordering of options and nonoptions. */
407
if (optstring[0] == '-')
409
ordering = RETURN_IN_ORDER;
412
else if (optstring[0] == '+')
414
ordering = REQUIRE_ORDER;
417
else if (posixly_correct != NULL)
418
ordering = REQUIRE_ORDER;
423
if (posixly_correct == NULL
424
&& argc == original_argc && argv == original_argv)
426
if (nonoption_flags_max_len == 0)
428
if (__getopt_nonoption_flags == NULL
429
|| __getopt_nonoption_flags[0] == '\0')
430
nonoption_flags_max_len = -1;
433
const char *orig_str = __getopt_nonoption_flags;
434
int len = nonoption_flags_max_len = strlen (orig_str);
435
if (nonoption_flags_max_len < argc)
436
nonoption_flags_max_len = argc;
437
__getopt_nonoption_flags =
438
(char *) malloc (nonoption_flags_max_len);
439
if (__getopt_nonoption_flags == NULL)
440
nonoption_flags_max_len = -1;
442
memset (__mempcpy (__getopt_nonoption_flags, orig_str, len),
443
'\0', nonoption_flags_max_len - len);
446
nonoption_flags_len = nonoption_flags_max_len;
449
nonoption_flags_len = 0;
455
/* Scan elements of ARGV (whose length is ARGC) for option characters
458
If an element of ARGV starts with '-', and is not exactly "-" or "--",
459
then it is an option element. The characters of this element
460
(aside from the initial '-') are option characters. If `getopt'
461
is called repeatedly, it returns successively each of the option characters
462
from each of the option elements.
464
If `getopt' finds another option character, it returns that character,
465
updating `optind' and `nextchar' so that the next call to `getopt' can
466
resume the scan with the following option character or ARGV-element.
468
If there are no more option characters, `getopt' returns -1.
469
Then `optind' is the index in ARGV of the first ARGV-element
470
that is not an option. (The ARGV-elements have been permuted
471
so that those that are not options now come last.)
473
OPTSTRING is a string containing the legitimate option characters.
474
If an option character is seen that is not listed in OPTSTRING,
475
return '?' after printing an error message. If you set `opterr' to
476
zero, the error message is suppressed but we still return '?'.
478
If a char in OPTSTRING is followed by a colon, that means it wants an arg,
479
so the following text in the same ARGV-element, or the text of the following
480
ARGV-element, is returned in `optarg'. Two colons mean an option that
481
wants an optional arg; if there is text in the current ARGV-element,
482
it is returned in `optarg', otherwise `optarg' is set to zero.
484
If OPTSTRING starts with `-' or `+', it requests different methods of
485
handling the non-option ARGV-elements.
486
See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
488
Long-named options begin with `--' instead of `-'.
489
Their names may be abbreviated as long as the abbreviation is unique
490
or is an exact match for some defined option. If they have an
491
argument, it follows the option name in the same ARGV-element, separated
492
from the option name by a `=', or else the in next ARGV-element.
493
When `getopt' finds a long-named option, it returns 0 if that option's
494
`flag' field is nonzero, the value of the option's `val' field
495
if the `flag' field is zero.
497
The elements of ARGV aren't really const, because we permute them.
498
But we pretend they're const in the prototype to be compatible
501
LONGOPTS is a vector of `struct option' terminated by an
502
element containing a name which is zero.
504
LONGIND returns the index in LONGOPT of the long-named option found.
505
It is only valid when a long-named option has been found by the most
508
If LONG_ONLY is nonzero, '-' as well as '--' can introduce
509
long-named options. */
512
_getopt_internal (argc, argv, optstring, longopts, longind, long_only)
515
const char *optstring;
516
const struct option *longopts;
522
if (optind == 0 || !__getopt_initialized)
525
optind = 1; /* Don't scan ARGV[0], the program name. */
526
optstring = _getopt_initialize (argc, argv, optstring);
527
__getopt_initialized = 1;
530
/* Test whether ARGV[optind] points to a non-option argument.
531
Either it does not have option syntax, or there is an environment flag
532
from the shell indicating it is not an option. The later information
533
is only used when the used in the GNU libc. */
535
# define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
536
|| (optind < nonoption_flags_len \
537
&& __getopt_nonoption_flags[optind] == '1'))
539
# define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
542
if (nextchar == NULL || *nextchar == '\0')
544
/* Advance to the next ARGV-element. */
546
/* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
547
moved back by the user (who may also have changed the arguments). */
548
if (last_nonopt > optind)
549
last_nonopt = optind;
550
if (first_nonopt > optind)
551
first_nonopt = optind;
553
if (ordering == PERMUTE)
555
/* If we have just processed some options following some non-options,
556
exchange them so that the options come first. */
558
if (first_nonopt != last_nonopt && last_nonopt != optind)
559
exchange ((char **) argv);
560
else if (last_nonopt != optind)
561
first_nonopt = optind;
563
/* Skip any additional non-options
564
and extend the range of non-options previously skipped. */
566
while (optind < argc && NONOPTION_P)
568
last_nonopt = optind;
571
/* The special ARGV-element `--' means premature end of options.
572
Skip it like a null option,
573
then exchange with previous non-options as if it were an option,
574
then skip everything else like a non-option. */
576
if (optind != argc && !strcmp (argv[optind], "--"))
580
if (first_nonopt != last_nonopt && last_nonopt != optind)
581
exchange ((char **) argv);
582
else if (first_nonopt == last_nonopt)
583
first_nonopt = optind;
589
/* If we have done all the ARGV-elements, stop the scan
590
and back over any non-options that we skipped and permuted. */
594
/* Set the next-arg-index to point at the non-options
595
that we previously skipped, so the caller will digest them. */
596
if (first_nonopt != last_nonopt)
597
optind = first_nonopt;
601
/* If we have come to a non-option and did not permute it,
602
either stop the scan or describe it to the caller and pass it by. */
606
if (ordering == REQUIRE_ORDER)
608
optarg = argv[optind++];
612
/* We have found another option-ARGV-element.
613
Skip the initial punctuation. */
615
nextchar = (argv[optind] + 1
616
+ (longopts != NULL && argv[optind][1] == '-'));
619
/* Decode the current option-ARGV-element. */
621
/* Check whether the ARGV-element is a long option.
623
If long_only and the ARGV-element has the form "-f", where f is
624
a valid short option, don't consider it an abbreviated form of
625
a long option that starts with f. Otherwise there would be no
626
way to give the -f short option.
628
On the other hand, if there's a long option "fubar" and
629
the ARGV-element is "-fu", do consider that an abbreviation of
630
the long option, just like "--fu", and not "-f" with arg "u".
632
This distinction seems to be the most useful approach. */
635
&& (argv[optind][1] == '-'
636
|| (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
639
const struct option *p;
640
const struct option *pfound = NULL;
646
for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
649
/* Test all long options for either exact match
650
or abbreviated matches. */
651
for (p = longopts, option_index = 0; p->name; p++, option_index++)
652
if (!strncmp (p->name, nextchar, nameend - nextchar))
654
if ((unsigned int) (nameend - nextchar)
655
== (unsigned int) strlen (p->name))
657
/* Exact match found. */
659
indfound = option_index;
663
else if (pfound == NULL)
665
/* First nonexact match found. */
667
indfound = option_index;
670
/* Second or later nonexact match found. */
677
fprintf (stderr, _("%s: option `%s' is ambiguous\n"),
678
argv[0], argv[optind]);
679
nextchar += strlen (nextchar);
687
option_index = indfound;
691
/* Don't test has_arg with >, because some C compilers don't
692
allow it to be used on enums. */
694
optarg = nameend + 1;
699
if (argv[optind - 1][1] == '-')
702
_("%s: option `--%s' doesn't allow an argument\n"),
703
argv[0], pfound->name);
705
/* +option or -option */
707
_("%s: option `%c%s' doesn't allow an argument\n"),
708
argv[0], argv[optind - 1][0], pfound->name);
711
nextchar += strlen (nextchar);
713
optopt = pfound->val;
717
else if (pfound->has_arg == 1)
720
optarg = argv[optind++];
725
_("%s: option `%s' requires an argument\n"),
726
argv[0], argv[optind - 1]);
727
nextchar += strlen (nextchar);
728
optopt = pfound->val;
729
return optstring[0] == ':' ? ':' : '?';
732
nextchar += strlen (nextchar);
734
*longind = option_index;
737
*(pfound->flag) = pfound->val;
743
/* Can't find it as a long option. If this is not getopt_long_only,
744
or the option starts with '--' or is not a valid short
745
option, then it's an error.
746
Otherwise interpret it as a short option. */
747
if (!long_only || argv[optind][1] == '-'
748
|| my_index (optstring, *nextchar) == NULL)
752
if (argv[optind][1] == '-')
754
fprintf (stderr, _("%s: unrecognized option `--%s'\n"),
757
/* +option or -option */
758
fprintf (stderr, _("%s: unrecognized option `%c%s'\n"),
759
argv[0], argv[optind][0], nextchar);
761
nextchar = (char *) "";
768
/* Look at and handle the next short option-character. */
771
char c = *nextchar++;
772
char *temp = my_index (optstring, c);
774
/* Increment `optind' when we start to process its last character. */
775
if (*nextchar == '\0')
778
if (temp == NULL || c == ':')
783
/* 1003.2 specifies the format of this message. */
784
fprintf (stderr, _("%s: illegal option -- %c\n"),
787
fprintf (stderr, _("%s: invalid option -- %c\n"),
793
/* Convenience. Treat POSIX -W foo same as long option --foo */
794
if (temp[0] == 'W' && temp[1] == ';')
797
const struct option *p;
798
const struct option *pfound = NULL;
804
/* This is an option that requires an argument. */
805
if (*nextchar != '\0')
808
/* If we end this ARGV-element by taking the rest as an arg,
809
we must advance to the next element now. */
812
else if (optind == argc)
816
/* 1003.2 specifies the format of this message. */
817
fprintf (stderr, _("%s: option requires an argument -- %c\n"),
821
if (optstring[0] == ':')
828
/* We already incremented `optind' once;
829
increment it again when taking next ARGV-elt as argument. */
830
optarg = argv[optind++];
832
/* optarg is now the argument, see if it's in the
833
table of longopts. */
835
for (nextchar = nameend = optarg; *nameend && *nameend != '='; nameend++)
838
/* Test all long options for either exact match
839
or abbreviated matches. */
840
for (p = longopts, option_index = 0; p->name; p++, option_index++)
841
if (!strncmp (p->name, nextchar, nameend - nextchar))
843
if ((unsigned int) (nameend - nextchar) == strlen (p->name))
845
/* Exact match found. */
847
indfound = option_index;
851
else if (pfound == NULL)
853
/* First nonexact match found. */
855
indfound = option_index;
858
/* Second or later nonexact match found. */
864
fprintf (stderr, _("%s: option `-W %s' is ambiguous\n"),
865
argv[0], argv[optind]);
866
nextchar += strlen (nextchar);
872
option_index = indfound;
875
/* Don't test has_arg with >, because some C compilers don't
876
allow it to be used on enums. */
878
optarg = nameend + 1;
882
fprintf (stderr, _("\
883
%s: option `-W %s' doesn't allow an argument\n"),
884
argv[0], pfound->name);
886
nextchar += strlen (nextchar);
890
else if (pfound->has_arg == 1)
893
optarg = argv[optind++];
898
_("%s: option `%s' requires an argument\n"),
899
argv[0], argv[optind - 1]);
900
nextchar += strlen (nextchar);
901
return optstring[0] == ':' ? ':' : '?';
904
nextchar += strlen (nextchar);
906
*longind = option_index;
909
*(pfound->flag) = pfound->val;
915
return 'W'; /* Let the application handle it. */
921
/* This is an option that accepts an argument optionally. */
922
if (*nextchar != '\0')
933
/* This is an option that requires an argument. */
934
if (*nextchar != '\0')
937
/* If we end this ARGV-element by taking the rest as an arg,
938
we must advance to the next element now. */
941
else if (optind == argc)
945
/* 1003.2 specifies the format of this message. */
947
_("%s: option requires an argument -- %c\n"),
951
if (optstring[0] == ':')
957
/* We already incremented `optind' once;
958
increment it again when taking next ARGV-elt as argument. */
959
optarg = argv[optind++];
968
getopt (argc, argv, optstring)
971
const char *optstring;
973
return _getopt_internal (argc, argv, optstring,
974
(const struct option *) 0,
979
#endif /* Not ELIDE_CODE. */
983
/* Compile with -DTEST to make an executable for use in testing
984
the above definition of `getopt'. */
992
int digit_optind = 0;
996
int this_option_optind = optind ? optind : 1;
998
c = getopt (argc, argv, "abc:d:0123456789");
1014
if (digit_optind != 0 && digit_optind != this_option_optind)
1015
printf ("digits occur in two different argv-elements.\n");
1016
digit_optind = this_option_optind;
1017
printf ("option %c\n", c);
1021
printf ("option a\n");
1025
printf ("option b\n");
1029
printf ("option c with value `%s'\n", optarg);
1036
printf ("?? getopt returned character code 0%o ??\n", c);
1042
printf ("non-option ARGV-elements: ");
1043
while (optind < argc)
1044
printf ("%s ", argv[optind++]);