home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / unix / unixtools / util / c / getopt < prev    next >
Encoding:
Text File  |  1992-07-21  |  13.5 KB  |  451 lines
  1. /* C.Getopt: Command argument parser */
  2.  
  3. /* Getopt for GNU.
  4.  * Copyright (C) 1987 Free Software Foundation, Inc.
  5.  * Subject to the standard Gnu conditions.
  6.  */
  7.  
  8. /* This version of `getopt' appears to the caller like standard Unix 'getopt'
  9.  * but it behaves differently for the user, since it allows the user
  10.  * to intersperse the options with the other arguments.
  11.  *
  12.  * As 'getopt' works, it permutes the elements of 'argv' so that,
  13.  * when it is done, all the options precede everything else.  Thus
  14.  * all application programs are extended to handle flexible argument order.
  15.  *
  16.  * Setting the environment variable POSIX_OPTION_ORDER disables permutation.
  17.  * Then the behavior is completely standard.
  18.  *
  19.  * GNU application programs can use a third alternative mode in which
  20.  * they can distinguish the relative order of options and other arguments.
  21.  */
  22.  
  23. /* Converted for ANSI C on the Archimedes, Paul Moore, 25/04/89 */
  24.  
  25. #include <stdio.h>
  26. #include <string.h>
  27. #include <stdlib.h>
  28.  
  29. #include "utils.h"
  30.  
  31. /* For communication from 'getopt' to the caller.
  32.    When 'getopt' finds an option that takes an argument,
  33.    the argument value is returned here.
  34.    Also, when 'ordering' is RETURN_IN_ORDER,
  35.    each non-option ARGV-element is returned here.
  36.  */
  37.  
  38. char *optarg = 0;
  39.  
  40. /* Index in ARGV of the next element to be scanned.
  41.    This is used for communication to and from the caller
  42.    and for communication between successive calls to 'getopt'.
  43.  
  44.    On entry to 'getopt', zero means this is the first call; initialize.
  45.  
  46.    When 'getopt' returns EOF, this is the index of the first of the
  47.    non-option elements that the caller should itself scan.
  48.  
  49.    Otherwise, 'optind' communicates from one call to the next
  50.    how much of ARGV has been scanned so far.
  51.  */
  52.  
  53. int optind = 0;
  54.  
  55. /* The next char to be scanned in the option-element
  56.    in which the last option character we returned was found.
  57.    This allows us to pick up the scan where we left off.
  58.  
  59.    If this is zero, or a null string, it means resume the scan
  60.    by advancing to the next ARGV-element.
  61.  */
  62.  
  63. static char *nextchar;
  64.  
  65. /* Callers store zero here to inhibit the error message
  66.    for unrecognized options.
  67.  */
  68.  
  69. int opterr = 1;
  70.  
  71. /* Describe how to deal with options that follow non-option ARGV-elements.
  72.  
  73.    REQUIRE_ORDER means don't recognize them as options. Stop option
  74.    processing when the first non-option is seen. This is what Unix does.
  75.    Using ':' as the first character of the list of option characters
  76.    requests this mode of operation.
  77.  
  78.    PERMUTE is the default.  We permute the contents of 'argv' as we scan,
  79.    so that eventually all the options are at the end.  This allows options
  80.    to be given in any order, even with programs that were not written to
  81.    expect this.
  82.  
  83.    RETURN_IN_ORDER is an option available to programs that were written
  84.    to expect options and other ARGV-elements in any order and that care about
  85.    the ordering of the two.  We describe each non-option ARGV-element
  86.    as if it were the argument of an option with character code zero.
  87.    Using '-' as the first character of the list of option characters
  88.    requests this mode of operation.
  89.  
  90.    The special argument '--' forces an end of option-scanning regardless
  91.    of the value of 'ordering'.  In the case of RETURN_IN_ORDER, only
  92.    '--' can cause 'getopt' to return EOF with 'optind' != ARGC.
  93.  */
  94.  
  95. static enum { REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER } ordering;
  96.  
  97. /* Handle permutation of arguments.  */
  98.  
  99. /* Describe the part of ARGV that contains non-options that have
  100.    been skipped.  'first_nonopt' is the index in ARGV of the first
  101.    of them; 'last_nonopt' is the index after the last of them.
  102.  */
  103.  
  104. static int first_nonopt;
  105. static int last_nonopt;
  106.  
  107. /* Exchange two adjacent subsequences of ARGV.
  108.    One subsequence is elements [first_nonopt,last_nonopt) which
  109.    contains all the non-options that have been skipped so far.
  110.    The other is elements [last_nonopt,optind), which contains all
  111.    the options processed since those non-options were skipped.
  112.  
  113.    'first_nonopt' and 'last_nonopt' are relocated so that they describe
  114.    the new indices of the non-options in ARGV after they are moved.
  115.  */
  116.  
  117. static void exchange (char *argv[])
  118. {
  119.     int nonopts_size = (last_nonopt - first_nonopt) * sizeof (char *);
  120.     char **temp = (char **) malloc (nonopts_size);
  121.  
  122.     if ( temp == NULL )
  123.     {
  124.         fprintf(stderr,"Fatal error - memory exhausted\n");
  125.         exit(1);
  126.     }
  127.  
  128.     /* Interchange the two blocks of data in argv.  */
  129.  
  130.     memcpy (temp, &argv[first_nonopt], nonopts_size);
  131.     memcpy (&argv[first_nonopt], &argv[last_nonopt],
  132.             (optind - last_nonopt) * sizeof (char *));
  133.     memcpy (&argv[first_nonopt + optind - last_nonopt], temp,
  134.             nonopts_size);
  135.  
  136.     /* Update records for the slots the non-options now occupy.  */
  137.  
  138.     first_nonopt += (optind - last_nonopt);
  139.     last_nonopt = optind;
  140.  
  141.     free(temp);
  142. }
  143.  
  144. /* Scan elements of ARGV (whose length is ARGC) for option characters
  145.    given in OPTSTRING.
  146.  
  147.    If an element of ARGV starts with '-', and is not exactly "-" or "--",
  148.    then it is an option element.  The characters of this element
  149.    (aside from the initial '-') are option characters.  If 'getopt'
  150.    is called repeatedly, it returns successively each of the option
  151.    characters from each of the option elements.
  152.  
  153.    If 'getopt' finds another option character, it returns that character,
  154.    updating 'optind' and 'nextchar' so that the next call to 'getopt' can
  155.    resume the scan with the following option character or ARGV-element.
  156.  
  157.    If there are no more option characters, 'getopt' returns 'EOF'.
  158.    Then 'optind' is the index in ARGV of the first ARGV-element
  159.    that is not an option.  (The ARGV-elements have been permuted
  160.    so that those that are not options now come last.)
  161.  
  162.    OPTSTRING is a string containing the legitimate option characters.
  163.    A colon in OPTSTRING means that the previous character is an option
  164.    that wants an argument.  The argument is taken from the rest of the
  165.    current ARGV-element, or from the following ARGV-element,
  166.    and returned in 'optarg'.
  167.  
  168.    If an option character is seen that is not listed in OPTSTRING,
  169.    return '?' after printing an error message.  If you set 'opterr' to
  170.    zero, the error message is suppressed but we still return '?'.
  171.  
  172.    If a char in OPTSTRING is followed by a colon, that means it wants
  173.    an arg, so the following text in the same ARGV-element, or the text
  174.    of the following ARGV-element, is returned in 'optarg.  Two colons
  175.    mean an option that wants an optional arg; if there is text in the
  176.    current ARGV-element, it is returned in 'optarg'.
  177.  
  178.    If OPTSTRING starts with '-' or ':', it requests a different method
  179.    of handling the non-option ARGV-elements.  See the comments about
  180.    RETURN_IN_ORDER and REQUIRE_ORDER, above.
  181.  */
  182.  
  183. int getopt (int argc, char *argv[], const char *optstring)
  184. {
  185.     /* Initialize the internal data when the first call is made.
  186.        Start processing options with ARGV-element 1 (since ARGV-element
  187.        0 is the program name); the sequence of previously skipped
  188.        non-option ARGV-elements is empty.
  189.      */
  190.  
  191.     if (optind == 0)
  192.     {
  193.         first_nonopt = last_nonopt = optind = 1;
  194.  
  195.         nextchar = 0;
  196.  
  197.         /* Determine how to handle the ordering of options and nonoptions.  */
  198.  
  199.         if (optstring[0] == '-')
  200.             ordering = RETURN_IN_ORDER;
  201.         else if (optstring[0] == ':')
  202.             ordering = REQUIRE_ORDER;
  203.         else
  204.             ordering = PERMUTE;
  205.     }
  206.  
  207.     if (optind < last_nonopt)
  208.         return EOF;
  209.  
  210.     if (nextchar == 0 || *nextchar == 0)
  211.     {
  212.         if (ordering == PERMUTE)
  213.         {
  214.             /* If we have just processed some options following
  215.                some non-options, exchange them so that the options
  216.                come first.
  217.              */
  218.  
  219.             if (first_nonopt != last_nonopt && last_nonopt != optind)
  220.                 exchange (argv);
  221.             else if (last_nonopt != optind)
  222.                 first_nonopt = optind;
  223.  
  224.             /* Now skip any additional non-options and
  225.                extend the range of non-options previously
  226.                skipped.
  227.              */
  228.  
  229.             while (optind < argc && (argv[optind][0] != '-' || argv[optind][1] == 0))
  230.                 optind++;
  231.  
  232.             last_nonopt = optind;
  233.         }
  234.  
  235.         /* Special ARGV-element '--' means premature end of options.
  236.            Skip it like a null option, then exchange with previous
  237.            non-options as if it were an option, then skip everything
  238.            else like a non-option.
  239.          */
  240.  
  241.         if (optind != argc && !strcmp (argv[optind], "--"))
  242.         {
  243.             optind++;
  244.  
  245.             if (first_nonopt != last_nonopt && last_nonopt != optind)
  246.                 exchange (argv);
  247.             else if (first_nonopt == last_nonopt)
  248.                 first_nonopt = optind;
  249.             last_nonopt = argc;
  250.  
  251.             optind = argc;
  252.         }
  253.  
  254.         /* If we have done all the ARGV-elements, stop the
  255.            scan and back over any non-options that we
  256.            skipped and permuted.
  257.          */
  258.  
  259.         if (optind == argc)
  260.         {
  261.             /* Set the next-arg-index to point at the
  262.                non-options that we previously skipped,
  263.                so the caller will digest them.
  264.              */
  265.  
  266.             if (first_nonopt != last_nonopt)
  267.                 optind = first_nonopt;
  268.  
  269.             return EOF;
  270.         }
  271.          
  272.         /* If we have come to a non-option and did not permute
  273.            it, either stop the scan or describe it to the caller
  274.            and pass it by.
  275.          */
  276.  
  277.         if (argv[optind][0] != '-' || argv[optind][1] == 0)
  278.         {
  279.             if (ordering == REQUIRE_ORDER)
  280.                 return EOF;
  281.             optarg = argv[optind++];
  282.             return 0;
  283.         }
  284.  
  285.         /* We have found another option-ARGV-element.
  286.            Start decoding its characters.
  287.          */
  288.  
  289.         nextchar = argv[optind] + 1;
  290.     }
  291.  
  292.     /* Look at and handle the next option-character */
  293.  
  294.     {
  295.         char c = *nextchar++;
  296.         char *temp = strchr (optstring, c);
  297.  
  298.         /* Increment 'optind' when we start to process its last character */
  299.         if (*nextchar == 0)
  300.             optind++;
  301.  
  302.         if (temp == 0 || c == ':' || c == '-')
  303.         {
  304.             if (opterr != 0)
  305.             {
  306.                 if (c < 040 || c >= 0177)
  307.                     fprintf (stderr, "%s: Unrecognized option, "
  308.                              "character code 0x%X\n", argv[0], c);
  309.                 else
  310.                     fprintf (stderr, "%s: Unrecognized option '-%c'\n",
  311.                              argv[0], c);
  312.             }
  313.  
  314.             return '?';
  315.         }
  316.  
  317.         if (temp[1] == ':')
  318.         {
  319.             if (temp[2] == ':')
  320.             {
  321.                 /* This is an option that accepts an argument optionally */
  322.  
  323.                 if (*nextchar == 0)
  324.                     optarg = 0;
  325.                 else
  326.                 {
  327.                     optarg = nextchar;
  328.                     optind++;
  329.                 }
  330.  
  331.                 nextchar = 0;
  332.             }
  333.             else
  334.             {
  335.                 /* This is an option that requires an argument */
  336.  
  337.                 if (*nextchar != 0)
  338.                 {
  339.                     optarg = nextchar;
  340.  
  341.                     /* If we end this ARGV-element by taking the
  342.                        rest as an arg, we must advance to the next
  343.                        element now.
  344.                      */
  345.  
  346.                     optind++;
  347.                 }
  348.                 else if (optind == argc)
  349.                 {
  350.                     if (opterr != 0)
  351.                         fprintf (stderr, "%s: No argument for '-%c' option\n",
  352.                                  argv[0], c);
  353.                     c = '?';
  354.                 }
  355.                 else
  356.                 {
  357.                     /* We already incremented 'optind' once;
  358.                        increment it again when taking next
  359.                        ARGV-element as argument.
  360.                      */
  361.                     optarg = argv[optind++];
  362.                 }
  363.  
  364.                 nextchar = 0;
  365.             }
  366.         }
  367.         return c;
  368.     }
  369. }
  370.  
  371. /* ----------------------------------------------------------------- */
  372.  
  373. #ifdef test
  374.  
  375. /* Compile with -Dtest to make an executable for use in
  376.    testing the above definition of getopt.
  377.  */
  378.  
  379. int main (int argc, char *argv[])
  380. {
  381.     int c;
  382.     int digit_optind = 0;
  383.     char *optstr = ( argc <= 1 ? "" : argv[1] );
  384.  
  385.     ++argv;
  386.     --argc;
  387.  
  388.     for ( ; ; )
  389.     {
  390.         int this_option_optind = optind;
  391.  
  392.         if ((c = getopt (argc, argv, optstr)) == EOF)
  393.             break;
  394.  
  395.         switch (c)
  396.         {
  397.         case '0':
  398.         case '1':
  399.         case '2':
  400.         case '3':
  401.         case '4':
  402.         case '5':
  403.         case '6':
  404.         case '7':
  405.         case '8':
  406.         case '9':
  407.             if (digit_optind != 0 && digit_optind != this_option_optind)
  408.                 printf ("digits occur in two different argv-elements.\n");
  409.  
  410.             digit_optind = this_option_optind;
  411.             printf ("option %c\n", c);
  412.             break;
  413.  
  414.         case 'a':
  415.             printf ("option a\n");
  416.             break;
  417.  
  418.         case 'b':
  419.             printf ("option b\n");
  420.             break;
  421.  
  422.         case 'c':
  423.             printf ("option c with value '%s'\n", optarg);
  424.             break;
  425.  
  426.         case 'd':
  427.             printf ("option d with value '%s'\n", optarg);
  428.             break;
  429.  
  430.         case '?':
  431.             break;
  432.  
  433.         default:
  434.             printf ("?? getopt returned character code 0x%X ??\n", (char)c);
  435.             break;
  436.         }
  437.     }
  438.  
  439.     if (optind < argc)
  440.     {
  441.         printf ("non-option ARGV-elements: ");
  442.         while (optind < argc)
  443.             printf ("%s ", argv[optind++]);
  444.         printf ("\n");
  445.     }
  446.  
  447.     return 0;
  448. }
  449.  
  450. #endif
  451.