00001 /* Hierarchial argument parsing, layered over getopt. 00002 Copyright (C) 1995-1999,2003,2004 Free Software Foundation, Inc. 00003 This file is part of the GNU C Library. 00004 Written by Miles Bader <miles@gnu.ai.mit.edu>. 00005 00006 This program is free software; you can redistribute it and/or modify 00007 it under the terms of the GNU Lesser General Public License as published by 00008 the Free Software Foundation; either version 2.1, or (at your option) 00009 any later version. 00010 00011 This program is distributed in the hope that it will be useful, 00012 but WITHOUT ANY WARRANTY; without even the implied warranty of 00013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00014 GNU Lesser General Public License for more details. 00015 00016 You should have received a copy of the GNU Lesser General Public License along 00017 with this program; if not, write to the Free Software Foundation, 00018 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ 00019 00020 #ifndef _ARGP_H 00021 #define _ARGP_H 00022 00023 #include <stdio.h> 00024 #include <ctype.h> 00025 #include <getopt.h> 00026 #include <limits.h> 00027 00028 #define __need_error_t 00029 #include <errno.h> 00030 00031 #ifndef __const 00032 # define __const const 00033 #endif 00034 00035 #ifndef __THROW 00036 # define __THROW 00037 #endif 00038 #ifndef __NTH 00039 # define __NTH(fct) fct __THROW 00040 #endif 00041 00042 #ifndef __attribute__ 00043 /* This feature is available in gcc versions 2.5 and later. */ 00044 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__ 00045 # define __attribute__(Spec) /* empty */ 00046 # endif 00047 /* The __-protected variants of `format' and `printf' attributes 00048 are accepted by gcc versions 2.6.4 (effectively 2.7) and later. */ 00049 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7) || __STRICT_ANSI__ 00050 # define __format__ format 00051 # define __printf__ printf 00052 # endif 00053 #endif 00054 00055 /* GCC 2.95 and later have "__restrict"; C99 compilers have 00056 "restrict", and "configure" may have defined "restrict". */ 00057 #ifndef __restrict 00058 # if ! (2 < __GNUC__ || (2 == __GNUC__ && 95 <= __GNUC_MINOR__)) 00059 # if defined restrict || 199901L <= __STDC_VERSION__ 00060 # define __restrict restrict 00061 # else 00062 # define __restrict 00063 # endif 00064 # endif 00065 #endif 00066 00067 #ifndef __error_t_defined 00068 typedef int error_t; 00069 # define __error_t_defined 00070 #endif 00071 00072 #ifdef __cplusplus 00073 extern "C" { 00074 #endif 00075 00076 /* A description of a particular option. A pointer to an array of 00077 these is passed in the OPTIONS field of an argp structure. Each option 00078 entry can correspond to one long option and/or one short option; more 00079 names for the same option can be added by following an entry in an option 00080 array with options having the OPTION_ALIAS flag set. */ 00081 struct argp_option 00082 { 00083 /* The long option name. For more than one name for the same option, you 00084 can use following options with the OPTION_ALIAS flag set. */ 00085 __const char *name; 00086 00087 /* What key is returned for this option. If > 0 and printable, then it's 00088 also accepted as a short option. */ 00089 int key; 00090 00091 /* If non-NULL, this is the name of the argument associated with this 00092 option, which is required unless the OPTION_ARG_OPTIONAL flag is set. */ 00093 __const char *arg; 00094 00095 /* OPTION_ flags. */ 00096 int flags; 00097 00098 /* The doc string for this option. If both NAME and KEY are 0, This string 00099 will be printed outdented from the normal option column, making it 00100 useful as a group header (it will be the first thing printed in its 00101 group); in this usage, it's conventional to end the string with a `:'. */ 00102 __const char *doc; 00103 00104 /* The group this option is in. In a long help message, options are sorted 00105 alphabetically within each group, and the groups presented in the order 00106 0, 1, 2, ..., n, -m, ..., -2, -1. Every entry in an options array with 00107 if this field 0 will inherit the group number of the previous entry, or 00108 zero if it's the first one, unless its a group header (NAME and KEY both 00109 0), in which case, the previous entry + 1 is the default. Automagic 00110 options such as --help are put into group -1. */ 00111 int group; 00112 }; 00113 00114 /* The argument associated with this option is optional. */ 00115 #define OPTION_ARG_OPTIONAL 0x1 00116 00117 /* This option isn't displayed in any help messages. */ 00118 #define OPTION_HIDDEN 0x2 00119 00120 /* This option is an alias for the closest previous non-alias option. This 00121 means that it will be displayed in the same help entry, and will inherit 00122 fields other than NAME and KEY from the aliased option. */ 00123 #define OPTION_ALIAS 0x4 00124 00125 /* This option isn't actually an option (and so should be ignored by the 00126 actual option parser), but rather an arbitrary piece of documentation that 00127 should be displayed in much the same manner as the options. If this flag 00128 is set, then the option NAME field is displayed unmodified (e.g., no `--' 00129 prefix is added) at the left-margin (where a *short* option would normally 00130 be displayed), and the documentation string in the normal place. The NAME 00131 field will be translated using gettext, unless OPTION_NO_TRANS is set (see 00132 below). For purposes of sorting, any leading whitespace and punctuation is 00133 ignored, except that if the first non-whitespace character is not `-', this 00134 entry is displayed after all options (and OPTION_DOC entries with a leading 00135 `-') in the same group. */ 00136 #define OPTION_DOC 0x8 00137 00138 /* This option shouldn't be included in `long' usage messages (but is still 00139 included in help messages). This is mainly intended for options that are 00140 completely documented in an argp's ARGS_DOC field, in which case including 00141 the option in the generic usage list would be redundant. For instance, 00142 if ARGS_DOC is "FOO BAR\n-x BLAH", and the `-x' option's purpose is to 00143 distinguish these two cases, -x should probably be marked 00144 OPTION_NO_USAGE. */ 00145 #define OPTION_NO_USAGE 0x10 00146 00147 /* Valid only in conjunction with OPTION_DOC. This option disables translation 00148 of option name. */ 00149 #define OPTION_NO_TRANS 0x20 00150 00151 00152 struct argp; /* fwd declare this type */ 00153 struct argp_state; /* " */ 00154 struct argp_child; /* " */ 00155 00156 /* The type of a pointer to an argp parsing function. */ 00157 typedef error_t (*argp_parser_t) (int key, char *arg, 00158 struct argp_state *state); 00159 00160 /* What to return for unrecognized keys. For special ARGP_KEY_ keys, such 00161 returns will simply be ignored. For user keys, this error will be turned 00162 into EINVAL (if the call to argp_parse is such that errors are propagated 00163 back to the user instead of exiting); returning EINVAL itself would result 00164 in an immediate stop to parsing in *all* cases. */ 00165 #define ARGP_ERR_UNKNOWN E2BIG /* Hurd should never need E2BIG. XXX */ 00166 00167 /* Special values for the KEY argument to an argument parsing function. 00168 ARGP_ERR_UNKNOWN should be returned if they aren't understood. 00169 00170 The sequence of keys to a parsing function is either (where each 00171 uppercased word should be prefixed by `ARGP_KEY_' and opt is a user key): 00172 00173 INIT opt... NO_ARGS END SUCCESS -- No non-option arguments at all 00174 or INIT (opt | ARG)... END SUCCESS -- All non-option args parsed 00175 or INIT (opt | ARG)... SUCCESS -- Some non-option arg unrecognized 00176 00177 The third case is where every parser returned ARGP_KEY_UNKNOWN for an 00178 argument, in which case parsing stops at that argument (returning the 00179 unparsed arguments to the caller of argp_parse if requested, or stopping 00180 with an error message if not). 00181 00182 If an error occurs (either detected by argp, or because the parsing 00183 function returned an error value), then the parser is called with 00184 ARGP_KEY_ERROR, and no further calls are made. */ 00185 00186 /* This is not an option at all, but rather a command line argument. If a 00187 parser receiving this key returns success, the fact is recorded, and the 00188 ARGP_KEY_NO_ARGS case won't be used. HOWEVER, if while processing the 00189 argument, a parser function decrements the NEXT field of the state it's 00190 passed, the option won't be considered processed; this is to allow you to 00191 actually modify the argument (perhaps into an option), and have it 00192 processed again. */ 00193 #define ARGP_KEY_ARG 0 00194 /* There are remaining arguments not parsed by any parser, which may be found 00195 starting at (STATE->argv + STATE->next). If success is returned, but 00196 STATE->next left untouched, it's assumed that all arguments were consume, 00197 otherwise, the parser should adjust STATE->next to reflect any arguments 00198 consumed. */ 00199 #define ARGP_KEY_ARGS 0x1000006 00200 /* There are no more command line arguments at all. */ 00201 #define ARGP_KEY_END 0x1000001 00202 /* Because it's common to want to do some special processing if there aren't 00203 any non-option args, user parsers are called with this key if they didn't 00204 successfully process any non-option arguments. Called just before 00205 ARGP_KEY_END (where more general validity checks on previously parsed 00206 arguments can take place). */ 00207 #define ARGP_KEY_NO_ARGS 0x1000002 00208 /* Passed in before any parsing is done. Afterwards, the values of each 00209 element of the CHILD_INPUT field, if any, in the state structure is 00210 copied to each child's state to be the initial value of the INPUT field. */ 00211 #define ARGP_KEY_INIT 0x1000003 00212 /* Use after all other keys, including SUCCESS & END. */ 00213 #define ARGP_KEY_FINI 0x1000007 00214 /* Passed in when parsing has successfully been completed (even if there are 00215 still arguments remaining). */ 00216 #define ARGP_KEY_SUCCESS 0x1000004 00217 /* Passed in if an error occurs. */ 00218 #define ARGP_KEY_ERROR 0x1000005 00219 00220 /* An argp structure contains a set of options declarations, a function to 00221 deal with parsing one, documentation string, a possible vector of child 00222 argp's, and perhaps a function to filter help output. When actually 00223 parsing options, getopt is called with the union of all the argp 00224 structures chained together through their CHILD pointers, with conflicts 00225 being resolved in favor of the first occurrence in the chain. */ 00226 struct argp 00227 { 00228 /* An array of argp_option structures, terminated by an entry with both 00229 NAME and KEY having a value of 0. */ 00230 __const struct argp_option *options; 00231 00232 /* What to do with an option from this structure. KEY is the key 00233 associated with the option, and ARG is any associated argument (NULL if 00234 none was supplied). If KEY isn't understood, ARGP_ERR_UNKNOWN should be 00235 returned. If a non-zero, non-ARGP_ERR_UNKNOWN value is returned, then 00236 parsing is stopped immediately, and that value is returned from 00237 argp_parse(). For special (non-user-supplied) values of KEY, see the 00238 ARGP_KEY_ definitions below. */ 00239 argp_parser_t parser; 00240 00241 /* A string describing what other arguments are wanted by this program. It 00242 is only used by argp_usage to print the `Usage:' message. If it 00243 contains newlines, the strings separated by them are considered 00244 alternative usage patterns, and printed on separate lines (lines after 00245 the first are prefix by ` or: ' instead of `Usage:'). */ 00246 __const char *args_doc; 00247 00248 /* If non-NULL, a string containing extra text to be printed before and 00249 after the options in a long help message (separated by a vertical tab 00250 `\v' character). */ 00251 __const char *doc; 00252 00253 /* A vector of argp_children structures, terminated by a member with a 0 00254 argp field, pointing to child argps should be parsed with this one. Any 00255 conflicts are resolved in favor of this argp, or early argps in the 00256 CHILDREN list. This field is useful if you use libraries that supply 00257 their own argp structure, which you want to use in conjunction with your 00258 own. */ 00259 __const struct argp_child *children; 00260 00261 /* If non-zero, this should be a function to filter the output of help 00262 messages. KEY is either a key from an option, in which case TEXT is 00263 that option's help text, or a special key from the ARGP_KEY_HELP_ 00264 defines, below, describing which other help text TEXT is. The function 00265 should return either TEXT, if it should be used as-is, a replacement 00266 string, which should be malloced, and will be freed by argp, or NULL, 00267 meaning `print nothing'. The value for TEXT is *after* any translation 00268 has been done, so if any of the replacement text also needs translation, 00269 that should be done by the filter function. INPUT is either the input 00270 supplied to argp_parse, or NULL, if argp_help was called directly. */ 00271 char *(*help_filter) (int __key, __const char *__text, void *__input); 00272 00273 /* If non-zero the strings used in the argp library are translated using 00274 the domain described by this string. Otherwise the currently installed 00275 default domain is used. */ 00276 const char *argp_domain; 00277 }; 00278 00279 /* Possible KEY arguments to a help filter function. */ 00280 #define ARGP_KEY_HELP_PRE_DOC 0x2000001 /* Help text preceeding options. */ 00281 #define ARGP_KEY_HELP_POST_DOC 0x2000002 /* Help text following options. */ 00282 #define ARGP_KEY_HELP_HEADER 0x2000003 /* Option header string. */ 00283 #define ARGP_KEY_HELP_EXTRA 0x2000004 /* After all other documentation; 00284 TEXT is NULL for this key. */ 00285 /* Explanatory note emitted when duplicate option arguments have been 00286 suppressed. */ 00287 #define ARGP_KEY_HELP_DUP_ARGS_NOTE 0x2000005 00288 #define ARGP_KEY_HELP_ARGS_DOC 0x2000006 /* Argument doc string. */ 00289 00290 /* When an argp has a non-zero CHILDREN field, it should point to a vector of 00291 argp_child structures, each of which describes a subsidiary argp. */ 00292 struct argp_child 00293 { 00294 /* The child parser. */ 00295 __const struct argp *argp; 00296 00297 /* Flags for this child. */ 00298 int flags; 00299 00300 /* If non-zero, an optional header to be printed in help output before the 00301 child options. As a side-effect, a non-zero value forces the child 00302 options to be grouped together; to achieve this effect without actually 00303 printing a header string, use a value of "". */ 00304 __const char *header; 00305 00306 /* Where to group the child options relative to the other (`consolidated') 00307 options in the parent argp; the values are the same as the GROUP field 00308 in argp_option structs, but all child-groupings follow parent options at 00309 a particular group level. If both this field and HEADER are zero, then 00310 they aren't grouped at all, but rather merged with the parent options 00311 (merging the child's grouping levels with the parents). */ 00312 int group; 00313 }; 00314 00315 /* Parsing state. This is provided to parsing functions called by argp, 00316 which may examine and, as noted, modify fields. */ 00317 struct argp_state 00318 { 00319 /* The top level ARGP being parsed. */ 00320 __const struct argp *root_argp; 00321 00322 /* The argument vector being parsed. May be modified. */ 00323 int argc; 00324 char **argv; 00325 00326 /* The index in ARGV of the next arg that to be parsed. May be modified. */ 00327 int next; 00328 00329 /* The flags supplied to argp_parse. May be modified. */ 00330 unsigned flags; 00331 00332 /* While calling a parsing function with a key of ARGP_KEY_ARG, this is the 00333 number of the current arg, starting at zero, and incremented after each 00334 such call returns. At all other times, this is the number of such 00335 arguments that have been processed. */ 00336 unsigned arg_num; 00337 00338 /* If non-zero, the index in ARGV of the first argument following a special 00339 `--' argument (which prevents anything following being interpreted as an 00340 option). Only set once argument parsing has proceeded past this point. */ 00341 int quoted; 00342 00343 /* An arbitrary pointer passed in from the user. */ 00344 void *input; 00345 /* Values to pass to child parsers. This vector will be the same length as 00346 the number of children for the current parser. */ 00347 void **child_inputs; 00348 00349 /* For the parser's use. Initialized to 0. */ 00350 void *hook; 00351 00352 /* The name used when printing messages. This is initialized to ARGV[0], 00353 or PROGRAM_INVOCATION_NAME if that is unavailable. */ 00354 char *name; 00355 00356 /* Streams used when argp prints something. */ 00357 FILE *err_stream; /* For errors; initialized to stderr. */ 00358 FILE *out_stream; /* For information; initialized to stdout. */ 00359 00360 void *pstate; /* Private, for use by argp. */ 00361 }; 00362 00363 /* Flags for argp_parse (note that the defaults are those that are 00364 convenient for program command line parsing): */ 00365 00366 /* Don't ignore the first element of ARGV. Normally (and always unless 00367 ARGP_NO_ERRS is set) the first element of the argument vector is 00368 skipped for option parsing purposes, as it corresponds to the program name 00369 in a command line. */ 00370 #define ARGP_PARSE_ARGV0 0x01 00371 00372 /* Don't print error messages for unknown options to stderr; unless this flag 00373 is set, ARGP_PARSE_ARGV0 is ignored, as ARGV[0] is used as the program 00374 name in the error messages. This flag implies ARGP_NO_EXIT (on the 00375 assumption that silent exiting upon errors is bad behaviour). */ 00376 #define ARGP_NO_ERRS 0x02 00377 00378 /* Don't parse any non-option args. Normally non-option args are parsed by 00379 calling the parse functions with a key of ARGP_KEY_ARG, and the actual arg 00380 as the value. Since it's impossible to know which parse function wants to 00381 handle it, each one is called in turn, until one returns 0 or an error 00382 other than ARGP_ERR_UNKNOWN; if an argument is handled by no one, the 00383 argp_parse returns prematurely (but with a return value of 0). If all 00384 args have been parsed without error, all parsing functions are called one 00385 last time with a key of ARGP_KEY_END. This flag needn't normally be set, 00386 as the normal behavior is to stop parsing as soon as some argument can't 00387 be handled. */ 00388 #define ARGP_NO_ARGS 0x04 00389 00390 /* Parse options and arguments in the same order they occur on the command 00391 line -- normally they're rearranged so that all options come first. */ 00392 #define ARGP_IN_ORDER 0x08 00393 00394 /* Don't provide the standard long option --help, which causes usage and 00395 option help information to be output to stdout, and exit (0) called. */ 00396 #define ARGP_NO_HELP 0x10 00397 00398 /* Don't exit on errors (they may still result in error messages). */ 00399 #define ARGP_NO_EXIT 0x20 00400 00401 /* Use the gnu getopt `long-only' rules for parsing arguments. */ 00402 #define ARGP_LONG_ONLY 0x40 00403 00404 /* Turns off any message-printing/exiting options. */ 00405 #define ARGP_SILENT (ARGP_NO_EXIT | ARGP_NO_ERRS | ARGP_NO_HELP) 00406 00407 /* Parse the options strings in ARGC & ARGV according to the options in ARGP. 00408 FLAGS is one of the ARGP_ flags above. If ARG_INDEX is non-NULL, the 00409 index in ARGV of the first unparsed option is returned in it. If an 00410 unknown option is present, ARGP_ERR_UNKNOWN is returned; if some parser 00411 routine returned a non-zero value, it is returned; otherwise 0 is 00412 returned. This function may also call exit unless the ARGP_NO_HELP flag 00413 is set. INPUT is a pointer to a value to be passed in to the parser. */ 00414 extern error_t argp_parse (__const struct argp *__restrict __argp, 00415 int __argc, char **__restrict __argv, 00416 unsigned __flags, int *__restrict __arg_index, 00417 void *__restrict __input); 00418 extern error_t __argp_parse (__const struct argp *__restrict __argp, 00419 int __argc, char **__restrict __argv, 00420 unsigned __flags, int *__restrict __arg_index, 00421 void *__restrict __input); 00422 00423 /* Global variables. */ 00424 00425 /* If defined or set by the user program to a non-zero value, then a default 00426 option --version is added (unless the ARGP_NO_HELP flag is used), which 00427 will print this string followed by a newline and exit (unless the 00428 ARGP_NO_EXIT flag is used). Overridden by ARGP_PROGRAM_VERSION_HOOK. */ 00429 extern __const char *argp_program_version; 00430 00431 /* If defined or set by the user program to a non-zero value, then a default 00432 option --version is added (unless the ARGP_NO_HELP flag is used), which 00433 calls this function with a stream to print the version to and a pointer to 00434 the current parsing state, and then exits (unless the ARGP_NO_EXIT flag is 00435 used). This variable takes precedent over ARGP_PROGRAM_VERSION. */ 00436 extern void (*argp_program_version_hook) (FILE *__restrict __stream, 00437 struct argp_state *__restrict 00438 __state); 00439 00440 /* If defined or set by the user program, it should point to string that is 00441 the bug-reporting address for the program. It will be printed by 00442 argp_help if the ARGP_HELP_BUG_ADDR flag is set (as it is by various 00443 standard help messages), embedded in a sentence that says something like 00444 `Report bugs to ADDR.'. */ 00445 extern __const char *argp_program_bug_address; 00446 00447 /* The exit status that argp will use when exiting due to a parsing error. 00448 If not defined or set by the user program, this defaults to EX_USAGE from 00449 <sysexits.h>. */ 00450 extern error_t argp_err_exit_status; 00451 00452 /* Flags for argp_help. */ 00453 #define ARGP_HELP_USAGE 0x01 /* a Usage: message. */ 00454 #define ARGP_HELP_SHORT_USAGE 0x02 /* " but don't actually print options. */ 00455 #define ARGP_HELP_SEE 0x04 /* a `Try ... for more help' message. */ 00456 #define ARGP_HELP_LONG 0x08 /* a long help message. */ 00457 #define ARGP_HELP_PRE_DOC 0x10 /* doc string preceding long help. */ 00458 #define ARGP_HELP_POST_DOC 0x20 /* doc string following long help. */ 00459 #define ARGP_HELP_DOC (ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC) 00460 #define ARGP_HELP_BUG_ADDR 0x40 /* bug report address */ 00461 #define ARGP_HELP_LONG_ONLY 0x80 /* modify output appropriately to 00462 reflect ARGP_LONG_ONLY mode. */ 00463 00464 /* These ARGP_HELP flags are only understood by argp_state_help. */ 00465 #define ARGP_HELP_EXIT_ERR 0x100 /* Call exit(1) instead of returning. */ 00466 #define ARGP_HELP_EXIT_OK 0x200 /* Call exit(0) instead of returning. */ 00467 00468 /* The standard thing to do after a program command line parsing error, if an 00469 error message has already been printed. */ 00470 #define ARGP_HELP_STD_ERR \ 00471 (ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR) 00472 /* The standard thing to do after a program command line parsing error, if no 00473 more specific error message has been printed. */ 00474 #define ARGP_HELP_STD_USAGE \ 00475 (ARGP_HELP_SHORT_USAGE | ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR) 00476 /* The standard thing to do in response to a --help option. */ 00477 #define ARGP_HELP_STD_HELP \ 00478 (ARGP_HELP_SHORT_USAGE | ARGP_HELP_LONG | ARGP_HELP_EXIT_OK \ 00479 | ARGP_HELP_DOC | ARGP_HELP_BUG_ADDR) 00480 00481 /* Output a usage message for ARGP to STREAM. FLAGS are from the set 00482 ARGP_HELP_*. */ 00483 extern void argp_help (__const struct argp *__restrict __argp, 00484 FILE *__restrict __stream, 00485 unsigned __flags, char *__restrict __name); 00486 extern void __argp_help (__const struct argp *__restrict __argp, 00487 FILE *__restrict __stream, unsigned __flags, 00488 char *__name); 00489 00490 /* The following routines are intended to be called from within an argp 00491 parsing routine (thus taking an argp_state structure as the first 00492 argument). They may or may not print an error message and exit, depending 00493 on the flags in STATE -- in any case, the caller should be prepared for 00494 them *not* to exit, and should return an appropiate error after calling 00495 them. [argp_usage & argp_error should probably be called argp_state_..., 00496 but they're used often enough that they should be short] */ 00497 00498 /* Output, if appropriate, a usage message for STATE to STREAM. FLAGS are 00499 from the set ARGP_HELP_*. */ 00500 extern void argp_state_help (__const struct argp_state *__restrict __state, 00501 FILE *__restrict __stream, 00502 unsigned int __flags); 00503 extern void __argp_state_help (__const struct argp_state *__restrict __state, 00504 FILE *__restrict __stream, 00505 unsigned int __flags); 00506 00507 /* Possibly output the standard usage message for ARGP to stderr and exit. */ 00508 extern void argp_usage (__const struct argp_state *__state); 00509 extern void __argp_usage (__const struct argp_state *__state); 00510 00511 /* If appropriate, print the printf string FMT and following args, preceded 00512 by the program name and `:', to stderr, and followed by a `Try ... --help' 00513 message, then exit (1). */ 00514 extern void argp_error (__const struct argp_state *__restrict __state, 00515 __const char *__restrict __fmt, ...) 00516 __attribute__ ((__format__ (__printf__, 2, 3))); 00517 extern void __argp_error (__const struct argp_state *__restrict __state, 00518 __const char *__restrict __fmt, ...) 00519 __attribute__ ((__format__ (__printf__, 2, 3))); 00520 00521 /* Similar to the standard gnu error-reporting function error(), but will 00522 respect the ARGP_NO_EXIT and ARGP_NO_ERRS flags in STATE, and will print 00523 to STATE->err_stream. This is useful for argument parsing code that is 00524 shared between program startup (when exiting is desired) and runtime 00525 option parsing (when typically an error code is returned instead). The 00526 difference between this function and argp_error is that the latter is for 00527 *parsing errors*, and the former is for other problems that occur during 00528 parsing but don't reflect a (syntactic) problem with the input. */ 00529 extern void argp_failure (__const struct argp_state *__restrict __state, 00530 int __status, int __errnum, 00531 __const char *__restrict __fmt, ...) 00532 __attribute__ ((__format__ (__printf__, 4, 5))); 00533 extern void __argp_failure (__const struct argp_state *__restrict __state, 00534 int __status, int __errnum, 00535 __const char *__restrict __fmt, ...) 00536 __attribute__ ((__format__ (__printf__, 4, 5))); 00537 00538 /* Returns true if the option OPT is a valid short option. */ 00539 extern int _option_is_short (__const struct argp_option *__opt) __THROW; 00540 extern int __option_is_short (__const struct argp_option *__opt) __THROW; 00541 00542 /* Returns true if the option OPT is in fact the last (unused) entry in an 00543 options array. */ 00544 extern int _option_is_end (__const struct argp_option *__opt) __THROW; 00545 extern int __option_is_end (__const struct argp_option *__opt) __THROW; 00546 00547 /* Return the input field for ARGP in the parser corresponding to STATE; used 00548 by the help routines. */ 00549 extern void *_argp_input (__const struct argp *__restrict __argp, 00550 __const struct argp_state *__restrict __state) 00551 __THROW; 00552 extern void *__argp_input (__const struct argp *__restrict __argp, 00553 __const struct argp_state *__restrict __state) 00554 __THROW; 00555 00556 #ifdef __USE_EXTERN_INLINES 00557 00558 # if !_LIBC 00559 # define __argp_usage argp_usage 00560 # define __argp_state_help argp_state_help 00561 # define __option_is_short _option_is_short 00562 # define __option_is_end _option_is_end 00563 # endif 00564 00565 # ifndef ARGP_EI 00566 # define ARGP_EI extern __inline__ 00567 # endif 00568 00569 ARGP_EI void 00570 __NTH (__argp_usage (__const struct argp_state *__state)) 00571 { 00572 __argp_state_help (__state, stderr, ARGP_HELP_STD_USAGE); 00573 } 00574 00575 ARGP_EI int 00576 __NTH (__option_is_short (__const struct argp_option *__opt)) 00577 { 00578 if (__opt->flags & OPTION_DOC) 00579 return 0; 00580 else 00581 { 00582 int __key = __opt->key; 00583 return __key > 0 && __key <= UCHAR_MAX && isprint (__key); 00584 } 00585 } 00586 00587 ARGP_EI int 00588 __NTH (__option_is_end (__const struct argp_option *__opt)) 00589 { 00590 return !__opt->key && !__opt->name && !__opt->doc && !__opt->group; 00591 } 00592 00593 # if !_LIBC 00594 # undef __argp_usage 00595 # undef __argp_state_help 00596 # undef __option_is_short 00597 # undef __option_is_end 00598 # endif 00599 #endif /* Use extern inlines. */ 00600 00601 #ifdef __cplusplus 00602 } 00603 #endif 00604 00605 #endif /* argp.h */