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