annotate lib/argp.h @ 423:079d43b6967b 3.0-beta2 3.0-beta2

Added missing file
author lost@l-w.ca
date Sun, 19 Sep 2010 01:44:47 -0600
parents 3c2e1f24cc7d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
421
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
1 /* Hierarchial argument parsing, layered over getopt.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
2 Copyright (C) 1995-1999, 2003-2010 Free Software Foundation, Inc.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
3 This file is part of the GNU C Library.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
4 Written by Miles Bader <miles@gnu.ai.mit.edu>.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
5
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
6 This program is free software: you can redistribute it and/or modify
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
8 the Free Software Foundation; either version 3 of the License, or
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
9 (at your option) any later version.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
10
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
11 This program is distributed in the hope that it will be useful,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
14 GNU General Public License for more details.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
15
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
18
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
19 #ifndef _ARGP_H
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
20 #define _ARGP_H
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
21
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
22 #include <stdio.h>
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
23 #include <ctype.h>
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
24 #include <getopt.h>
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
25 #include <limits.h>
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
26
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
27 #define __need_error_t
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
28 #include <errno.h>
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
29
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
30 #ifndef __THROW
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
31 # define __THROW
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
32 #endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
33 #ifndef __NTH
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
34 # define __NTH(fct) fct __THROW
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
35 #endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
36
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
37 #ifndef __attribute__
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
38 /* This feature is available in gcc versions 2.5 and later. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
39 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
40 # define __attribute__(Spec) /* empty */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
41 # endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
42 /* The __-protected variants of `format' and `printf' attributes
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
43 are accepted by gcc versions 2.6.4 (effectively 2.7) and later. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
44 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7) || __STRICT_ANSI__
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
45 # define __format__ format
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
46 # define __printf__ printf
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
47 # endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
48 #endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
49
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
50 /* GCC 2.95 and later have "__restrict"; C99 compilers have
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
51 "restrict", and "configure" may have defined "restrict".
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
52 Other compilers use __restrict, __restrict__, and _Restrict, and
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
53 'configure' might #define 'restrict' to those words. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
54 #ifndef __restrict
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
55 # if ! (2 < __GNUC__ || (2 == __GNUC__ && 95 <= __GNUC_MINOR__))
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
56 # if 199901L <= __STDC_VERSION__
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
57 # define __restrict restrict
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
58 # else
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
59 # define __restrict
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
60 # endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
61 # endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
62 #endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
63
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
64 #ifndef __error_t_defined
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
65 typedef int error_t;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
66 # define __error_t_defined
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
67 #endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
68
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
69 #ifdef __cplusplus
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
70 extern "C" {
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
71 #endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
72
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
73 /* A description of a particular option. A pointer to an array of
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
74 these is passed in the OPTIONS field of an argp structure. Each option
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
75 entry can correspond to one long option and/or one short option; more
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
76 names for the same option can be added by following an entry in an option
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
77 array with options having the OPTION_ALIAS flag set. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
78 struct argp_option
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
79 {
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
80 /* The long option name. For more than one name for the same option, you
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
81 can use following options with the OPTION_ALIAS flag set. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
82 const char *name;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
83
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
84 /* What key is returned for this option. If > 0 and printable, then it's
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
85 also accepted as a short option. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
86 int key;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
87
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
88 /* If non-NULL, this is the name of the argument associated with this
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
89 option, which is required unless the OPTION_ARG_OPTIONAL flag is set. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
90 const char *arg;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
91
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
92 /* OPTION_ flags. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
93 int flags;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
94
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
95 /* The doc string for this option. If both NAME and KEY are 0, This string
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
96 will be printed outdented from the normal option column, making it
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
97 useful as a group header (it will be the first thing printed in its
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
98 group); in this usage, it's conventional to end the string with a `:'.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
99
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
100 Write the initial value as N_("TEXT") if you want xgettext to collect
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
101 it into a POT file. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
102 const char *doc;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
103
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
104 /* The group this option is in. In a long help message, options are sorted
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
105 alphabetically within each group, and the groups presented in the order
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
106 0, 1, 2, ..., n, -m, ..., -2, -1. Every entry in an options array with
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
107 if this field 0 will inherit the group number of the previous entry, or
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
108 zero if it's the first one, unless its a group header (NAME and KEY both
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
109 0), in which case, the previous entry + 1 is the default. Automagic
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
110 options such as --help are put into group -1. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
111 int group;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
112 };
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
113
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
114 /* The argument associated with this option is optional. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
115 #define OPTION_ARG_OPTIONAL 0x1
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
116
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
117 /* This option isn't displayed in any help messages. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
118 #define OPTION_HIDDEN 0x2
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
119
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
120 /* This option is an alias for the closest previous non-alias option. This
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
121 means that it will be displayed in the same help entry, and will inherit
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
122 fields other than NAME and KEY from the aliased option. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
123 #define OPTION_ALIAS 0x4
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
124
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
125 /* This option isn't actually an option (and so should be ignored by the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
126 actual option parser), but rather an arbitrary piece of documentation that
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
127 should be displayed in much the same manner as the options. If this flag
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
128 is set, then the option NAME field is displayed unmodified (e.g., no `--'
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
129 prefix is added) at the left-margin (where a *short* option would normally
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
130 be displayed), and the documentation string in the normal place. The NAME
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
131 field will be translated using gettext, unless OPTION_NO_TRANS is set (see
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
132 below). For purposes of sorting, any leading whitespace and punctuation is
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
133 ignored, except that if the first non-whitespace character is not `-', this
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
134 entry is displayed after all options (and OPTION_DOC entries with a leading
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
135 `-') in the same group. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
136 #define OPTION_DOC 0x8
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
137
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
138 /* This option shouldn't be included in `long' usage messages (but is still
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
139 included in help messages). This is mainly intended for options that are
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
140 completely documented in an argp's ARGS_DOC field, in which case including
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
141 the option in the generic usage list would be redundant. For instance,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
142 if ARGS_DOC is "FOO BAR\n-x BLAH", and the `-x' option's purpose is to
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
143 distinguish these two cases, -x should probably be marked
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
144 OPTION_NO_USAGE. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
145 #define OPTION_NO_USAGE 0x10
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
146
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
147 /* Valid only in conjunction with OPTION_DOC. This option disables translation
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
148 of option name. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
149 #define OPTION_NO_TRANS 0x20
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
150
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
151
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
152 struct argp; /* fwd declare this type */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
153 struct argp_state; /* " */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
154 struct argp_child; /* " */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
155
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
156 /* The type of a pointer to an argp parsing function. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
157 typedef error_t (*argp_parser_t) (int key, char *arg,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
158 struct argp_state *state);
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
159
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
160 /* What to return for unrecognized keys. For special ARGP_KEY_ keys, such
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
161 returns will simply be ignored. For user keys, this error will be turned
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
162 into EINVAL (if the call to argp_parse is such that errors are propagated
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
163 back to the user instead of exiting); returning EINVAL itself would result
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
164 in an immediate stop to parsing in *all* cases. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
165 #define ARGP_ERR_UNKNOWN E2BIG /* Hurd should never need E2BIG. XXX */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
166
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
167 /* Special values for the KEY argument to an argument parsing function.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
168 ARGP_ERR_UNKNOWN should be returned if they aren't understood.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
169
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
170 The sequence of keys to a parsing function is either (where each
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
171 uppercased word should be prefixed by `ARGP_KEY_' and opt is a user key):
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
172
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
173 INIT opt... NO_ARGS END SUCCESS -- No non-option arguments at all
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
174 or INIT (opt | ARG)... END SUCCESS -- All non-option args parsed
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
175 or INIT (opt | ARG)... SUCCESS -- Some non-option arg unrecognized
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
176
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
177 The third case is where every parser returned ARGP_KEY_UNKNOWN for an
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
178 argument, in which case parsing stops at that argument (returning the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
179 unparsed arguments to the caller of argp_parse if requested, or stopping
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
180 with an error message if not).
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
181
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
182 If an error occurs (either detected by argp, or because the parsing
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
183 function returned an error value), then the parser is called with
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
184 ARGP_KEY_ERROR, and no further calls are made. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
185
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
186 /* This is not an option at all, but rather a command line argument. If a
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
187 parser receiving this key returns success, the fact is recorded, and the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
188 ARGP_KEY_NO_ARGS case won't be used. HOWEVER, if while processing the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
189 argument, a parser function decrements the NEXT field of the state it's
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
190 passed, the option won't be considered processed; this is to allow you to
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
191 actually modify the argument (perhaps into an option), and have it
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
192 processed again. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
193 #define ARGP_KEY_ARG 0
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
194 /* There are remaining arguments not parsed by any parser, which may be found
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
195 starting at (STATE->argv + STATE->next). If success is returned, but
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
196 STATE->next left untouched, it's assumed that all arguments were consume,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
197 otherwise, the parser should adjust STATE->next to reflect any arguments
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
198 consumed. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
199 #define ARGP_KEY_ARGS 0x1000006
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
200 /* There are no more command line arguments at all. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
201 #define ARGP_KEY_END 0x1000001
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
202 /* Because it's common to want to do some special processing if there aren't
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
203 any non-option args, user parsers are called with this key if they didn't
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
204 successfully process any non-option arguments. Called just before
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
205 ARGP_KEY_END (where more general validity checks on previously parsed
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
206 arguments can take place). */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
207 #define ARGP_KEY_NO_ARGS 0x1000002
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
208 /* Passed in before any parsing is done. Afterwards, the values of each
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
209 element of the CHILD_INPUT field, if any, in the state structure is
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
210 copied to each child's state to be the initial value of the INPUT field. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
211 #define ARGP_KEY_INIT 0x1000003
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
212 /* Use after all other keys, including SUCCESS & END. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
213 #define ARGP_KEY_FINI 0x1000007
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
214 /* Passed in when parsing has successfully been completed (even if there are
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
215 still arguments remaining). */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
216 #define ARGP_KEY_SUCCESS 0x1000004
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
217 /* Passed in if an error occurs. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
218 #define ARGP_KEY_ERROR 0x1000005
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
219
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
220 /* An argp structure contains a set of options declarations, a function to
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
221 deal with parsing one, documentation string, a possible vector of child
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
222 argp's, and perhaps a function to filter help output. When actually
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
223 parsing options, getopt is called with the union of all the argp
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
224 structures chained together through their CHILD pointers, with conflicts
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
225 being resolved in favor of the first occurrence in the chain. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
226 struct argp
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
227 {
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
228 /* An array of argp_option structures, terminated by an entry with both
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
229 NAME and KEY having a value of 0. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
230 const struct argp_option *options;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
231
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
232 /* What to do with an option from this structure. KEY is the key
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
233 associated with the option, and ARG is any associated argument (NULL if
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
234 none was supplied). If KEY isn't understood, ARGP_ERR_UNKNOWN should be
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
235 returned. If a non-zero, non-ARGP_ERR_UNKNOWN value is returned, then
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
236 parsing is stopped immediately, and that value is returned from
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
237 argp_parse(). For special (non-user-supplied) values of KEY, see the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
238 ARGP_KEY_ definitions below. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
239 argp_parser_t parser;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
240
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
241 /* A string describing what other arguments are wanted by this program. It
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
242 is only used by argp_usage to print the `Usage:' message. If it
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
243 contains newlines, the strings separated by them are considered
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
244 alternative usage patterns, and printed on separate lines (lines after
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
245 the first are prefix by ` or: ' instead of `Usage:'). */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
246 const char *args_doc;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
247
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
248 /* If non-NULL, a string containing extra text to be printed before and
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
249 after the options in a long help message (separated by a vertical tab
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
250 `\v' character).
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
251 Write the initial value as N_("BEFORE-TEXT") "\v" N_("AFTER-TEXT") if
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
252 you want xgettext to collect the two pieces of text into a POT file. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
253 const char *doc;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
254
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
255 /* A vector of argp_children structures, terminated by a member with a 0
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
256 argp field, pointing to child argps should be parsed with this one. Any
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
257 conflicts are resolved in favor of this argp, or early argps in the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
258 CHILDREN list. This field is useful if you use libraries that supply
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
259 their own argp structure, which you want to use in conjunction with your
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
260 own. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
261 const struct argp_child *children;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
262
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
263 /* If non-zero, this should be a function to filter the output of help
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
264 messages. KEY is either a key from an option, in which case TEXT is
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
265 that option's help text, or a special key from the ARGP_KEY_HELP_
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
266 defines, below, describing which other help text TEXT is. The function
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
267 should return either TEXT, if it should be used as-is, a replacement
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
268 string, which should be malloced, and will be freed by argp, or NULL,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
269 meaning `print nothing'. The value for TEXT is *after* any translation
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
270 has been done, so if any of the replacement text also needs translation,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
271 that should be done by the filter function. INPUT is either the input
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
272 supplied to argp_parse, or NULL, if argp_help was called directly. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
273 char *(*help_filter) (int __key, const char *__text, void *__input);
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
274
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
275 /* If non-zero the strings used in the argp library are translated using
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
276 the domain described by this string. Otherwise the currently installed
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
277 default domain is used. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
278 const char *argp_domain;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
279 };
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
280
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
281 /* Possible KEY arguments to a help filter function. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
282 #define ARGP_KEY_HELP_PRE_DOC 0x2000001 /* Help text preceeding options. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
283 #define ARGP_KEY_HELP_POST_DOC 0x2000002 /* Help text following options. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
284 #define ARGP_KEY_HELP_HEADER 0x2000003 /* Option header string. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
285 #define ARGP_KEY_HELP_EXTRA 0x2000004 /* After all other documentation;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
286 TEXT is NULL for this key. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
287 /* Explanatory note emitted when duplicate option arguments have been
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
288 suppressed. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
289 #define ARGP_KEY_HELP_DUP_ARGS_NOTE 0x2000005
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
290 #define ARGP_KEY_HELP_ARGS_DOC 0x2000006 /* Argument doc string. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
291
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
292 /* When an argp has a non-zero CHILDREN field, it should point to a vector of
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
293 argp_child structures, each of which describes a subsidiary argp. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
294 struct argp_child
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
295 {
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
296 /* The child parser. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
297 const struct argp *argp;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
298
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
299 /* Flags for this child. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
300 int flags;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
301
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
302 /* If non-zero, an optional header to be printed in help output before the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
303 child options. As a side-effect, a non-zero value forces the child
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
304 options to be grouped together; to achieve this effect without actually
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
305 printing a header string, use a value of "". */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
306 const char *header;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
307
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
308 /* Where to group the child options relative to the other (`consolidated')
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
309 options in the parent argp; the values are the same as the GROUP field
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
310 in argp_option structs, but all child-groupings follow parent options at
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
311 a particular group level. If both this field and HEADER are zero, then
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
312 they aren't grouped at all, but rather merged with the parent options
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
313 (merging the child's grouping levels with the parents). */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
314 int group;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
315 };
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
316
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
317 /* Parsing state. This is provided to parsing functions called by argp,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
318 which may examine and, as noted, modify fields. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
319 struct argp_state
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
320 {
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
321 /* The top level ARGP being parsed. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
322 const struct argp *root_argp;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
323
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
324 /* The argument vector being parsed. May be modified. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
325 int argc;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
326 char **argv;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
327
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
328 /* The index in ARGV of the next arg that to be parsed. May be modified. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
329 int next;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
330
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
331 /* The flags supplied to argp_parse. May be modified. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
332 unsigned flags;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
333
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
334 /* While calling a parsing function with a key of ARGP_KEY_ARG, this is the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
335 number of the current arg, starting at zero, and incremented after each
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
336 such call returns. At all other times, this is the number of such
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
337 arguments that have been processed. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
338 unsigned arg_num;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
339
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
340 /* If non-zero, the index in ARGV of the first argument following a special
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
341 `--' argument (which prevents anything following being interpreted as an
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
342 option). Only set once argument parsing has proceeded past this point. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
343 int quoted;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
344
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
345 /* An arbitrary pointer passed in from the user. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
346 void *input;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
347 /* Values to pass to child parsers. This vector will be the same length as
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
348 the number of children for the current parser. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
349 void **child_inputs;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
350
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
351 /* For the parser's use. Initialized to 0. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
352 void *hook;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
353
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
354 /* The name used when printing messages. This is initialized to ARGV[0],
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
355 or PROGRAM_INVOCATION_NAME if that is unavailable. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
356 char *name;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
357
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
358 /* Streams used when argp prints something. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
359 FILE *err_stream; /* For errors; initialized to stderr. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
360 FILE *out_stream; /* For information; initialized to stdout. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
361
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
362 void *pstate; /* Private, for use by argp. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
363 };
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
364
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
365 /* Flags for argp_parse (note that the defaults are those that are
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
366 convenient for program command line parsing): */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
367
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
368 /* Don't ignore the first element of ARGV. Normally (and always unless
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
369 ARGP_NO_ERRS is set) the first element of the argument vector is
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
370 skipped for option parsing purposes, as it corresponds to the program name
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
371 in a command line. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
372 #define ARGP_PARSE_ARGV0 0x01
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
373
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
374 /* Don't print error messages for unknown options to stderr; unless this flag
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
375 is set, ARGP_PARSE_ARGV0 is ignored, as ARGV[0] is used as the program
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
376 name in the error messages. This flag implies ARGP_NO_EXIT (on the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
377 assumption that silent exiting upon errors is bad behaviour). */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
378 #define ARGP_NO_ERRS 0x02
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
379
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
380 /* Don't parse any non-option args. Normally non-option args are parsed by
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
381 calling the parse functions with a key of ARGP_KEY_ARG, and the actual arg
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
382 as the value. Since it's impossible to know which parse function wants to
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
383 handle it, each one is called in turn, until one returns 0 or an error
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
384 other than ARGP_ERR_UNKNOWN; if an argument is handled by no one, the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
385 argp_parse returns prematurely (but with a return value of 0). If all
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
386 args have been parsed without error, all parsing functions are called one
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
387 last time with a key of ARGP_KEY_END. This flag needn't normally be set,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
388 as the normal behavior is to stop parsing as soon as some argument can't
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
389 be handled. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
390 #define ARGP_NO_ARGS 0x04
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
391
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
392 /* Parse options and arguments in the same order they occur on the command
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
393 line -- normally they're rearranged so that all options come first. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
394 #define ARGP_IN_ORDER 0x08
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
395
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
396 /* Don't provide the standard long option --help, which causes usage and
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
397 option help information to be output to stdout, and exit (0) called. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
398 #define ARGP_NO_HELP 0x10
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
399
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
400 /* Don't exit on errors (they may still result in error messages). */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
401 #define ARGP_NO_EXIT 0x20
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
402
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
403 /* Use the gnu getopt `long-only' rules for parsing arguments. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
404 #define ARGP_LONG_ONLY 0x40
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
405
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
406 /* Turns off any message-printing/exiting options. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
407 #define ARGP_SILENT (ARGP_NO_EXIT | ARGP_NO_ERRS | ARGP_NO_HELP)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
408
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
409 /* Parse the options strings in ARGC & ARGV according to the options in ARGP.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
410 FLAGS is one of the ARGP_ flags above. If ARG_INDEX is non-NULL, the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
411 index in ARGV of the first unparsed option is returned in it. If an
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
412 unknown option is present, ARGP_ERR_UNKNOWN is returned; if some parser
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
413 routine returned a non-zero value, it is returned; otherwise 0 is
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
414 returned. This function may also call exit unless the ARGP_NO_HELP flag
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
415 is set. INPUT is a pointer to a value to be passed in to the parser. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
416 extern error_t argp_parse (const struct argp *__restrict __argp,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
417 int /*argc*/, char **__restrict /*argv*/,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
418 unsigned __flags, int *__restrict __arg_index,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
419 void *__restrict __input);
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
420 extern error_t __argp_parse (const struct argp *__restrict __argp,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
421 int /*argc*/, char **__restrict /*argv*/,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
422 unsigned __flags, int *__restrict __arg_index,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
423 void *__restrict __input);
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
424
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
425 /* Global variables. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
426
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
427 /* GNULIB makes sure both program_invocation_name and
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
428 program_invocation_short_name are available */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
429 #ifdef GNULIB_PROGRAM_INVOCATION_NAME
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
430 extern char *program_invocation_name;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
431 # undef HAVE_DECL_PROGRAM_INVOCATION_NAME
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
432 # define HAVE_DECL_PROGRAM_INVOCATION_NAME 1
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
433 #endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
434
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
435 #ifdef GNULIB_PROGRAM_INVOCATION_SHORT_NAME
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
436 extern char *program_invocation_short_name;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
437 # undef HAVE_DECL_PROGRAM_INVOCATION_SHORT_NAME
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
438 # define HAVE_DECL_PROGRAM_INVOCATION_SHORT_NAME 1
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
439 #endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
440
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
441 /* If defined or set by the user program to a non-zero value, then a default
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
442 option --version is added (unless the ARGP_NO_HELP flag is used), which
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
443 will print this string followed by a newline and exit (unless the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
444 ARGP_NO_EXIT flag is used). Overridden by ARGP_PROGRAM_VERSION_HOOK. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
445 extern const char *argp_program_version;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
446
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
447 /* If defined or set by the user program to a non-zero value, then a default
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
448 option --version is added (unless the ARGP_NO_HELP flag is used), which
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
449 calls this function with a stream to print the version to and a pointer to
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
450 the current parsing state, and then exits (unless the ARGP_NO_EXIT flag is
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
451 used). This variable takes precedent over ARGP_PROGRAM_VERSION. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
452 extern void (*argp_program_version_hook) (FILE *__restrict __stream,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
453 struct argp_state *__restrict
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
454 __state);
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
455
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
456 /* If defined or set by the user program, it should point to string that is
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
457 the bug-reporting address for the program. It will be printed by
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
458 argp_help if the ARGP_HELP_BUG_ADDR flag is set (as it is by various
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
459 standard help messages), embedded in a sentence that says something like
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
460 `Report bugs to ADDR.'. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
461 extern const char *argp_program_bug_address;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
462
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
463 /* The exit status that argp will use when exiting due to a parsing error.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
464 If not defined or set by the user program, this defaults to EX_USAGE from
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
465 <sysexits.h>. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
466 extern error_t argp_err_exit_status;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
467
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
468 /* Flags for argp_help. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
469 #define ARGP_HELP_USAGE 0x01 /* a Usage: message. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
470 #define ARGP_HELP_SHORT_USAGE 0x02 /* " but don't actually print options. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
471 #define ARGP_HELP_SEE 0x04 /* a `Try ... for more help' message. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
472 #define ARGP_HELP_LONG 0x08 /* a long help message. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
473 #define ARGP_HELP_PRE_DOC 0x10 /* doc string preceding long help. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
474 #define ARGP_HELP_POST_DOC 0x20 /* doc string following long help. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
475 #define ARGP_HELP_DOC (ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
476 #define ARGP_HELP_BUG_ADDR 0x40 /* bug report address */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
477 #define ARGP_HELP_LONG_ONLY 0x80 /* modify output appropriately to
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
478 reflect ARGP_LONG_ONLY mode. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
479
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
480 /* These ARGP_HELP flags are only understood by argp_state_help. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
481 #define ARGP_HELP_EXIT_ERR 0x100 /* Call exit(1) instead of returning. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
482 #define ARGP_HELP_EXIT_OK 0x200 /* Call exit(0) instead of returning. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
483
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
484 /* The standard thing to do after a program command line parsing error, if an
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
485 error message has already been printed. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
486 #define ARGP_HELP_STD_ERR \
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
487 (ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
488 /* The standard thing to do after a program command line parsing error, if no
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
489 more specific error message has been printed. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
490 #define ARGP_HELP_STD_USAGE \
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
491 (ARGP_HELP_SHORT_USAGE | ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
492 /* The standard thing to do in response to a --help option. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
493 #define ARGP_HELP_STD_HELP \
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
494 (ARGP_HELP_SHORT_USAGE | ARGP_HELP_LONG | ARGP_HELP_EXIT_OK \
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
495 | ARGP_HELP_DOC | ARGP_HELP_BUG_ADDR)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
496
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
497 /* Output a usage message for ARGP to STREAM. FLAGS are from the set
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
498 ARGP_HELP_*. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
499 extern void argp_help (const struct argp *__restrict __argp,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
500 FILE *__restrict __stream,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
501 unsigned __flags, char *__restrict __name);
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
502 extern void __argp_help (const struct argp *__restrict __argp,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
503 FILE *__restrict __stream, unsigned __flags,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
504 char *__name);
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
505
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
506 /* The following routines are intended to be called from within an argp
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
507 parsing routine (thus taking an argp_state structure as the first
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
508 argument). They may or may not print an error message and exit, depending
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
509 on the flags in STATE -- in any case, the caller should be prepared for
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
510 them *not* to exit, and should return an appropiate error after calling
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
511 them. [argp_usage & argp_error should probably be called argp_state_...,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
512 but they're used often enough that they should be short] */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
513
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
514 /* Output, if appropriate, a usage message for STATE to STREAM. FLAGS are
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
515 from the set ARGP_HELP_*. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
516 extern void argp_state_help (const struct argp_state *__restrict __state,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
517 FILE *__restrict __stream,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
518 unsigned int __flags);
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
519 extern void __argp_state_help (const struct argp_state *__restrict __state,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
520 FILE *__restrict __stream,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
521 unsigned int __flags);
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
522
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
523 #if _LIBC || !defined __USE_EXTERN_INLINES
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
524 /* Possibly output the standard usage message for ARGP to stderr and exit. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
525 extern void argp_usage (const struct argp_state *__state);
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
526 extern void __argp_usage (const struct argp_state *__state);
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
527 #endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
528
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
529 /* If appropriate, print the printf string FMT and following args, preceded
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
530 by the program name and `:', to stderr, and followed by a `Try ... --help'
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
531 message, then exit (1). */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
532 extern void argp_error (const struct argp_state *__restrict __state,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
533 const char *__restrict __fmt, ...)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
534 __attribute__ ((__format__ (__printf__, 2, 3)));
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
535 extern void __argp_error (const struct argp_state *__restrict __state,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
536 const char *__restrict __fmt, ...)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
537 __attribute__ ((__format__ (__printf__, 2, 3)));
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
538
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
539 /* Similar to the standard gnu error-reporting function error(), but will
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
540 respect the ARGP_NO_EXIT and ARGP_NO_ERRS flags in STATE, and will print
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
541 to STATE->err_stream. This is useful for argument parsing code that is
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
542 shared between program startup (when exiting is desired) and runtime
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
543 option parsing (when typically an error code is returned instead). The
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
544 difference between this function and argp_error is that the latter is for
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
545 *parsing errors*, and the former is for other problems that occur during
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
546 parsing but don't reflect a (syntactic) problem with the input. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
547 extern void argp_failure (const struct argp_state *__restrict __state,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
548 int __status, int __errnum,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
549 const char *__restrict __fmt, ...)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
550 __attribute__ ((__format__ (__printf__, 4, 5)));
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
551 extern void __argp_failure (const struct argp_state *__restrict __state,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
552 int __status, int __errnum,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
553 const char *__restrict __fmt, ...)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
554 __attribute__ ((__format__ (__printf__, 4, 5)));
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
555
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
556 #if _LIBC || !defined __USE_EXTERN_INLINES
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
557 /* Returns true if the option OPT is a valid short option. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
558 extern int _option_is_short (const struct argp_option *__opt) __THROW;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
559 extern int __option_is_short (const struct argp_option *__opt) __THROW;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
560
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
561 /* Returns true if the option OPT is in fact the last (unused) entry in an
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
562 options array. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
563 extern int _option_is_end (const struct argp_option *__opt) __THROW;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
564 extern int __option_is_end (const struct argp_option *__opt) __THROW;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
565 #endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
566
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
567 /* Return the input field for ARGP in the parser corresponding to STATE; used
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
568 by the help routines. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
569 extern void *_argp_input (const struct argp *__restrict __argp,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
570 const struct argp_state *__restrict __state)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
571 __THROW;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
572 extern void *__argp_input (const struct argp *__restrict __argp,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
573 const struct argp_state *__restrict __state)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
574 __THROW;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
575
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
576 #ifdef __USE_EXTERN_INLINES
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
577
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
578 # if !_LIBC
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
579 # define __argp_usage argp_usage
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
580 # define __argp_state_help argp_state_help
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
581 # define __option_is_short _option_is_short
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
582 # define __option_is_end _option_is_end
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
583 # endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
584
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
585 # ifndef ARGP_EI
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
586 # ifdef __GNUC__
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
587 /* GCC 4.3 and above with -std=c99 or -std=gnu99 implements ISO C99
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
588 inline semantics, unless -fgnu89-inline is used. It defines a macro
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
589 __GNUC_STDC_INLINE__ to indicate this situation or a macro
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
590 __GNUC_GNU_INLINE__ to indicate the opposite situation.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
591 GCC 4.2 with -std=c99 or -std=gnu99 implements the GNU C inline
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
592 semantics but warns, unless -fgnu89-inline is used:
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
593 warning: C99 inline functions are not supported; using GNU89
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
594 warning: to disable this warning use -fgnu89-inline or the gnu_inline function attribute
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
595 It defines a macro __GNUC_GNU_INLINE__ to indicate this situation. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
596 # if defined __GNUC_STDC_INLINE__
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
597 # define ARGP_EI __inline__
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
598 # elif defined __GNUC_GNU_INLINE__
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
599 # define ARGP_EI extern __inline__ __attribute__ ((__gnu_inline__))
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
600 # else
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
601 # define ARGP_EI extern __inline__
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
602 # endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
603 # else
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
604 /* With other compilers, assume the ISO C99 meaning of 'inline', if
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
605 the compiler supports 'inline' at all. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
606 # define ARGP_EI inline
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
607 # endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
608 # endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
609
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
610 ARGP_EI void
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
611 __argp_usage (const struct argp_state *__state)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
612 {
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
613 __argp_state_help (__state, stderr, ARGP_HELP_STD_USAGE);
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
614 }
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
615
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
616 ARGP_EI int
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
617 __NTH (__option_is_short (const struct argp_option *__opt))
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
618 {
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
619 if (__opt->flags & OPTION_DOC)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
620 return 0;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
621 else
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
622 {
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
623 int __key = __opt->key;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
624 return __key > 0 && __key <= UCHAR_MAX && isprint (__key);
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
625 }
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
626 }
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
627
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
628 ARGP_EI int
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
629 __NTH (__option_is_end (const struct argp_option *__opt))
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
630 {
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
631 return !__opt->key && !__opt->name && !__opt->doc && !__opt->group;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
632 }
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
633
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
634 # if !_LIBC
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
635 # undef __argp_usage
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
636 # undef __argp_state_help
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
637 # undef __option_is_short
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
638 # undef __option_is_end
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
639 # endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
640 #endif /* Use extern inlines. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
641
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
642 #ifdef __cplusplus
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
643 }
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
644 #endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
645
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
646 #endif /* argp.h */