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
NOTE: The canonical source of this file is maintained with the GNU C Library.
10
Bugs can be reported to bug-glibc@gnu.org.
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, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
27
/* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
28
Ditto for AIX 3.2 and <stdlib.h>. */
37
#if !defined __STDC__ || !__STDC__
38
/* This is a separate conditional since some stdc systems
39
reject `defined (const)'. */
47
/* Comment out all this code if we are using the GNU C Library, and are not
48
actually compiling the library itself. This code is part of the GNU C
49
Library, but also included in many other GNU distributions. Compiling
50
and linking in this code is a waste when using the GNU C library
51
(especially if it is a shared library). Rather than having every GNU
52
program understand `configure --with-gnu-libc' and omit the object files,
53
it is simpler to just do this in the source for each such file. */
55
#define GETOPT_INTERFACE_VERSION 2
56
#if !defined _LIBC && defined __GLIBC__ && __GLIBC__ >= 2
57
# include <gnu-versions.h>
58
# if _GNU_GETOPT_INTERFACE_VERSION == GETOPT_INTERFACE_VERSION
66
/* This needs to come after some library #include
67
to get __GNU_LIBRARY__ defined. */
68
#ifdef __GNU_LIBRARY__
69
/* Don't include stdlib.h for non-GNU C libraries because some of them
70
contain conflicting prototypes for getopt. */
73
#endif /* GNU C library. */
77
# if HAVE_STRING_H - 0
83
/* This is for other GNU distributions with internationalized messages.
84
When compiling libc, the _ macro is predefined. */
85
# ifdef HAVE_LIBINTL_H
87
# define _(msgid) gettext (msgid)
89
# define _(msgid) (msgid)
93
/* This version of `getopt' appears to the caller like standard Unix `getopt'
94
but it behaves differently for the user, since it allows the user
95
to intersperse the options with the other arguments.
97
As `getopt' works, it permutes the elements of ARGV so that,
98
when it is done, all the options precede everything else. Thus
99
all application programs are extended to handle flexible argument order.
101
Setting the environment variable POSIXLY_CORRECT disables permutation.
102
Then the behavior is completely standard.
104
GNU application programs can use a third alternative mode in which
105
they can distinguish the relative order of options and other arguments. */
109
/* For communication from `getopt' to the caller.
110
When `getopt' finds an option that takes an argument,
111
the argument value is returned here.
112
Also, when `ordering' is RETURN_IN_ORDER,
113
each non-option ARGV-element is returned here. */
117
/* Index in ARGV of the next element to be scanned.
118
This is used for communication to and from the caller
119
and for communication between successive calls to `getopt'.
121
On entry to `getopt', zero means this is the first call; initialize.
123
When `getopt' returns -1, this is the index of the first of the
124
non-option elements that the caller should itself scan.
126
Otherwise, `optind' communicates from one call to the next
127
how much of ARGV has been scanned so far. */
129
/* 1003.2 says this must be 1 before any call. */
132
/* Formerly, initialization of getopt depended on optind==0, which
133
causes problems with re-calling getopt as programs generally don't
136
int __getopt_initialized = 0;
138
/* The next char to be scanned in the option-element
139
in which the last option character we returned was found.
140
This allows us to pick up the scan where we left off.
142
If this is zero, or a null string, it means resume the scan
143
by advancing to the next ARGV-element. */
145
static char *nextchar;
147
/* Callers store zero here to inhibit the error message
148
for unrecognized options. */
152
/* Set to an option character which was unrecognized.
153
This must be initialized on some systems to avoid linking in the
154
system's own getopt implementation. */
158
/* Describe how to deal with options that follow non-option ARGV-elements.
160
If the caller did not specify anything,
161
the default is REQUIRE_ORDER if the environment variable
162
POSIXLY_CORRECT is defined, PERMUTE otherwise.
164
REQUIRE_ORDER means don't recognize them as options;
165
stop option processing when the first non-option is seen.
166
This is what Unix does.
167
This mode of operation is selected by either setting the environment
168
variable POSIXLY_CORRECT, or using `+' as the first character
169
of the list of option characters.
171
PERMUTE is the default. We permute the contents of ARGV as we scan,
172
so that eventually all the non-options are at the end. This allows options
173
to be given in any order, even with programs that were not written to
176
RETURN_IN_ORDER is an option available to programs that were written
177
to expect options and other ARGV-elements in any order and that care about
178
the ordering of the two. We describe each non-option ARGV-element
179
as if it were the argument of an option with character code 1.
180
Using `-' as the first character of the list of option characters
181
selects this mode of operation.
183
The special argument `--' forces an end of option-scanning regardless
184
of the value of `ordering'. In the case of RETURN_IN_ORDER, only
185
`--' can cause `getopt' to return -1 with `optind' != ARGC. */
189
REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
192
/* Value of POSIXLY_CORRECT environment variable. */
193
static char *posixly_correct;
195
#ifdef __GNU_LIBRARY__
196
/* We want to avoid inclusion of string.h with non-GNU libraries
197
because there are many ways it can cause trouble.
198
On some systems, it contains special magic macros that don't work
201
# define my_index strchr
207
# include <strings.h>
210
/* Avoid depending on library functions or files
211
whose names are inconsistent. */
214
extern char *getenv ();
231
/* If using GCC, we can safely declare strlen this way.
232
If not using GCC, it is ok not to declare it. */
234
/* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
235
That was relevant to code that was here before. */
236
# if (!defined __STDC__ || !__STDC__) && !defined strlen
237
/* gcc with -traditional declares the built-in strlen to return int,
238
and has done so at least since version 2.4.5. -- rms. */
239
extern int strlen (const char *);
240
# endif /* not __STDC__ */
241
#endif /* __GNUC__ */
243
#endif /* not __GNU_LIBRARY__ */
245
/* Handle permutation of arguments. */
247
/* Describe the part of ARGV that contains non-options that have
248
been skipped. `first_nonopt' is the index in ARGV of the first of them;
249
`last_nonopt' is the index after the last of them. */
251
static int first_nonopt;
252
static int last_nonopt;
255
/* Bash 2.0 gives us an environment variable containing flags
256
indicating ARGV elements that should not be considered arguments. */
258
/* Defined in getopt_init.c */
259
extern char *__getopt_nonoption_flags;
261
static int nonoption_flags_max_len;
262
static int nonoption_flags_len;
264
static int original_argc;
265
static char *const *original_argv;
267
/* Make sure the environment variable bash 2.0 puts in the environment
268
is valid for the getopt call we must make sure that the ARGV passed
269
to getopt is that one passed to the process. */
271
__attribute__ ((unused))
272
store_args_and_env (int argc, char *const *argv)
274
/* XXX This is no good solution. We should rather copy the args so
275
that we can compare them later. But we must not use malloc(3). */
276
original_argc = argc;
277
original_argv = argv;
279
# ifdef text_set_element
280
text_set_element (__libc_subinit, store_args_and_env);
281
# endif /* text_set_element */
283
# define SWAP_FLAGS(ch1, ch2) \
284
if (nonoption_flags_len > 0) \
286
char __tmp = __getopt_nonoption_flags[ch1]; \
287
__getopt_nonoption_flags[ch1] = __getopt_nonoption_flags[ch2]; \
288
__getopt_nonoption_flags[ch2] = __tmp; \
291
# define SWAP_FLAGS(ch1, ch2)
294
/* Exchange two adjacent subsequences of ARGV.
295
One subsequence is elements [first_nonopt,last_nonopt)
296
which contains all the non-options that have been skipped so far.
297
The other is elements [last_nonopt,optind), which contains all
298
the options processed since those non-options were skipped.
300
`first_nonopt' and `last_nonopt' are relocated so that they describe
301
the new indices of the non-options in ARGV after they are moved. */
303
#if defined __STDC__ && __STDC__
304
static void exchange (char **);
311
int bottom = first_nonopt;
312
int middle = last_nonopt;
316
/* Exchange the shorter segment with the far end of the longer segment.
317
That puts the shorter segment into the right place.
318
It leaves the longer segment in the right place overall,
319
but it consists of two parts that need to be swapped next. */
322
/* First make sure the handling of the `__getopt_nonoption_flags'
323
string can work normally. Our top argument must be in the range
325
if (nonoption_flags_len > 0 && top >= nonoption_flags_max_len)
327
/* We must extend the array. The user plays games with us and
328
presents new arguments. */
329
char *new_str = malloc (top + 1);
331
nonoption_flags_len = nonoption_flags_max_len = 0;
334
memset (__mempcpy (new_str, __getopt_nonoption_flags,
335
nonoption_flags_max_len),
336
'\0', top + 1 - nonoption_flags_max_len);
337
nonoption_flags_max_len = top + 1;
338
__getopt_nonoption_flags = new_str;
343
while (top > middle && middle > bottom)
345
if (top - middle > middle - bottom)
347
/* Bottom segment is the short one. */
348
int len = middle - bottom;
351
/* Swap it with the top part of the top segment. */
352
for (i = 0; i < len; i++)
354
tem = argv[bottom + i];
355
argv[bottom + i] = argv[top - (middle - bottom) + i];
356
argv[top - (middle - bottom) + i] = tem;
357
SWAP_FLAGS (bottom + i, top - (middle - bottom) + i);
359
/* Exclude the moved bottom segment from further swapping. */
364
/* Top segment is the short one. */
365
int len = top - middle;
368
/* Swap it with the bottom part of the bottom segment. */
369
for (i = 0; i < len; i++)
371
tem = argv[bottom + i];
372
argv[bottom + i] = argv[middle + i];
373
argv[middle + i] = tem;
374
SWAP_FLAGS (bottom + i, middle + i);
376
/* Exclude the moved top segment from further swapping. */
381
/* Update records for the slots the non-options now occupy. */
383
first_nonopt += (optind - last_nonopt);
384
last_nonopt = optind;
387
/* Initialize the internal data when the first call is made. */
389
#if defined __STDC__ && __STDC__
390
static const char *_getopt_initialize (int, char *const *, const char *);
393
_getopt_initialize (argc, argv, optstring)
396
const char *optstring;
398
/* Start processing options with ARGV-element 1 (since ARGV-element 0
399
is the program name); the sequence of previously skipped
400
non-option ARGV-elements is empty. */
402
first_nonopt = last_nonopt = optind;
406
posixly_correct = getenv ("POSIXLY_CORRECT");
408
/* Determine how to handle the ordering of options and nonoptions. */
410
if (optstring[0] == '-')
412
ordering = RETURN_IN_ORDER;
415
else if (optstring[0] == '+')
417
ordering = REQUIRE_ORDER;
420
else if (posixly_correct != NULL)
421
ordering = REQUIRE_ORDER;
426
if (posixly_correct == NULL
427
&& argc == original_argc && argv == original_argv)
429
if (nonoption_flags_max_len == 0)
431
if (__getopt_nonoption_flags == NULL
432
|| __getopt_nonoption_flags[0] == '\0')
433
nonoption_flags_max_len = -1;
436
const char *orig_str = __getopt_nonoption_flags;
437
int len = nonoption_flags_max_len = strlen (orig_str);
438
if (nonoption_flags_max_len < argc)
439
nonoption_flags_max_len = argc;
440
__getopt_nonoption_flags =
441
(char *) malloc (nonoption_flags_max_len);
442
if (__getopt_nonoption_flags == NULL)
443
nonoption_flags_max_len = -1;
445
memset (__mempcpy (__getopt_nonoption_flags, orig_str, len),
446
'\0', nonoption_flags_max_len - len);
449
nonoption_flags_len = nonoption_flags_max_len;
452
nonoption_flags_len = 0;
458
/* Scan elements of ARGV (whose length is ARGC) for option characters
461
If an element of ARGV starts with '-', and is not exactly "-" or "--",
462
then it is an option element. The characters of this element
463
(aside from the initial '-') are option characters. If `getopt'
464
is called repeatedly, it returns successively each of the option characters
465
from each of the option elements.
467
If `getopt' finds another option character, it returns that character,
468
updating `optind' and `nextchar' so that the next call to `getopt' can
469
resume the scan with the following option character or ARGV-element.
471
If there are no more option characters, `getopt' returns -1.
472
Then `optind' is the index in ARGV of the first ARGV-element
473
that is not an option. (The ARGV-elements have been permuted
474
so that those that are not options now come last.)
476
OPTSTRING is a string containing the legitimate option characters.
477
If an option character is seen that is not listed in OPTSTRING,
478
return '?' after printing an error message. If you set `opterr' to
479
zero, the error message is suppressed but we still return '?'.
481
If a char in OPTSTRING is followed by a colon, that means it wants an arg,
482
so the following text in the same ARGV-element, or the text of the following
483
ARGV-element, is returned in `optarg'. Two colons mean an option that
484
wants an optional arg; if there is text in the current ARGV-element,
485
it is returned in `optarg', otherwise `optarg' is set to zero.
487
If OPTSTRING starts with `-' or `+', it requests different methods of
488
handling the non-option ARGV-elements.
489
See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
491
Long-named options begin with `--' instead of `-'.
492
Their names may be abbreviated as long as the abbreviation is unique
493
or is an exact match for some defined option. If they have an
494
argument, it follows the option name in the same ARGV-element, separated
495
from the option name by a `=', or else the in next ARGV-element.
496
When `getopt' finds a long-named option, it returns 0 if that option's
497
`flag' field is nonzero, the value of the option's `val' field
498
if the `flag' field is zero.
500
The elements of ARGV aren't really const, because we permute them.
501
But we pretend they're const in the prototype to be compatible
504
LONGOPTS is a vector of `struct option' terminated by an
505
element containing a name which is zero.
507
LONGIND returns the index in LONGOPT of the long-named option found.
508
It is only valid when a long-named option has been found by the most
511
If LONG_ONLY is nonzero, '-' as well as '--' can introduce
512
long-named options. */
515
_getopt_internal (argc, argv, optstring, longopts, longind, long_only)
518
const char *optstring;
519
const struct option *longopts;
525
if (optind == 0 || !__getopt_initialized)
528
optind = 1; /* Don't scan ARGV[0], the program name. */
529
optstring = _getopt_initialize (argc, argv, optstring);
530
__getopt_initialized = 1;
533
/* Test whether ARGV[optind] points to a non-option argument.
534
Either it does not have option syntax, or there is an environment flag
535
from the shell indicating it is not an option. The later information
536
is only used when the used in the GNU libc. */
538
# define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
539
|| (optind < nonoption_flags_len \
540
&& __getopt_nonoption_flags[optind] == '1'))
542
# define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
545
if (nextchar == NULL || *nextchar == '\0')
547
/* Advance to the next ARGV-element. */
549
/* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
550
moved back by the user (who may also have changed the arguments). */
551
if (last_nonopt > optind)
552
last_nonopt = optind;
553
if (first_nonopt > optind)
554
first_nonopt = optind;
556
if (ordering == PERMUTE)
558
/* If we have just processed some options following some non-options,
559
exchange them so that the options come first. */
561
if (first_nonopt != last_nonopt && last_nonopt != optind)
562
exchange ((char **) argv);
563
else if (last_nonopt != optind)
564
first_nonopt = optind;
566
/* Skip any additional non-options
567
and extend the range of non-options previously skipped. */
569
while (optind < argc && NONOPTION_P)
571
last_nonopt = optind;
574
/* The special ARGV-element `--' means premature end of options.
575
Skip it like a null option,
576
then exchange with previous non-options as if it were an option,
577
then skip everything else like a non-option. */
579
if (optind != argc && !strcmp (argv[optind], "--"))
583
if (first_nonopt != last_nonopt && last_nonopt != optind)
584
exchange ((char **) argv);
585
else if (first_nonopt == last_nonopt)
586
first_nonopt = optind;
592
/* If we have done all the ARGV-elements, stop the scan
593
and back over any non-options that we skipped and permuted. */
597
/* Set the next-arg-index to point at the non-options
598
that we previously skipped, so the caller will digest them. */
599
if (first_nonopt != last_nonopt)
600
optind = first_nonopt;
604
/* If we have come to a non-option and did not permute it,
605
either stop the scan or describe it to the caller and pass it by. */
609
if (ordering == REQUIRE_ORDER)
611
optarg = argv[optind++];
615
/* We have found another option-ARGV-element.
616
Skip the initial punctuation. */
618
nextchar = (argv[optind] + 1
619
+ (longopts != NULL && argv[optind][1] == '-'));
622
/* Decode the current option-ARGV-element. */
624
/* Check whether the ARGV-element is a long option.
626
If long_only and the ARGV-element has the form "-f", where f is
627
a valid short option, don't consider it an abbreviated form of
628
a long option that starts with f. Otherwise there would be no
629
way to give the -f short option.
631
On the other hand, if there's a long option "fubar" and
632
the ARGV-element is "-fu", do consider that an abbreviation of
633
the long option, just like "--fu", and not "-f" with arg "u".
635
This distinction seems to be the most useful approach. */
638
&& (argv[optind][1] == '-'
639
|| (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
642
const struct option *p;
643
const struct option *pfound = NULL;
649
for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
652
/* Test all long options for either exact match
653
or abbreviated matches. */
654
for (p = longopts, option_index = 0; p->name; p++, option_index++)
655
if (!strncmp (p->name, nextchar, nameend - nextchar))
657
if ((unsigned int) (nameend - nextchar)
658
== (unsigned int) strlen (p->name))
660
/* Exact match found. */
662
indfound = option_index;
666
else if (pfound == NULL)
668
/* First nonexact match found. */
670
indfound = option_index;
673
/* Second or later nonexact match found. */
680
fprintf (stderr, _("%s: option `%s' is ambiguous\n"),
681
argv[0], argv[optind]);
682
nextchar += strlen (nextchar);
690
option_index = indfound;
694
/* Don't test has_arg with >, because some C compilers don't
695
allow it to be used on enums. */
697
optarg = nameend + 1;
701
if (argv[optind - 1][1] == '-')
704
_("%s: option `--%s' doesn't allow an argument\n"),
705
argv[0], pfound->name);
707
/* +option or -option */
709
_("%s: option `%c%s' doesn't allow an argument\n"),
710
argv[0], argv[optind - 1][0], pfound->name);
712
nextchar += strlen (nextchar);
714
optopt = pfound->val;
718
else if (pfound->has_arg == 1)
721
optarg = argv[optind++];
726
_("%s: option `%s' requires an argument\n"),
727
argv[0], argv[optind - 1]);
728
nextchar += strlen (nextchar);
729
optopt = pfound->val;
730
return optstring[0] == ':' ? ':' : '?';
733
nextchar += strlen (nextchar);
735
*longind = option_index;
738
*(pfound->flag) = pfound->val;
744
/* Can't find it as a long option. If this is not getopt_long_only,
745
or the option starts with '--' or is not a valid short
746
option, then it's an error.
747
Otherwise interpret it as a short option. */
748
if (!long_only || argv[optind][1] == '-'
749
|| my_index (optstring, *nextchar) == NULL)
753
if (argv[optind][1] == '-')
755
fprintf (stderr, _("%s: unrecognized option `--%s'\n"),
758
/* +option or -option */
759
fprintf (stderr, _("%s: unrecognized option `%c%s'\n"),
760
argv[0], argv[optind][0], nextchar);
762
nextchar = (char *) "";
769
/* Look at and handle the next short option-character. */
772
char c = *nextchar++;
773
char *temp = my_index (optstring, c);
775
/* Increment `optind' when we start to process its last character. */
776
if (*nextchar == '\0')
779
if (temp == NULL || c == ':')
784
/* 1003.2 specifies the format of this message. */
785
fprintf (stderr, _("%s: illegal option -- %c\n"),
788
fprintf (stderr, _("%s: invalid option -- %c\n"),
794
/* Convenience. Treat POSIX -W foo same as long option --foo */
795
if (temp[0] == 'W' && temp[1] == ';')
798
const struct option *p;
799
const struct option *pfound = NULL;
805
/* This is an option that requires an argument. */
806
if (*nextchar != '\0')
809
/* If we end this ARGV-element by taking the rest as an arg,
810
we must advance to the next element now. */
813
else if (optind == argc)
817
/* 1003.2 specifies the format of this message. */
818
fprintf (stderr, _("%s: option requires an argument -- %c\n"),
822
if (optstring[0] == ':')
829
/* We already incremented `optind' once;
830
increment it again when taking next ARGV-elt as argument. */
831
optarg = argv[optind++];
833
/* optarg is now the argument, see if it's in the
834
table of longopts. */
836
for (nextchar = nameend = optarg; *nameend && *nameend != '='; nameend++)
839
/* Test all long options for either exact match
840
or abbreviated matches. */
841
for (p = longopts, option_index = 0; p->name; p++, option_index++)
842
if (!strncmp (p->name, nextchar, nameend - nextchar))
844
if ((unsigned int) (nameend - nextchar) == strlen (p->name))
846
/* Exact match found. */
848
indfound = option_index;
852
else if (pfound == NULL)
854
/* First nonexact match found. */
856
indfound = option_index;
859
/* Second or later nonexact match found. */
865
fprintf (stderr, _("%s: option `-W %s' is ambiguous\n"),
866
argv[0], argv[optind]);
867
nextchar += strlen (nextchar);
873
option_index = indfound;
876
/* Don't test has_arg with >, because some C compilers don't
877
allow it to be used on enums. */
879
optarg = nameend + 1;
883
fprintf (stderr, _("\
884
%s: option `-W %s' doesn't allow an argument\n"),
885
argv[0], pfound->name);
887
nextchar += strlen (nextchar);
891
else if (pfound->has_arg == 1)
894
optarg = argv[optind++];
899
_("%s: option `%s' requires an argument\n"),
900
argv[0], argv[optind - 1]);
901
nextchar += strlen (nextchar);
902
return optstring[0] == ':' ? ':' : '?';
905
nextchar += strlen (nextchar);
907
*longind = option_index;
910
*(pfound->flag) = pfound->val;
916
return 'W'; /* Let the application handle it. */
922
/* This is an option that accepts an argument optionally. */
923
if (*nextchar != '\0')
934
/* This is an option that requires an argument. */
935
if (*nextchar != '\0')
938
/* If we end this ARGV-element by taking the rest as an arg,
939
we must advance to the next element now. */
942
else if (optind == argc)
946
/* 1003.2 specifies the format of this message. */
948
_("%s: option requires an argument -- %c\n"),
952
if (optstring[0] == ':')
958
/* We already incremented `optind' once;
959
increment it again when taking next ARGV-elt as argument. */
960
optarg = argv[optind++];
969
getopt (argc, argv, optstring)
972
const char *optstring;
974
return _getopt_internal (argc, argv, optstring,
975
(const struct option *) 0,
980
#endif /* Not ELIDE_CODE. */
984
/* Compile with -DTEST to make an executable for use in testing
985
the above definition of `getopt'. */
993
int digit_optind = 0;
997
int this_option_optind = optind ? optind : 1;
999
c = getopt (argc, argv, "abc:d:0123456789");
1015
if (digit_optind != 0 && digit_optind != this_option_optind)
1016
printf ("digits occur in two different argv-elements.\n");
1017
digit_optind = this_option_optind;
1018
printf ("option %c\n", c);
1022
printf ("option a\n");
1026
printf ("option b\n");
1030
printf ("option c with value `%s'\n", optarg);
1037
printf ("?? getopt returned character code 0%o ??\n", c);
1043
printf ("non-option ARGV-elements: ");
1044
while (optind < argc)
1045
printf ("%s ", argv[optind++]);