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