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, 1993
7
Free Software Foundation, Inc.
9
This program is free software; you can redistribute it and/or modify it
10
under the terms of the GNU General Public License as published by the
11
Free Software Foundation; either version 2, or (at your option) any
14
This program 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
17
GNU General Public License for more details.
19
You should have received a copy of the GNU General Public License
20
along with this program; if not, write to the Free Software
21
Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
35
#define __GNU_LIBRARY__
37
/* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>. */
45
/* Comment out all this code if we are using the GNU C Library, and are not
46
actually compiling the library itself. This code is part of the GNU C
47
Library, but also included in many other GNU distributions. Compiling
48
and linking in this code is a waste when using the GNU C library
49
(especially if it is a shared library). Rather than having every GNU
50
program understand `configure --with-gnu-libc' and omit the object files,
51
it is simpler to just do this in the source for each such file. */
53
#if defined (_LIBC) || !defined (__GNU_LIBRARY__)
56
/* This needs to come after some library #include
57
to get __GNU_LIBRARY__ defined. */
58
#ifdef __GNU_LIBRARY__
59
/* Don't include stdlib.h for non-GNU C libraries because some of them
60
contain conflicting prototypes for getopt. */
62
#endif /* GNU C library. */
64
/* If GETOPT_COMPAT is defined, `+' as well as `--' can introduce a
65
long-named option. Because this is not POSIX.2 compliant, it is
67
/* #define GETOPT_COMPAT */
69
/* This version of `getopt' appears to the caller like standard Unix `getopt'
70
but it behaves differently for the user, since it allows the user
71
to intersperse the options with the other arguments.
73
As `getopt' works, it permutes the elements of ARGV so that,
74
when it is done, all the options precede everything else. Thus
75
all application programs are extended to handle flexible argument order.
77
Setting the environment variable POSIXLY_CORRECT disables permutation.
78
Then the behavior is completely standard.
80
GNU application programs can use a third alternative mode in which
81
they can distinguish the relative order of options and other arguments. */
85
/* For communication from `getopt' to the caller.
86
When `getopt' finds an option that takes an argument,
87
the argument value is returned here.
88
Also, when `ordering' is RETURN_IN_ORDER,
89
each non-option ARGV-element is returned here. */
93
/* Index in ARGV of the next element to be scanned.
94
This is used for communication to and from the caller
95
and for communication between successive calls to `getopt'.
97
On entry to `getopt', zero means this is the first call; initialize.
99
When `getopt' returns EOF, this is the index of the first of the
100
non-option elements that the caller should itself scan.
102
Otherwise, `optind' communicates from one call to the next
103
how much of ARGV has been scanned so far. */
105
/* XXX 1003.2 says this must be 1 before any call. */
108
/* The next char to be scanned in the option-element
109
in which the last option character we returned was found.
110
This allows us to pick up the scan where we left off.
112
If this is zero, or a null string, it means resume the scan
113
by advancing to the next ARGV-element. */
115
static char *nextchar;
117
/* Callers store zero here to inhibit the error message
118
for unrecognized options. */
122
/* Set to an option character which was unrecognized.
123
This must be initialized on some systems to avoid linking in the
124
system's own getopt implementation. */
126
#define BAD_OPTION '\0'
127
int optopt = BAD_OPTION;
129
/* Describe how to deal with options that follow non-option ARGV-elements.
131
If the caller did not specify anything,
132
the default is REQUIRE_ORDER if the environment variable
133
POSIXLY_CORRECT is defined, PERMUTE otherwise.
135
REQUIRE_ORDER means don't recognize them as options;
136
stop option processing when the first non-option is seen.
137
This is what Unix does.
138
This mode of operation is selected by either setting the environment
139
variable POSIXLY_CORRECT, or using `+' as the first character
140
of the list of option characters.
142
PERMUTE is the default. We permute the contents of ARGV as we scan,
143
so that eventually all the non-options are at the end. This allows options
144
to be given in any order, even with programs that were not written to
147
RETURN_IN_ORDER is an option available to programs that were written
148
to expect options and other ARGV-elements in any order and that care about
149
the ordering of the two. We describe each non-option ARGV-element
150
as if it were the argument of an option with character code 1.
151
Using `-' as the first character of the list of option characters
152
selects this mode of operation.
154
The special argument `--' forces an end of option-scanning regardless
155
of the value of `ordering'. In the case of RETURN_IN_ORDER, only
156
`--' can cause `getopt' to return EOF with `optind' != ARGC. */
159
REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
162
#ifdef __GNU_LIBRARY__
163
/* We want to avoid inclusion of string.h with non-GNU libraries
164
because there are many ways it can cause trouble.
165
On some systems, it contains special magic macros that don't work
168
#define my_index strchr
169
#define my_strlen strlen
172
/* Avoid depending on library functions or files
173
whose names are inconsistent. */
175
#if __STDC__ || defined(PROTO)
176
extern char *getenv(const char *name);
177
extern int strcmp(const char *s1, const char *s2);
178
extern int strncmp(const char *s1, const char *s2, int n);
180
static int my_strlen(const char *s);
181
static char *my_index(const char *str, int chr);
183
extern char *getenv();
186
static int my_strlen(const char *str)
194
static char *my_index(const char *str, int chr)
204
#endif /* GNU C library. */
206
/* Handle permutation of arguments. */
208
/* Describe the part of ARGV that contains non-options that have
209
been skipped. `first_nonopt' is the index in ARGV of the first of them;
210
`last_nonopt' is the index after the last of them. */
212
static int first_nonopt;
213
static int last_nonopt;
215
/* Exchange two adjacent subsequences of ARGV.
216
One subsequence is elements [first_nonopt,last_nonopt)
217
which contains all the non-options that have been skipped so far.
218
The other is elements [last_nonopt,optind), which contains all
219
the options processed since those non-options were skipped.
221
`first_nonopt' and `last_nonopt' are relocated so that they describe
222
the new indices of the non-options in ARGV after they are moved.
224
To perform the swap, we first reverse the order of all elements. So
225
all options now come before all non options, but they are in the
226
wrong order. So we put back the options and non options in original
227
order by reversing them again. For example:
228
original input: a b c -x -y
229
reverse all: -y -x c b a
230
reverse options: -x -y c b a
231
reverse non options: -x -y a b c
234
#if __STDC__ || defined(PROTO)
235
static void exchange(char **argv);
238
static void exchange(char **argv)
240
char *temp, **first, **last;
242
/* Reverse all the elements [first_nonopt, optind) */
243
first = &argv[first_nonopt];
244
last = &argv[optind - 1];
245
while (first < last) {
252
/* Put back the options in order */
253
first = &argv[first_nonopt];
254
first_nonopt += (optind - last_nonopt);
255
last = &argv[first_nonopt - 1];
256
while (first < last) {
264
/* Put back the non options in order */
265
first = &argv[first_nonopt];
266
last_nonopt = optind;
267
last = &argv[last_nonopt - 1];
268
while (first < last) {
277
/* Scan elements of ARGV (whose length is ARGC) for option characters
280
If an element of ARGV starts with '-', and is not exactly "-" or "--",
281
then it is an option element. The characters of this element
282
(aside from the initial '-') are option characters. If `getopt'
283
is called repeatedly, it returns successively each of the option characters
284
from each of the option elements.
286
If `getopt' finds another option character, it returns that character,
287
updating `optind' and `nextchar' so that the next call to `getopt' can
288
resume the scan with the following option character or ARGV-element.
290
If there are no more option characters, `getopt' returns `EOF'.
291
Then `optind' is the index in ARGV of the first ARGV-element
292
that is not an option. (The ARGV-elements have been permuted
293
so that those that are not options now come last.)
295
OPTSTRING is a string containing the legitimate option characters.
296
If an option character is seen that is not listed in OPTSTRING,
297
return BAD_OPTION after printing an error message. If you set `opterr' to
298
zero, the error message is suppressed but we still return BAD_OPTION.
300
If a char in OPTSTRING is followed by a colon, that means it wants an arg,
301
so the following text in the same ARGV-element, or the text of the following
302
ARGV-element, is returned in `optarg'. Two colons mean an option that
303
wants an optional arg; if there is text in the current ARGV-element,
304
it is returned in `optarg', otherwise `optarg' is set to zero.
306
If OPTSTRING starts with `-' or `+', it requests different methods of
307
handling the non-option ARGV-elements.
308
See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
310
Long-named options begin with `--' instead of `-'.
311
Their names may be abbreviated as long as the abbreviation is unique
312
or is an exact match for some defined option. If they have an
313
argument, it follows the option name in the same ARGV-element, separated
314
from the option name by a `=', or else the in next ARGV-element.
315
When `getopt' finds a long-named option, it returns 0 if that option's
316
`flag' field is nonzero, the value of the option's `val' field
317
if the `flag' field is zero.
319
The elements of ARGV aren't really const, because we permute them.
320
But we pretend they're const in the prototype to be compatible
323
LONGOPTS is a vector of `struct option' terminated by an
324
element containing a name which is zero.
326
LONGIND returns the index in LONGOPT of the long-named option found.
327
It is only valid when a long-named option has been found by the most
330
If LONG_ONLY is nonzero, '-' as well as '--' can introduce
331
long-named options. */
333
int _getopt_internal(int argc, char *const *argv, const char *optstring,
334
const struct option *longopts, int *longind, int long_only)
340
/* Initialize the internal data when the first call is made.
341
Start processing options with ARGV-element 1 (since ARGV-element 0
342
is the program name); the sequence of previously skipped
343
non-option ARGV-elements is empty. */
346
first_nonopt = last_nonopt = optind = 1;
350
/* Determine how to handle the ordering of options and nonoptions. */
352
if (optstring[0] == '-') {
353
ordering = RETURN_IN_ORDER;
355
} else if (optstring[0] == '+') {
356
ordering = REQUIRE_ORDER;
358
} else if (getenv("POSIXLY_CORRECT") != NULL)
359
ordering = REQUIRE_ORDER;
364
if (nextchar == NULL || *nextchar == '\0') {
365
if (ordering == PERMUTE) {
366
/* If we have just processed some options following some non-options,
367
exchange them so that the options come first. */
369
if (first_nonopt != last_nonopt && last_nonopt != optind)
370
exchange((char **) argv);
371
else if (last_nonopt != optind)
372
first_nonopt = optind;
374
/* Now skip any additional non-options
375
and extend the range of non-options previously skipped. */
377
while (optind < argc && (argv[optind][0] != '-' || argv[optind][1] == '\0')
380
|| argv[optind][0] != '+' || argv[optind][1] == '\0')
381
#endif /* GETOPT_COMPAT */
384
last_nonopt = optind;
387
/* Special ARGV-element `--' means premature end of options.
388
Skip it like a null option,
389
then exchange with previous non-options as if it were an option,
390
then skip everything else like a non-option. */
392
if (optind != argc && !strcmp(argv[optind], "--")) {
395
if (first_nonopt != last_nonopt && last_nonopt != optind)
396
exchange((char **) argv);
397
else if (first_nonopt == last_nonopt)
398
first_nonopt = optind;
404
/* If we have done all the ARGV-elements, stop the scan
405
and back over any non-options that we skipped and permuted. */
407
if (optind == argc) {
408
/* Set the next-arg-index to point at the non-options
409
that we previously skipped, so the caller will digest them. */
410
if (first_nonopt != last_nonopt)
411
optind = first_nonopt;
415
/* If we have come to a non-option and did not permute it,
416
either stop the scan or describe it to the caller and pass it by. */
418
if ((argv[optind][0] != '-' || argv[optind][1] == '\0')
420
&& (longopts == NULL || argv[optind][0] != '+' || argv[optind][1] == '\0')
421
#endif /* GETOPT_COMPAT */
423
if (ordering == REQUIRE_ORDER)
425
optarg = argv[optind++];
429
/* We have found another option-ARGV-element.
430
Start decoding its characters. */
432
nextchar = (argv[optind] + 1 + (longopts != NULL && argv[optind][1] == '-'));
435
if (longopts != NULL && ((argv[optind][0] == '-' && (argv[optind][1] == '-' || long_only))
437
|| argv[optind][0] == '+'
438
#endif /* GETOPT_COMPAT */
440
const struct option *p;
444
const struct option *pfound = NULL;
447
while (*s && *s != '=')
450
/* Test all options for either exact match or abbreviated matches. */
451
for (p = longopts, option_index = 0; p->name; p++, option_index++)
452
if (!strncmp(p->name, nextchar, s - nextchar)) {
453
if (s - nextchar == my_strlen(p->name)) {
454
/* Exact match found. */
456
indfound = option_index;
459
} else if (pfound == NULL) {
460
/* First nonexact match found. */
462
indfound = option_index;
464
/* Second nonexact match found. */
468
if (ambig && !exact) {
470
fprintf(stderr, "%s: option `%s' is ambiguous\n",
471
argv[0], argv[optind]);
472
nextchar += my_strlen(nextchar);
477
if (pfound != NULL) {
478
option_index = indfound;
481
/* Don't test has_arg with >, because some C compilers don't
482
allow it to be used on enums. */
487
if (argv[optind - 1][1] == '-')
490
"%s: option `--%s' doesn't allow an argument\n",
491
argv[0], pfound->name);
493
/* +option or -option */
495
"%s: option `%c%s' doesn't allow an argument\n",
496
argv[0], argv[optind - 1][0],
499
nextchar += my_strlen(nextchar);
502
} else if (pfound->has_arg == 1) {
504
optarg = argv[optind++];
508
"%s: option `%s' requires an argument\n",
509
argv[0], argv[optind - 1]);
510
nextchar += my_strlen(nextchar);
511
return optstring[0] == ':' ? ':' : BAD_OPTION;
514
nextchar += my_strlen(nextchar);
516
*longind = option_index;
518
*(pfound->flag) = pfound->val;
523
/* Can't find it as a long option. If this is not getopt_long_only,
524
or the option starts with '--' or is not a valid short
525
option, then it's an error.
526
Otherwise interpret it as a short option. */
527
if (!long_only || argv[optind][1] == '-'
529
|| argv[optind][0] == '+'
530
#endif /* GETOPT_COMPAT */
531
|| my_index(optstring, *nextchar) == NULL) {
533
if (argv[optind][1] == '-')
535
fprintf(stderr, "%s: unrecognized option `--%s'\n",
538
/* +option or -option */
539
fprintf(stderr, "%s: unrecognized option `%c%s'\n",
540
argv[0], argv[optind][0], nextchar);
542
nextchar = (char *) "";
548
/* Look at and handle the next option-character. */
551
char c = *nextchar++;
552
char *temp = my_index(optstring, c);
554
/* Increment `optind' when we start to process its last character. */
555
if (*nextchar == '\0')
558
if (temp == NULL || c == ':') {
561
if (c < 040 || c >= 0177)
563
"%s: unrecognized option, character code 0%o\n",
566
fprintf(stderr, "%s: unrecognized option `-%c'\n", argv[0],
569
/* 1003.2 specifies the format of this message. */
570
fprintf(stderr, "%s: illegal option -- %c\n", argv[0], c);
576
if (temp[1] == ':') {
577
if (temp[2] == ':') {
578
/* This is an option that accepts an argument optionally. */
579
if (*nextchar != '\0') {
586
/* This is an option that requires an argument. */
587
if (*nextchar != '\0') {
589
/* If we end this ARGV-element by taking the rest as an arg,
590
we must advance to the next element now. */
592
} else if (optind == argc) {
596
"%s: option `-%c' requires an argument\n",
599
/* 1003.2 specifies the format of this message. */
601
"%s: option requires an argument -- %c\n",
606
if (optstring[0] == ':')
611
/* We already incremented `optind' once;
612
increment it again when taking next ARGV-elt as argument. */
613
optarg = argv[optind++];
621
int getopt(int argc, char *const *argv, const char *optstring)
623
return _getopt_internal(argc, argv, optstring, (const struct option *) 0, (int *) 0, 0);
626
int getopt_long(int argc, char *const *argv, const char *options, const struct option long_options, int *opt_index)
628
return _getopt_internal(argc, argv, options, long_options, opt_index, 0);
631
#endif /* _LIBC or not __GNU_LIBRARY__. */
635
/* Compile with -DTEST to make an executable for use in testing
636
the above definition of `getopt'. */
638
int main(int argc, char **argv)
641
int digit_optind = 0;
644
int this_option_optind = optind ? optind : 1;
646
c = getopt(argc, argv, "abc:d:0123456789");
661
if (digit_optind != 0 && digit_optind != this_option_optind)
662
printf("digits occur in two different argv-elements.\n");
663
digit_optind = this_option_optind;
664
printf("option %c\n", c);
668
printf("option a\n");
672
printf("option b\n");
676
printf("option c with value `%s'\n", optarg);
683
printf("?? getopt returned character code 0%o ??\n", c);
688
printf("non-option ARGV-elements: ");
689
while (optind < argc)
690
printf("%s ", argv[optind++]);
699
#endif /* HAVE_GETOPT */
added
removed
subst/getopt.c
