Mercurial > hg > octave-shane > gnulib-hg

annotate lib/getopt.in.h @ 12070:f098f1865179

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
getopt: fix inclusion guards for cygwin cygwin <unistd.h> includes <getopt.h>, but gnulib <getopt.h> includes <unistd.h>, so system declarations were happening after gnulib replacements, leading to multiply-defined rpl_readlink error on cygwin 1.5. The solution is to ensure that the system <unistd.h> is complete prior to any of gnulib's contents, by picking up system <getopt.h> in preference to a cycle to <unistd.h>. * modules/getopt-posix (Depends-on): Add include-next. (Makefile.am): Substitute more items in replacement header. * m4/getopt.m4 (gl_GETOPT_CHECK_HEADERS): Also check for native <getopt.h>. * lib/getopt.in.h (includes): Use split inclusion guard, and prefer <getopt.h> over include <unistd.h> when one is present. (option): Also override name of 'struct option'. Signed-off-by: Eric Blake <ebb9@byu.net>
author Eric Blake <ebb9@byu.net>
date Thu, 24 Sep 2009 10:57:14 -0600
parents bbbbbf4cd1c5
children 272a2761593e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9250
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
1 /* Declarations for getopt.
12070
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
2 Copyright (C) 1989-1994,1996-1999,2001,2003,2004,2005,2006,2007,2009
9250
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
3 Free Software Foundation, Inc.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
4 This file is part of the GNU C Library.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
5
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9250
diff changeset
6 This program is free software: you can redistribute it and/or modify
9250
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9250
diff changeset
8 the Free Software Foundation; either version 3 of the License, or
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9250
diff changeset
9 (at your option) any later version.
9250
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
10
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
11 This program is distributed in the hope that it will be useful,
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
14 GNU General Public License for more details.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
15
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9250
diff changeset
16 You should have received a copy of the GNU General Public License
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9250
diff changeset
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
9250
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
18
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
19 #ifndef _GETOPT_H
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
20
12070
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
21 #if __GNUC__ >= 3
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
22 @PRAGMA_SYSTEM_HEADER@
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
23 #endif
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
24
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
25 /* The include_next requires a split double-inclusion guard. */
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
26 #if @HAVE_GETOPT_H@
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
27 # @INCLUDE_NEXT@ @NEXT_GETOPT_H@
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
28 #endif
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
29
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
30 #ifndef _GETOPT_H
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
31
9250
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32 #ifndef __need_getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33 # define _GETOPT_H 1
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36 /* Standalone applications should #define __GETOPT_PREFIX to an
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
37 identifier that prefixes the external functions and variables
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
38 defined in this header. When this happens, include the
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
39 headers that might declare getopt so that they will not cause
12070
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
40 confusion if included after this file (if the system had <getopt.h>,
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
41 we have already included it). Then systematically rename
9250
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
42 identifiers so that they do not collide with the system functions
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
43 and variables. Renaming avoids problems with some compilers and
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
44 linkers. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
45 #if defined __GETOPT_PREFIX && !defined __need_getopt
12070
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
46 # if !@HAVE_GETOPT_H@
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
47 # include <stdlib.h>
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
48 # include <stdio.h>
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
49 # include <unistd.h>
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
50 # endif
9250
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
51 # undef __need_getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
52 # undef getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
53 # undef getopt_long
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
54 # undef getopt_long_only
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
55 # undef optarg
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
56 # undef opterr
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
57 # undef optind
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
58 # undef optopt
12070
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
59 # undef option
9250
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
60 # define __GETOPT_CONCAT(x, y) x ## y
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
61 # define __GETOPT_XCONCAT(x, y) __GETOPT_CONCAT (x, y)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
62 # define __GETOPT_ID(y) __GETOPT_XCONCAT (__GETOPT_PREFIX, y)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
63 # define getopt __GETOPT_ID (getopt)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
64 # define getopt_long __GETOPT_ID (getopt_long)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
65 # define getopt_long_only __GETOPT_ID (getopt_long_only)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
66 # define optarg __GETOPT_ID (optarg)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
67 # define opterr __GETOPT_ID (opterr)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
68 # define optind __GETOPT_ID (optind)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
69 # define optopt __GETOPT_ID (optopt)
12070
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
70 # define option __GETOPT_ID (option)
9250
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
71 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
72
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
73 /* Standalone applications get correct prototypes for getopt_long and
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
74 getopt_long_only; they declare "char **argv". libc uses prototypes
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
75 with "char *const *argv" that are incorrect because getopt_long and
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
76 getopt_long_only can permute argv; this is required for backward
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
77 compatibility (e.g., for LSB 2.0.1).
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
78
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
79 This used to be `#if defined __GETOPT_PREFIX && !defined __need_getopt',
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
80 but it caused redefinition warnings if both unistd.h and getopt.h were
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
81 included, since unistd.h includes getopt.h having previously defined
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
82 __need_getopt.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
83
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
84 The only place where __getopt_argv_const is used is in definitions
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
85 of getopt_long and getopt_long_only below, but these are visible
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
86 only if __need_getopt is not defined, so it is quite safe to rewrite
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
87 the conditional as follows:
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
88 */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
89 #if !defined __need_getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
90 # if defined __GETOPT_PREFIX
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
91 # define __getopt_argv_const /* empty */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
92 # else
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
93 # define __getopt_argv_const const
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
94 # endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
95 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
96
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
97 /* If __GNU_LIBRARY__ is not already defined, either we are being used
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
98 standalone, or this is the first header included in the source file.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
99 If we are being used with glibc, we need to include <features.h>, but
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
100 that does not exist if we are standalone. So: if __GNU_LIBRARY__ is
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
101 not defined, include <ctype.h>, which will pull in <features.h> for us
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
102 if it's from glibc. (Why ctype.h? It's guaranteed to exist and it
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
103 doesn't flood the namespace with stuff the way some other headers do.) */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
104 #if !defined __GNU_LIBRARY__
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
105 # include <ctype.h>
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
106 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
107
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
108 #ifndef __THROW
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
109 # ifndef __GNUC_PREREQ
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
110 # define __GNUC_PREREQ(maj, min) (0)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
111 # endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
112 # if defined __cplusplus && __GNUC_PREREQ (2,8)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
113 # define __THROW throw ()
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
114 # else
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
115 # define __THROW
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
116 # endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
117 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
118
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
119 #ifdef __cplusplus
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
120 extern "C" {
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
121 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
122
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
123 /* For communication from `getopt' to the caller.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
124 When `getopt' finds an option that takes an argument,
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
125 the argument value is returned here.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
126 Also, when `ordering' is RETURN_IN_ORDER,
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
127 each non-option ARGV-element is returned here. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
128
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
129 extern char *optarg;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
130
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
131 /* Index in ARGV of the next element to be scanned.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
132 This is used for communication to and from the caller
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
133 and for communication between successive calls to `getopt'.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
134
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
135 On entry to `getopt', zero means this is the first call; initialize.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
136
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
137 When `getopt' returns -1, this is the index of the first of the
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
138 non-option elements that the caller should itself scan.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
139
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
140 Otherwise, `optind' communicates from one call to the next
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
141 how much of ARGV has been scanned so far. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
142
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
143 extern int optind;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
144
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
145 /* Callers store zero here to inhibit the error message `getopt' prints
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
146 for unrecognized options. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
147
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
148 extern int opterr;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
149
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
150 /* Set to an option character which was unrecognized. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
151
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
152 extern int optopt;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
153
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
154 #ifndef __need_getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
155 /* Describe the long-named options requested by the application.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
156 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
157 of `struct option' terminated by an element containing a name which is
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
158 zero.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
159
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
160 The field `has_arg' is:
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
161 no_argument (or 0) if the option does not take an argument,
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
162 required_argument (or 1) if the option requires an argument,
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
163 optional_argument (or 2) if the option takes an optional argument.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
164
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
165 If the field `flag' is not NULL, it points to a variable that is set
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
166 to the value given in the field `val' when the option is found, but
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
167 left unchanged if the option is not found.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
168
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
169 To have a long-named option do something other than set an `int' to
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
170 a compiled-in constant, such as set a value from `optarg', set the
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
171 option's `flag' field to zero and its `val' field to a nonzero
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
172 value (the equivalent single-letter option character, if there is
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
173 one). For long options that have a zero `flag' field, `getopt'
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
174 returns the contents of the `val' field. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
175
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
176 struct option
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
177 {
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
178 const char *name;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
179 /* has_arg can't be an enum because some compilers complain about
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
180 type mismatches in all the code that assumes it is an int. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
181 int has_arg;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
182 int *flag;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
183 int val;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
184 };
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
185
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
186 /* Names for the values of the `has_arg' field of `struct option'. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
187
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
188 # define no_argument 0
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
189 # define required_argument 1
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
190 # define optional_argument 2
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
191 #endif /* need getopt */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
192
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
193
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
194 /* Get definitions and prototypes for functions to process the
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
195 arguments in ARGV (ARGC of them, minus the program name) for
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
196 options given in OPTS.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
197
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
198 Return the option character from OPTS just read. Return -1 when
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
199 there are no more options. For unrecognized options, or options
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
200 missing arguments, `optopt' is set to the option letter, and '?' is
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
201 returned.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
202
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
203 The OPTS string is a list of characters which are recognized option
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
204 letters, optionally followed by colons, specifying that that letter
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
205 takes an argument, to be placed in `optarg'.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
206
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
207 If a letter in OPTS is followed by two colons, its argument is
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
208 optional. This behavior is specific to the GNU `getopt'.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
209
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
210 The argument `--' causes premature termination of argument
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
211 scanning, explicitly telling `getopt' that there are no more
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
212 options.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
213
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
214 If OPTS begins with `-', then non-option arguments are treated as
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
215 arguments to the option '\1'. This behavior is specific to the GNU
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
216 `getopt'. If OPTS begins with `+', or POSIXLY_CORRECT is set in
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
217 the environment, then do not permute arguments. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
218
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
219 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
220 __THROW;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
221
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
222 #ifndef __need_getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
223 extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
224 const char *__shortopts,
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
225 const struct option *__longopts, int *__longind)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
226 __THROW;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
227 extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
228 const char *__shortopts,
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
229 const struct option *__longopts, int *__longind)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
230 __THROW;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
231
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
232 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
233
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
234 #ifdef __cplusplus
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
235 }
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
236 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
237
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
238 /* Make sure we later can get all the definitions and declarations. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
239 #undef __need_getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
240
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
241 #endif /* getopt.h */
12070
f098f1865179 getopt: fix inclusion guards for cygwin
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
242 #endif /* getopt.h */