argp.h 26 KB

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