1 /* Getopt for GNU.
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
4 before changing it!
5
6 Copyright (C) 1987, 88, 89, 90, 91, 92, 93, 94, 95
7 Free Software Foundation, Inc.
8
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
12 later version.
13
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.
18
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, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
22
23 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
24 Ditto for AIX 3.2 and <stdlib.h>. */
25 #ifndef _NO_PROTO
26 #define _NO_PROTO
27 #endif
28
29 #ifdef HAVE_CONFIG_H
30 #include <config.h>
31 #endif
32
33 #if !defined (__STDC__) || !__STDC__
34 /* This is a separate conditional since some stdc systems
35 reject `defined (const)'. */
36 #ifndef const
37 #define const
38 #endif
39 #endif
40
41 #include <stdio.h>
42
43 /* Comment out all this code if we are using the GNU C Library, and are not
44 actually compiling the library itself. This code is part of the GNU C
45 Library, but also included in many other GNU distributions. Compiling
46 and linking in this code is a waste when using the GNU C library
47 (especially if it is a shared library). Rather than having every GNU
48 program understand `configure --with-gnu-libc' and omit the object files,
49 it is simpler to just do this in the source for each such file. */
50
51 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
52
53
54 /* This needs to come after some library #include
55 to get __GNU_LIBRARY__ defined. */
56 #ifdef __GNU_LIBRARY__
57 /* Don't include stdlib.h for non-GNU C libraries because some of them
58 contain conflicting prototypes for getopt. */
59 #include <stdlib.h>
60 #endif /* GNU C library. */
61
62 /* This is for other GNU distributions with internationalized messages.
63 The GNU C Library itself does not yet support such messages. */
64 #if HAVE_LIBINTL_H
65 # include <libintl.h>
66 #else
67 # define gettext(msgid) (msgid)
68 #endif
69
70 /* This version of `getopt' appears to the caller like standard Unix `getopt'
71 but it behaves differently for the user, since it allows the user
72 to intersperse the options with the other arguments.
73
74 As `getopt' works, it permutes the elements of ARGV so that,
75 when it is done, all the options precede everything else. Thus
76 all application programs are extended to handle flexible argument order.
77
78 Setting the environment variable POSIXLY_CORRECT disables permutation.
79 Then the behavior is completely standard.
80
81 GNU application programs can use a third alternative mode in which
82 they can distinguish the relative order of options and other arguments. */
83
84 #include "getopt.h"
85
86 /* For communication from `getopt' to the caller.
87 When `getopt' finds an option that takes an argument,
88 the argument value is returned here.
89 Also, when `ordering' is RETURN_IN_ORDER,
90 each non-option ARGV-element is returned here. */
91
92 char *optarg = NULL;
93
94 /* Index in ARGV of the next element to be scanned.
95 This is used for communication to and from the caller
96 and for communication between successive calls to `getopt'.
97
98 On entry to `getopt', zero means this is the first call; initialize.
99
100 When `getopt' returns EOF, this is the index of the first of the
101 non-option elements that the caller should itself scan.
102
103 Otherwise, `optind' communicates from one call to the next
104 how much of ARGV has been scanned so far. */
105
106 /* XXX 1003.2 says this must be 1 before any call. */
107 int optind = 0;
108
109 /* The next char to be scanned in the option-element
110 in which the last option character we returned was found.
111 This allows us to pick up the scan where we left off.
112
113 If this is zero, or a null string, it means resume the scan
114 by advancing to the next ARGV-element. */
115
116 static char *nextchar;
117
118 /* Callers store zero here to inhibit the error message
119 for unrecognized options. */
120
121 int opterr = 1;
122
123 /* Set to an option character which was unrecognized.
124 This must be initialized on some systems to avoid linking in the
125 system's own getopt implementation. */
126
127 int optopt = '?';
128
129 /* Describe how to deal with options that follow non-option ARGV-elements.
130
131 If the caller did not specify anything,
132 the default is REQUIRE_ORDER if the environment variable
133 POSIXLY_CORRECT is defined, PERMUTE otherwise.
134
135 REQUIRE_ORDER means don't recognize them as options;
136 stop option processing when the first non-option is seen.
137 This is what Unix does.
138 This mode of operation is selected by either setting the environment
139 variable POSIXLY_CORRECT, or using `+' as the first character
140 of the list of option characters.
141
142 PERMUTE is the default. We permute the contents of ARGV as we scan,
143 so that eventually all the non-options are at the end. This allows options
144 to be given in any order, even with programs that were not written to
145 expect this.
146
147 RETURN_IN_ORDER is an option available to programs that were written
148 to expect options and other ARGV-elements in any order and that care about
149 the ordering of the two. We describe each non-option ARGV-element
150 as if it were the argument of an option with character code 1.
151 Using `-' as the first character of the list of option characters
152 selects this mode of operation.
153
154 The special argument `--' forces an end of option-scanning regardless
155 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
156 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
157
158 static enum
159 {
160 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
161 } ordering;
162
163 /* Value of POSIXLY_CORRECT environment variable. */
164 static char *posixly_correct;
165
166 #ifdef __GNU_LIBRARY__
167 /* We want to avoid inclusion of string.h with non-GNU libraries
168 because there are many ways it can cause trouble.
169 On some systems, it contains special magic macros that don't work
170 in GCC. */
171 #include <string.h>
172 #define my_index strchr
173 #else
174
175 /* Avoid depending on library functions or files
176 whose names are inconsistent. */
177
178 char *getenv ();
179
180 static char *
my_index(str,chr)181 my_index (str, chr)
182 const char *str;
183 int chr;
184 {
185 while (*str)
186 {
187 if (*str == chr)
188 return (char *) str;
189 str++;
190 }
191 return 0;
192 }
193
194 /* If using GCC, we can safely declare strlen this way.
195 If not using GCC, it is ok not to declare it. */
196 #ifdef __GNUC__
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__ */
205
206 #endif /* not __GNU_LIBRARY__ */
207
208 /* Handle permutation of arguments. */
209
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. */
213
214 static int first_nonopt;
215 static int last_nonopt;
216
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.
222
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. */
225
226 static void
exchange(argv)227 exchange (argv)
228 char **argv;
229 {
230 int bottom = first_nonopt;
231 int middle = last_nonopt;
232 int top = optind;
233 char *tem;
234
235 /* Exchange the shorter segment with the far end of the longer segment.
236 That puts the shorter segment into the right place.
237 It leaves the longer segment in the right place overall,
238 but it consists of two parts that need to be swapped next. */
239
240 while (top > middle && middle > bottom)
241 {
242 if (top - middle > middle - bottom)
243 {
244 /* Bottom segment is the short one. */
245 int len = middle - bottom;
246 register int i;
247
248 /* Swap it with the top part of the top segment. */
249 for (i = 0; i < len; i++)
250 {
251 tem = argv[bottom + i];
252 argv[bottom + i] = argv[top - (middle - bottom) + i];
253 argv[top - (middle - bottom) + i] = tem;
254 }
255 /* Exclude the moved bottom segment from further swapping. */
256 top -= len;
257 }
258 else
259 {
260 /* Top segment is the short one. */
261 int len = top - middle;
262 register int i;
263
264 /* Swap it with the bottom part of the bottom segment. */
265 for (i = 0; i < len; i++)
266 {
267 tem = argv[bottom + i];
268 argv[bottom + i] = argv[middle + i];
269 argv[middle + i] = tem;
270 }
271 /* Exclude the moved top segment from further swapping. */
272 bottom += len;
273 }
274 }
275
276 /* Update records for the slots the non-options now occupy. */
277
278 first_nonopt += (optind - last_nonopt);
279 last_nonopt = optind;
280 }
281
282 /* Initialize the internal data when the first call is made. */
283
284 static const char *
_getopt_initialize(optstring)285 _getopt_initialize (optstring)
286 const char *optstring;
287 {
288 /* Start processing options with ARGV-element 1 (since ARGV-element 0
289 is the program name); the sequence of previously skipped
290 non-option ARGV-elements is empty. */
291
292 first_nonopt = last_nonopt = optind = 1;
293
294 nextchar = NULL;
295
296 posixly_correct = getenv ("POSIXLY_CORRECT");
297
298 /* Determine how to handle the ordering of options and nonoptions. */
299
300 if (optstring[0] == '-')
301 {
302 ordering = RETURN_IN_ORDER;
303 ++optstring;
304 }
305 else if (optstring[0] == '+')
306 {
307 ordering = REQUIRE_ORDER;
308 ++optstring;
309 }
310 else if (posixly_correct != NULL)
311 ordering = REQUIRE_ORDER;
312 else
313 ordering = PERMUTE;
314
315 return optstring;
316 }
317
318 /* Scan elements of ARGV (whose length is ARGC) for option characters
319 given in OPTSTRING.
320
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.
326
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.
330
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.)
335
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 '?'.
340
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.
346
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.
350
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.
359
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
362 with other systems.
363
364 LONGOPTS is a vector of `struct option' terminated by an
365 element containing a name which is zero.
366
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
369 recent call.
370
371 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
372 long-named options. */
373
374 int
_getopt_internal(argc,argv,optstring,longopts,longind,long_only)375 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
376 int argc;
377 char *const *argv;
378 const char *optstring;
379 const struct option *longopts;
380 int *longind;
381 int long_only;
382 {
383 optarg = NULL;
384
385 if (optind == 0)
386 {
387 optstring = _getopt_initialize (optstring);
388 optind = 1; /* Don't scan ARGV[0], the program name. */
389 }
390
391 if (nextchar == NULL || *nextchar == '\0')
392 {
393 /* Advance to the next ARGV-element. */
394
395 if (ordering == PERMUTE)
396 {
397 /* If we have just processed some options following some non-options,
398 exchange them so that the options come first. */
399
400 if (first_nonopt != last_nonopt && last_nonopt != optind)
401 exchange ((char **) argv);
402 else if (last_nonopt != optind)
403 first_nonopt = optind;
404
405 /* Skip any additional non-options
406 and extend the range of non-options previously skipped. */
407
408 while (optind < argc
409 && (argv[optind][0] != '-' || argv[optind][1] == '\0'))
410 optind++;
411 last_nonopt = optind;
412 }
413
414 /* The special ARGV-element `--' means premature end of options.
415 Skip it like a null option,
416 then exchange with previous non-options as if it were an option,
417 then skip everything else like a non-option. */
418
419 if (optind != argc && !strcmp (argv[optind], "--"))
420 {
421 optind++;
422
423 if (first_nonopt != last_nonopt && last_nonopt != optind)
424 exchange ((char **) argv);
425 else if (first_nonopt == last_nonopt)
426 first_nonopt = optind;
427 last_nonopt = argc;
428
429 optind = argc;
430 }
431
432 /* If we have done all the ARGV-elements, stop the scan
433 and back over any non-options that we skipped and permuted. */
434
435 if (optind == argc)
436 {
437 /* Set the next-arg-index to point at the non-options
438 that we previously skipped, so the caller will digest them. */
439 if (first_nonopt != last_nonopt)
440 optind = first_nonopt;
441 return EOF;
442 }
443
444 /* If we have come to a non-option and did not permute it,
445 either stop the scan or describe it to the caller and pass it by. */
446
447 if ((argv[optind][0] != '-' || argv[optind][1] == '\0'))
448 {
449 if (ordering == REQUIRE_ORDER)
450 return EOF;
451 optarg = argv[optind++];
452 return 1;
453 }
454
455 /* We have found another option-ARGV-element.
456 Skip the initial punctuation. */
457
458 nextchar = (argv[optind] + 1
459 + (longopts != NULL && argv[optind][1] == '-'));
460 }
461
462 /* Decode the current option-ARGV-element. */
463
464 /* Check whether the ARGV-element is a long option.
465
466 If long_only and the ARGV-element has the form "-f", where f is
467 a valid short option, don't consider it an abbreviated form of
468 a long option that starts with f. Otherwise there would be no
469 way to give the -f short option.
470
471 On the other hand, if there's a long option "fubar" and
472 the ARGV-element is "-fu", do consider that an abbreviation of
473 the long option, just like "--fu", and not "-f" with arg "u".
474
475 This distinction seems to be the most useful approach. */
476
477 if (longopts != NULL
478 && (argv[optind][1] == '-'
479 || (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
480 {
481 char *nameend;
482 const struct option *p;
483 const struct option *pfound = NULL;
484 int exact = 0;
485 int ambig = 0;
486 int indfound;
487 int option_index;
488
489 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
490 /* Do nothing. */ ;
491
492 /* Test all long options for either exact match
493 or abbreviated matches. */
494 for (p = longopts, option_index = 0; p->name; p++, option_index++)
495 if (!strncmp (p->name, nextchar, nameend - nextchar))
496 {
497 if (nameend - nextchar == strlen (p->name))
498 {
499 /* Exact match found. */
500 pfound = p;
501 indfound = option_index;
502 exact = 1;
503 break;
504 }
505 else if (pfound == NULL)
506 {
507 /* First nonexact match found. */
508 pfound = p;
509 indfound = option_index;
510 }
511 else
512 /* Second or later nonexact match found. */
513 ambig = 1;
514 }
515
516 if (ambig && !exact)
517 {
518 if (opterr)
519 fprintf (stderr, gettext ("%s: option `%s' is ambiguous\n"),
520 argv[0], argv[optind]);
521 nextchar += strlen (nextchar);
522 optind++;
523 return '?';
524 }
525
526 if (pfound != NULL)
527 {
528 option_index = indfound;
529 optind++;
530 if (*nameend)
531 {
532 /* Don't test has_arg with >, because some C compilers don't
533 allow it to be used on enums. */
534 if (pfound->has_arg)
535 optarg = nameend + 1;
536 else
537 {
538 if (opterr)
539 if (argv[optind - 1][1] == '-')
540 /* --option */
541 fprintf (stderr,
542 gettext ("%s: option `--%s' doesn't allow an argument\n"),
543 argv[0], pfound->name);
544 else
545 /* +option or -option */
546 fprintf (stderr,
547 gettext ("%s: option `%c%s' doesn't allow an argument\n"),
548 argv[0], argv[optind - 1][0], pfound->name);
549
550 nextchar += strlen (nextchar);
551 return '?';
552 }
553 }
554 else if (pfound->has_arg == 1)
555 {
556 if (optind < argc)
557 optarg = argv[optind++];
558 else
559 {
560 if (opterr)
561 fprintf (stderr,
562 gettext ("%s: option `%s' requires an argument\n"),
563 argv[0], argv[optind - 1]);
564 nextchar += strlen (nextchar);
565 return optstring[0] == ':' ? ':' : '?';
566 }
567 }
568 nextchar += strlen (nextchar);
569 if (longind != NULL)
570 *longind = option_index;
571 if (pfound->flag)
572 {
573 *(pfound->flag) = pfound->val;
574 return 0;
575 }
576 return pfound->val;
577 }
578
579 /* Can't find it as a long option. If this is not getopt_long_only,
580 or the option starts with '--' or is not a valid short
581 option, then it's an error.
582 Otherwise interpret it as a short option. */
583 if (!long_only || argv[optind][1] == '-'
584 || my_index (optstring, *nextchar) == NULL)
585 {
586 if (opterr)
587 {
588 if (argv[optind][1] == '-')
589 /* --option */
590 fprintf (stderr, gettext ("%s: unrecognized option `--%s'\n"),
591 argv[0], nextchar);
592 else
593 /* +option or -option */
594 fprintf (stderr, gettext ("%s: unrecognized option `%c%s'\n"),
595 argv[0], argv[optind][0], nextchar);
596 }
597 nextchar = (char *) "";
598 optind++;
599 return '?';
600 }
601 }
602
603 /* Look at and handle the next short option-character. */
604
605 {
606 char c = *nextchar++;
607 char *temp = my_index (optstring, c);
608
609 /* Increment `optind' when we start to process its last character. */
610 if (*nextchar == '\0')
611 ++optind;
612
613 if (temp == NULL || c == ':')
614 {
615 if (opterr)
616 {
617 if (posixly_correct)
618 /* 1003.2 specifies the format of this message. */
619 fprintf (stderr, gettext ("%s: illegal option -- %c\n"),
620 argv[0], c);
621 else
622 fprintf (stderr, gettext ("%s: invalid option -- %c\n"),
623 argv[0], c);
624 }
625 optopt = c;
626 return '?';
627 }
628 if (temp[1] == ':')
629 {
630 if (temp[2] == ':')
631 {
632 /* This is an option that accepts an argument optionally. */
633 if (*nextchar != '\0')
634 {
635 optarg = nextchar;
636 optind++;
637 }
638 else
639 optarg = NULL;
640 nextchar = NULL;
641 }
642 else
643 {
644 /* This is an option that requires an argument. */
645 if (*nextchar != '\0')
646 {
647 optarg = nextchar;
648 /* If we end this ARGV-element by taking the rest as an arg,
649 we must advance to the next element now. */
650 optind++;
651 }
652 else if (optind == argc)
653 {
654 if (opterr)
655 {
656 /* 1003.2 specifies the format of this message. */
657 fprintf (stderr,
658 gettext ("%s: option requires an argument -- %c\n"),
659 argv[0], c);
660 }
661 optopt = c;
662 if (optstring[0] == ':')
663 c = ':';
664 else
665 c = '?';
666 }
667 else
668 /* We already incremented `optind' once;
669 increment it again when taking next ARGV-elt as argument. */
670 optarg = argv[optind++];
671 nextchar = NULL;
672 }
673 }
674 return c;
675 }
676 }
677
678 int
getopt(argc,argv,optstring)679 getopt (argc, argv, optstring)
680 int argc;
681 char *const *argv;
682 const char *optstring;
683 {
684 return _getopt_internal (argc, argv, optstring,
685 (const struct option *) 0,
686 (int *) 0,
687 0);
688 }
689
690 #endif /* _LIBC or not __GNU_LIBRARY__. */
691
692 #ifdef TEST
693
694 /* Compile with -DTEST to make an executable for use in testing
695 the above definition of `getopt'. */
696
697 int
main(argc,argv)698 main (argc, argv)
699 int argc;
700 char **argv;
701 {
702 int c;
703 int digit_optind = 0;
704
705 while (1)
706 {
707 int this_option_optind = optind ? optind : 1;
708
709 c = getopt (argc, argv, "abc:d:0123456789");
710 if (c == EOF)
711 break;
712
713 switch (c)
714 {
715 case '0':
716 case '1':
717 case '2':
718 case '3':
719 case '4':
720 case '5':
721 case '6':
722 case '7':
723 case '8':
724 case '9':
725 if (digit_optind != 0 && digit_optind != this_option_optind)
726 printf ("digits occur in two different argv-elements.\n");
727 digit_optind = this_option_optind;
728 printf ("option %c\n", c);
729 break;
730
731 case 'a':
732 printf ("option a\n");
733 break;
734
735 case 'b':
736 printf ("option b\n");
737 break;
738
739 case 'c':
740 printf ("option c with value `%s'\n", optarg);
741 break;
742
743 case '?':
744 break;
745
746 default:
747 printf ("?? getopt returned character code 0%o ??\n", c);
748 }
749 }
750
751 if (optind < argc)
752 {
753 printf ("non-option ARGV-elements: ");
754 while (optind < argc)
755 printf ("%s ", argv[optind++]);
756 printf ("\n");
757 }
758
759 exit (0);
760 }
761
762 #endif /* TEST */
763