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