blob: a871785d17419351e5d9e5fc672af6b859c9b7ed [file] [log] [blame]
lh9ed821d2023-04-07 01:36:19 -07001/* 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 The GNU C Library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Lesser General Public
8 License as published by the Free Software Foundation; either
9 version 2.1 of the License, or (at your option) any later version.
10
11 The GNU C Library 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 GNU
14 Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public
17 License along with the GNU C Library; if not, write to the Free
18 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 02111-1307 USA. */
20
21#ifndef _GETOPT_INT_H
22#define _GETOPT_INT_H 1
23
24extern int _getopt_internal (int ___argc, char *const *___argv,
25 const char *__shortopts,
26 const struct option *__longopts, int *__longind,
27 int __long_only) attribute_hidden;
28
29
30/* Reentrant versions which can handle parsing multiple argument
31 vectors at the same time. */
32
33/* For __ordering member */
34enum {
35 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
36};
37
38/* Data type for reentrant functions. */
39
40struct _getopt_data
41{
42 /* These have exactly the same meaning as the corresponding global
43 variables, except that they are used for the reentrant
44 versions of getopt. */
45 int optind;
46 int opterr;
47 char *optarg;
48 smalluint optopt; /* we store characters here, a byte is enough */
49
50 /* Internal members. */
51
52 /* True if the internal members have been initialized. */
53 smallint __initialized;
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.
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 smallint __ordering;
84
85 /* If the POSIXLY_CORRECT environment variable is set. */
86 smallint __posixly_correct;
87
88 /* The next char to be scanned in the option-element
89 in which the last option character we returned was found.
90 This allows us to pick up the scan where we left off.
91
92 If this is zero, or a null string, it means resume the scan
93 by advancing to the next ARGV-element. */
94 char *__nextchar;
95
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 int __first_nonopt;
104 int __last_nonopt;
105
106#if defined _LIBC && defined USE_NONOPTION_FLAGS
107 int __nonoption_flags_max_len;
108 int __nonoption_flags_len;
109# endif
110};
111
112/* The initializer is necessary to set OPTIND and OPTERR to their
113 default values and to clear the initialization flag. */
114#define _GETOPT_DATA_INITIALIZER { 1, 1 }
115
116#if 0 /* first is static on uClibc, the others not used */
117extern int _getopt_internal_r (int ___argc, char *const *___argv,
118 const char *__shortopts,
119 const struct option *__longopts, int *__longind,
120 int __long_only, struct _getopt_data *__data);
121
122extern int _getopt_long_r (int ___argc, char *const *___argv,
123 const char *__shortopts,
124 const struct option *__longopts, int *__longind,
125 struct _getopt_data *__data);
126
127extern int _getopt_long_only_r (int ___argc, char *const *___argv,
128 const char *__shortopts,
129 const struct option *__longopts,
130 int *__longind,
131 struct _getopt_data *__data);
132#endif
133
134#endif /* getopt_int.h */