annotate lib/getopt.in.h @ 112311:babd014aab81

Regenerate.
author Paul Eggert <eggert@cs.ucla.edu>
date Sat, 08 Jan 2011 23:33:50 -0800
parents
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 /* Declarations for getopt.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
2 Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2007, 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 _GL_GETOPT_H
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
20
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
21 #if __GNUC__ >= 3
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
22 @PRAGMA_SYSTEM_HEADER@
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
23 #endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
24 @PRAGMA_COLUMNS@
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
25
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
26 /* The include_next requires a split double-inclusion guard. We must
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
27 also inform the replacement unistd.h to not recursively use
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
28 <getopt.h>; our definitions will be present soon enough. */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
29 #if @HAVE_GETOPT_H@
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
30 # define _GL_SYSTEM_GETOPT
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
31 # @INCLUDE_NEXT@ @NEXT_GETOPT_H@
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
32 # undef _GL_SYSTEM_GETOPT
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
33 #endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
34
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
35 #ifndef _GL_GETOPT_H
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
36
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
37 #ifndef __need_getopt
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
38 # define _GL_GETOPT_H 1
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
39 #endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
40
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
41 /* Standalone applications should #define __GETOPT_PREFIX to an
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
42 identifier that prefixes the external functions and variables
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
43 defined in this header. When this happens, include the
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
44 headers that might declare getopt so that they will not cause
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
45 confusion if included after this file (if the system had <getopt.h>,
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
46 we have already included it). Then systematically rename
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
47 identifiers so that they do not collide with the system functions
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
48 and variables. Renaming avoids problems with some compilers and
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
49 linkers. */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
50 #if defined __GETOPT_PREFIX && !defined __need_getopt
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
51 # if !@HAVE_GETOPT_H@
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
52 # include <stdlib.h>
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
53 # include <stdio.h>
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
54 # include <unistd.h>
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
55 # endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
56 # undef __need_getopt
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
57 # undef getopt
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
58 # undef getopt_long
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
59 # undef getopt_long_only
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
60 # undef optarg
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
61 # undef opterr
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
62 # undef optind
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
63 # undef optopt
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
64 # undef option
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
65 # define __GETOPT_CONCAT(x, y) x ## y
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
66 # define __GETOPT_XCONCAT(x, y) __GETOPT_CONCAT (x, y)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
67 # define __GETOPT_ID(y) __GETOPT_XCONCAT (__GETOPT_PREFIX, y)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
68 # define getopt __GETOPT_ID (getopt)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
69 # define getopt_long __GETOPT_ID (getopt_long)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
70 # define getopt_long_only __GETOPT_ID (getopt_long_only)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
71 # define optarg __GETOPT_ID (optarg)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
72 # define opterr __GETOPT_ID (opterr)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
73 # define optind __GETOPT_ID (optind)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
74 # define optopt __GETOPT_ID (optopt)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
75 # define option __GETOPT_ID (option)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
76 # define _getopt_internal __GETOPT_ID (getopt_internal)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
77 #endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
78
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
79 /* Standalone applications get correct prototypes for getopt_long and
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
80 getopt_long_only; they declare "char **argv". libc uses prototypes
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
81 with "char *const *argv" that are incorrect because getopt_long and
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
82 getopt_long_only can permute argv; this is required for backward
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
83 compatibility (e.g., for LSB 2.0.1).
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
84
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
85 This used to be `#if defined __GETOPT_PREFIX && !defined __need_getopt',
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
86 but it caused redefinition warnings if both unistd.h and getopt.h were
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
87 included, since unistd.h includes getopt.h having previously defined
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
88 __need_getopt.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
89
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
90 The only place where __getopt_argv_const is used is in definitions
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
91 of getopt_long and getopt_long_only below, but these are visible
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
92 only if __need_getopt is not defined, so it is quite safe to rewrite
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
93 the conditional as follows:
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
94 */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
95 #if !defined __need_getopt
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
96 # if defined __GETOPT_PREFIX
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
97 # define __getopt_argv_const /* empty */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
98 # else
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
99 # define __getopt_argv_const const
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
100 # endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
101 #endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
102
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
103 /* If __GNU_LIBRARY__ is not already defined, either we are being used
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
104 standalone, or this is the first header included in the source file.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
105 If we are being used with glibc, we need to include <features.h>, but
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
106 that does not exist if we are standalone. So: if __GNU_LIBRARY__ is
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
107 not defined, include <ctype.h>, which will pull in <features.h> for us
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
108 if it's from glibc. (Why ctype.h? It's guaranteed to exist and it
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
109 doesn't flood the namespace with stuff the way some other headers do.) */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
110 #if !defined __GNU_LIBRARY__
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
111 # include <ctype.h>
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
112 #endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
113
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
114 #ifndef __THROW
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
115 # ifndef __GNUC_PREREQ
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
116 # define __GNUC_PREREQ(maj, min) (0)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
117 # endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
118 # if defined __cplusplus && __GNUC_PREREQ (2,8)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
119 # define __THROW throw ()
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
120 # else
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
121 # define __THROW
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
122 # endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
123 #endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
124
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
125 /* The definition of _GL_ARG_NONNULL is copied here. */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
126
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
127 #ifdef __cplusplus
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
128 extern "C" {
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
129 #endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
130
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
131 /* For communication from `getopt' to the caller.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
132 When `getopt' finds an option that takes an argument,
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
133 the argument value is returned here.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
134 Also, when `ordering' is RETURN_IN_ORDER,
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
135 each non-option ARGV-element is returned here. */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
136
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
137 extern char *optarg;
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
138
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
139 /* Index in ARGV of the next element to be scanned.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
140 This is used for communication to and from the caller
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
141 and for communication between successive calls to `getopt'.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
142
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
143 On entry to `getopt', zero means this is the first call; initialize.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
144
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
145 When `getopt' returns -1, this is the index of the first of the
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
146 non-option elements that the caller should itself scan.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
147
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
148 Otherwise, `optind' communicates from one call to the next
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
149 how much of ARGV has been scanned so far. */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
150
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
151 extern int optind;
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
152
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
153 /* Callers store zero here to inhibit the error message `getopt' prints
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
154 for unrecognized options. */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
155
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
156 extern int opterr;
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
157
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
158 /* Set to an option character which was unrecognized. */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
159
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
160 extern int optopt;
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
161
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
162 #ifndef __need_getopt
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
163 /* Describe the long-named options requested by the application.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
164 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
165 of `struct option' terminated by an element containing a name which is
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
166 zero.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
167
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
168 The field `has_arg' is:
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
169 no_argument (or 0) if the option does not take an argument,
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
170 required_argument (or 1) if the option requires an argument,
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
171 optional_argument (or 2) if the option takes an optional argument.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
172
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
173 If the field `flag' is not NULL, it points to a variable that is set
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
174 to the value given in the field `val' when the option is found, but
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
175 left unchanged if the option is not found.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
176
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
177 To have a long-named option do something other than set an `int' to
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
178 a compiled-in constant, such as set a value from `optarg', set the
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
179 option's `flag' field to zero and its `val' field to a nonzero
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
180 value (the equivalent single-letter option character, if there is
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
181 one). For long options that have a zero `flag' field, `getopt'
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
182 returns the contents of the `val' field. */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
183
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
184 struct option
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
185 {
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
186 const char *name;
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
187 /* has_arg can't be an enum because some compilers complain about
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
188 type mismatches in all the code that assumes it is an int. */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
189 int has_arg;
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
190 int *flag;
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
191 int val;
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
192 };
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
193
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
194 /* Names for the values of the `has_arg' field of `struct option'. */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
195
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
196 # define no_argument 0
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
197 # define required_argument 1
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
198 # define optional_argument 2
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
199 #endif /* need getopt */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
200
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
201
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
202 /* Get definitions and prototypes for functions to process the
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
203 arguments in ARGV (ARGC of them, minus the program name) for
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
204 options given in OPTS.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
205
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
206 Return the option character from OPTS just read. Return -1 when
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
207 there are no more options. For unrecognized options, or options
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
208 missing arguments, `optopt' is set to the option letter, and '?' is
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
209 returned.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
210
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
211 The OPTS string is a list of characters which are recognized option
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
212 letters, optionally followed by colons, specifying that that letter
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
213 takes an argument, to be placed in `optarg'.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
214
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
215 If a letter in OPTS is followed by two colons, its argument is
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
216 optional. This behavior is specific to the GNU `getopt'.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
217
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
218 The argument `--' causes premature termination of argument
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
219 scanning, explicitly telling `getopt' that there are no more
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
220 options.
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
221
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
222 If OPTS begins with `-', then non-option arguments are treated as
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
223 arguments to the option '\1'. This behavior is specific to the GNU
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
224 `getopt'. If OPTS begins with `+', or POSIXLY_CORRECT is set in
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
225 the environment, then do not permute arguments. */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
226
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
227 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
228 __THROW _GL_ARG_NONNULL ((2, 3));
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
229
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
230 #ifndef __need_getopt
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
231 extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
232 const char *__shortopts,
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
233 const struct option *__longopts, int *__longind)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
234 __THROW _GL_ARG_NONNULL ((2, 3));
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
235 extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
236 const char *__shortopts,
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
237 const struct option *__longopts, int *__longind)
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
238 __THROW _GL_ARG_NONNULL ((2, 3));
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
239
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
240 #endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
241
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
242 #ifdef __cplusplus
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
243 }
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
244 #endif
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
245
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
246 /* Make sure we later can get all the definitions and declarations. */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
247 #undef __need_getopt
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
248
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
249 #endif /* getopt.h */
babd014aab81 Regenerate.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
250 #endif /* getopt.h */