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