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.org
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
24
not, write to the Free Software Foundation, Inc., 51 Franklin
25
Street, Fifth Floor, Boston, MA 02110-1301, 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>. */
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. */
82
#if defined (WIN32) && !defined (__CYGWIN__)
83
/* It's not Unix, really. See? Capital letters. */
86
#define getpid() GetCurrentProcessId()
90
/* This is for other GNU distributions with internationalized messages.
91
When compiling libc, the _ macro is predefined. */
94
# define _(msgid) gettext (msgid)
96
# define _(msgid) (msgid)
100
/* This version of `getopt' appears to the caller like standard Unix `getopt'
101
but it behaves differently for the user, since it allows the user
102
to intersperse the options with the other arguments.
104
As `getopt' works, it permutes the elements of ARGV so that,
105
when it is done, all the options precede everything else. Thus
106
all application programs are extended to handle flexible argument order.
108
Setting the environment variable POSIXLY_CORRECT disables permutation.
109
Then the behavior is completely standard.
111
GNU application programs can use a third alternative mode in which
112
they can distinguish the relative order of options and other arguments. */
116
/* For communication from `getopt' to the caller.
117
When `getopt' finds an option that takes an argument,
118
the argument value is returned here.
119
Also, when `ordering' is RETURN_IN_ORDER,
120
each non-option ARGV-element is returned here. */
124
/* Index in ARGV of the next element to be scanned.
125
This is used for communication to and from the caller
126
and for communication between successive calls to `getopt'.
128
On entry to `getopt', zero means this is the first call; initialize.
130
When `getopt' returns -1, this is the index of the first of the
131
non-option elements that the caller should itself scan.
133
Otherwise, `optind' communicates from one call to the next
134
how much of ARGV has been scanned so far. */
136
/* 1003.2 says this must be 1 before any call. */
139
/* Formerly, initialization of getopt depended on optind==0, which
140
causes problems with re-calling getopt as programs generally don't
143
int __getopt_initialized = 0;
145
/* The next char to be scanned in the option-element
146
in which the last option character we returned was found.
147
This allows us to pick up the scan where we left off.
149
If this is zero, or a null string, it means resume the scan
150
by advancing to the next ARGV-element. */
152
static char *nextchar;
154
/* Callers store zero here to inhibit the error message
155
for unrecognized options. */
159
/* Set to an option character which was unrecognized.
160
This must be initialized on some systems to avoid linking in the
161
system's own getopt implementation. */
165
/* Describe how to deal with options that follow non-option ARGV-elements.
167
If the caller did not specify anything,
168
the default is REQUIRE_ORDER if the environment variable
169
POSIXLY_CORRECT is defined, PERMUTE otherwise.
171
REQUIRE_ORDER means don't recognize them as options;
172
stop option processing when the first non-option is seen.
173
This is what Unix does.
174
This mode of operation is selected by either setting the environment
175
variable POSIXLY_CORRECT, or using `+' as the first character
176
of the list of option characters.
178
PERMUTE is the default. We permute the contents of ARGV as we scan,
179
so that eventually all the non-options are at the end. This allows options
180
to be given in any order, even with programs that were not written to
183
RETURN_IN_ORDER is an option available to programs that were written
184
to expect options and other ARGV-elements in any order and that care about
185
the ordering of the two. We describe each non-option ARGV-element
186
as if it were the argument of an option with character code 1.
187
Using `-' as the first character of the list of option characters
188
selects this mode of operation.
190
The special argument `--' forces an end of option-scanning regardless
191
of the value of `ordering'. In the case of RETURN_IN_ORDER, only
192
`--' can cause `getopt' to return -1 with `optind' != ARGC. */
196
REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
199
/* Value of POSIXLY_CORRECT environment variable. */
200
static char *posixly_correct;
202
#if defined(__GNU_LIBRARY__) || defined(WIN32)
203
/* We want to avoid inclusion of string.h with non-GNU libraries
204
because there are many ways it can cause trouble.
205
On some systems, it contains special magic macros that don't work
208
#define my_index strchr
211
/* Avoid depending on library functions or files
212
whose names are inconsistent. */
230
/* If using GCC, we can safely declare strlen this way.
231
If not using GCC, it is ok not to declare it. */
233
/* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
234
That was relevant to code that was here before. */
235
#if !defined (__STDC__) || !__STDC__
236
/* gcc with -traditional declares the built-in strlen to return int,
237
and has done so at least since version 2.4.5. -- rms. */
238
extern int strlen (const char *);
239
#endif /* not __STDC__ */
240
#endif /* __GNUC__ */
242
#endif /* not __GNU_LIBRARY__ */
244
/* Handle permutation of arguments. */
246
/* Describe the part of ARGV that contains non-options that have
247
been skipped. `first_nonopt' is the index in ARGV of the first of them;
248
`last_nonopt' is the index after the last of them. */
250
static int first_nonopt;
251
static int last_nonopt;
254
/* Bash 2.0 gives us an environment variable containing flags
255
indicating ARGV elements that should not be considered arguments. */
257
static const char *nonoption_flags;
258
static int nonoption_flags_len;
260
static int original_argc;
261
static char *const *original_argv;
263
/* Make sure the environment variable bash 2.0 puts in the environment
264
is valid for the getopt call we must make sure that the ARGV passed
265
to getopt is that one passed to the process. */
266
static void store_args (int argc, char *const *argv) __attribute__ ((unused));
268
store_args (int argc, char *const *argv)
270
/* XXX This is no good solution. We should rather copy the args so
271
that we can compare them later. But we must not use malloc(3). */
272
original_argc = argc;
273
original_argv = argv;
275
text_set_element (__libc_subinit, store_args);
278
/* Exchange two adjacent subsequences of ARGV.
279
One subsequence is elements [first_nonopt,last_nonopt)
280
which contains all the non-options that have been skipped so far.
281
The other is elements [last_nonopt,optind), which contains all
282
the options processed since those non-options were skipped.
284
`first_nonopt' and `last_nonopt' are relocated so that they describe
285
the new indices of the non-options in ARGV after they are moved. */
287
#if defined (__STDC__) && __STDC__
288
static void exchange (char **);
295
int bottom = first_nonopt;
296
int middle = last_nonopt;
300
/* Exchange the shorter segment with the far end of the longer segment.
301
That puts the shorter segment into the right place.
302
It leaves the longer segment in the right place overall,
303
but it consists of two parts that need to be swapped next. */
305
while (top > middle && middle > bottom)
307
if (top - middle > middle - bottom)
309
/* Bottom segment is the short one. */
310
int len = middle - bottom;
313
/* Swap it with the top part of the top segment. */
314
for (i = 0; i < len; i++)
316
tem = argv[bottom + i];
317
argv[bottom + i] = argv[top - (middle - bottom) + i];
318
argv[top - (middle - bottom) + i] = tem;
320
/* Exclude the moved bottom segment from further swapping. */
325
/* Top segment is the short one. */
326
int len = top - middle;
329
/* Swap it with the bottom part of the bottom segment. */
330
for (i = 0; i < len; i++)
332
tem = argv[bottom + i];
333
argv[bottom + i] = argv[middle + i];
334
argv[middle + i] = tem;
336
/* Exclude the moved top segment from further swapping. */
341
/* Update records for the slots the non-options now occupy. */
343
first_nonopt += (optind - last_nonopt);
344
last_nonopt = optind;
347
/* Initialize the internal data when the first call is made. */
349
#if defined (__STDC__) && __STDC__
350
static const char *_getopt_initialize (int, char *const *, const char *);
353
_getopt_initialize (argc, argv, optstring)
356
const char *optstring;
358
/* Start processing options with ARGV-element 1 (since ARGV-element 0
359
is the program name); the sequence of previously skipped
360
non-option ARGV-elements is empty. */
362
first_nonopt = last_nonopt = optind = 1;
366
posixly_correct = getenv ("POSIXLY_CORRECT");
368
/* Determine how to handle the ordering of options and nonoptions. */
370
if (optstring[0] == '-')
372
ordering = RETURN_IN_ORDER;
375
else if (optstring[0] == '+')
377
ordering = REQUIRE_ORDER;
380
else if (posixly_correct != NULL)
381
ordering = REQUIRE_ORDER;
386
if (posixly_correct == NULL
387
&& argc == original_argc && argv == original_argv)
389
/* Bash 2.0 puts a special variable in the environment for each
390
command it runs, specifying which ARGV elements are the results of
391
file name wildcard expansion and therefore should not be
392
considered as options. */
394
sprintf (var, "_%d_GNU_nonoption_argv_flags_", getpid ());
395
nonoption_flags = getenv (var);
396
if (nonoption_flags == NULL)
397
nonoption_flags_len = 0;
399
nonoption_flags_len = strlen (nonoption_flags);
402
nonoption_flags_len = 0;
408
/* Scan elements of ARGV (whose length is ARGC) for option characters
411
If an element of ARGV starts with '-', and is not exactly "-" or "--",
412
then it is an option element. The characters of this element
413
(aside from the initial '-') are option characters. If `getopt'
414
is called repeatedly, it returns successively each of the option characters
415
from each of the option elements.
417
If `getopt' finds another option character, it returns that character,
418
updating `optind' and `nextchar' so that the next call to `getopt' can
419
resume the scan with the following option character or ARGV-element.
421
If there are no more option characters, `getopt' returns -1.
422
Then `optind' is the index in ARGV of the first ARGV-element
423
that is not an option. (The ARGV-elements have been permuted
424
so that those that are not options now come last.)
426
OPTSTRING is a string containing the legitimate option characters.
427
If an option character is seen that is not listed in OPTSTRING,
428
return '?' after printing an error message. If you set `opterr' to
429
zero, the error message is suppressed but we still return '?'.
431
If a char in OPTSTRING is followed by a colon, that means it wants an arg,
432
so the following text in the same ARGV-element, or the text of the following
433
ARGV-element, is returned in `optarg'. Two colons mean an option that
434
wants an optional arg; if there is text in the current ARGV-element,
435
it is returned in `optarg', otherwise `optarg' is set to zero.
437
If OPTSTRING starts with `-' or `+', it requests different methods of
438
handling the non-option ARGV-elements.
439
See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
441
Long-named options begin with `--' instead of `-'.
442
Their names may be abbreviated as long as the abbreviation is unique
443
or is an exact match for some defined option. If they have an
444
argument, it follows the option name in the same ARGV-element, separated
445
from the option name by a `=', or else the in next ARGV-element.
446
When `getopt' finds a long-named option, it returns 0 if that option's
447
`flag' field is nonzero, the value of the option's `val' field
448
if the `flag' field is zero.
450
The elements of ARGV aren't really const, because we permute them.
451
But we pretend they're const in the prototype to be compatible
454
LONGOPTS is a vector of `struct option' terminated by an
455
element containing a name which is zero.
457
LONGIND returns the index in LONGOPT of the long-named option found.
458
It is only valid when a long-named option has been found by the most
461
If LONG_ONLY is nonzero, '-' as well as '--' can introduce
462
long-named options. */
465
_getopt_internal (argc, argv, optstring, longopts, longind, long_only)
468
const char *optstring;
469
const struct option *longopts;
475
if (!__getopt_initialized || optind == 0)
477
optstring = _getopt_initialize (argc, argv, optstring);
478
optind = 1; /* Don't scan ARGV[0], the program name. */
479
__getopt_initialized = 1;
482
/* Test whether ARGV[optind] points to a non-option argument.
483
Either it does not have option syntax, or there is an environment flag
484
from the shell indicating it is not an option. The later information
485
is only used when the used in the GNU libc. */
487
#define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0' \
488
|| (optind < nonoption_flags_len \
489
&& nonoption_flags[optind] == '1'))
491
#define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
494
if (nextchar == NULL || *nextchar == '\0')
496
/* Advance to the next ARGV-element. */
498
/* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
499
moved back by the user (who may also have changed the arguments). */
500
if (last_nonopt > optind)
501
last_nonopt = optind;
502
if (first_nonopt > optind)
503
first_nonopt = optind;
505
if (ordering == PERMUTE)
507
/* If we have just processed some options following some non-options,
508
exchange them so that the options come first. */
510
if (first_nonopt != last_nonopt && last_nonopt != optind)
511
exchange ((char **) argv);
512
else if (last_nonopt != optind)
513
first_nonopt = optind;
515
/* Skip any additional non-options
516
and extend the range of non-options previously skipped. */
518
while (optind < argc && NONOPTION_P)
520
last_nonopt = optind;
523
/* The special ARGV-element `--' means premature end of options.
524
Skip it like a null option,
525
then exchange with previous non-options as if it were an option,
526
then skip everything else like a non-option. */
528
if (optind != argc && !strcmp (argv[optind], "--"))
532
if (first_nonopt != last_nonopt && last_nonopt != optind)
533
exchange ((char **) argv);
534
else if (first_nonopt == last_nonopt)
535
first_nonopt = optind;
541
/* If we have done all the ARGV-elements, stop the scan
542
and back over any non-options that we skipped and permuted. */
546
/* Set the next-arg-index to point at the non-options
547
that we previously skipped, so the caller will digest them. */
548
if (first_nonopt != last_nonopt)
549
optind = first_nonopt;
553
/* If we have come to a non-option and did not permute it,
554
either stop the scan or describe it to the caller and pass it by. */
558
if (ordering == REQUIRE_ORDER)
560
optarg = argv[optind++];
564
/* We have found another option-ARGV-element.
565
Skip the initial punctuation. */
567
nextchar = (argv[optind] + 1
568
+ (longopts != NULL && argv[optind][1] == '-'));
571
/* Decode the current option-ARGV-element. */
573
/* Check whether the ARGV-element is a long option.
575
If long_only and the ARGV-element has the form "-f", where f is
576
a valid short option, don't consider it an abbreviated form of
577
a long option that starts with f. Otherwise there would be no
578
way to give the -f short option.
580
On the other hand, if there's a long option "fubar" and
581
the ARGV-element is "-fu", do consider that an abbreviation of
582
the long option, just like "--fu", and not "-f" with arg "u".
584
This distinction seems to be the most useful approach. */
587
&& (argv[optind][1] == '-'
588
|| (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
591
const struct option *p;
592
const struct option *pfound = NULL;
598
for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
601
/* Test all long options for either exact match
602
or abbreviated matches. */
603
for (p = longopts, option_index = 0; p->name; p++, option_index++)
604
if (!strncmp (p->name, nextchar, nameend - nextchar))
606
if ((unsigned int) (nameend - nextchar)
607
== (unsigned int) strlen (p->name))
609
/* Exact match found. */
611
indfound = option_index;
615
else if (pfound == NULL)
617
/* First nonexact match found. */
619
indfound = option_index;
622
/* Second or later nonexact match found. */
629
fprintf (stderr, _("%s: option `%s' is ambiguous\n"),
630
argv[0], argv[optind]);
631
nextchar += strlen (nextchar);
639
option_index = indfound;
643
/* Don't test has_arg with >, because some C compilers don't
644
allow it to be used on enums. */
646
optarg = nameend + 1;
650
if (argv[optind - 1][1] == '-')
653
_("%s: option `--%s' doesn't allow an argument\n"),
654
argv[0], pfound->name);
656
/* +option or -option */
658
_("%s: option `%c%s' doesn't allow an argument\n"),
659
argv[0], argv[optind - 1][0], pfound->name);
661
nextchar += strlen (nextchar);
663
optopt = pfound->val;
667
else if (pfound->has_arg == 1)
670
optarg = argv[optind++];
675
_("%s: option `%s' requires an argument\n"),
676
argv[0], argv[optind - 1]);
677
nextchar += strlen (nextchar);
678
optopt = pfound->val;
679
return optstring[0] == ':' ? ':' : '?';
682
nextchar += strlen (nextchar);
684
*longind = option_index;
687
*(pfound->flag) = pfound->val;
693
/* Can't find it as a long option. If this is not getopt_long_only,
694
or the option starts with '--' or is not a valid short
695
option, then it's an error.
696
Otherwise interpret it as a short option. */
697
if (!long_only || argv[optind][1] == '-'
698
|| my_index (optstring, *nextchar) == NULL)
702
if (argv[optind][1] == '-')
704
fprintf (stderr, _("%s: unrecognized option `--%s'\n"),
707
/* +option or -option */
708
fprintf (stderr, _("%s: unrecognized option `%c%s'\n"),
709
argv[0], argv[optind][0], nextchar);
711
nextchar = (char *) "";
718
/* Look at and handle the next short option-character. */
721
char c = *nextchar++;
722
char *temp = my_index (optstring, c);
724
/* Increment `optind' when we start to process its last character. */
725
if (*nextchar == '\0')
728
if (temp == NULL || c == ':')
733
/* 1003.2 specifies the format of this message. */
734
fprintf (stderr, _("%s: illegal option -- %c\n"),
737
fprintf (stderr, _("%s: invalid option -- %c\n"),
743
/* Convenience. Treat POSIX -W foo same as long option --foo */
744
if (temp[0] == 'W' && temp[1] == ';')
747
const struct option *p;
748
const struct option *pfound = NULL;
754
/* This is an option that requires an argument. */
755
if (*nextchar != '\0')
758
/* If we end this ARGV-element by taking the rest as an arg,
759
we must advance to the next element now. */
762
else if (optind == argc)
766
/* 1003.2 specifies the format of this message. */
767
fprintf (stderr, _("%s: option requires an argument -- %c\n"),
771
if (optstring[0] == ':')
778
/* We already incremented `optind' once;
779
increment it again when taking next ARGV-elt as argument. */
780
optarg = argv[optind++];
782
/* optarg is now the argument, see if it's in the
783
table of longopts. */
785
for (nextchar = nameend = optarg; *nameend && *nameend != '='; nameend++)
788
/* Test all long options for either exact match
789
or abbreviated matches. */
790
for (p = longopts, option_index = 0; p->name; p++, option_index++)
791
if (!strncmp (p->name, nextchar, nameend - nextchar))
793
if ((unsigned int) (nameend - nextchar) == strlen (p->name))
795
/* Exact match found. */
797
indfound = option_index;
801
else if (pfound == NULL)
803
/* First nonexact match found. */
805
indfound = option_index;
808
/* Second or later nonexact match found. */
814
fprintf (stderr, _("%s: option `-W %s' is ambiguous\n"),
815
argv[0], argv[optind]);
816
nextchar += strlen (nextchar);
822
option_index = indfound;
825
/* Don't test has_arg with >, because some C compilers don't
826
allow it to be used on enums. */
828
optarg = nameend + 1;
832
fprintf (stderr, _("\
833
%s: option `-W %s' doesn't allow an argument\n"),
834
argv[0], pfound->name);
836
nextchar += strlen (nextchar);
840
else if (pfound->has_arg == 1)
843
optarg = argv[optind++];
848
_("%s: option `%s' requires an argument\n"),
849
argv[0], argv[optind - 1]);
850
nextchar += strlen (nextchar);
851
return optstring[0] == ':' ? ':' : '?';
854
nextchar += strlen (nextchar);
856
*longind = option_index;
859
*(pfound->flag) = pfound->val;
865
return 'W'; /* Let the application handle it. */
871
/* This is an option that accepts an argument optionally. */
872
if (*nextchar != '\0')
883
/* This is an option that requires an argument. */
884
if (*nextchar != '\0')
887
/* If we end this ARGV-element by taking the rest as an arg,
888
we must advance to the next element now. */
891
else if (optind == argc)
895
/* 1003.2 specifies the format of this message. */
897
_("%s: option requires an argument -- %c\n"),
901
if (optstring[0] == ':')
907
/* We already incremented `optind' once;
908
increment it again when taking next ARGV-elt as argument. */
909
optarg = argv[optind++];
918
getopt (argc, argv, optstring)
921
const char *optstring;
923
return _getopt_internal (argc, argv, optstring,
924
(const struct option *) 0,
929
#endif /* Not ELIDE_CODE. */
933
/* Compile with -DTEST to make an executable for use in testing
934
the above definition of `getopt'. */
942
int digit_optind = 0;
946
int this_option_optind = optind ? optind : 1;
948
c = getopt (argc, argv, "abc:d:0123456789");
964
if (digit_optind != 0 && digit_optind != this_option_optind)
965
printf ("digits occur in two different argv-elements.\n");
966
digit_optind = this_option_optind;
967
printf ("option %c\n", c);
971
printf ("option a\n");
975
printf ("option b\n");
979
printf ("option c with value `%s'\n", optarg);
986
printf ("?? getopt returned character code 0%o ??\n", c);
992
printf ("non-option ARGV-elements: ");
993
while (optind < argc)
994
printf ("%s ", argv[optind++]);
added
removed
liboctave/getopt.c
