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
7
Free Software Foundation, Inc.
9
This program is free software; you can redistribute it and/or
10
modify it under the terms of the GNU Library General Public License
11
as published by the Free Software Foundation; either version 2, or
12
(at your option) any later version.
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 Library General Public License for more details.
19
You should have received a copy of the GNU Library General Public License
20
along with this program; if not, write to the Free Software
21
Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
23
/* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
24
Ditto for AIX 3.2 and <stdlib.h>. */
30
#if defined (emacs) || defined (CONFIG_BROKETS)
31
/* We use <config.h> instead of "config.h" so that a compilation
32
using -I. -I$srcdir will use ./config.h rather than $srcdir/config.h
33
(which it would do because it found this file in $srcdir). */
41
/* This is a separate conditional since some stdc systems
42
reject `defined (const)'. */
50
/* Comment out all this code if we are using the GNU C Library, and are not
51
actually compiling the library itself. This code is part of the GNU C
52
Library, but also included in many other GNU distributions. Compiling
53
and linking in this code is a waste when using the GNU C library
54
(especially if it is a shared library). Rather than having every GNU
55
program understand `configure --with-gnu-libc' and omit the object files,
56
it is simpler to just do this in the source for each such file. */
58
#if defined (_LIBC) || !defined (__GNU_LIBRARY__)
61
/* This needs to come after some library #include
62
to get __GNU_LIBRARY__ defined. */
63
#ifdef __GNU_LIBRARY__
64
/* Don't include stdlib.h for non-GNU C libraries because some of them
65
contain conflicting prototypes for getopt. */
67
#endif /* GNU C library. */
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. */
128
/* Describe how to deal with options that follow non-option ARGV-elements.
130
If the caller did not specify anything,
131
the default is REQUIRE_ORDER if the environment variable
132
POSIXLY_CORRECT is defined, PERMUTE otherwise.
134
REQUIRE_ORDER means don't recognize them as options;
135
stop option processing when the first non-option is seen.
136
This is what Unix does.
137
This mode of operation is selected by either setting the environment
138
variable POSIXLY_CORRECT, or using `+' as the first character
139
of the list of option characters.
141
PERMUTE is the default. We permute the contents of ARGV as we scan,
142
so that eventually all the non-options are at the end. This allows options
143
to be given in any order, even with programs that were not written to
146
RETURN_IN_ORDER is an option available to programs that were written
147
to expect options and other ARGV-elements in any order and that care about
148
the ordering of the two. We describe each non-option ARGV-element
149
as if it were the argument of an option with character code 1.
150
Using `-' as the first character of the list of option characters
151
selects this mode of operation.
153
The special argument `--' forces an end of option-scanning regardless
154
of the value of `ordering'. In the case of RETURN_IN_ORDER, only
155
`--' 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
171
/* Avoid depending on library functions or files
172
whose names are inconsistent. */
190
/* If using GCC, we can safely declare strlen this way.
191
If not using GCC, it is ok not to declare it. */
193
/* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
194
That was relevant to code that was here before. */
196
/* gcc with -traditional declares the built-in strlen to return int,
197
and has done so at least since version 2.4.5. -- rms. */
198
extern int strlen (const char *);
199
#endif /* not __STDC__ */
200
#endif /* __GNUC__ */
202
#endif /* not __GNU_LIBRARY__ */
204
/* Handle permutation of arguments. */
206
/* Describe the part of ARGV that contains non-options that have
207
been skipped. `first_nonopt' is the index in ARGV of the first of them;
208
`last_nonopt' is the index after the last of them. */
210
static int first_nonopt;
211
static int last_nonopt;
213
/* Exchange two adjacent subsequences of ARGV.
214
One subsequence is elements [first_nonopt,last_nonopt)
215
which contains all the non-options that have been skipped so far.
216
The other is elements [last_nonopt,optind), which contains all
217
the options processed since those non-options were skipped.
219
`first_nonopt' and `last_nonopt' are relocated so that they describe
220
the new indices of the non-options in ARGV after they are moved. */
222
static void exchange ( char **argv );
223
static const char *_getopt_initialize ( const char * );
224
int _getopt_internal ( int, char *const *, const char *,
225
const struct option *, int *,
227
int getopt ( int, char *const *, const char * );
233
int bottom = first_nonopt;
234
int middle = last_nonopt;
238
/* Exchange the shorter segment with the far end of the longer segment.
239
That puts the shorter segment into the right place.
240
It leaves the longer segment in the right place overall,
241
but it consists of two parts that need to be swapped next. */
243
while (top > middle && middle > bottom)
245
if (top - middle > middle - bottom)
247
/* Bottom segment is the short one. */
248
int len = middle - bottom;
251
/* Swap it with the top part of the top segment. */
252
for (i = 0; i < len; i++)
254
tem = argv[bottom + i];
255
argv[bottom + i] = argv[top - (middle - bottom) + i];
256
argv[top - (middle - bottom) + i] = tem;
258
/* Exclude the moved bottom segment from further swapping. */
263
/* Top segment is the short one. */
264
int len = top - middle;
267
/* Swap it with the bottom part of the bottom segment. */
268
for (i = 0; i < len; i++)
270
tem = argv[bottom + i];
271
argv[bottom + i] = argv[middle + i];
272
argv[middle + i] = tem;
274
/* Exclude the moved top segment from further swapping. */
279
/* Update records for the slots the non-options now occupy. */
281
first_nonopt += (optind - last_nonopt);
282
last_nonopt = optind;
285
/* Initialize the internal data when the first call is made. */
288
_getopt_initialize ( const char *optstring )
290
/* Start processing options with ARGV-element 1 (since ARGV-element 0
291
is the program name); the sequence of previously skipped
292
non-option ARGV-elements is empty. */
294
first_nonopt = last_nonopt = optind = 1;
298
/* Determine how to handle the ordering of options and nonoptions. */
300
if (optstring[0] == '-')
302
ordering = RETURN_IN_ORDER;
305
else if (optstring[0] == '+')
307
ordering = REQUIRE_ORDER;
310
else if (getenv ("POSIXLY_CORRECT") != NULL)
311
ordering = REQUIRE_ORDER;
318
/* Scan elements of ARGV (whose length is ARGC) for option characters
321
If an element of ARGV starts with '-', and is not exactly "-" or "--",
322
then it is an option element. The characters of this element
323
(aside from the initial '-') are option characters. If `getopt'
324
is called repeatedly, it returns successively each of the option characters
325
from each of the option elements.
327
If `getopt' finds another option character, it returns that character,
328
updating `optind' and `nextchar' so that the next call to `getopt' can
329
resume the scan with the following option character or ARGV-element.
331
If there are no more option characters, `getopt' returns `EOF'.
332
Then `optind' is the index in ARGV of the first ARGV-element
333
that is not an option. (The ARGV-elements have been permuted
334
so that those that are not options now come last.)
336
OPTSTRING is a string containing the legitimate option characters.
337
If an option character is seen that is not listed in OPTSTRING,
338
return '?' after printing an error message. If you set `opterr' to
339
zero, the error message is suppressed but we still return '?'.
341
If a char in OPTSTRING is followed by a colon, that means it wants an arg,
342
so the following text in the same ARGV-element, or the text of the following
343
ARGV-element, is returned in `optarg'. Two colons mean an option that
344
wants an optional arg; if there is text in the current ARGV-element,
345
it is returned in `optarg', otherwise `optarg' is set to zero.
347
If OPTSTRING starts with `-' or `+', it requests different methods of
348
handling the non-option ARGV-elements.
349
See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
351
Long-named options begin with `--' instead of `-'.
352
Their names may be abbreviated as long as the abbreviation is unique
353
or is an exact match for some defined option. If they have an
354
argument, it follows the option name in the same ARGV-element, separated
355
from the option name by a `=', or else the in next ARGV-element.
356
When `getopt' finds a long-named option, it returns 0 if that option's
357
`flag' field is nonzero, the value of the option's `val' field
358
if the `flag' field is zero.
360
The elements of ARGV aren't really const, because we permute them.
361
But we pretend they're const in the prototype to be compatible
364
LONGOPTS is a vector of `struct option' terminated by an
365
element containing a name which is zero.
367
LONGIND returns the index in LONGOPT of the long-named option found.
368
It is only valid when a long-named option has been found by the most
371
If LONG_ONLY is nonzero, '-' as well as '--' can introduce
372
long-named options. */
375
#include "nl_types.h"
379
_getopt_internal ( int argc, char *const *argv, const char *optstring,
380
const struct option *longopts, int *longind,
390
optstring = _getopt_initialize (optstring);
392
if (nextchar == NULL || *nextchar == '\0')
394
/* Advance to the next ARGV-element. */
396
if (ordering == PERMUTE)
398
/* If we have just processed some options following some non-options,
399
exchange them so that the options come first. */
401
if (first_nonopt != last_nonopt && last_nonopt != optind)
402
exchange ((char **) argv);
403
else if (last_nonopt != optind)
404
first_nonopt = optind;
406
/* Skip any additional non-options
407
and extend the range of non-options previously skipped. */
410
&& (argv[optind][0] != '-' || argv[optind][1] == '\0'))
412
last_nonopt = optind;
415
/* The special ARGV-element `--' means premature end of options.
416
Skip it like a null option,
417
then exchange with previous non-options as if it were an option,
418
then skip everything else like a non-option. */
420
if (optind != argc && !strcmp (argv[optind], "--"))
424
if (first_nonopt != last_nonopt && last_nonopt != optind)
425
exchange ((char **) argv);
426
else if (first_nonopt == last_nonopt)
427
first_nonopt = optind;
433
/* If we have done all the ARGV-elements, stop the scan
434
and back over any non-options that we skipped and permuted. */
438
/* Set the next-arg-index to point at the non-options
439
that we previously skipped, so the caller will digest them. */
440
if (first_nonopt != last_nonopt)
441
optind = first_nonopt;
445
/* If we have come to a non-option and did not permute it,
446
either stop the scan or describe it to the caller and pass it by. */
448
if ((argv[optind][0] != '-' || argv[optind][1] == '\0'))
450
if (ordering == REQUIRE_ORDER)
452
optarg = argv[optind++];
456
/* We have found another option-ARGV-element.
457
Skip the initial punctuation. */
459
nextchar = (argv[optind] + 1
460
+ (longopts != NULL && argv[optind][1] == '-'));
463
/* Decode the current option-ARGV-element. */
465
/* Check whether the ARGV-element is a long option.
467
If long_only and the ARGV-element has the form "-f", where f is
468
a valid short option, don't consider it an abbreviated form of
469
a long option that starts with f. Otherwise there would be no
470
way to give the -f short option.
472
On the other hand, if there's a long option "fubar" and
473
the ARGV-element is "-fu", do consider that an abbreviation of
474
the long option, just like "--fu", and not "-f" with arg "u".
476
This distinction seems to be the most useful approach. */
479
&& (argv[optind][1] == '-'
480
|| (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
483
const struct option *p;
484
const struct option *pfound = NULL;
490
for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
493
/* Test all long options for either exact match
494
or abbreviated matches. */
495
for (p = longopts, option_index = 0; p->name; p++, option_index++)
496
if (!strncmp (p->name, nextchar, nameend - nextchar))
498
if (nameend - nextchar == strlen (p->name))
500
/* Exact match found. */
502
indfound = option_index;
506
else if (pfound == NULL)
508
/* First nonexact match found. */
510
indfound = option_index;
513
/* Second or later nonexact match found. */
522
catgets(_libc_cat, GetoptSet, GetoptAmbiguous,
523
"%s: option `%s' is ambiguous\n"),
524
argv[0], argv[optind]);
526
fprintf (stderr, "%s: option `%s' is ambiguous\n",
527
argv[0], argv[optind]);
529
nextchar += strlen (nextchar);
536
option_index = indfound;
540
/* Don't test has_arg with >, because some C compilers don't
541
allow it to be used on enums. */
543
optarg = nameend + 1;
548
if (argv[optind - 1][1] == '-')
552
catgets(_libc_cat, GetoptSet, GetoptNoArgumentsAllowed1,
553
"%s: option `--%s' doesn't allow an argument\n"),
554
argv[0], pfound->name);
557
"%s: option `--%s' doesn't allow an argument\n",
558
argv[0], pfound->name);
561
/* +option or -option */
564
catgets(_libc_cat, GetoptSet, GetoptNoArgumentsAllowed2,
565
"%s: option `%c%s' doesn't allow an argument\n"),
566
argv[0], argv[optind - 1][0], pfound->name);
569
"%s: option `%c%s' doesn't allow an argument\n",
570
argv[0], argv[optind - 1][0], pfound->name);
573
nextchar += strlen (nextchar);
577
else if (pfound->has_arg == 1)
580
optarg = argv[optind++];
586
catgets(_libc_cat, GetoptSet, GetoptRequiresArgument1,
587
"%s: option `%s' requires an argument\n"),
588
argv[0], argv[optind - 1]);
590
fprintf (stderr, "%s: option `%s' requires an argument\n",
591
argv[0], argv[optind - 1]);
593
nextchar += strlen (nextchar);
594
return optstring[0] == ':' ? ':' : '?';
597
nextchar += strlen (nextchar);
599
*longind = option_index;
602
*(pfound->flag) = pfound->val;
608
/* Can't find it as a long option. If this is not getopt_long_only,
609
or the option starts with '--' or is not a valid short
610
option, then it's an error.
611
Otherwise interpret it as a short option. */
612
if (!long_only || argv[optind][1] == '-'
613
|| my_index (optstring, *nextchar) == NULL)
617
if (argv[optind][1] == '-')
621
catgets(_libc_cat, GetoptSet, GetoptUnrecognized1,
622
"%s: unrecognized option `--%s'\n"),
625
fprintf (stderr, "%s: unrecognized option `--%s'\n",
629
/* +option or -option */
632
catgets(_libc_cat, GetoptSet, GetoptUnrecognized2,
633
"%s: unrecognized option `%c%s'\n"),
634
argv[0], argv[optind][0], nextchar);
636
fprintf (stderr, "%s: unrecognized option `%c%s'\n",
637
argv[0], argv[optind][0], nextchar);
640
nextchar = (char *) "";
646
/* Look at and handle the next short option-character. */
649
char c = *nextchar++;
650
char *temp = my_index (optstring, c);
652
/* Increment `optind' when we start to process its last character. */
653
if (*nextchar == '\0')
656
if (temp == NULL || c == ':')
660
/* 1003.2 specifies the format of this message. */
663
catgets(_libc_cat, GetoptSet, GetoptIllegal,
664
"%s: illegal option -- %c\n"),
667
fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
677
/* This is an option that accepts an argument optionally. */
678
if (*nextchar != '\0')
689
/* This is an option that requires an argument. */
690
if (*nextchar != '\0')
693
/* If we end this ARGV-element by taking the rest as an arg,
694
we must advance to the next element now. */
697
else if (optind == argc)
701
/* 1003.2 specifies the format of this message. */
704
catgets(_libc_cat, GetoptSet,
705
GetoptRequiresArgument2,
706
"%s: option requires an argument -- %c\n"),
709
fprintf (stderr, "%s: option requires an argument -- %c\n",
714
if (optstring[0] == ':')
720
/* We already incremented `optind' once;
721
increment it again when taking next ARGV-elt as argument. */
722
optarg = argv[optind++];
732
getopt ( int argc, char *const *argv, const char *optstring )
734
return _getopt_internal (argc, argv, optstring,
735
(const struct option *) 0,
740
#endif /* _LIBC or not __GNU_LIBRARY__. */
744
/* Compile with -DTEST to make an executable for use in testing
745
the above definition of `getopt'. */
753
int digit_optind = 0;
757
int this_option_optind = optind ? optind : 1;
759
c = getopt (argc, argv, "abc:d:0123456789");
775
if (digit_optind != 0 && digit_optind != this_option_optind)
776
printf ("digits occur in two different argv-elements.\n");
777
digit_optind = this_option_optind;
778
printf ("option %c\n", c);
782
printf ("option a\n");
786
printf ("option b\n");
790
printf ("option c with value `%s'\n", optarg);
797
printf ("?? getopt returned character code 0%o ??\n", c);
803
printf ("non-option ARGV-elements: ");
804
while (optind < argc)
805
printf ("%s ", argv[optind++]);
added
removed
getopt/getopt.c
