argp.h 25 KB

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