gnulib: lib/argp.h annotate

annotate lib/argp.h @ 17363:5a51fb7777a9

sys_select, sys_time: port 2013-01-30 Solaris 2.6 fix to Cygwin Problem reported by Marco Atzeri in <http://lists.gnu.org/archive/html/bug-gnulib/2013-03/msg00000.html>. * lib/sys_select.in.h [HAVE_SYS_SELECT_H && _CYGWIN_SYS_TIME_H]: Simply delegate to the system <sys/select.h> in this case too. Also, pay attention to _GL_SYS_SELECT_H_REDIRECT_FROM_SYS_TIME_H only if OSF/1, since otherwise Cygwin breaks, and it doesn't seem to be needed on Solaris either. * lib/sys_time.in.h [_CYGWIN_SYS_TIME_H]: Simply delgate to the system <sys/time.h> in this case.

author	Paul Eggert <eggert@cs.ucla.edu>
date	Tue, 19 Mar 2013 09:08:47 -0700
parents	e542fd46ad6f
children	1f9070ef79b0

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

Mercurial > gnulib

annotate lib/argp.h @ 17363:5a51fb7777a9