Mercurial > hg > octave-shane > gnulib-hg

annotate lib/getopt.in.h @ 9309:bbbbbf4cd1c5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Change copyright notice from GPLv2+ to GPLv3+.
author Bruno Haible <bruno@clisp.org>
date Sun, 07 Oct 2007 19:14:58 +0200
parents 6e379cd631c3
children f098f1865179
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.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
2 Copyright (C) 1989-1994,1996-1999,2001,2003,2004,2005,2006,2007
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
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
21 #ifndef __need_getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
22 # define _GETOPT_H 1
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
23 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
24
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
25 /* Standalone applications should #define __GETOPT_PREFIX to an
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26 identifier that prefixes the external functions and variables
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
27 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
28 headers that might declare getopt so that they will not cause
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29 confusion if included after this file. Then systematically rename
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30 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
31 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
32 linkers. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33 #if defined __GETOPT_PREFIX && !defined __need_getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 # include <stdlib.h>
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35 # include <stdio.h>
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36 # include <unistd.h>
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
37 # undef __need_getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
38 # undef getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
39 # undef getopt_long
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
40 # undef getopt_long_only
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
41 # undef optarg
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
42 # undef opterr
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
43 # undef optind
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
44 # undef optopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
45 # define __GETOPT_CONCAT(x, y) x ## y
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
46 # 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
47 # 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
48 # define getopt __GETOPT_ID (getopt)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
49 # define getopt_long __GETOPT_ID (getopt_long)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
50 # 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
51 # define optarg __GETOPT_ID (optarg)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
52 # define opterr __GETOPT_ID (opterr)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
53 # define optind __GETOPT_ID (optind)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
54 # define optopt __GETOPT_ID (optopt)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
55 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
56
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
57 /* 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
58 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
59 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
60 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
61 compatibility (e.g., for LSB 2.0.1).
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
62
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
63 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
64 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
65 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
66 __need_getopt.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
67
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
68 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
69 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
70 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
71 the conditional as follows:
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 #if !defined __need_getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
74 # if defined __GETOPT_PREFIX
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
75 # define __getopt_argv_const /* empty */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
76 # else
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
77 # define __getopt_argv_const const
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
78 # endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
79 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
80
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
81 /* 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
82 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
83 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
84 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
85 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
86 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
87 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
88 #if !defined __GNU_LIBRARY__
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
89 # include <ctype.h>
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
90 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
91
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
92 #ifndef __THROW
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
93 # ifndef __GNUC_PREREQ
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
94 # define __GNUC_PREREQ(maj, min) (0)
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 # if defined __cplusplus && __GNUC_PREREQ (2,8)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
97 # define __THROW throw ()
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
98 # else
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
99 # define __THROW
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
100 # endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
101 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
102
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
103 #ifdef __cplusplus
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
104 extern "C" {
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
105 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
106
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
107 /* For communication from `getopt' to the caller.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
108 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
109 the argument value is returned here.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
110 Also, when `ordering' is RETURN_IN_ORDER,
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
111 each non-option ARGV-element is returned here. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
112
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
113 extern char *optarg;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
114
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
115 /* 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
116 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
117 and for communication between successive calls to `getopt'.
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 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
120
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
121 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
122 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
123
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
124 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
125 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
126
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
127 extern int optind;
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 /* 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
130 for unrecognized options. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
131
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
132 extern int opterr;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
133
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
134 /* Set to an option character which was unrecognized. */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
135
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
136 extern int optopt;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
137
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
138 #ifndef __need_getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
139 /* 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
140 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
141 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
142 zero.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
143
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
144 The field `has_arg' is:
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
145 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
146 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
147 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
148
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
149 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
150 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
151 left unchanged if the option is not found.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
152
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
153 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
154 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
155 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
156 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
157 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
158 returns the contents of the `val' field. */
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 struct option
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
161 {
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
162 const char *name;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
163 /* 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
164 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
165 int has_arg;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
166 int *flag;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
167 int val;
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
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
170 /* 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
171
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
172 # define no_argument 0
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
173 # define required_argument 1
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
174 # define optional_argument 2
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
175 #endif /* need getopt */
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
176
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 /* 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
179 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
180 options given in OPTS.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
181
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
182 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
183 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
184 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
185 returned.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
186
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
187 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
188 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
189 takes an argument, to be placed in `optarg'.
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
190
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
191 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
192 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
193
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
194 The argument `--' causes premature termination of argument
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
195 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
196 options.
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 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
199 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
200 `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
201 the environment, then do not permute arguments. */
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 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
204 __THROW;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
205
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
206 #ifndef __need_getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
207 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
208 const char *__shortopts,
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
209 const struct option *__longopts, int *__longind)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
210 __THROW;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
211 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
212 const char *__shortopts,
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
213 const struct option *__longopts, int *__longind)
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
214 __THROW;
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
215
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
216 #endif
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
217
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
218 #ifdef __cplusplus
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
219 }
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
220 #endif
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 /* 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
223 #undef __need_getopt
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
224
6e379cd631c3 Rename getopt_.h to getopt.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
225 #endif /* getopt.h */