argp.h 29 KB

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