getopt_int.h 4.05 KB
Newer Older
Paul Eggert's avatar
Paul Eggert committed
1
/* Internal declarations for getopt.
Paul Eggert's avatar
Paul Eggert committed
2
   Copyright (C) 1989-2020 Free Software Foundation, Inc.
Paul Eggert's avatar
Paul Eggert committed
3 4
   This file is part of the GNU C Library and is also part of gnulib.
   Patches to this file should be submitted to both projects.
Paul Eggert's avatar
Paul Eggert committed
5

Paul Eggert's avatar
Paul Eggert committed
6 7 8 9
   The GNU C Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public
   License as published by the Free Software Foundation; either
   version 3 of the License, or (at your option) any later version.
Paul Eggert's avatar
Paul Eggert committed
10

Paul Eggert's avatar
Paul Eggert committed
11
   The GNU C Library is distributed in the hope that it will be useful,
Paul Eggert's avatar
Paul Eggert committed
12
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Paul Eggert's avatar
Paul Eggert committed
13 14
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.
Paul Eggert's avatar
Paul Eggert committed
15

Paul Eggert's avatar
Paul Eggert committed
16 17
   You should have received a copy of the GNU General Public
   License along with the GNU C Library; if not, see
Paul Eggert's avatar
Paul Eggert committed
18
   <https://www.gnu.org/licenses/>.  */
Paul Eggert's avatar
Paul Eggert committed
19 20

#ifndef _GETOPT_INT_H
Paul Eggert's avatar
Paul Eggert committed
21
#define _GETOPT_INT_H	1
Paul Eggert's avatar
Paul Eggert committed
22 23 24 25

#include <getopt.h>

extern int _getopt_internal (int ___argc, char **___argv,
Paul Eggert's avatar
Paul Eggert committed
26 27 28
			     const char *__shortopts,
			     const struct option *__longopts, int *__longind,
			     int __long_only, int __posixly_correct);
Paul Eggert's avatar
Paul Eggert committed
29 30 31 32 33 34 35


/* Reentrant versions which can handle parsing multiple argument
   vectors at the same time.  */

/* Describe how to deal with options that follow non-option ARGV-elements.

Paul Eggert's avatar
Paul Eggert committed
36 37 38
   REQUIRE_ORDER means don't recognize them as options; stop option
   processing when the first non-option is seen.  This is what POSIX
   specifies should happen.
Paul Eggert's avatar
Paul Eggert committed
39

Paul Eggert's avatar
Paul Eggert committed
40 41 42 43
   PERMUTE means permute the contents of ARGV as we scan, so that
   eventually all the non-options are at the end.  This allows options
   to be given in any order, even with programs that were not written
   to expect this.
Paul Eggert's avatar
Paul Eggert committed
44 45 46 47 48

   RETURN_IN_ORDER is an option available to programs that were
   written to expect options and other ARGV-elements in any order
   and that care about the ordering of the two.  We describe each
   non-option ARGV-element as if it were the argument of an option
Paul Eggert's avatar
Paul Eggert committed
49
   with character code 1.
Paul Eggert's avatar
Paul Eggert committed
50

Paul Eggert's avatar
Paul Eggert committed
51 52 53
   The special argument '--' forces an end of option-scanning regardless
   of the value of 'ordering'.  In the case of RETURN_IN_ORDER, only
   '--' can cause 'getopt' to return -1 with 'optind' != ARGC.  */
Paul Eggert's avatar
Paul Eggert committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

enum __ord
  {
    REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
  };

/* Data type for reentrant functions.  */
struct _getopt_data
{
  /* These have exactly the same meaning as the corresponding global
     variables, except that they are used for the reentrant
     versions of getopt.  */
  int optind;
  int opterr;
  int optopt;
  char *optarg;

  /* Internal members.  */

  /* True if the internal members have been initialized.  */
  int __initialized;

  /* The next char to be scanned in the option-element
     in which the last option character we returned was found.
     This allows us to pick up the scan where we left off.

     If this is zero, or a null string, it means resume the scan
     by advancing to the next ARGV-element.  */
  char *__nextchar;

  /* See __ord above.  */
  enum __ord __ordering;

  /* Handle permutation of arguments.  */

  /* Describe the part of ARGV that contains non-options that have
Paul Eggert's avatar
Paul Eggert committed
90 91
     been skipped.  'first_nonopt' is the index in ARGV of the first
     of them; 'last_nonopt' is the index after the last of them.  */
Paul Eggert's avatar
Paul Eggert committed
92 93 94 95 96 97 98

  int __first_nonopt;
  int __last_nonopt;
};

/* The initializer is necessary to set OPTIND and OPTERR to their
   default values and to clear the initialization flag.  */
Paul Eggert's avatar
Paul Eggert committed
99
#define _GETOPT_DATA_INITIALIZER	{ 1, 1 }
Paul Eggert's avatar
Paul Eggert committed
100 101

extern int _getopt_internal_r (int ___argc, char **___argv,
Paul Eggert's avatar
Paul Eggert committed
102 103 104 105
			       const char *__shortopts,
			       const struct option *__longopts, int *__longind,
			       int __long_only, struct _getopt_data *__data,
			       int __posixly_correct);
Paul Eggert's avatar
Paul Eggert committed
106 107

extern int _getopt_long_r (int ___argc, char **___argv,
Paul Eggert's avatar
Paul Eggert committed
108 109 110
			   const char *__shortopts,
			   const struct option *__longopts, int *__longind,
			   struct _getopt_data *__data);
Paul Eggert's avatar
Paul Eggert committed
111 112

extern int _getopt_long_only_r (int ___argc, char **___argv,
Paul Eggert's avatar
Paul Eggert committed
113 114 115 116
				const char *__shortopts,
				const struct option *__longopts,
				int *__longind,
				struct _getopt_data *__data);
Paul Eggert's avatar
Paul Eggert committed
117 118

#endif /* getopt_int.h */