1 /* Hierarchial argument parsing help output
2 Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4 Written by Miles Bader <miles@gnu.ai.mit.edu>.
6 The GNU C Library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public License as
8 published by the Free Software Foundation; either version 2 of the
9 License, or (at your option) any later version.
11 The GNU C Library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
16 You should have received a copy of the GNU Library General Public
17 License along with the GNU C Library; see the file COPYING.LIB. If not,
18 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
34 /* This is for other GNU distributions with internationalized messages.
35 When compiling libc, the _ macro is predefined. */
38 # define _(msgid) gettext (msgid)
40 # define _(msgid) (msgid)
41 # define gettext(msgid) (msgid)
46 #include "argp-fmtstream.h"
47 #include "argp-namefrob.h"
49 /* User-selectable (using an environment variable) formatting parameters.
51 These may be specified in an environment variable called `ARGP_HELP_FMT',
52 with a contents like: VAR1=VAL1,VAR2=VAL2,BOOLVAR2,no-BOOLVAR2
53 Where VALn must be a positive integer. The list of variables is in the
54 UPARAM_NAMES vector, below. */
56 /* Default parameters. */
57 #define DUP_ARGS 0 /* True if option argument can be duplicated. */
58 #define DUP_ARGS_NOTE 1 /* True to print a note about duplicate args. */
59 #define SHORT_OPT_COL 2 /* column in which short options start */
60 #define LONG_OPT_COL 6 /* column in which long options start */
61 #define DOC_OPT_COL 2 /* column in which doc options start */
62 #define OPT_DOC_COL 29 /* column in which option text starts */
63 #define HEADER_COL 1 /* column in which group headers are printed */
64 #define USAGE_INDENT 12 /* indentation of wrapped usage lines */
65 #define RMARGIN 79 /* right margin used for wrapping */
67 /* User-selectable (using an environment variable) formatting parameters.
68 They must all be of type `int' for the parsing code to work. */
71 /* If true, arguments for an option are shown with both short and long
72 options, even when a given option has both, e.g. `-x ARG, --longx=ARG'.
73 If false, then if an option has both, the argument is only shown with
74 the long one, e.g., `-x, --longx=ARG', and a message indicating that
75 this really means both is printed below the options. */
78 /* This is true if when DUP_ARGS is false, and some duplicate arguments have
79 been suppressed, an explanatory message should be printed. */
82 /* Various output columns. */
91 int valid
; /* True when the values in here are valid. */
94 /* This is a global variable, as user options are only ever read once. */
95 static struct uparams uparams
= {
96 DUP_ARGS
, DUP_ARGS_NOTE
,
97 SHORT_OPT_COL
, LONG_OPT_COL
, DOC_OPT_COL
, OPT_DOC_COL
, HEADER_COL
,
98 USAGE_INDENT
, RMARGIN
,
102 /* A particular uparam, and what the user name is. */
105 const char *name
; /* User name. */
106 int is_bool
; /* Whether it's `boolean'. */
107 size_t uparams_offs
; /* Location of the (int) field in UPARAMS. */
110 /* The name-field mappings we know about. */
111 static const struct uparam_name uparam_names
[] =
113 { "dup-args", 1, offsetof (struct uparams
, dup_args
) },
114 { "dup-args-note", 1, offsetof (struct uparams
, dup_args_note
) },
115 { "short-opt-col", 0, offsetof (struct uparams
, short_opt_col
) },
116 { "long-opt-col", 0, offsetof (struct uparams
, long_opt_col
) },
117 { "doc-opt-col", 0, offsetof (struct uparams
, doc_opt_col
) },
118 { "opt-doc-col", 0, offsetof (struct uparams
, opt_doc_col
) },
119 { "header-col", 0, offsetof (struct uparams
, header_col
) },
120 { "usage-indent", 0, offsetof (struct uparams
, usage_indent
) },
121 { "rmargin", 0, offsetof (struct uparams
, rmargin
) },
125 /* Read user options from the environment, and fill in UPARAMS appropiately. */
127 fill_in_uparams (const struct argp_state
*state
)
129 const char *var
= getenv ("ARGP_HELP_FMT");
131 #define SKIPWS(p) do { while (isspace (*p)) p++; } while (0);
142 const struct uparam_name
*un
;
143 int unspec
= 0, val
= 0;
144 const char *arg
= var
;
146 while (isalnum (*arg
) || *arg
== '-' || *arg
== '_')
152 if (*arg
== '\0' || *arg
== ',')
154 else if (*arg
== '=')
161 if (var
[0] == 'n' && var
[1] == 'o' && var
[2] == '-')
169 else if (isdigit (*arg
))
172 while (isdigit (*arg
))
177 for (un
= uparam_names
; un
->name
; un
++)
178 if (strlen (un
->name
) == var_len
179 && strncmp (var
, un
->name
, var_len
) == 0)
181 if (unspec
&& !un
->is_bool
)
182 __argp_failure (state
, 0, 0,
183 _("%.*s: ARGP_HELP_FMT parameter requires a value"),
186 *(int *)((char *)&uparams
+ un
->uparams_offs
) = val
;
190 __argp_failure (state
, 0, 0,
191 _("%.*s: Unknown ARGP_HELP_FMT parameter"),
200 __argp_failure (state
, 0, 0,
201 _("Garbage in ARGP_HELP_FMT: %s"), var
);
207 /* Returns true if OPT hasn't been marked invisible. Visibility only affects
208 whether OPT is displayed or used in sorting, not option shadowing. */
209 #define ovisible(opt) (! ((opt)->flags & OPTION_HIDDEN))
211 /* Returns true if OPT is an alias for an earlier option. */
212 #define oalias(opt) ((opt)->flags & OPTION_ALIAS)
214 /* Returns true if OPT is an documentation-only entry. */
215 #define odoc(opt) ((opt)->flags & OPTION_DOC)
217 /* Returns true if OPT is the end-of-list marker for a list of options. */
218 #define oend(opt) __option_is_end (opt)
220 /* Returns true if OPT has a short option. */
221 #define oshort(opt) __option_is_short (opt)
224 The help format for a particular option is like:
226 -xARG, -yARG, --long1=ARG, --long2=ARG Documentation...
228 Where ARG will be omitted if there's no argument, for this option, or
229 will be surrounded by "[" and "]" appropiately if the argument is
230 optional. The documentation string is word-wrapped appropiately, and if
231 the list of options is long enough, it will be started on a separate line.
232 If there are no short options for a given option, the first long option is
233 indented slighly in a way that's supposed to make most long options appear
234 to be in a separate column.
236 For example, the following output (from ps):
238 -p PID, --pid=PID List the process PID
239 --pgrp=PGRP List processes in the process group PGRP
240 -P, -x, --no-parent Include processes without parents
241 -Q, --all-fields Don't elide unusable fields (normally if there's
242 some reason ps can't print a field for any
243 process, it's removed from the output entirely)
244 -r, --reverse, --gratuitously-long-reverse-option
245 Reverse the order of any sort
246 --session[=SID] Add the processes from the session SID (which
247 defaults to the sid of the current process)
249 Here are some more options:
250 -f ZOT, --foonly=ZOT Glork a foonly
251 -z, --zaza Snit a zar
253 -?, --help Give this help list
254 --usage Give a short usage message
255 -V, --version Print program version
257 The struct argp_option array for the above could look like:
260 {"pid", 'p', "PID", 0, "List the process PID"},
261 {"pgrp", OPT_PGRP, "PGRP", 0, "List processes in the process group PGRP"},
262 {"no-parent", 'P', 0, 0, "Include processes without parents"},
263 {0, 'x', 0, OPTION_ALIAS},
264 {"all-fields",'Q', 0, 0, "Don't elide unusable fields (normally"
265 " if there's some reason ps can't"
266 " print a field for any process, it's"
267 " removed from the output entirely)" },
268 {"reverse", 'r', 0, 0, "Reverse the order of any sort"},
269 {"gratuitously-long-reverse-option", 0, 0, OPTION_ALIAS},
270 {"session", OPT_SESS, "SID", OPTION_ARG_OPTIONAL,
271 "Add the processes from the session"
272 " SID (which defaults to the sid of"
273 " the current process)" },
275 {0,0,0,0, "Here are some more options:"},
276 {"foonly", 'f', "ZOT", 0, "Glork a foonly"},
277 {"zaza", 'z', 0, 0, "Snit a zar"},
282 Note that the last three options are automatically supplied by argp_parse,
283 unless you tell it not to with ARGP_NO_HELP.
287 /* Returns true if CH occurs between BEG and END. */
289 find_char (char ch
, char *beg
, char *end
)
299 struct hol_cluster
; /* fwd decl */
304 const struct argp_option
*opt
;
305 /* Number of options (including aliases). */
308 /* A pointers into the HOL's short_options field, to the first short option
309 letter for this entry. The order of the characters following this point
310 corresponds to the order of options pointed to by OPT, and there are at
311 most NUM. A short option recorded in a option following OPT is only
312 valid if it occurs in the right place in SHORT_OPTIONS (otherwise it's
313 probably been shadowed by some other entry). */
316 /* Entries are sorted by their group first, in the order:
317 1, 2, ..., n, 0, -m, ..., -2, -1
318 and then alphabetically within each group. The default is 0. */
321 /* The cluster of options this entry belongs to, or 0 if none. */
322 struct hol_cluster
*cluster
;
324 /* The argp from which this option came. */
325 const struct argp
*argp
;
328 /* A cluster of entries to reflect the argp tree structure. */
331 /* A descriptive header printed before options in this cluster. */
334 /* Used to order clusters within the same group with the same parent,
335 according to the order in which they occured in the parent argp's child
339 /* How to sort this cluster with respect to options and other clusters at the
340 same depth (clusters always follow options in the same group). */
343 /* The cluster to which this cluster belongs, or 0 if it's at the base
345 struct hol_cluster
*parent
;
347 /* The argp from which this cluster is (eventually) derived. */
348 const struct argp
*argp
;
350 /* The distance this cluster is from the root. */
353 /* Clusters in a given hol are kept in a linked list, to make freeing them
355 struct hol_cluster
*next
;
358 /* A list of options for help. */
361 /* An array of hol_entry's. */
362 struct hol_entry
*entries
;
363 /* The number of entries in this hol. If this field is zero, the others
365 unsigned num_entries
;
367 /* A string containing all short options in this HOL. Each entry contains
368 pointers into this string, so the order can't be messed with blindly. */
371 /* Clusters of entries in this hol. */
372 struct hol_cluster
*clusters
;
375 /* Create a struct hol from the options in ARGP. CLUSTER is the
376 hol_cluster in which these entries occur, or 0, if at the root. */
378 make_hol (const struct argp
*argp
, struct hol_cluster
*cluster
)
381 const struct argp_option
*o
;
382 const struct argp_option
*opts
= argp
->options
;
383 struct hol_entry
*entry
;
384 unsigned num_short_options
= 0;
385 struct hol
*hol
= malloc (sizeof (struct hol
));
389 hol
->num_entries
= 0;
396 /* The first option must not be an alias. */
397 assert (! oalias (opts
));
399 /* Calculate the space needed. */
400 for (o
= opts
; ! oend (o
); o
++)
405 num_short_options
++; /* This is an upper bound. */
408 hol
->entries
= malloc (sizeof (struct hol_entry
) * hol
->num_entries
);
409 hol
->short_options
= malloc (num_short_options
+ 1);
411 assert (hol
->entries
&& hol
->short_options
);
413 /* Fill in the entries. */
414 so
= hol
->short_options
;
415 for (o
= opts
, entry
= hol
->entries
; ! oend (o
); entry
++)
419 entry
->short_options
= so
;
420 entry
->group
= cur_group
=
423 : ((!o
->name
&& !o
->key
)
426 entry
->cluster
= cluster
;
432 if (oshort (o
) && ! find_char (o
->key
, hol
->short_options
, so
))
433 /* O has a valid short option which hasn't already been used.*/
437 while (! oend (o
) && oalias (o
));
439 *so
= '\0'; /* null terminated so we can find the length */
445 /* Add a new cluster to HOL, with the given GROUP and HEADER (taken from the
446 associated argp child list entry), INDEX, and PARENT, and return a pointer
447 to it. ARGP is the argp that this cluster results from. */
448 static struct hol_cluster
*
449 hol_add_cluster (struct hol
*hol
, int group
, const char *header
, int index
,
450 struct hol_cluster
*parent
, const struct argp
*argp
)
452 struct hol_cluster
*cl
= malloc (sizeof (struct hol_cluster
));
461 cl
->depth
= parent
? parent
->depth
+ 1 : 0;
463 cl
->next
= hol
->clusters
;
469 /* Free HOL and any resources it uses. */
471 hol_free (struct hol
*hol
)
473 struct hol_cluster
*cl
= hol
->clusters
;
477 struct hol_cluster
*next
= cl
->next
;
482 if (hol
->num_entries
> 0)
485 free (hol
->short_options
);
492 hol_entry_short_iterate (const struct hol_entry
*entry
,
493 int (*func
)(const struct argp_option
*opt
,
494 const struct argp_option
*real
,
500 const struct argp_option
*opt
, *real
= entry
->opt
;
501 char *so
= entry
->short_options
;
503 for (opt
= real
, nopts
= entry
->num
; nopts
> 0 && !val
; opt
++, nopts
--)
504 if (oshort (opt
) && *so
== opt
->key
)
509 val
= (*func
)(opt
, real
, cookie
);
517 hol_entry_long_iterate (const struct hol_entry
*entry
,
518 int (*func
)(const struct argp_option
*opt
,
519 const struct argp_option
*real
,
525 const struct argp_option
*opt
, *real
= entry
->opt
;
527 for (opt
= real
, nopts
= entry
->num
; nopts
> 0 && !val
; opt
++, nopts
--)
533 val
= (*func
)(opt
, real
, cookie
);
539 /* Iterator that returns true for the first short option. */
541 until_short (const struct argp_option
*opt
, const struct argp_option
*real
,
544 return oshort (opt
) ? opt
->key
: 0;
547 /* Returns the first valid short option in ENTRY, or 0 if there is none. */
549 hol_entry_first_short (const struct hol_entry
*entry
)
551 return hol_entry_short_iterate (entry
, until_short
, 0);
554 /* Returns the first valid long option in ENTRY, or 0 if there is none. */
556 hol_entry_first_long (const struct hol_entry
*entry
)
558 const struct argp_option
*opt
;
560 for (opt
= entry
->opt
, num
= entry
->num
; num
> 0; opt
++, num
--)
561 if (opt
->name
&& ovisible (opt
))
566 /* Returns the entry in HOL with the long option name NAME, or 0 if there is
568 static struct hol_entry
*
569 hol_find_entry (struct hol
*hol
, const char *name
)
571 struct hol_entry
*entry
= hol
->entries
;
572 unsigned num_entries
= hol
->num_entries
;
574 while (num_entries
-- > 0)
576 const struct argp_option
*opt
= entry
->opt
;
577 unsigned num_opts
= entry
->num
;
579 while (num_opts
-- > 0)
580 if (opt
->name
&& ovisible (opt
) && strcmp (opt
->name
, name
) == 0)
591 /* If an entry with the long option NAME occurs in HOL, set it's special
592 sort position to GROUP. */
594 hol_set_group (struct hol
*hol
, const char *name
, int group
)
596 struct hol_entry
*entry
= hol_find_entry (hol
, name
);
598 entry
->group
= group
;
601 /* Order by group: 0, 1, 2, ..., n, -m, ..., -2, -1.
602 EQ is what to return if GROUP1 and GROUP2 are the same. */
604 group_cmp (int group1
, int group2
, int eq
)
606 if (group1
== group2
)
608 else if ((group1
< 0 && group2
< 0) || (group1
>= 0 && group2
>= 0))
609 return group1
- group2
;
611 return group2
- group1
;
614 /* Compare clusters CL1 & CL2 by the order that they should appear in
617 hol_cluster_cmp (const struct hol_cluster
*cl1
, const struct hol_cluster
*cl2
)
619 /* If one cluster is deeper than the other, use its ancestor at the same
620 level, so that finding the common ancestor is straightforward. */
621 while (cl1
->depth
< cl2
->depth
)
623 while (cl2
->depth
< cl1
->depth
)
626 /* Now reduce both clusters to their ancestors at the point where both have
627 a common parent; these can be directly compared. */
628 while (cl1
->parent
!= cl2
->parent
)
629 cl1
= cl1
->parent
, cl2
= cl2
->parent
;
631 return group_cmp (cl1
->group
, cl2
->group
, cl2
->index
- cl1
->index
);
634 /* Return the ancestor of CL that's just below the root (i.e., has a parent
636 static struct hol_cluster
*
637 hol_cluster_base (struct hol_cluster
*cl
)
644 /* Return true if CL1 is a child of CL2. */
646 hol_cluster_is_child (const struct hol_cluster
*cl1
,
647 const struct hol_cluster
*cl2
)
649 while (cl1
&& cl1
!= cl2
)
654 /* Given the name of a OPTION_DOC option, modifies NAME to start at the tail
655 that should be used for comparisons, and returns true iff it should be
656 treated as a non-option. */
658 canon_doc_option (const char **name
)
661 /* Skip initial whitespace. */
662 while (isspace (**name
))
664 /* Decide whether this looks like an option (leading `-') or not. */
665 non_opt
= (**name
!= '-');
666 /* Skip until part of name used for sorting. */
667 while (**name
&& !isalnum (**name
))
672 /* Order ENTRY1 & ENTRY2 by the order which they should appear in a help
675 hol_entry_cmp (const struct hol_entry
*entry1
, const struct hol_entry
*entry2
)
677 /* The group numbers by which the entries should be ordered; if either is
678 in a cluster, then this is just the group within the cluster. */
679 int group1
= entry1
->group
, group2
= entry2
->group
;
681 if (entry1
->cluster
!= entry2
->cluster
)
682 /* The entries are not within the same cluster, so we can't compare them
683 directly, we have to use the appropiate clustering level too. */
684 if (! entry1
->cluster
)
685 /* ENTRY1 is at the `base level', not in a cluster, so we have to
686 compare it's group number with that of the base cluster in which
687 ENTRY2 resides. Note that if they're in the same group, the
688 clustered option always comes laster. */
689 return group_cmp (group1
, hol_cluster_base (entry2
->cluster
)->group
, -1);
690 else if (! entry2
->cluster
)
691 /* Likewise, but ENTRY2's not in a cluster. */
692 return group_cmp (hol_cluster_base (entry1
->cluster
)->group
, group2
, 1);
694 /* Both entries are in clusters, we can just compare the clusters. */
695 return hol_cluster_cmp (entry1
->cluster
, entry2
->cluster
);
696 else if (group1
== group2
)
697 /* The entries are both in the same cluster and group, so compare them
700 int short1
= hol_entry_first_short (entry1
);
701 int short2
= hol_entry_first_short (entry2
);
702 int doc1
= odoc (entry1
->opt
);
703 int doc2
= odoc (entry2
->opt
);
704 const char *long1
= hol_entry_first_long (entry1
);
705 const char *long2
= hol_entry_first_long (entry2
);
708 doc1
= canon_doc_option (&long1
);
710 doc2
= canon_doc_option (&long2
);
713 /* `documentation' options always follow normal options (or
714 documentation options that *look* like normal options). */
716 else if (!short1
&& !short2
&& long1
&& long2
)
717 /* Only long options. */
718 return __strcasecmp (long1
, long2
);
720 /* Compare short/short, long/short, short/long, using the first
721 character of long options. Entries without *any* valid
722 options (such as options with OPTION_HIDDEN set) will be put
723 first, but as they're not displayed, it doesn't matter where
726 char first1
= short1
? short1
: long1
? *long1
: 0;
727 char first2
= short2
? short2
: long2
? *long2
: 0;
728 int lower_cmp
= tolower (first1
) - tolower (first2
);
729 /* Compare ignoring case, except when the options are both the
730 same letter, in which case lower-case always comes first. */
731 return lower_cmp
? lower_cmp
: first2
- first1
;
735 /* Within the same cluster, but not the same group, so just compare
737 return group_cmp (group1
, group2
, 0);
740 /* Version of hol_entry_cmp with correct signature for qsort. */
742 hol_entry_qcmp (const void *entry1_v
, const void *entry2_v
)
744 return hol_entry_cmp (entry1_v
, entry2_v
);
747 /* Sort HOL by group and alphabetically by option name (with short options
748 taking precedence over long). Since the sorting is for display purposes
749 only, the shadowing of options isn't effected. */
751 hol_sort (struct hol
*hol
)
753 if (hol
->num_entries
> 0)
754 qsort (hol
->entries
, hol
->num_entries
, sizeof (struct hol_entry
),
758 /* Append MORE to HOL, destroying MORE in the process. Options in HOL shadow
759 any in MORE with the same name. */
761 hol_append (struct hol
*hol
, struct hol
*more
)
763 struct hol_cluster
**cl_end
= &hol
->clusters
;
765 /* Steal MORE's cluster list, and add it to the end of HOL's. */
767 cl_end
= &(*cl_end
)->next
;
768 *cl_end
= more
->clusters
;
772 if (more
->num_entries
> 0)
773 if (hol
->num_entries
== 0)
775 hol
->num_entries
= more
->num_entries
;
776 hol
->entries
= more
->entries
;
777 hol
->short_options
= more
->short_options
;
778 more
->num_entries
= 0; /* Mark MORE's fields as invalid. */
781 /* append the entries in MORE to those in HOL, taking care to only add
782 non-shadowed SHORT_OPTIONS values. */
787 unsigned num_entries
= hol
->num_entries
+ more
->num_entries
;
788 struct hol_entry
*entries
=
789 malloc (num_entries
* sizeof (struct hol_entry
));
790 unsigned hol_so_len
= strlen (hol
->short_options
);
791 char *short_options
=
792 malloc (hol_so_len
+ strlen (more
->short_options
) + 1);
794 memcpy (entries
, hol
->entries
,
795 hol
->num_entries
* sizeof (struct hol_entry
));
796 memcpy (entries
+ hol
->num_entries
, more
->entries
,
797 more
->num_entries
* sizeof (struct hol_entry
));
799 memcpy (short_options
, hol
->short_options
, hol_so_len
);
801 /* Fix up the short options pointers from HOL. */
802 for (e
= entries
, left
= hol
->num_entries
; left
> 0; e
++, left
--)
803 e
->short_options
+= (short_options
- hol
->short_options
);
805 /* Now add the short options from MORE, fixing up its entries too. */
806 so
= short_options
+ hol_so_len
;
807 more_so
= more
->short_options
;
808 for (left
= more
->num_entries
; left
> 0; e
++, left
--)
811 const struct argp_option
*opt
;
813 e
->short_options
= so
;
815 for (opts_left
= e
->num
, opt
= e
->opt
; opts_left
; opt
++, opts_left
--)
818 if (oshort (opt
) && ch
== opt
->key
)
819 /* The next short option in MORE_SO, CH, is from OPT. */
821 if (! find_char (ch
, short_options
,
822 short_options
+ hol_so_len
))
823 /* The short option CH isn't shadowed by HOL's options,
824 so add it to the sum. */
834 free (hol
->short_options
);
836 hol
->entries
= entries
;
837 hol
->num_entries
= num_entries
;
838 hol
->short_options
= short_options
;
844 /* Inserts enough spaces to make sure STREAM is at column COL. */
846 indent_to (argp_fmtstream_t stream
, unsigned col
)
848 int needed
= col
- __argp_fmtstream_point (stream
);
850 __argp_fmtstream_putc (stream
, ' ');
853 /* Output to STREAM either a space, or a newline if there isn't room for at
854 least ENSURE characters before the right margin. */
856 space (argp_fmtstream_t stream
, size_t ensure
)
858 if (__argp_fmtstream_point (stream
) + ensure
859 >= __argp_fmtstream_rmargin (stream
))
860 __argp_fmtstream_putc (stream
, '\n');
862 __argp_fmtstream_putc (stream
, ' ');
865 /* If the option REAL has an argument, we print it in using the printf
866 format REQ_FMT or OPT_FMT depending on whether it's a required or
867 optional argument. */
869 arg (const struct argp_option
*real
, const char *req_fmt
, const char *opt_fmt
,
870 argp_fmtstream_t stream
)
873 if (real
->flags
& OPTION_ARG_OPTIONAL
)
874 __argp_fmtstream_printf (stream
, opt_fmt
, gettext (real
->arg
));
876 __argp_fmtstream_printf (stream
, req_fmt
, gettext (real
->arg
));
879 /* Helper functions for hol_entry_help. */
881 /* State used during the execution of hol_help. */
882 struct hol_help_state
884 /* PREV_ENTRY should contain the previous entry printed, or 0. */
885 struct hol_entry
*prev_entry
;
887 /* If an entry is in a different group from the previous one, and SEP_GROUPS
888 is true, then a blank line will be printed before any output. */
891 /* True if a duplicate option argument was suppressed (only ever set if
892 UPARAMS.dup_args is false). */
893 int suppressed_dup_arg
;
896 /* Some state used while printing a help entry (used to communicate with
897 helper functions). See the doc for hol_entry_help for more info, as most
898 of the fields are copied from its arguments. */
901 const struct hol_entry
*entry
;
902 argp_fmtstream_t stream
;
903 struct hol_help_state
*hhstate
;
905 /* True if nothing's been printed so far. */
908 /* If non-zero, the state that was used to print this help. */
909 const struct argp_state
*state
;
912 /* If a user doc filter should be applied to DOC, do so. */
914 filter_doc (const char *doc
, int key
, const struct argp
*argp
,
915 const struct argp_state
*state
)
917 if (argp
->help_filter
)
918 /* We must apply a user filter to this output. */
920 void *input
= __argp_input (argp
, state
);
921 return (*argp
->help_filter
) (key
, doc
, input
);
928 /* Prints STR as a header line, with the margin lines set appropiately, and
929 notes the fact that groups should be separated with a blank line. ARGP is
930 the argp that should dictate any user doc filtering to take place. Note
931 that the previous wrap margin isn't restored, but the left margin is reset
934 print_header (const char *str
, const struct argp
*argp
,
935 struct pentry_state
*pest
)
937 const char *tstr
= gettext (str
);
938 const char *fstr
= filter_doc (tstr
, ARGP_KEY_HELP_HEADER
, argp
, pest
->state
);
944 if (pest
->hhstate
->prev_entry
)
945 /* Precede with a blank line. */
946 __argp_fmtstream_putc (pest
->stream
, '\n');
947 indent_to (pest
->stream
, uparams
.header_col
);
948 __argp_fmtstream_set_lmargin (pest
->stream
, uparams
.header_col
);
949 __argp_fmtstream_set_wmargin (pest
->stream
, uparams
.header_col
);
950 __argp_fmtstream_puts (pest
->stream
, fstr
);
951 __argp_fmtstream_set_lmargin (pest
->stream
, 0);
952 __argp_fmtstream_putc (pest
->stream
, '\n');
955 pest
->hhstate
->sep_groups
= 1; /* Separate subsequent groups. */
959 free ((char *) fstr
);
962 /* Inserts a comma if this isn't the first item on the line, and then makes
963 sure we're at least to column COL. If this *is* the first item on a line,
964 prints any pending whitespace/headers that should precede this line. Also
967 comma (unsigned col
, struct pentry_state
*pest
)
971 const struct hol_entry
*pe
= pest
->hhstate
->prev_entry
;
972 const struct hol_cluster
*cl
= pest
->entry
->cluster
;
974 if (pest
->hhstate
->sep_groups
&& pe
&& pest
->entry
->group
!= pe
->group
)
975 __argp_fmtstream_putc (pest
->stream
, '\n');
977 if (cl
&& cl
->header
&& *cl
->header
979 || (pe
->cluster
!= cl
980 && !hol_cluster_is_child (pe
->cluster
, cl
))))
981 /* If we're changing clusters, then this must be the start of the
982 ENTRY's cluster unless that is an ancestor of the previous one
983 (in which case we had just popped into a sub-cluster for a bit).
984 If so, then print the cluster's header line. */
986 int old_wm
= __argp_fmtstream_wmargin (pest
->stream
);
987 print_header (cl
->header
, cl
->argp
, pest
);
988 __argp_fmtstream_set_wmargin (pest
->stream
, old_wm
);
994 __argp_fmtstream_puts (pest
->stream
, ", ");
996 indent_to (pest
->stream
, col
);
999 /* Print help for ENTRY to STREAM. */
1001 hol_entry_help (struct hol_entry
*entry
, const struct argp_state
*state
,
1002 argp_fmtstream_t stream
, struct hol_help_state
*hhstate
)
1005 const struct argp_option
*real
= entry
->opt
, *opt
;
1006 char *so
= entry
->short_options
;
1007 int have_long_opt
= 0; /* We have any long options. */
1008 /* Saved margins. */
1009 int old_lm
= __argp_fmtstream_set_lmargin (stream
, 0);
1010 int old_wm
= __argp_fmtstream_wmargin (stream
);
1011 /* PEST is a state block holding some of our variables that we'd like to
1012 share with helper functions. */
1013 struct pentry_state pest
= { entry
, stream
, hhstate
, 1, state
};
1016 for (opt
= real
, num
= entry
->num
; num
> 0; opt
++, num
--)
1017 if (opt
->name
&& ovisible (opt
))
1023 /* First emit short options. */
1024 __argp_fmtstream_set_wmargin (stream
, uparams
.short_opt_col
); /* For truly bizarre cases. */
1025 for (opt
= real
, num
= entry
->num
; num
> 0; opt
++, num
--)
1026 if (oshort (opt
) && opt
->key
== *so
)
1027 /* OPT has a valid (non shadowed) short option. */
1031 comma (uparams
.short_opt_col
, &pest
);
1032 __argp_fmtstream_putc (stream
, '-');
1033 __argp_fmtstream_putc (stream
, *so
);
1034 if (!have_long_opt
|| uparams
.dup_args
)
1035 arg (real
, " %s", "[%s]", stream
);
1037 hhstate
->suppressed_dup_arg
= 1;
1042 /* Now, long options. */
1044 /* A `documentation' option. */
1046 __argp_fmtstream_set_wmargin (stream
, uparams
.doc_opt_col
);
1047 for (opt
= real
, num
= entry
->num
; num
> 0; opt
++, num
--)
1048 if (opt
->name
&& ovisible (opt
))
1050 comma (uparams
.doc_opt_col
, &pest
);
1051 /* Calling gettext here isn't quite right, since sorting will
1052 have been done on the original; but documentation options
1053 should be pretty rare anyway... */
1054 __argp_fmtstream_puts (stream
, gettext (opt
->name
));
1058 /* A real long option. */
1060 int first_long_opt
= 1;
1062 __argp_fmtstream_set_wmargin (stream
, uparams
.long_opt_col
);
1063 for (opt
= real
, num
= entry
->num
; num
> 0; opt
++, num
--)
1064 if (opt
->name
&& ovisible (opt
))
1066 comma (uparams
.long_opt_col
, &pest
);
1067 __argp_fmtstream_printf (stream
, "--%s", opt
->name
);
1068 if (first_long_opt
|| uparams
.dup_args
)
1069 arg (real
, "=%s", "[=%s]", stream
);
1071 hhstate
->suppressed_dup_arg
= 1;
1075 /* Next, documentation strings. */
1076 __argp_fmtstream_set_lmargin (stream
, 0);
1079 /* Didn't print any switches, what's up? */
1080 if (!oshort (real
) && !real
->name
)
1081 /* This is a group header, print it nicely. */
1082 print_header (real
->doc
, entry
->argp
, &pest
);
1084 /* Just a totally shadowed option or null header; print nothing. */
1085 goto cleanup
; /* Just return, after cleaning up. */
1088 const char *tstr
= real
->doc
? gettext (real
->doc
) : 0;
1089 const char *fstr
= filter_doc (tstr
, real
->key
, entry
->argp
, state
);
1092 unsigned int col
= __argp_fmtstream_point (stream
);
1094 __argp_fmtstream_set_lmargin (stream
, uparams
.opt_doc_col
);
1095 __argp_fmtstream_set_wmargin (stream
, uparams
.opt_doc_col
);
1097 if (col
> (unsigned int) (uparams
.opt_doc_col
+ 3))
1098 __argp_fmtstream_putc (stream
, '\n');
1099 else if (col
>= (unsigned int) uparams
.opt_doc_col
)
1100 __argp_fmtstream_puts (stream
, " ");
1102 indent_to (stream
, uparams
.opt_doc_col
);
1104 __argp_fmtstream_puts (stream
, fstr
);
1106 if (fstr
&& fstr
!= tstr
)
1107 free ((char *) fstr
);
1109 /* Reset the left margin. */
1110 __argp_fmtstream_set_lmargin (stream
, 0);
1111 __argp_fmtstream_putc (stream
, '\n');
1114 hhstate
->prev_entry
= entry
;
1117 __argp_fmtstream_set_lmargin (stream
, old_lm
);
1118 __argp_fmtstream_set_wmargin (stream
, old_wm
);
1121 /* Output a long help message about the options in HOL to STREAM. */
1123 hol_help (struct hol
*hol
, const struct argp_state
*state
,
1124 argp_fmtstream_t stream
)
1127 struct hol_entry
*entry
;
1128 struct hol_help_state hhstate
= { 0, 0, 0 };
1130 for (entry
= hol
->entries
, num
= hol
->num_entries
; num
> 0; entry
++, num
--)
1131 hol_entry_help (entry
, state
, stream
, &hhstate
);
1133 if (hhstate
.suppressed_dup_arg
&& uparams
.dup_args_note
)
1135 const char *tstr
= _("\
1136 Mandatory or optional arguments to long options are also mandatory or \
1137 optional for any corresponding short options.");
1138 const char *fstr
= filter_doc (tstr
, ARGP_KEY_HELP_DUP_ARGS_NOTE
,
1139 state
? state
->root_argp
: 0, state
);
1142 __argp_fmtstream_putc (stream
, '\n');
1143 __argp_fmtstream_puts (stream
, fstr
);
1144 __argp_fmtstream_putc (stream
, '\n');
1146 if (fstr
&& fstr
!= tstr
)
1147 free ((char *) fstr
);
1151 /* Helper functions for hol_usage. */
1153 /* If OPT is a short option without an arg, append its key to the string
1154 pointer pointer to by COOKIE, and advance the pointer. */
1156 add_argless_short_opt (const struct argp_option
*opt
,
1157 const struct argp_option
*real
,
1160 char **snao_end
= cookie
;
1161 if (!(opt
->arg
|| real
->arg
)
1162 && !((opt
->flags
| real
->flags
) & OPTION_NO_USAGE
))
1163 *(*snao_end
)++ = opt
->key
;
1167 /* If OPT is a short option with an arg, output a usage entry for it to the
1168 stream pointed at by COOKIE. */
1170 usage_argful_short_opt (const struct argp_option
*opt
,
1171 const struct argp_option
*real
,
1174 argp_fmtstream_t stream
= cookie
;
1175 const char *arg
= opt
->arg
;
1176 int flags
= opt
->flags
| real
->flags
;
1181 if (arg
&& !(flags
& OPTION_NO_USAGE
))
1183 arg
= gettext (arg
);
1185 if (flags
& OPTION_ARG_OPTIONAL
)
1186 __argp_fmtstream_printf (stream
, " [-%c[%s]]", opt
->key
, arg
);
1189 /* Manually do line wrapping so that it (probably) won't
1190 get wrapped at the embedded space. */
1191 space (stream
, 6 + strlen (arg
));
1192 __argp_fmtstream_printf (stream
, "[-%c %s]", opt
->key
, arg
);
1199 /* Output a usage entry for the long option opt to the stream pointed at by
1202 usage_long_opt (const struct argp_option
*opt
,
1203 const struct argp_option
*real
,
1206 argp_fmtstream_t stream
= cookie
;
1207 const char *arg
= opt
->arg
;
1208 int flags
= opt
->flags
| real
->flags
;
1213 if (! (flags
& OPTION_NO_USAGE
))
1216 arg
= gettext (arg
);
1217 if (flags
& OPTION_ARG_OPTIONAL
)
1218 __argp_fmtstream_printf (stream
, " [--%s[=%s]]", opt
->name
, arg
);
1220 __argp_fmtstream_printf (stream
, " [--%s=%s]", opt
->name
, arg
);
1223 __argp_fmtstream_printf (stream
, " [--%s]", opt
->name
);
1228 /* Print a short usage description for the arguments in HOL to STREAM. */
1230 hol_usage (struct hol
*hol
, argp_fmtstream_t stream
)
1232 if (hol
->num_entries
> 0)
1235 struct hol_entry
*entry
;
1236 char *short_no_arg_opts
= alloca (strlen (hol
->short_options
) + 1);
1237 char *snao_end
= short_no_arg_opts
;
1239 /* First we put a list of short options without arguments. */
1240 for (entry
= hol
->entries
, nentries
= hol
->num_entries
1242 ; entry
++, nentries
--)
1243 hol_entry_short_iterate (entry
, add_argless_short_opt
, &snao_end
);
1244 if (snao_end
> short_no_arg_opts
)
1247 __argp_fmtstream_printf (stream
, " [-%s]", short_no_arg_opts
);
1250 /* Now a list of short options *with* arguments. */
1251 for (entry
= hol
->entries
, nentries
= hol
->num_entries
1253 ; entry
++, nentries
--)
1254 hol_entry_short_iterate (entry
, usage_argful_short_opt
, stream
);
1256 /* Finally, a list of long options (whew!). */
1257 for (entry
= hol
->entries
, nentries
= hol
->num_entries
1259 ; entry
++, nentries
--)
1260 hol_entry_long_iterate (entry
, usage_long_opt
, stream
);
1264 /* Make a HOL containing all levels of options in ARGP. CLUSTER is the
1265 cluster in which ARGP's entries should be clustered, or 0. */
1267 argp_hol (const struct argp
*argp
, struct hol_cluster
*cluster
)
1269 const struct argp_child
*child
= argp
->children
;
1270 struct hol
*hol
= make_hol (argp
, cluster
);
1274 struct hol_cluster
*child_cluster
=
1275 ((child
->group
|| child
->header
)
1276 /* Put CHILD->argp within its own cluster. */
1277 ? hol_add_cluster (hol
, child
->group
, child
->header
,
1278 child
- argp
->children
, cluster
, argp
)
1279 /* Just merge it into the parent's cluster. */
1281 hol_append (hol
, argp_hol (child
->argp
, child_cluster
)) ;
1287 /* Calculate how many different levels with alternative args strings exist in
1290 argp_args_levels (const struct argp
*argp
)
1293 const struct argp_child
*child
= argp
->children
;
1295 if (argp
->args_doc
&& strchr (argp
->args_doc
, '\n'))
1300 levels
+= argp_args_levels ((child
++)->argp
);
1305 /* Print all the non-option args documented in ARGP to STREAM. Any output is
1306 preceded by a space. LEVELS is a pointer to a byte vector the length
1307 returned by argp_args_levels; it should be initialized to zero, and
1308 updated by this routine for the next call if ADVANCE is true. True is
1309 returned as long as there are more patterns to output. */
1311 argp_args_usage (const struct argp
*argp
, const struct argp_state
*state
,
1312 char **levels
, int advance
, argp_fmtstream_t stream
)
1314 char *our_level
= *levels
;
1316 const struct argp_child
*child
= argp
->children
;
1317 const char *tdoc
= gettext (argp
->args_doc
), *nl
= 0;
1318 const char *fdoc
= filter_doc (tdoc
, ARGP_KEY_HELP_ARGS_DOC
, argp
, state
);
1322 nl
= strchr (fdoc
, '\n');
1324 /* This is a `multi-level' args doc; advance to the correct position
1325 as determined by our state in LEVELS, and update LEVELS. */
1329 for (i
= 0; i
< *our_level
; i
++)
1330 fdoc
= nl
+ 1, nl
= strchr (fdoc
, '\n');
1334 nl
= fdoc
+ strlen (fdoc
);
1336 /* Manually do line wrapping so that it (probably) won't get wrapped at
1337 any embedded spaces. */
1338 space (stream
, 1 + nl
- fdoc
);
1340 __argp_fmtstream_write (stream
, fdoc
, nl
- fdoc
);
1342 if (fdoc
&& fdoc
!= tdoc
)
1343 free ((char *)fdoc
); /* Free user's modified doc string. */
1347 advance
= !argp_args_usage ((child
++)->argp
, state
, levels
, advance
, stream
);
1349 if (advance
&& multiple
)
1350 /* Need to increment our level. */
1352 /* There's more we can do here. */
1355 advance
= 0; /* Our parent shouldn't advance also. */
1357 else if (*our_level
> 0)
1358 /* We had multiple levels, but used them up; reset to zero. */
1364 /* Print the documentation for ARGP to STREAM; if POST is false, then
1365 everything preceeding a `\v' character in the documentation strings (or
1366 the whole string, for those with none) is printed, otherwise, everything
1367 following the `\v' character (nothing for strings without). Each separate
1368 bit of documentation is separated a blank line, and if PRE_BLANK is true,
1369 then the first is as well. If FIRST_ONLY is true, only the first
1370 occurance is output. Returns true if anything was output. */
1372 argp_doc (const struct argp
*argp
, const struct argp_state
*state
,
1373 int post
, int pre_blank
, int first_only
,
1374 argp_fmtstream_t stream
)
1377 const char *inp_text
;
1380 size_t inp_text_limit
= 0;
1381 const char *doc
= gettext (argp
->doc
);
1382 const struct argp_child
*child
= argp
->children
;
1386 char *vt
= strchr (doc
, '\v');
1387 inp_text
= post
? (vt
? vt
+ 1 : 0) : doc
;
1388 inp_text_limit
= (!post
&& vt
) ? (vt
- doc
) : 0;
1393 if (argp
->help_filter
)
1394 /* We have to filter the doc strings. */
1397 /* Copy INP_TEXT so that it's nul-terminated. */
1398 inp_text
= strndup (inp_text
, inp_text_limit
);
1399 input
= __argp_input (argp
, state
);
1401 (*argp
->help_filter
) (post
1402 ? ARGP_KEY_HELP_POST_DOC
1403 : ARGP_KEY_HELP_PRE_DOC
,
1407 text
= (const char *) inp_text
;
1412 __argp_fmtstream_putc (stream
, '\n');
1414 if (text
== inp_text
&& inp_text_limit
)
1415 __argp_fmtstream_write (stream
, inp_text
, inp_text_limit
);
1417 __argp_fmtstream_puts (stream
, text
);
1419 if (__argp_fmtstream_point (stream
) > __argp_fmtstream_lmargin (stream
))
1420 __argp_fmtstream_putc (stream
, '\n');
1425 if (text
&& text
!= inp_text
)
1426 free ((char *) text
); /* Free TEXT returned from the help filter. */
1427 if (inp_text
&& inp_text_limit
&& argp
->help_filter
)
1428 free ((char *) inp_text
); /* We copied INP_TEXT, so free it now. */
1430 if (post
&& argp
->help_filter
)
1431 /* Now see if we have to output a ARGP_KEY_HELP_EXTRA text. */
1433 text
= (*argp
->help_filter
) (ARGP_KEY_HELP_EXTRA
, 0, input
);
1436 if (anything
|| pre_blank
)
1437 __argp_fmtstream_putc (stream
, '\n');
1438 __argp_fmtstream_puts (stream
, text
);
1439 free ((char *) text
);
1440 if (__argp_fmtstream_point (stream
)
1441 > __argp_fmtstream_lmargin (stream
))
1442 __argp_fmtstream_putc (stream
, '\n');
1448 while (child
->argp
&& !(first_only
&& anything
))
1450 argp_doc ((child
++)->argp
, state
,
1451 post
, anything
|| pre_blank
, first_only
,
1457 /* Output a usage message for ARGP to STREAM. If called from
1458 argp_state_help, STATE is the relevent parsing state. FLAGS are from the
1459 set ARGP_HELP_*. NAME is what to use wherever a `program name' is
1462 _help (const struct argp
*argp
, const struct argp_state
*state
, FILE *stream
,
1463 unsigned flags
, char *name
)
1465 int anything
= 0; /* Whether we've output anything. */
1466 struct hol
*hol
= 0;
1467 argp_fmtstream_t fs
;
1472 if (! uparams
.valid
)
1473 fill_in_uparams (state
);
1475 fs
= __argp_make_fmtstream (stream
, 0, uparams
.rmargin
, 0);
1479 if (flags
& (ARGP_HELP_USAGE
| ARGP_HELP_SHORT_USAGE
| ARGP_HELP_LONG
))
1481 hol
= argp_hol (argp
, 0);
1483 /* If present, these options always come last. */
1484 hol_set_group (hol
, "help", -1);
1485 hol_set_group (hol
, "version", -1);
1490 if (flags
& (ARGP_HELP_USAGE
| ARGP_HELP_SHORT_USAGE
))
1491 /* Print a short `Usage:' message. */
1493 int first_pattern
= 1, more_patterns
;
1494 size_t num_pattern_levels
= argp_args_levels (argp
);
1495 char *pattern_levels
= alloca (num_pattern_levels
);
1497 memset (pattern_levels
, 0, num_pattern_levels
);
1502 int old_wm
= __argp_fmtstream_set_wmargin (fs
, uparams
.usage_indent
);
1503 char *levels
= pattern_levels
;
1505 __argp_fmtstream_printf (fs
, "%s %s",
1506 _(first_pattern
? "Usage:" : " or: "),
1509 /* We set the lmargin as well as the wmargin, because hol_usage
1510 manually wraps options with newline to avoid annoying breaks. */
1511 old_lm
= __argp_fmtstream_set_lmargin (fs
, uparams
.usage_indent
);
1513 if (flags
& ARGP_HELP_SHORT_USAGE
)
1514 /* Just show where the options go. */
1516 if (hol
->num_entries
> 0)
1517 __argp_fmtstream_puts (fs
, _(" [OPTION...]"));
1520 /* Actually print the options. */
1522 hol_usage (hol
, fs
);
1523 flags
|= ARGP_HELP_SHORT_USAGE
; /* But only do so once. */
1526 more_patterns
= argp_args_usage (argp
, state
, &levels
, 1, fs
);
1528 __argp_fmtstream_set_wmargin (fs
, old_wm
);
1529 __argp_fmtstream_set_lmargin (fs
, old_lm
);
1531 __argp_fmtstream_putc (fs
, '\n');
1536 while (more_patterns
);
1539 if (flags
& ARGP_HELP_PRE_DOC
)
1540 anything
|= argp_doc (argp
, state
, 0, 0, 1, fs
);
1542 if (flags
& ARGP_HELP_SEE
)
1544 __argp_fmtstream_printf (fs
, _("\
1545 Try `%s --help' or `%s --usage' for more information.\n"),
1550 if (flags
& ARGP_HELP_LONG
)
1551 /* Print a long, detailed help message. */
1553 /* Print info about all the options. */
1554 if (hol
->num_entries
> 0)
1557 __argp_fmtstream_putc (fs
, '\n');
1558 hol_help (hol
, state
, fs
);
1563 if (flags
& ARGP_HELP_POST_DOC
)
1564 /* Print any documentation strings at the end. */
1565 anything
|= argp_doc (argp
, state
, 1, anything
, 0, fs
);
1567 if ((flags
& ARGP_HELP_BUG_ADDR
) && argp_program_bug_address
)
1570 __argp_fmtstream_putc (fs
, '\n');
1571 __argp_fmtstream_printf (fs
, _("Report bugs to %s.\n"),
1572 argp_program_bug_address
);
1579 __argp_fmtstream_free (fs
);
1582 /* Output a usage message for ARGP to STREAM. FLAGS are from the set
1583 ARGP_HELP_*. NAME is what to use wherever a `program name' is needed. */
1584 void __argp_help (const struct argp
*argp
, FILE *stream
,
1585 unsigned flags
, char *name
)
1587 _help (argp
, 0, stream
, flags
, name
);
1590 weak_alias (__argp_help
, argp_help
)
1593 /* Output, if appropriate, a usage message for STATE to STREAM. FLAGS are
1594 from the set ARGP_HELP_*. */
1596 __argp_state_help (const struct argp_state
*state
, FILE *stream
, unsigned flags
)
1598 if ((!state
|| ! (state
->flags
& ARGP_NO_ERRS
)) && stream
)
1600 if (state
&& (state
->flags
& ARGP_LONG_ONLY
))
1601 flags
|= ARGP_HELP_LONG_ONLY
;
1603 _help (state
? state
->root_argp
: 0, state
, stream
, flags
,
1604 state
? state
->name
: program_invocation_short_name
);
1606 if (!state
|| ! (state
->flags
& ARGP_NO_EXIT
))
1608 if (flags
& ARGP_HELP_EXIT_ERR
)
1609 exit (argp_err_exit_status
);
1610 if (flags
& ARGP_HELP_EXIT_OK
)
1616 weak_alias (__argp_state_help
, argp_state_help
)
1619 /* If appropriate, print the printf string FMT and following args, preceded
1620 by the program name and `:', to stderr, and followed by a `Try ... --help'
1621 message, then exit (1). */
1623 __argp_error (const struct argp_state
*state
, const char *fmt
, ...)
1625 if (!state
|| !(state
->flags
& ARGP_NO_ERRS
))
1627 FILE *stream
= state
? state
->err_stream
: stderr
;
1633 fputs (state
? state
->name
: program_invocation_short_name
, stream
);
1638 vfprintf (stream
, fmt
, ap
);
1641 putc ('\n', stream
);
1643 __argp_state_help (state
, stream
, ARGP_HELP_STD_ERR
);
1648 weak_alias (__argp_error
, argp_error
)
1651 /* Similar to the standard gnu error-reporting function error(), but will
1652 respect the ARGP_NO_EXIT and ARGP_NO_ERRS flags in STATE, and will print
1653 to STATE->err_stream. This is useful for argument parsing code that is
1654 shared between program startup (when exiting is desired) and runtime
1655 option parsing (when typically an error code is returned instead). The
1656 difference between this function and argp_error is that the latter is for
1657 *parsing errors*, and the former is for other problems that occur during
1658 parsing but don't reflect a (syntactic) problem with the input. */
1660 __argp_failure (const struct argp_state
*state
, int status
, int errnum
,
1661 const char *fmt
, ...)
1663 if (!state
|| !(state
->flags
& ARGP_NO_ERRS
))
1665 FILE *stream
= state
? state
->err_stream
: stderr
;
1669 fputs (state
? state
->name
: program_invocation_short_name
, stream
);
1679 vfprintf (stream
, fmt
, ap
);
1687 fputs (strerror (errnum
), stream
);
1690 putc ('\n', stream
);
1692 if (status
&& (!state
|| !(state
->flags
& ARGP_NO_EXIT
)))
1698 weak_alias (__argp_failure
, argp_failure
)