Back to index

tetex-bin  3.0
Defines | Enumerations | Functions | Variables
getopt.c File Reference
#include <stdio.h>
#include "getopt.h"

Go to the source code of this file.

Defines

#define _NO_PROTO
#define const
#define GETOPT_INTERFACE_VERSION   2
#define _(msgid)   (msgid)
#define NONOPTION_P   (argv[optind][0] != '-' || argv[optind][1] == '\0')

Enumerations

enum  { REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER }

Functions

char * getenv ()
static char * my_index (char *str, int chr) const
static void exchange (char **argv)
static const char * _getopt_initialize (int argc, char *const *argv, const char *optstring)
int _getopt_internal (int argc, char *const *argv, const char *optstring, const struct option *longopts, int *longind, int long_only)
int getopt (int argc, char *const *argv, const char *optstring)

Variables

char * optarg = NULL
int optind = 1
int __getopt_initialized = 0
static char * nextchar
int opterr = 1
int optopt = '?'
static enum { ... }  ordering
static char * posixly_correct
static int first_nonopt
static int last_nonopt

Define Documentation

#define _ (   msgid)    (msgid)

Definition at line 99 of file getopt.c.

#define _NO_PROTO

Definition at line 30 of file getopt.c.

#define const

Definition at line 41 of file getopt.c.

#define GETOPT_INTERFACE_VERSION   2

Definition at line 55 of file getopt.c.

#define NONOPTION_P   (argv[optind][0] != '-' || argv[optind][1] == '\0')

Enumeration Type Documentation

anonymous enum
Enumerator:
REQUIRE_ORDER 
PERMUTE 
RETURN_IN_ORDER 

Definition at line 197 of file getopt.c.


Function Documentation

static const char* _getopt_initialize ( int  argc,
char *const argv,
const char *  optstring 
) [static]

Definition at line 356 of file getopt.c.

{
  /* Start processing options with ARGV-element 1 (since ARGV-element 0
     is the program name); the sequence of previously skipped
     non-option ARGV-elements is empty.  */

  first_nonopt = last_nonopt = optind = 1;

  nextchar = NULL;

  posixly_correct = getenv ("POSIXLY_CORRECT");

  /* Determine how to handle the ordering of options and nonoptions.  */

  if (optstring[0] == '-')
    {
      ordering = RETURN_IN_ORDER;
      ++optstring;
    }
  else if (optstring[0] == '+')
    {
      ordering = REQUIRE_ORDER;
      ++optstring;
    }
  else if (posixly_correct != NULL)
    ordering = REQUIRE_ORDER;
  else
    ordering = PERMUTE;

#ifdef _LIBC
  if (posixly_correct == NULL
      && argc == original_argc && argv == original_argv)
    {
      /* Bash 2.0 puts a special variable in the environment for each
        command it runs, specifying which ARGV elements are the results of
        file name wildcard expansion and therefore should not be
        considered as options.  */
      char var[100];
      sprintf (var, "_%d_GNU_nonoption_argv_flags_", getpid ());
      nonoption_flags = getenv (var);
      if (nonoption_flags == NULL)
       nonoption_flags_len = 0;
      else
       nonoption_flags_len = strlen (nonoption_flags);
    }
  else
    nonoption_flags_len = 0;
#endif

  return optstring;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int _getopt_internal ( int  argc,
char *const argv,
const char *  optstring,
const struct option longopts,
int longind,
int  long_only 
)

Definition at line 468 of file getopt.c.

{
  optarg = NULL;

  if (!__getopt_initialized || optind == 0)
    {
      optstring = _getopt_initialize (argc, argv, optstring);
      optind = 1;           /* Don't scan ARGV[0], the program name.  */
      __getopt_initialized = 1;
    }

  /* Test whether ARGV[optind] points to a non-option argument.
     Either it does not have option syntax, or there is an environment flag
     from the shell indicating it is not an option.  The later information
     is only used when the used in the GNU libc.  */
#ifdef _LIBC
#define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0'             \
                   || (optind < nonoption_flags_len                         \
                      && nonoption_flags[optind] == '1'))
#else
#define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
#endif

  if (nextchar == NULL || *nextchar == '\0')
    {
      /* Advance to the next ARGV-element.  */

      /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
        moved back by the user (who may also have changed the arguments).  */
      if (last_nonopt > optind)
       last_nonopt = optind;
      if (first_nonopt > optind)
       first_nonopt = optind;

      if (ordering == PERMUTE)
       {
         /* If we have just processed some options following some non-options,
            exchange them so that the options come first.  */

         if (first_nonopt != last_nonopt && last_nonopt != optind)
           exchange ((char **) argv);
         else if (last_nonopt != optind)
           first_nonopt = optind;

         /* Skip any additional non-options
            and extend the range of non-options previously skipped.  */

         while (optind < argc && NONOPTION_P)
           optind++;
         last_nonopt = optind;
       }

      /* The special ARGV-element `--' means premature end of options.
        Skip it like a null option,
        then exchange with previous non-options as if it were an option,
        then skip everything else like a non-option.  */

      if (optind != argc && !strcmp (argv[optind], "--"))
       {
         optind++;

         if (first_nonopt != last_nonopt && last_nonopt != optind)
           exchange ((char **) argv);
         else if (first_nonopt == last_nonopt)
           first_nonopt = optind;
         last_nonopt = argc;

         optind = argc;
       }

      /* If we have done all the ARGV-elements, stop the scan
        and back over any non-options that we skipped and permuted.  */

      if (optind == argc)
       {
         /* Set the next-arg-index to point at the non-options
            that we previously skipped, so the caller will digest them.  */
         if (first_nonopt != last_nonopt)
           optind = first_nonopt;
         return -1;
       }

      /* If we have come to a non-option and did not permute it,
        either stop the scan or describe it to the caller and pass it by.  */

      if (NONOPTION_P)
       {
         if (ordering == REQUIRE_ORDER)
           return -1;
         optarg = argv[optind++];
         return 1;
       }

      /* We have found another option-ARGV-element.
        Skip the initial punctuation.  */

      nextchar = (argv[optind] + 1
                + (longopts != NULL && argv[optind][1] == '-'));
    }

  /* Decode the current option-ARGV-element.  */

  /* Check whether the ARGV-element is a long option.

     If long_only and the ARGV-element has the form "-f", where f is
     a valid short option, don't consider it an abbreviated form of
     a long option that starts with f.  Otherwise there would be no
     way to give the -f short option.

     On the other hand, if there's a long option "fubar" and
     the ARGV-element is "-fu", do consider that an abbreviation of
     the long option, just like "--fu", and not "-f" with arg "u".

     This distinction seems to be the most useful approach.  */

  if (longopts != NULL
      && (argv[optind][1] == '-'
         || (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
    {
      char *nameend;
      const struct option *p;
      const struct option *pfound = NULL;
      int exact = 0;
      int ambig = 0;
      int indfound = -1;
      int option_index;

      for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
       /* Do nothing.  */ ;

      /* Test all long options for either exact match
        or abbreviated matches.  */
      for (p = longopts, option_index = 0; p->name; p++, option_index++)
       if (!strncmp (p->name, nextchar, nameend - nextchar))
         {
           if ((unsigned int) (nameend - nextchar)
              == (unsigned int) strlen (p->name))
             {
              /* Exact match found.  */
              pfound = p;
              indfound = option_index;
              exact = 1;
              break;
             }
           else if (pfound == NULL)
             {
              /* First nonexact match found.  */
              pfound = p;
              indfound = option_index;
             }
           else
             /* Second or later nonexact match found.  */
             ambig = 1;
         }

      if (ambig && !exact)
       {
         if (opterr)
           fprintf (stderr, _("%s: option `%s' is ambiguous\n"),
                   argv[0], argv[optind]);
         nextchar += strlen (nextchar);
         optind++;
         optopt = 0;
         return '?';
       }

      if (pfound != NULL)
       {
         option_index = indfound;
         optind++;
         if (*nameend)
           {
             /* Don't test has_arg with >, because some C compilers don't
               allow it to be used on enums.  */
             if (pfound->has_arg)
              optarg = nameend + 1;
             else
              {
                if (opterr)
                 if (argv[optind - 1][1] == '-')
                  /* --option */
                  fprintf (stderr,
                   _("%s: option `--%s' doesn't allow an argument\n"),
                   argv[0], pfound->name);
                 else
                  /* +option or -option */
                  fprintf (stderr,
                   _("%s: option `%c%s' doesn't allow an argument\n"),
                   argv[0], argv[optind - 1][0], pfound->name);

                nextchar += strlen (nextchar);

                optopt = pfound->val;
                return '?';
              }
           }
         else if (pfound->has_arg == 1)
           {
             if (optind < argc)
              optarg = argv[optind++];
             else
              {
                if (opterr)
                  fprintf (stderr,
                        _("%s: option `%s' requires an argument\n"),
                        argv[0], argv[optind - 1]);
                nextchar += strlen (nextchar);
                optopt = pfound->val;
                return optstring[0] == ':' ? ':' : '?';
              }
           }
         nextchar += strlen (nextchar);
         if (longind != NULL)
           *longind = option_index;
         if (pfound->flag)
           {
             *(pfound->flag) = pfound->val;
             return 0;
           }
         return pfound->val;
       }

      /* Can't find it as a long option.  If this is not getopt_long_only,
        or the option starts with '--' or is not a valid short
        option, then it's an error.
        Otherwise interpret it as a short option.  */
      if (!long_only || argv[optind][1] == '-'
         || my_index (optstring, *nextchar) == NULL)
       {
         if (opterr)
           {
             if (argv[optind][1] == '-')
              /* --option */
              fprintf (stderr, _("%s: unrecognized option `--%s'\n"),
                      argv[0], nextchar);
             else
              /* +option or -option */
              fprintf (stderr, _("%s: unrecognized option `%c%s'\n"),
                      argv[0], argv[optind][0], nextchar);
           }
         nextchar = (char *) "";
         optind++;
         optopt = 0;
         return '?';
       }
    }

  /* Look at and handle the next short option-character.  */

  {
    char c = *nextchar++;
    char *temp = my_index (optstring, c);

    /* Increment `optind' when we start to process its last character.  */
    if (*nextchar == '\0')
      ++optind;

    if (temp == NULL || c == ':')
      {
       if (opterr)
         {
           if (posixly_correct)
             /* 1003.2 specifies the format of this message.  */
             fprintf (stderr, _("%s: illegal option -- %c\n"),
                     argv[0], c);
           else
             fprintf (stderr, _("%s: invalid option -- %c\n"),
                     argv[0], c);
         }
       optopt = c;
       return '?';
      }
    /* Convenience. Treat POSIX -W foo same as long option --foo */
    if (temp[0] == 'W' && temp[1] == ';')
      {
       char *nameend;
       const struct option *p;
       const struct option *pfound = NULL;
       int exact = 0;
       int ambig = 0;
       int indfound = 0;
       int option_index;

       /* This is an option that requires an argument.  */
       if (*nextchar != '\0')
         {
           optarg = nextchar;
           /* If we end this ARGV-element by taking the rest as an arg,
              we must advance to the next element now.  */
           optind++;
         }
       else if (optind == argc)
         {
           if (opterr)
             {
              /* 1003.2 specifies the format of this message.  */
              fprintf (stderr, _("%s: option requires an argument -- %c\n"),
                      argv[0], c);
             }
           optopt = c;
           if (optstring[0] == ':')
             c = ':';
           else
             c = '?';
           return c;
         }
       else
         /* We already incremented `optind' once;
            increment it again when taking next ARGV-elt as argument.  */
         optarg = argv[optind++];

       /* optarg is now the argument, see if it's in the
          table of longopts.  */

       for (nextchar = nameend = optarg; *nameend && *nameend != '='; nameend++)
         /* Do nothing.  */ ;

       /* Test all long options for either exact match
          or abbreviated matches.  */
       for (p = longopts, option_index = 0; p->name; p++, option_index++)
         if (!strncmp (p->name, nextchar, nameend - nextchar))
           {
             if ((unsigned int) (nameend - nextchar) == strlen (p->name))
              {
                /* Exact match found.  */
                pfound = p;
                indfound = option_index;
                exact = 1;
                break;
              }
             else if (pfound == NULL)
              {
                /* First nonexact match found.  */
                pfound = p;
                indfound = option_index;
              }
             else
              /* Second or later nonexact match found.  */
              ambig = 1;
           }
       if (ambig && !exact)
         {
           if (opterr)
             fprintf (stderr, _("%s: option `-W %s' is ambiguous\n"),
                     argv[0], argv[optind]);
           nextchar += strlen (nextchar);
           optind++;
           return '?';
         }
       if (pfound != NULL)
         {
           option_index = indfound;
           if (*nameend)
             {
              /* Don't test has_arg with >, because some C compilers don't
                 allow it to be used on enums.  */
              if (pfound->has_arg)
                optarg = nameend + 1;
              else
                {
                  if (opterr)
                    fprintf (stderr, _("\
%s: option `-W %s' doesn't allow an argument\n"),
                            argv[0], pfound->name);

                  nextchar += strlen (nextchar);
                  return '?';
                }
             }
           else if (pfound->has_arg == 1)
             {
              if (optind < argc)
                optarg = argv[optind++];
              else
                {
                  if (opterr)
                    fprintf (stderr,
                            _("%s: option `%s' requires an argument\n"),
                            argv[0], argv[optind - 1]);
                  nextchar += strlen (nextchar);
                  return optstring[0] == ':' ? ':' : '?';
                }
             }
           nextchar += strlen (nextchar);
           if (longind != NULL)
             *longind = option_index;
           if (pfound->flag)
             {
              *(pfound->flag) = pfound->val;
              return 0;
             }
           return pfound->val;
         }
         nextchar = NULL;
         return 'W'; /* Let the application handle it.   */
      }
    if (temp[1] == ':')
      {
       if (temp[2] == ':')
         {
           /* This is an option that accepts an argument optionally.  */
           if (*nextchar != '\0')
             {
              optarg = nextchar;
              optind++;
             }
           else
             optarg = NULL;
           nextchar = NULL;
         }
       else
         {
           /* This is an option that requires an argument.  */
           if (*nextchar != '\0')
             {
              optarg = nextchar;
              /* If we end this ARGV-element by taking the rest as an arg,
                 we must advance to the next element now.  */
              optind++;
             }
           else if (optind == argc)
             {
              if (opterr)
                {
                  /* 1003.2 specifies the format of this message.  */
                  fprintf (stderr,
                        _("%s: option requires an argument -- %c\n"),
                        argv[0], c);
                }
              optopt = c;
              if (optstring[0] == ':')
                c = ':';
              else
                c = '?';
             }
           else
             /* We already incremented `optind' once;
               increment it again when taking next ARGV-elt as argument.  */
             optarg = argv[optind++];
           nextchar = NULL;
         }
      }
    return c;
  }
}

Here is the caller graph for this function:

static void exchange ( char **  argv) [static]

Definition at line 295 of file getopt.c.

{
  int bottom = first_nonopt;
  int middle = last_nonopt;
  int top = optind;
  char *tem;

  /* Exchange the shorter segment with the far end of the longer segment.
     That puts the shorter segment into the right place.
     It leaves the longer segment in the right place overall,
     but it consists of two parts that need to be swapped next.  */

  while (top > middle && middle > bottom)
    {
      if (top - middle > middle - bottom)
       {
         /* Bottom segment is the short one.  */
         int len = middle - bottom;
         register int i;

         /* Swap it with the top part of the top segment.  */
         for (i = 0; i < len; i++)
           {
             tem = argv[bottom + i];
             argv[bottom + i] = argv[top - (middle - bottom) + i];
             argv[top - (middle - bottom) + i] = tem;
           }
         /* Exclude the moved bottom segment from further swapping.  */
         top -= len;
       }
      else
       {
         /* Top segment is the short one.  */
         int len = top - middle;
         register int i;

         /* Swap it with the bottom part of the bottom segment.  */
         for (i = 0; i < len; i++)
           {
             tem = argv[bottom + i];
             argv[bottom + i] = argv[middle + i];
             argv[middle + i] = tem;
           }
         /* Exclude the moved top segment from further swapping.  */
         bottom += len;
       }
    }

  /* Update records for the slots the non-options now occupy.  */

  first_nonopt += (optind - last_nonopt);
  last_nonopt = optind;
}

Here is the caller graph for this function:

char* getenv ( )
int getopt ( int  argc,
char *const argv,
const char *  optstring 
)

Definition at line 921 of file getopt.c.

{
  return _getopt_internal (argc, argv, optstring,
                        (const struct option *) 0,
                        (int *) 0,
                        0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

static char* my_index ( char *  str,
int  chr 
) const [static]

Definition at line 220 of file getopt.c.

{
  while (*str)
    {
      if (*str == chr)
       return (char *) str;
      str++;
    }
  return 0;
}

Here is the caller graph for this function:


Variable Documentation

Definition at line 146 of file getopt.c.

int first_nonopt [static]

Definition at line 253 of file getopt.c.

int last_nonopt [static]

Definition at line 254 of file getopt.c.

char* nextchar [static]

Definition at line 155 of file getopt.c.

char* optarg = NULL

Definition at line 125 of file getopt.c.

int opterr = 1

Definition at line 160 of file getopt.c.

int optind = 1

Definition at line 140 of file getopt.c.

int optopt = '?'

Definition at line 166 of file getopt.c.

enum { ... } ordering [static]
char* posixly_correct [static]

Definition at line 203 of file getopt.c.