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, 95
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., 675 Mass Ave,
25 Cambridge, MA 02139, 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 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
58 /* This needs to come after some library #include
59 to get __GNU_LIBRARY__ defined. */
60 #ifdef __GNU_LIBRARY__
61 /* Don't include stdlib.h for non-GNU C libraries because some of them
62 contain conflicting prototypes for getopt. */
64 #endif /* GNU C library. */
67 /* This is for other GNU distributions with internationalized messages.
68 When compiling libc, the _ macro is predefined. */
71 # define _(msgid) gettext (msgid)
73 # define _(msgid) (msgid)
77 /* This version of `getopt' appears to the caller like standard Unix `getopt'
78 but it behaves differently for the user, since it allows the user
79 to intersperse the options with the other arguments.
81 As `getopt' works, it permutes the elements of ARGV so that,
82 when it is done, all the options precede everything else. Thus
83 all application programs are extended to handle flexible argument order.
85 Setting the environment variable POSIXLY_CORRECT disables permutation.
86 Then the behavior is completely standard.
88 GNU application programs can use a third alternative mode in which
89 they can distinguish the relative order of options and other arguments. */
93 /* For communication from `getopt' to the caller.
94 When `getopt' finds an option that takes an argument,
95 the argument value is returned here.
96 Also, when `ordering' is RETURN_IN_ORDER,
97 each non-option ARGV-element is returned here. */
101 /* Index in ARGV of the next element to be scanned.
102 This is used for communication to and from the caller
103 and for communication between successive calls to `getopt'.
105 On entry to `getopt', zero means this is the first call; initialize.
107 When `getopt' returns EOF, this is the index of the first of the
108 non-option elements that the caller should itself scan.
110 Otherwise, `optind' communicates from one call to the next
111 how much of ARGV has been scanned so far. */
113 /* XXX 1003.2 says this must be 1 before any call. */
116 /* The next char to be scanned in the option-element
117 in which the last option character we returned was found.
118 This allows us to pick up the scan where we left off.
120 If this is zero, or a null string, it means resume the scan
121 by advancing to the next ARGV-element. */
123 static char *nextchar
;
125 /* Callers store zero here to inhibit the error message
126 for unrecognized options. */
130 /* Set to an option character which was unrecognized.
131 This must be initialized on some systems to avoid linking in the
132 system's own getopt implementation. */
136 /* Describe how to deal with options that follow non-option ARGV-elements.
138 If the caller did not specify anything,
139 the default is REQUIRE_ORDER if the environment variable
140 POSIXLY_CORRECT is defined, PERMUTE otherwise.
142 REQUIRE_ORDER means don't recognize them as options;
143 stop option processing when the first non-option is seen.
144 This is what Unix does.
145 This mode of operation is selected by either setting the environment
146 variable POSIXLY_CORRECT, or using `+' as the first character
147 of the list of option characters.
149 PERMUTE is the default. We permute the contents of ARGV as we scan,
150 so that eventually all the non-options are at the end. This allows options
151 to be given in any order, even with programs that were not written to
154 RETURN_IN_ORDER is an option available to programs that were written
155 to expect options and other ARGV-elements in any order and that care about
156 the ordering of the two. We describe each non-option ARGV-element
157 as if it were the argument of an option with character code 1.
158 Using `-' as the first character of the list of option characters
159 selects this mode of operation.
161 The special argument `--' forces an end of option-scanning regardless
162 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
163 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
167 REQUIRE_ORDER
, PERMUTE
, RETURN_IN_ORDER
170 /* Value of POSIXLY_CORRECT environment variable. */
171 static char *posixly_correct
;
173 #ifdef __GNU_LIBRARY__
174 /* We want to avoid inclusion of string.h with non-GNU libraries
175 because there are many ways it can cause trouble.
176 On some systems, it contains special magic macros that don't work
179 #define my_index strchr
182 /* Avoid depending on library functions or files
183 whose names are inconsistent. */
201 /* If using GCC, we can safely declare strlen this way.
202 If not using GCC, it is ok not to declare it. */
204 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
205 That was relevant to code that was here before. */
206 #if !defined (__STDC__) || !__STDC__
207 /* gcc with -traditional declares the built-in strlen to return int,
208 and has done so at least since version 2.4.5. -- rms. */
209 extern int strlen (const char *);
210 #endif /* not __STDC__ */
211 #endif /* __GNUC__ */
213 #endif /* not __GNU_LIBRARY__ */
215 /* Handle permutation of arguments. */
217 /* Describe the part of ARGV that contains non-options that have
218 been skipped. `first_nonopt' is the index in ARGV of the first of them;
219 `last_nonopt' is the index after the last of them. */
221 static int first_nonopt
;
222 static int last_nonopt
;
224 /* Exchange two adjacent subsequences of ARGV.
225 One subsequence is elements [first_nonopt,last_nonopt)
226 which contains all the non-options that have been skipped so far.
227 The other is elements [last_nonopt,optind), which contains all
228 the options processed since those non-options were skipped.
230 `first_nonopt' and `last_nonopt' are relocated so that they describe
231 the new indices of the non-options in ARGV after they are moved. */
233 #if defined (__STDC__) && __STDC__
234 static void exchange (char **);
241 int bottom
= first_nonopt
;
242 int middle
= last_nonopt
;
246 /* Exchange the shorter segment with the far end of the longer segment.
247 That puts the shorter segment into the right place.
248 It leaves the longer segment in the right place overall,
249 but it consists of two parts that need to be swapped next. */
251 while (top
> middle
&& middle
> bottom
)
253 if (top
- middle
> middle
- bottom
)
255 /* Bottom segment is the short one. */
256 int len
= middle
- bottom
;
259 /* Swap it with the top part of the top segment. */
260 for (i
= 0; i
< len
; i
++)
262 tem
= argv
[bottom
+ i
];
263 argv
[bottom
+ i
] = argv
[top
- (middle
- bottom
) + i
];
264 argv
[top
- (middle
- bottom
) + i
] = tem
;
266 /* Exclude the moved bottom segment from further swapping. */
271 /* Top segment is the short one. */
272 int len
= top
- middle
;
275 /* Swap it with the bottom part of the bottom segment. */
276 for (i
= 0; i
< len
; i
++)
278 tem
= argv
[bottom
+ i
];
279 argv
[bottom
+ i
] = argv
[middle
+ i
];
280 argv
[middle
+ i
] = tem
;
282 /* Exclude the moved top segment from further swapping. */
287 /* Update records for the slots the non-options now occupy. */
289 first_nonopt
+= (optind
- last_nonopt
);
290 last_nonopt
= optind
;
293 /* Initialize the internal data when the first call is made. */
295 #if defined (__STDC__) && __STDC__
296 static const char *_getopt_initialize (const char *);
299 _getopt_initialize (optstring
)
300 const char *optstring
;
302 /* Start processing options with ARGV-element 1 (since ARGV-element 0
303 is the program name); the sequence of previously skipped
304 non-option ARGV-elements is empty. */
306 first_nonopt
= last_nonopt
= optind
= 1;
310 posixly_correct
= getenv ("POSIXLY_CORRECT");
312 /* Determine how to handle the ordering of options and nonoptions. */
314 if (optstring
[0] == '-')
316 ordering
= RETURN_IN_ORDER
;
319 else if (optstring
[0] == '+')
321 ordering
= REQUIRE_ORDER
;
324 else if (posixly_correct
!= NULL
)
325 ordering
= REQUIRE_ORDER
;
332 /* Scan elements of ARGV (whose length is ARGC) for option characters
335 If an element of ARGV starts with '-', and is not exactly "-" or "--",
336 then it is an option element. The characters of this element
337 (aside from the initial '-') are option characters. If `getopt'
338 is called repeatedly, it returns successively each of the option characters
339 from each of the option elements.
341 If `getopt' finds another option character, it returns that character,
342 updating `optind' and `nextchar' so that the next call to `getopt' can
343 resume the scan with the following option character or ARGV-element.
345 If there are no more option characters, `getopt' returns `EOF'.
346 Then `optind' is the index in ARGV of the first ARGV-element
347 that is not an option. (The ARGV-elements have been permuted
348 so that those that are not options now come last.)
350 OPTSTRING is a string containing the legitimate option characters.
351 If an option character is seen that is not listed in OPTSTRING,
352 return '?' after printing an error message. If you set `opterr' to
353 zero, the error message is suppressed but we still return '?'.
355 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
356 so the following text in the same ARGV-element, or the text of the following
357 ARGV-element, is returned in `optarg'. Two colons mean an option that
358 wants an optional arg; if there is text in the current ARGV-element,
359 it is returned in `optarg', otherwise `optarg' is set to zero.
361 If OPTSTRING starts with `-' or `+', it requests different methods of
362 handling the non-option ARGV-elements.
363 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
365 Long-named options begin with `--' instead of `-'.
366 Their names may be abbreviated as long as the abbreviation is unique
367 or is an exact match for some defined option. If they have an
368 argument, it follows the option name in the same ARGV-element, separated
369 from the option name by a `=', or else the in next ARGV-element.
370 When `getopt' finds a long-named option, it returns 0 if that option's
371 `flag' field is nonzero, the value of the option's `val' field
372 if the `flag' field is zero.
374 The elements of ARGV aren't really const, because we permute them.
375 But we pretend they're const in the prototype to be compatible
378 LONGOPTS is a vector of `struct option' terminated by an
379 element containing a name which is zero.
381 LONGIND returns the index in LONGOPT of the long-named option found.
382 It is only valid when a long-named option has been found by the most
385 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
386 long-named options. */
389 _getopt_internal (argc
, argv
, optstring
, longopts
, longind
, long_only
)
392 const char *optstring
;
393 const struct option
*longopts
;
401 optstring
= _getopt_initialize (optstring
);
402 optind
= 1; /* Don't scan ARGV[0], the program name. */
405 if (nextchar
== NULL
|| *nextchar
== '\0')
407 /* Advance to the next ARGV-element. */
409 if (ordering
== PERMUTE
)
411 /* If we have just processed some options following some non-options,
412 exchange them so that the options come first. */
414 if (first_nonopt
!= last_nonopt
&& last_nonopt
!= optind
)
415 exchange ((char **) argv
);
416 else if (last_nonopt
!= optind
)
417 first_nonopt
= optind
;
419 /* Skip any additional non-options
420 and extend the range of non-options previously skipped. */
423 && (argv
[optind
][0] != '-' || argv
[optind
][1] == '\0'))
425 last_nonopt
= optind
;
428 /* The special ARGV-element `--' means premature end of options.
429 Skip it like a null option,
430 then exchange with previous non-options as if it were an option,
431 then skip everything else like a non-option. */
433 if (optind
!= argc
&& !strcmp (argv
[optind
], "--"))
437 if (first_nonopt
!= last_nonopt
&& last_nonopt
!= optind
)
438 exchange ((char **) argv
);
439 else if (first_nonopt
== last_nonopt
)
440 first_nonopt
= optind
;
446 /* If we have done all the ARGV-elements, stop the scan
447 and back over any non-options that we skipped and permuted. */
451 /* Set the next-arg-index to point at the non-options
452 that we previously skipped, so the caller will digest them. */
453 if (first_nonopt
!= last_nonopt
)
454 optind
= first_nonopt
;
458 /* If we have come to a non-option and did not permute it,
459 either stop the scan or describe it to the caller and pass it by. */
461 if ((argv
[optind
][0] != '-' || argv
[optind
][1] == '\0'))
463 if (ordering
== REQUIRE_ORDER
)
465 optarg
= argv
[optind
++];
469 /* We have found another option-ARGV-element.
470 Skip the initial punctuation. */
472 nextchar
= (argv
[optind
] + 1
473 + (longopts
!= NULL
&& argv
[optind
][1] == '-'));
476 /* Decode the current option-ARGV-element. */
478 /* Check whether the ARGV-element is a long option.
480 If long_only and the ARGV-element has the form "-f", where f is
481 a valid short option, don't consider it an abbreviated form of
482 a long option that starts with f. Otherwise there would be no
483 way to give the -f short option.
485 On the other hand, if there's a long option "fubar" and
486 the ARGV-element is "-fu", do consider that an abbreviation of
487 the long option, just like "--fu", and not "-f" with arg "u".
489 This distinction seems to be the most useful approach. */
492 && (argv
[optind
][1] == '-'
493 || (long_only
&& (argv
[optind
][2] || !my_index (optstring
, argv
[optind
][1])))))
496 const struct option
*p
;
497 const struct option
*pfound
= NULL
;
503 for (nameend
= nextchar
; *nameend
&& *nameend
!= '='; nameend
++)
506 /* Test all long options for either exact match
507 or abbreviated matches. */
508 for (p
= longopts
, option_index
= 0; p
->name
; p
++, option_index
++)
509 if (!strncmp (p
->name
, nextchar
, nameend
- nextchar
))
511 if (nameend
- nextchar
== strlen (p
->name
))
513 /* Exact match found. */
515 indfound
= option_index
;
519 else if (pfound
== NULL
)
521 /* First nonexact match found. */
523 indfound
= option_index
;
526 /* Second or later nonexact match found. */
533 fprintf (stderr
, _("%s: option `%s' is ambiguous\n"),
534 argv
[0], argv
[optind
]);
535 nextchar
+= strlen (nextchar
);
542 option_index
= indfound
;
546 /* Don't test has_arg with >, because some C compilers don't
547 allow it to be used on enums. */
549 optarg
= nameend
+ 1;
553 if (argv
[optind
- 1][1] == '-')
556 _("%s: option `--%s' doesn't allow an argument\n"),
557 argv
[0], pfound
->name
);
559 /* +option or -option */
561 _("%s: option `%c%s' doesn't allow an argument\n"),
562 argv
[0], argv
[optind
- 1][0], pfound
->name
);
564 nextchar
+= strlen (nextchar
);
568 else if (pfound
->has_arg
== 1)
571 optarg
= argv
[optind
++];
576 _("%s: option `%s' requires an argument\n"),
577 argv
[0], argv
[optind
- 1]);
578 nextchar
+= strlen (nextchar
);
579 return optstring
[0] == ':' ? ':' : '?';
582 nextchar
+= strlen (nextchar
);
584 *longind
= option_index
;
587 *(pfound
->flag
) = pfound
->val
;
593 /* Can't find it as a long option. If this is not getopt_long_only,
594 or the option starts with '--' or is not a valid short
595 option, then it's an error.
596 Otherwise interpret it as a short option. */
597 if (!long_only
|| argv
[optind
][1] == '-'
598 || my_index (optstring
, *nextchar
) == NULL
)
602 if (argv
[optind
][1] == '-')
604 fprintf (stderr
, _("%s: unrecognized option `--%s'\n"),
607 /* +option or -option */
608 fprintf (stderr
, _("%s: unrecognized option `%c%s'\n"),
609 argv
[0], argv
[optind
][0], nextchar
);
611 nextchar
= (char *) "";
617 /* Look at and handle the next short option-character. */
620 char c
= *nextchar
++;
621 char *temp
= my_index (optstring
, c
);
623 /* Increment `optind' when we start to process its last character. */
624 if (*nextchar
== '\0')
627 if (temp
== NULL
|| c
== ':')
632 /* 1003.2 specifies the format of this message. */
633 fprintf (stderr
, _("%s: illegal option -- %c\n"),
636 fprintf (stderr
, _("%s: invalid option -- %c\n"),
646 /* This is an option that accepts an argument optionally. */
647 if (*nextchar
!= '\0')
658 /* This is an option that requires an argument. */
659 if (*nextchar
!= '\0')
662 /* If we end this ARGV-element by taking the rest as an arg,
663 we must advance to the next element now. */
666 else if (optind
== argc
)
670 /* 1003.2 specifies the format of this message. */
672 _("%s: option requires an argument -- %c\n"),
676 if (optstring
[0] == ':')
682 /* We already incremented `optind' once;
683 increment it again when taking next ARGV-elt as argument. */
684 optarg
= argv
[optind
++];
693 getopt (argc
, argv
, optstring
)
696 const char *optstring
;
698 return _getopt_internal (argc
, argv
, optstring
,
699 (const struct option
*) 0,
704 #endif /* _LIBC or not __GNU_LIBRARY__. */
708 /* Compile with -DTEST to make an executable for use in testing
709 the above definition of `getopt'. */
717 int digit_optind
= 0;
721 int this_option_optind
= optind
? optind
: 1;
723 c
= getopt (argc
, argv
, "abc:d:0123456789");
739 if (digit_optind
!= 0 && digit_optind
!= this_option_optind
)
740 printf ("digits occur in two different argv-elements.\n");
741 digit_optind
= this_option_optind
;
742 printf ("option %c\n", c
);
746 printf ("option a\n");
750 printf ("option b\n");
754 printf ("option c with value `%s'\n", optarg
);
761 printf ("?? getopt returned character code 0%o ??\n", c
);
767 printf ("non-option ARGV-elements: ");
768 while (optind
< argc
)
769 printf ("%s ", argv
[optind
++]);