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 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. */
66 /* This is for other GNU distributions with internationalized messages.
67 The GNU C Library itself does not yet support such messages. */
71 # define gettext(msgid) (msgid)
74 /* This version of `getopt' appears to the caller like standard Unix `getopt'
75 but it behaves differently for the user, since it allows the user
76 to intersperse the options with the other arguments.
78 As `getopt' works, it permutes the elements of ARGV so that,
79 when it is done, all the options precede everything else. Thus
80 all application programs are extended to handle flexible argument order.
82 Setting the environment variable POSIXLY_CORRECT disables permutation.
83 Then the behavior is completely standard.
85 GNU application programs can use a third alternative mode in which
86 they can distinguish the relative order of options and other arguments. */
90 /* For communication from `getopt' to the caller.
91 When `getopt' finds an option that takes an argument,
92 the argument value is returned here.
93 Also, when `ordering' is RETURN_IN_ORDER,
94 each non-option ARGV-element is returned here. */
98 /* Index in ARGV of the next element to be scanned.
99 This is used for communication to and from the caller
100 and for communication between successive calls to `getopt'.
102 On entry to `getopt', zero means this is the first call; initialize.
104 When `getopt' returns EOF, this is the index of the first of the
105 non-option elements that the caller should itself scan.
107 Otherwise, `optind' communicates from one call to the next
108 how much of ARGV has been scanned so far. */
110 /* XXX 1003.2 says this must be 1 before any call. */
113 /* The next char to be scanned in the option-element
114 in which the last option character we returned was found.
115 This allows us to pick up the scan where we left off.
117 If this is zero, or a null string, it means resume the scan
118 by advancing to the next ARGV-element. */
120 static char *nextchar
;
122 /* Callers store zero here to inhibit the error message
123 for unrecognized options. */
127 /* Set to an option character which was unrecognized.
128 This must be initialized on some systems to avoid linking in the
129 system's own getopt implementation. */
133 /* Describe how to deal with options that follow non-option ARGV-elements.
135 If the caller did not specify anything,
136 the default is REQUIRE_ORDER if the environment variable
137 POSIXLY_CORRECT is defined, PERMUTE otherwise.
139 REQUIRE_ORDER means don't recognize them as options;
140 stop option processing when the first non-option is seen.
141 This is what Unix does.
142 This mode of operation is selected by either setting the environment
143 variable POSIXLY_CORRECT, or using `+' as the first character
144 of the list of option characters.
146 PERMUTE is the default. We permute the contents of ARGV as we scan,
147 so that eventually all the non-options are at the end. This allows options
148 to be given in any order, even with programs that were not written to
151 RETURN_IN_ORDER is an option available to programs that were written
152 to expect options and other ARGV-elements in any order and that care about
153 the ordering of the two. We describe each non-option ARGV-element
154 as if it were the argument of an option with character code 1.
155 Using `-' as the first character of the list of option characters
156 selects this mode of operation.
158 The special argument `--' forces an end of option-scanning regardless
159 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
160 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
164 REQUIRE_ORDER
, PERMUTE
, RETURN_IN_ORDER
167 /* Value of POSIXLY_CORRECT environment variable. */
168 static char *posixly_correct
;
170 #ifdef __GNU_LIBRARY__
171 /* We want to avoid inclusion of string.h with non-GNU libraries
172 because there are many ways it can cause trouble.
173 On some systems, it contains special magic macros that don't work
176 #define my_index strchr
179 /* Avoid depending on library functions or files
180 whose names are inconsistent. */
198 /* If using GCC, we can safely declare strlen this way.
199 If not using GCC, it is ok not to declare it. */
201 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
202 That was relevant to code that was here before. */
203 #if !defined (__STDC__) || !__STDC__
204 /* gcc with -traditional declares the built-in strlen to return int,
205 and has done so at least since version 2.4.5. -- rms. */
206 extern int strlen (const char *);
207 #endif /* not __STDC__ */
208 #endif /* __GNUC__ */
210 #endif /* not __GNU_LIBRARY__ */
212 /* Handle permutation of arguments. */
214 /* Describe the part of ARGV that contains non-options that have
215 been skipped. `first_nonopt' is the index in ARGV of the first of them;
216 `last_nonopt' is the index after the last of them. */
218 static int first_nonopt
;
219 static int last_nonopt
;
221 /* Exchange two adjacent subsequences of ARGV.
222 One subsequence is elements [first_nonopt,last_nonopt)
223 which contains all the non-options that have been skipped so far.
224 The other is elements [last_nonopt,optind), which contains all
225 the options processed since those non-options were skipped.
227 `first_nonopt' and `last_nonopt' are relocated so that they describe
228 the new indices of the non-options in ARGV after they are moved. */
234 int bottom
= first_nonopt
;
235 int middle
= last_nonopt
;
239 /* Exchange the shorter segment with the far end of the longer segment.
240 That puts the shorter segment into the right place.
241 It leaves the longer segment in the right place overall,
242 but it consists of two parts that need to be swapped next. */
244 while (top
> middle
&& middle
> bottom
)
246 if (top
- middle
> middle
- bottom
)
248 /* Bottom segment is the short one. */
249 int len
= middle
- bottom
;
252 /* Swap it with the top part of the top segment. */
253 for (i
= 0; i
< len
; i
++)
255 tem
= argv
[bottom
+ i
];
256 argv
[bottom
+ i
] = argv
[top
- (middle
- bottom
) + i
];
257 argv
[top
- (middle
- bottom
) + i
] = tem
;
259 /* Exclude the moved bottom segment from further swapping. */
264 /* Top segment is the short one. */
265 int len
= top
- middle
;
268 /* Swap it with the bottom part of the bottom segment. */
269 for (i
= 0; i
< len
; i
++)
271 tem
= argv
[bottom
+ i
];
272 argv
[bottom
+ i
] = argv
[middle
+ i
];
273 argv
[middle
+ i
] = tem
;
275 /* Exclude the moved top segment from further swapping. */
280 /* Update records for the slots the non-options now occupy. */
282 first_nonopt
+= (optind
- last_nonopt
);
283 last_nonopt
= optind
;
286 /* Initialize the internal data when the first call is made. */
289 _getopt_initialize (optstring
)
290 const char *optstring
;
292 /* Start processing options with ARGV-element 1 (since ARGV-element 0
293 is the program name); the sequence of previously skipped
294 non-option ARGV-elements is empty. */
296 first_nonopt
= last_nonopt
= optind
= 1;
300 posixly_correct
= getenv ("POSIXLY_CORRECT");
302 /* Determine how to handle the ordering of options and nonoptions. */
304 if (optstring
[0] == '-')
306 ordering
= RETURN_IN_ORDER
;
309 else if (optstring
[0] == '+')
311 ordering
= REQUIRE_ORDER
;
314 else if (posixly_correct
!= NULL
)
315 ordering
= REQUIRE_ORDER
;
322 /* Scan elements of ARGV (whose length is ARGC) for option characters
325 If an element of ARGV starts with '-', and is not exactly "-" or "--",
326 then it is an option element. The characters of this element
327 (aside from the initial '-') are option characters. If `getopt'
328 is called repeatedly, it returns successively each of the option characters
329 from each of the option elements.
331 If `getopt' finds another option character, it returns that character,
332 updating `optind' and `nextchar' so that the next call to `getopt' can
333 resume the scan with the following option character or ARGV-element.
335 If there are no more option characters, `getopt' returns `EOF'.
336 Then `optind' is the index in ARGV of the first ARGV-element
337 that is not an option. (The ARGV-elements have been permuted
338 so that those that are not options now come last.)
340 OPTSTRING is a string containing the legitimate option characters.
341 If an option character is seen that is not listed in OPTSTRING,
342 return '?' after printing an error message. If you set `opterr' to
343 zero, the error message is suppressed but we still return '?'.
345 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
346 so the following text in the same ARGV-element, or the text of the following
347 ARGV-element, is returned in `optarg'. Two colons mean an option that
348 wants an optional arg; if there is text in the current ARGV-element,
349 it is returned in `optarg', otherwise `optarg' is set to zero.
351 If OPTSTRING starts with `-' or `+', it requests different methods of
352 handling the non-option ARGV-elements.
353 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
355 Long-named options begin with `--' instead of `-'.
356 Their names may be abbreviated as long as the abbreviation is unique
357 or is an exact match for some defined option. If they have an
358 argument, it follows the option name in the same ARGV-element, separated
359 from the option name by a `=', or else the in next ARGV-element.
360 When `getopt' finds a long-named option, it returns 0 if that option's
361 `flag' field is nonzero, the value of the option's `val' field
362 if the `flag' field is zero.
364 The elements of ARGV aren't really const, because we permute them.
365 But we pretend they're const in the prototype to be compatible
368 LONGOPTS is a vector of `struct option' terminated by an
369 element containing a name which is zero.
371 LONGIND returns the index in LONGOPT of the long-named option found.
372 It is only valid when a long-named option has been found by the most
375 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
376 long-named options. */
379 _getopt_internal (argc
, argv
, optstring
, longopts
, longind
, long_only
)
382 const char *optstring
;
383 const struct option
*longopts
;
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. */
520 fprintf (stderr
, gettext ("%s: option `%s' is ambiguous\n"),
521 argv
[0], argv
[optind
]);
522 nextchar
+= strlen (nextchar
);
529 option_index
= indfound
;
533 /* Don't test has_arg with >, because some C compilers don't
534 allow it to be used on enums. */
536 optarg
= nameend
+ 1;
540 if (argv
[optind
- 1][1] == '-')
543 gettext ("%s: option `--%s' doesn't allow an argument\n"),
544 argv
[0], pfound
->name
);
546 /* +option or -option */
548 gettext ("%s: option `%c%s' doesn't allow an argument\n"),
549 argv
[0], argv
[optind
- 1][0], pfound
->name
);
551 nextchar
+= strlen (nextchar
);
555 else if (pfound
->has_arg
== 1)
558 optarg
= argv
[optind
++];
563 gettext ("%s: option `%s' requires an argument\n"),
564 argv
[0], argv
[optind
- 1]);
565 nextchar
+= strlen (nextchar
);
566 return optstring
[0] == ':' ? ':' : '?';
569 nextchar
+= strlen (nextchar
);
571 *longind
= option_index
;
574 *(pfound
->flag
) = pfound
->val
;
580 /* Can't find it as a long option. If this is not getopt_long_only,
581 or the option starts with '--' or is not a valid short
582 option, then it's an error.
583 Otherwise interpret it as a short option. */
584 if (!long_only
|| argv
[optind
][1] == '-'
585 || my_index (optstring
, *nextchar
) == NULL
)
589 if (argv
[optind
][1] == '-')
591 fprintf (stderr
, gettext ("%s: unrecognized option `--%s'\n"),
594 /* +option or -option */
595 fprintf (stderr
, gettext ("%s: unrecognized option `%c%s'\n"),
596 argv
[0], argv
[optind
][0], nextchar
);
598 nextchar
= (char *) "";
604 /* Look at and handle the next short option-character. */
607 char c
= *nextchar
++;
608 char *temp
= my_index (optstring
, c
);
610 /* Increment `optind' when we start to process its last character. */
611 if (*nextchar
== '\0')
614 if (temp
== NULL
|| c
== ':')
619 /* 1003.2 specifies the format of this message. */
620 fprintf (stderr
, gettext ("%s: illegal option -- %c\n"),
623 fprintf (stderr
, gettext ("%s: invalid option -- %c\n"),
633 /* This is an option that accepts an argument optionally. */
634 if (*nextchar
!= '\0')
645 /* This is an option that requires an argument. */
646 if (*nextchar
!= '\0')
649 /* If we end this ARGV-element by taking the rest as an arg,
650 we must advance to the next element now. */
653 else if (optind
== argc
)
657 /* 1003.2 specifies the format of this message. */
659 gettext ("%s: option requires an argument -- %c\n"),
663 if (optstring
[0] == ':')
669 /* We already incremented `optind' once;
670 increment it again when taking next ARGV-elt as argument. */
671 optarg
= argv
[optind
++];
680 getopt (argc
, argv
, optstring
)
683 const char *optstring
;
685 return _getopt_internal (argc
, argv
, optstring
,
686 (const struct option
*) 0,
691 #endif /* _LIBC or not __GNU_LIBRARY__. */
695 /* Compile with -DTEST to make an executable for use in testing
696 the above definition of `getopt'. */
704 int digit_optind
= 0;
708 int this_option_optind
= optind
? optind
: 1;
710 c
= getopt (argc
, argv
, "abc:d:0123456789");
726 if (digit_optind
!= 0 && digit_optind
!= this_option_optind
)
727 printf ("digits occur in two different argv-elements.\n");
728 digit_optind
= this_option_optind
;
729 printf ("option %c\n", c
);
733 printf ("option a\n");
737 printf ("option b\n");
741 printf ("option c with value `%s'\n", optarg
);
748 printf ("?? getopt returned character code 0%o ??\n", c
);
754 printf ("non-option ARGV-elements: ");
755 while (optind
< argc
)
756 printf ("%s ", argv
[optind
++]);