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