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 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. */
23 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
24 Ditto for AIX 3.2 and <stdlib.h>. */
33 #if !defined (__STDC__) || !__STDC__
34 /* This is a separate conditional since some stdc systems
35 reject `defined (const)'. */
44 /* Comment out all this code if we are using the GNU C Library, and are not
45 actually compiling the library itself. This code is part of the GNU C
46 Library, but also included in many other GNU distributions. Compiling
47 and linking in this code is a waste when using the GNU C library
48 (especially if it is a shared library). Rather than having every GNU
49 program understand `configure --with-gnu-libc' and omit the object files,
50 it is simpler to just do this in the source for each such file. */
52 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
55 /* This needs to come after some library #include
56 to get __GNU_LIBRARY__ defined. */
57 #ifdef __GNU_LIBRARY__
58 /* Don't include stdlib.h for non-GNU C libraries because some of them
59 contain conflicting prototypes for getopt. */
61 #endif /* GNU C library. */
63 /* This is for other GNU distributions with internationalized messages.
64 The GNU C Library itself does not yet support such messages. */
68 # define gettext(msgid) (msgid)
71 /* This version of `getopt' appears to the caller like standard Unix `getopt'
72 but it behaves differently for the user, since it allows the user
73 to intersperse the options with the other arguments.
75 As `getopt' works, it permutes the elements of ARGV so that,
76 when it is done, all the options precede everything else. Thus
77 all application programs are extended to handle flexible argument order.
79 Setting the environment variable POSIXLY_CORRECT disables permutation.
80 Then the behavior is completely standard.
82 GNU application programs can use a third alternative mode in which
83 they can distinguish the relative order of options and other arguments. */
87 /* For communication from `getopt' to the caller.
88 When `getopt' finds an option that takes an argument,
89 the argument value is returned here.
90 Also, when `ordering' is RETURN_IN_ORDER,
91 each non-option ARGV-element is returned here. */
95 /* Index in ARGV of the next element to be scanned.
96 This is used for communication to and from the caller
97 and for communication between successive calls to `getopt'.
99 On entry to `getopt', zero means this is the first call; initialize.
101 When `getopt' returns EOF, this is the index of the first of the
102 non-option elements that the caller should itself scan.
104 Otherwise, `optind' communicates from one call to the next
105 how much of ARGV has been scanned so far. */
107 /* XXX 1003.2 says this must be 1 before any call. */
110 /* The next char to be scanned in the option-element
111 in which the last option character we returned was found.
112 This allows us to pick up the scan where we left off.
114 If this is zero, or a null string, it means resume the scan
115 by advancing to the next ARGV-element. */
117 static char *nextchar
;
119 /* Callers store zero here to inhibit the error message
120 for unrecognized options. */
124 /* Set to an option character which was unrecognized.
125 This must be initialized on some systems to avoid linking in the
126 system's own getopt implementation. */
130 /* Describe how to deal with options that follow non-option ARGV-elements.
132 If the caller did not specify anything,
133 the default is REQUIRE_ORDER if the environment variable
134 POSIXLY_CORRECT is defined, PERMUTE otherwise.
136 REQUIRE_ORDER means don't recognize them as options;
137 stop option processing when the first non-option is seen.
138 This is what Unix does.
139 This mode of operation is selected by either setting the environment
140 variable POSIXLY_CORRECT, or using `+' as the first character
141 of the list of option characters.
143 PERMUTE is the default. We permute the contents of ARGV as we scan,
144 so that eventually all the non-options are at the end. This allows options
145 to be given in any order, even with programs that were not written to
148 RETURN_IN_ORDER is an option available to programs that were written
149 to expect options and other ARGV-elements in any order and that care about
150 the ordering of the two. We describe each non-option ARGV-element
151 as if it were the argument of an option with character code 1.
152 Using `-' as the first character of the list of option characters
153 selects this mode of operation.
155 The special argument `--' forces an end of option-scanning regardless
156 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
157 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
161 REQUIRE_ORDER
, PERMUTE
, RETURN_IN_ORDER
164 /* Value of POSIXLY_CORRECT environment variable. */
165 static char *posixly_correct
;
167 #ifdef __GNU_LIBRARY__
168 /* We want to avoid inclusion of string.h with non-GNU libraries
169 because there are many ways it can cause trouble.
170 On some systems, it contains special magic macros that don't work
173 #define my_index strchr
176 /* Avoid depending on library functions or files
177 whose names are inconsistent. */
178 /* ADK: No, let's just include the darn thing and be done with it. */
179 /* char *getenv (); */
183 my_index (const char *str
, int chr
)
194 /* If using GCC, we can safely declare strlen this way.
195 If not using GCC, it is ok not to declare it. */
197 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
198 That was relevant to code that was here before. */
199 #if !defined (__STDC__) || !__STDC__
200 /* gcc with -traditional declares the built-in strlen to return int,
201 and has done so at least since version 2.4.5. -- rms. */
202 extern int strlen (const char *);
203 #endif /* not __STDC__ */
204 #endif /* __GNUC__ */
206 #endif /* not __GNU_LIBRARY__ */
208 /* Handle permutation of arguments. */
210 /* Describe the part of ARGV that contains non-options that have
211 been skipped. `first_nonopt' is the index in ARGV of the first of them;
212 `last_nonopt' is the index after the last of them. */
214 static int first_nonopt
;
215 static int last_nonopt
;
217 /* Exchange two adjacent subsequences of ARGV.
218 One subsequence is elements [first_nonopt,last_nonopt)
219 which contains all the non-options that have been skipped so far.
220 The other is elements [last_nonopt,optind), which contains all
221 the options processed since those non-options were skipped.
223 `first_nonopt' and `last_nonopt' are relocated so that they describe
224 the new indices of the non-options in ARGV after they are moved. */
227 exchange (char **argv
)
229 int bottom
= first_nonopt
;
230 int middle
= last_nonopt
;
234 /* Exchange the shorter segment with the far end of the longer segment.
235 That puts the shorter segment into the right place.
236 It leaves the longer segment in the right place overall,
237 but it consists of two parts that need to be swapped next. */
239 while (top
> middle
&& middle
> bottom
)
241 if (top
- middle
> middle
- bottom
)
243 /* Bottom segment is the short one. */
244 int len
= middle
- bottom
;
247 /* Swap it with the top part of the top segment. */
248 for (i
= 0; i
< len
; i
++)
250 tem
= argv
[bottom
+ i
];
251 argv
[bottom
+ i
] = argv
[top
- (middle
- bottom
) + i
];
252 argv
[top
- (middle
- bottom
) + i
] = tem
;
254 /* Exclude the moved bottom segment from further swapping. */
259 /* Top segment is the short one. */
260 int len
= top
- middle
;
263 /* Swap it with the bottom part of the bottom segment. */
264 for (i
= 0; i
< len
; i
++)
266 tem
= argv
[bottom
+ i
];
267 argv
[bottom
+ i
] = argv
[middle
+ i
];
268 argv
[middle
+ i
] = tem
;
270 /* Exclude the moved top segment from further swapping. */
275 /* Update records for the slots the non-options now occupy. */
277 first_nonopt
+= (optind
- last_nonopt
);
278 last_nonopt
= optind
;
281 /* Initialize the internal data when the first call is made. */
284 _getopt_initialize (const char *optstring
)
286 /* Start processing options with ARGV-element 1 (since ARGV-element 0
287 is the program name); the sequence of previously skipped
288 non-option ARGV-elements is empty. */
290 first_nonopt
= last_nonopt
= optind
= 1;
294 posixly_correct
= getenv ("POSIXLY_CORRECT");
296 /* Determine how to handle the ordering of options and nonoptions. */
298 if (optstring
[0] == '-')
300 ordering
= RETURN_IN_ORDER
;
303 else if (optstring
[0] == '+')
305 ordering
= REQUIRE_ORDER
;
308 else if (posixly_correct
!= NULL
)
309 ordering
= REQUIRE_ORDER
;
316 /* Scan elements of ARGV (whose length is ARGC) for option characters
319 If an element of ARGV starts with '-', and is not exactly "-" or "--",
320 then it is an option element. The characters of this element
321 (aside from the initial '-') are option characters. If `getopt'
322 is called repeatedly, it returns successively each of the option characters
323 from each of the option elements.
325 If `getopt' finds another option character, it returns that character,
326 updating `optind' and `nextchar' so that the next call to `getopt' can
327 resume the scan with the following option character or ARGV-element.
329 If there are no more option characters, `getopt' returns `EOF'.
330 Then `optind' is the index in ARGV of the first ARGV-element
331 that is not an option. (The ARGV-elements have been permuted
332 so that those that are not options now come last.)
334 OPTSTRING is a string containing the legitimate option characters.
335 If an option character is seen that is not listed in OPTSTRING,
336 return '?' after printing an error message. If you set `opterr' to
337 zero, the error message is suppressed but we still return '?'.
339 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
340 so the following text in the same ARGV-element, or the text of the following
341 ARGV-element, is returned in `optarg'. Two colons mean an option that
342 wants an optional arg; if there is text in the current ARGV-element,
343 it is returned in `optarg', otherwise `optarg' is set to zero.
345 If OPTSTRING starts with `-' or `+', it requests different methods of
346 handling the non-option ARGV-elements.
347 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
349 Long-named options begin with `--' instead of `-'.
350 Their names may be abbreviated as long as the abbreviation is unique
351 or is an exact match for some defined option. If they have an
352 argument, it follows the option name in the same ARGV-element, separated
353 from the option name by a `=', or else the in next ARGV-element.
354 When `getopt' finds a long-named option, it returns 0 if that option's
355 `flag' field is nonzero, the value of the option's `val' field
356 if the `flag' field is zero.
358 The elements of ARGV aren't really const, because we permute them.
359 But we pretend they're const in the prototype to be compatible
362 LONGOPTS is a vector of `struct option' terminated by an
363 element containing a name which is zero.
365 LONGIND returns the index in LONGOPT of the long-named option found.
366 It is only valid when a long-named option has been found by the most
369 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
370 long-named options. */
373 _getopt_internal (int argc
, char *const *argv
, const char *optstring
,
374 const struct option
*longopts
, int *longind
, int long_only
)
380 optstring
= _getopt_initialize (optstring
);
381 optind
= 1; /* Don't scan ARGV[0], the program name. */
384 if (nextchar
== NULL
|| *nextchar
== '\0')
386 /* Advance to the next ARGV-element. */
388 if (ordering
== PERMUTE
)
390 /* If we have just processed some options following some non-options,
391 exchange them so that the options come first. */
393 if (first_nonopt
!= last_nonopt
&& last_nonopt
!= optind
)
394 exchange ((char **) argv
);
395 else if (last_nonopt
!= optind
)
396 first_nonopt
= optind
;
398 /* Skip any additional non-options
399 and extend the range of non-options previously skipped. */
402 && (argv
[optind
][0] != '-' || argv
[optind
][1] == '\0'))
404 last_nonopt
= optind
;
407 /* The special ARGV-element `--' means premature end of options.
408 Skip it like a null option,
409 then exchange with previous non-options as if it were an option,
410 then skip everything else like a non-option. */
412 if (optind
!= argc
&& !strcmp (argv
[optind
], "--"))
416 if (first_nonopt
!= last_nonopt
&& last_nonopt
!= optind
)
417 exchange ((char **) argv
);
418 else if (first_nonopt
== last_nonopt
)
419 first_nonopt
= optind
;
425 /* If we have done all the ARGV-elements, stop the scan
426 and back over any non-options that we skipped and permuted. */
430 /* Set the next-arg-index to point at the non-options
431 that we previously skipped, so the caller will digest them. */
432 if (first_nonopt
!= last_nonopt
)
433 optind
= first_nonopt
;
437 /* If we have come to a non-option and did not permute it,
438 either stop the scan or describe it to the caller and pass it by. */
440 if ((argv
[optind
][0] != '-' || argv
[optind
][1] == '\0'))
442 if (ordering
== REQUIRE_ORDER
)
444 optarg
= argv
[optind
++];
448 /* We have found another option-ARGV-element.
449 Skip the initial punctuation. */
451 nextchar
= (argv
[optind
] + 1
452 + (longopts
!= NULL
&& argv
[optind
][1] == '-'));
455 /* Decode the current option-ARGV-element. */
457 /* Check whether the ARGV-element is a long option.
459 If long_only and the ARGV-element has the form "-f", where f is
460 a valid short option, don't consider it an abbreviated form of
461 a long option that starts with f. Otherwise there would be no
462 way to give the -f short option.
464 On the other hand, if there's a long option "fubar" and
465 the ARGV-element is "-fu", do consider that an abbreviation of
466 the long option, just like "--fu", and not "-f" with arg "u".
468 This distinction seems to be the most useful approach. */
471 && (argv
[optind
][1] == '-'
472 || (long_only
&& (argv
[optind
][2] || !my_index (optstring
, argv
[optind
][1])))))
475 const struct option
*p
;
476 const struct option
*pfound
= NULL
;
482 for (nameend
= nextchar
; *nameend
&& *nameend
!= '='; nameend
++)
485 /* Test all long options for either exact match
486 or abbreviated matches. */
487 for (p
= longopts
, option_index
= 0; p
->name
; p
++, option_index
++)
488 if (!strncmp (p
->name
, nextchar
, nameend
- nextchar
))
490 if (nameend
- nextchar
== strlen (p
->name
))
492 /* Exact match found. */
494 indfound
= option_index
;
498 else if (pfound
== NULL
)
500 /* First nonexact match found. */
502 indfound
= option_index
;
505 /* Second or later nonexact match found. */
512 fprintf (stderr
, gettext ("%s: option `%s' is ambiguous\n"),
513 argv
[0], argv
[optind
]);
514 nextchar
+= strlen (nextchar
);
521 option_index
= indfound
;
525 /* Don't test has_arg with >, because some C compilers don't
526 allow it to be used on enums. */
528 optarg
= nameend
+ 1;
532 if (argv
[optind
- 1][1] == '-') {
535 gettext ("%s: option `--%s' doesn't allow an argument\n"),
536 argv
[0], pfound
->name
);
538 /* +option or -option */
540 gettext ("%s: option `%c%s' doesn't allow an argument\n"),
541 argv
[0], argv
[optind
- 1][0], pfound
->name
);
544 nextchar
+= strlen (nextchar
);
548 else if (pfound
->has_arg
== 1)
551 optarg
= argv
[optind
++];
556 gettext ("%s: option `%s' requires an argument\n"),
557 argv
[0], argv
[optind
- 1]);
558 nextchar
+= strlen (nextchar
);
559 return optstring
[0] == ':' ? ':' : '?';
562 nextchar
+= strlen (nextchar
);
564 *longind
= option_index
;
567 *(pfound
->flag
) = pfound
->val
;
573 /* Can't find it as a long option. If this is not getopt_long_only,
574 or the option starts with '--' or is not a valid short
575 option, then it's an error.
576 Otherwise interpret it as a short option. */
577 if (!long_only
|| argv
[optind
][1] == '-'
578 || my_index (optstring
, *nextchar
) == NULL
)
582 if (argv
[optind
][1] == '-')
584 fprintf (stderr
, gettext ("%s: unrecognized option `--%s'\n"),
587 /* +option or -option */
588 fprintf (stderr
, gettext ("%s: unrecognized option `%c%s'\n"),
589 argv
[0], argv
[optind
][0], nextchar
);
591 nextchar
= (char *) "";
597 /* Look at and handle the next short option-character. */
600 char c
= *nextchar
++;
601 char *temp
= my_index (optstring
, c
);
603 /* Increment `optind' when we start to process its last character. */
604 if (*nextchar
== '\0')
607 if (temp
== NULL
|| c
== ':')
612 /* 1003.2 specifies the format of this message. */
613 fprintf (stderr
, gettext ("%s: illegal option -- %c\n"),
616 fprintf (stderr
, gettext ("%s: invalid option -- %c\n"),
626 /* This is an option that accepts an argument optionally. */
627 if (*nextchar
!= '\0')
638 /* This is an option that requires an argument. */
639 if (*nextchar
!= '\0')
642 /* If we end this ARGV-element by taking the rest as an arg,
643 we must advance to the next element now. */
646 else if (optind
== argc
)
650 /* 1003.2 specifies the format of this message. */
652 gettext ("%s: option requires an argument -- %c\n"),
656 if (optstring
[0] == ':')
662 /* We already incremented `optind' once;
663 increment it again when taking next ARGV-elt as argument. */
664 optarg
= argv
[optind
++];
673 getopt (int argc
, char *const *argv
, const char *optstring
)
675 return _getopt_internal (argc
, argv
, optstring
,
676 (const struct option
*) 0,
681 #endif /* _LIBC or not __GNU_LIBRARY__. */
685 /* Compile with -DTEST to make an executable for use in testing
686 the above definition of `getopt'. */
689 main (int argc
, char **argv
)
692 int digit_optind
= 0;
696 int this_option_optind
= optind
? optind
: 1;
698 c
= getopt (argc
, argv
, "abc:d:0123456789");
714 if (digit_optind
!= 0 && digit_optind
!= this_option_optind
)
715 printf ("digits occur in two different argv-elements.\n");
716 digit_optind
= this_option_optind
;
717 printf ("option %c\n", c
);
721 printf ("option a\n");
725 printf ("option b\n");
729 printf ("option c with value `%s'\n", optarg
);
736 printf ("?? getopt returned character code 0%o ??\n", c
);
742 printf ("non-option ARGV-elements: ");
743 while (optind
< argc
)
744 printf ("%s ", argv
[optind
++]);