annotate lib/getopt_int.h @ 112442:76fa839f455e

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