git.cworth.org Git - tar/blob - gnu/getopt_int.h

   1 /* -*- buffer-read-only: t -*- vi: set ro: */
   2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
   3 /* Internal declarations for getopt.
   4    Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2004, 2009-2010 Free Software
   5    Foundation, Inc.
   6    This file is part of the GNU C Library.
   7
   8    This program is free software: you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef _GETOPT_INT_H
  22 #define _GETOPT_INT_H   1
  23
  24 #include <getopt.h>
  25
  26 extern int _getopt_internal (int ___argc, char **___argv,
  27                              const char *__shortopts,
  28                              const struct option *__longopts, int *__longind,
  29                              int __long_only, int __posixly_correct);
  30
  31 \f
  32 /* Reentrant versions which can handle parsing multiple argument
  33    vectors at the same time.  */
  34
  35 /* Data type for reentrant functions.  */
  36 struct _getopt_data
  37 {
  38   /* These have exactly the same meaning as the corresponding global
  39      variables, except that they are used for the reentrant
  40      versions of getopt.  */
  41   int optind;
  42   int opterr;
  43   int optopt;
  44   char *optarg;
  45
  46   /* Internal members.  */
  47
  48   /* True if the internal members have been initialized.  */
  49   int __initialized;
  50
  51   /* The next char to be scanned in the option-element
  52      in which the last option character we returned was found.
  53      This allows us to pick up the scan where we left off.
  54
  55      If this is zero, or a null string, it means resume the scan
  56      by advancing to the next ARGV-element.  */
  57   char *__nextchar;
  58
  59   /* Describe how to deal with options that follow non-option ARGV-elements.
  60
  61      If the caller did not specify anything,
  62      the default is REQUIRE_ORDER if the environment variable
  63      POSIXLY_CORRECT is defined, PERMUTE otherwise.
  64
  65      REQUIRE_ORDER means don't recognize them as options;
  66      stop option processing when the first non-option is seen.
  67      This is what Unix does.
  68      This mode of operation is selected by either setting the environment
  69      variable POSIXLY_CORRECT, or using `+' as the first character
  70      of the list of option characters, or by calling getopt.
  71
  72      PERMUTE is the default.  We permute the contents of ARGV as we
  73      scan, so that eventually all the non-options are at the end.
  74      This allows options to be given in any order, even with programs
  75      that were not written to expect this.
  76
  77      RETURN_IN_ORDER is an option available to programs that were
  78      written to expect options and other ARGV-elements in any order
  79      and that care about the ordering of the two.  We describe each
  80      non-option ARGV-element as if it were the argument of an option
  81      with character code 1.  Using `-' as the first character of the
  82      list of option characters selects this mode of operation.
  83
  84      The special argument `--' forces an end of option-scanning regardless
  85      of the value of `ordering'.  In the case of RETURN_IN_ORDER, only
  86      `--' can cause `getopt' to return -1 with `optind' != ARGC.  */
  87
  88   enum
  89     {
  90       REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
  91     } __ordering;
  92
  93   /* If the POSIXLY_CORRECT environment variable is set
  94      or getopt was called.  */
  95   int __posixly_correct;
  96
  97
  98   /* Handle permutation of arguments.  */
  99
 100   /* Describe the part of ARGV that contains non-options that have
 101      been skipped.  `first_nonopt' is the index in ARGV of the first
 102      of them; `last_nonopt' is the index after the last of them.  */
 103
 104   int __first_nonopt;
 105   int __last_nonopt;
 106
 107 #if defined _LIBC && defined USE_NONOPTION_FLAGS
 108   int __nonoption_flags_max_len;
 109   int __nonoption_flags_len;
 110 # endif
 111 };
 112
 113 /* The initializer is necessary to set OPTIND and OPTERR to their
 114    default values and to clear the initialization flag.  */
 115 #define _GETOPT_DATA_INITIALIZER        { 1, 1 }
 116
 117 extern int _getopt_internal_r (int ___argc, char **___argv,
 118                                const char *__shortopts,
 119                                const struct option *__longopts, int *__longind,
 120                                int __long_only, struct _getopt_data *__data,
 121                                int __posixly_correct);
 122
 123 extern int _getopt_long_r (int ___argc, char **___argv,
 124                            const char *__shortopts,
 125                            const struct option *__longopts, int *__longind,
 126                            struct _getopt_data *__data);
 127
 128 extern int _getopt_long_only_r (int ___argc, char **___argv,
 129                                 const char *__shortopts,
 130                                 const struct option *__longopts,
 131                                 int *__longind,
 132                                 struct _getopt_data *__data);
 133
 134 #endif /* getopt_int.h */