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