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