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