1 /* Hierarchial argument parsing help output
2 Copyright (C) 1995-2003, 2004, 2005 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 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 This program 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
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License along
17 with this program; if not, write to the Free Software Foundation,
18 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
21 # define _GNU_SOURCE 1
44 # define dgettext(domain, msgid) \
45 INTUSE(__dcgettext) (domain, msgid, LC_MESSAGES)
51 #include "argp-fmtstream.h"
52 #include "argp-namefrob.h"
55 # define SIZE_MAX ((size_t) -1)
58 /* User-selectable (using an environment variable) formatting parameters.
60 These may be specified in an environment variable called `ARGP_HELP_FMT',
61 with a contents like: VAR1=VAL1,VAR2=VAL2,BOOLVAR2,no-BOOLVAR2
62 Where VALn must be a positive integer. The list of variables is in the
63 UPARAM_NAMES vector, below. */
65 /* Default parameters. */
66 #define DUP_ARGS 0 /* True if option argument can be duplicated. */
67 #define DUP_ARGS_NOTE 1 /* True to print a note about duplicate args. */
68 #define SHORT_OPT_COL 2 /* column in which short options start */
69 #define LONG_OPT_COL 6 /* column in which long options start */
70 #define DOC_OPT_COL 2 /* column in which doc options start */
71 #define OPT_DOC_COL 29 /* column in which option text starts */
72 #define HEADER_COL 1 /* column in which group headers are printed */
73 #define USAGE_INDENT 12 /* indentation of wrapped usage lines */
74 #define RMARGIN 79 /* right margin used for wrapping */
76 /* User-selectable (using an environment variable) formatting parameters.
77 They must all be of type `int' for the parsing code to work. */
80 /* If true, arguments for an option are shown with both short and long
81 options, even when a given option has both, e.g. `-x ARG, --longx=ARG'.
82 If false, then if an option has both, the argument is only shown with
83 the long one, e.g., `-x, --longx=ARG', and a message indicating that
84 this really means both is printed below the options. */
87 /* This is true if when DUP_ARGS is false, and some duplicate arguments have
88 been suppressed, an explanatory message should be printed. */
91 /* Various output columns. */
92 int short_opt_col; /* column in which short options start */
93 int long_opt_col; /* column in which long options start */
94 int doc_opt_col; /* column in which doc options start */
95 int opt_doc_col; /* column in which option text starts */
96 int header_col; /* column in which group headers are printed */
97 int usage_indent; /* indentation of wrapped usage lines */
98 int rmargin; /* right margin used for wrapping */
100 int valid; /* True when the values in here are valid. */
103 /* This is a global variable, as user options are only ever read once. */
104 static struct uparams uparams = {
105 DUP_ARGS, DUP_ARGS_NOTE,
106 SHORT_OPT_COL, LONG_OPT_COL, DOC_OPT_COL, OPT_DOC_COL, HEADER_COL,
107 USAGE_INDENT, RMARGIN,
111 /* A particular uparam, and what the user name is. */
114 const char *name; /* User name. */
115 int is_bool; /* Whether it's `boolean'. */
116 size_t uparams_offs; /* Location of the (int) field in UPARAMS. */
119 /* The name-field mappings we know about. */
120 static const struct uparam_name uparam_names[] =
122 { "dup-args", 1, offsetof (struct uparams, dup_args) },
123 { "dup-args-note", 1, offsetof (struct uparams, dup_args_note) },
124 { "short-opt-col", 0, offsetof (struct uparams, short_opt_col) },
125 { "long-opt-col", 0, offsetof (struct uparams, long_opt_col) },
126 { "doc-opt-col", 0, offsetof (struct uparams, doc_opt_col) },
127 { "opt-doc-col", 0, offsetof (struct uparams, opt_doc_col) },
128 { "header-col", 0, offsetof (struct uparams, header_col) },
129 { "usage-indent", 0, offsetof (struct uparams, usage_indent) },
130 { "rmargin", 0, offsetof (struct uparams, rmargin) },
135 validate_uparams (const struct argp_state *state, struct uparams *upptr)
137 const struct uparam_name *up;
139 for (up = uparam_names; up->name; up++)
142 || up->uparams_offs == offsetof (struct uparams, rmargin))
144 if (*(int *)((char *)upptr + up->uparams_offs) >= upptr->rmargin)
146 __argp_failure (state, 0, 0,
147 dgettext (state->root_argp->argp_domain,
149 ARGP_HELP_FMT: %s value is less then or equal to %s"),
150 "rmargin", up->name);
158 /* Read user options from the environment, and fill in UPARAMS appropiately. */
160 fill_in_uparams (const struct argp_state *state)
162 const char *var = getenv ("ARGP_HELP_FMT");
163 struct uparams new_params = uparams;
165 #define SKIPWS(p) do { while (isspace (*p)) p++; } while (0);
177 const struct uparam_name *un;
178 int unspec = 0, val = 0;
179 const char *arg = var;
181 while (isalnum (*arg) || *arg == '-' || *arg == '_')
187 if (*arg == '\0' || *arg == ',')
189 else if (*arg == '=')
197 if (var[0] == 'n' && var[1] == 'o' && var[2] == '-')
206 else if (isdigit (*arg))
209 while (isdigit (*arg))
214 for (un = uparam_names; un->name; un++)
215 if (strlen (un->name) == var_len
216 && strncmp (var, un->name, var_len) == 0)
218 if (unspec && !un->is_bool)
219 __argp_failure (state, 0, 0,
220 dgettext (state->root_argp->argp_domain,
222 %.*s: ARGP_HELP_FMT parameter requires a value"),
225 __argp_failure (state, 0, 0,
226 dgettext (state->root_argp->argp_domain,
228 %.*s: ARGP_HELP_FMT parameter must be positive"),
231 *(int *)((char *)&new_params + un->uparams_offs) = val;
235 __argp_failure (state, 0, 0,
236 dgettext (state->root_argp->argp_domain, "\
237 %.*s: Unknown ARGP_HELP_FMT parameter"),
246 __argp_failure (state, 0, 0,
247 dgettext (state->root_argp->argp_domain,
248 "Garbage in ARGP_HELP_FMT: %s"), var);
252 validate_uparams (state, &new_params);
256 /* Returns true if OPT hasn't been marked invisible. Visibility only affects
257 whether OPT is displayed or used in sorting, not option shadowing. */
258 #define ovisible(opt) (! ((opt)->flags & OPTION_HIDDEN))
260 /* Returns true if OPT is an alias for an earlier option. */
261 #define oalias(opt) ((opt)->flags & OPTION_ALIAS)
263 /* Returns true if OPT is an documentation-only entry. */
264 #define odoc(opt) ((opt)->flags & OPTION_DOC)
266 /* Returns true if OPT should not be translated */
267 #define onotrans(opt) ((opt)->flags & OPTION_NO_TRANS)
269 /* Returns true if OPT is the end-of-list marker for a list of options. */
270 #define oend(opt) __option_is_end (opt)
272 /* Returns true if OPT has a short option. */
273 #define oshort(opt) __option_is_short (opt)
276 The help format for a particular option is like:
278 -xARG, -yARG, --long1=ARG, --long2=ARG Documentation...
280 Where ARG will be omitted if there's no argument, for this option, or
281 will be surrounded by "[" and "]" appropiately if the argument is
282 optional. The documentation string is word-wrapped appropiately, and if
283 the list of options is long enough, it will be started on a separate line.
284 If there are no short options for a given option, the first long option is
285 indented slighly in a way that's supposed to make most long options appear
286 to be in a separate column.
288 For example, the following output (from ps):
290 -p PID, --pid=PID List the process PID
291 --pgrp=PGRP List processes in the process group PGRP
292 -P, -x, --no-parent Include processes without parents
293 -Q, --all-fields Don't elide unusable fields (normally if there's
294 some reason ps can't print a field for any
295 process, it's removed from the output entirely)
296 -r, --reverse, --gratuitously-long-reverse-option
297 Reverse the order of any sort
298 --session[=SID] Add the processes from the session SID (which
299 defaults to the sid of the current process)
301 Here are some more options:
302 -f ZOT, --foonly=ZOT Glork a foonly
303 -z, --zaza Snit a zar
305 -?, --help Give this help list
306 --usage Give a short usage message
307 -V, --version Print program version
309 The struct argp_option array for the above could look like:
312 {"pid", 'p', "PID", 0, "List the process PID"},
313 {"pgrp", OPT_PGRP, "PGRP", 0, "List processes in the process group PGRP"},
314 {"no-parent", 'P', 0, 0, "Include processes without parents"},
315 {0, 'x', 0, OPTION_ALIAS},
316 {"all-fields",'Q', 0, 0, "Don't elide unusable fields (normally"
317 " if there's some reason ps can't"
318 " print a field for any process, it's"
319 " removed from the output entirely)" },
320 {"reverse", 'r', 0, 0, "Reverse the order of any sort"},
321 {"gratuitously-long-reverse-option", 0, 0, OPTION_ALIAS},
322 {"session", OPT_SESS, "SID", OPTION_ARG_OPTIONAL,
323 "Add the processes from the session"
324 " SID (which defaults to the sid of"
325 " the current process)" },
327 {0,0,0,0, "Here are some more options:"},
328 {"foonly", 'f', "ZOT", 0, "Glork a foonly"},
329 {"zaza", 'z', 0, 0, "Snit a zar"},
334 Note that the last three options are automatically supplied by argp_parse,
335 unless you tell it not to with ARGP_NO_HELP.
339 /* Returns true if CH occurs between BEG and END. */
341 find_char (char ch, char *beg, char *end)
351 struct hol_cluster; /* fwd decl */
356 const struct argp_option *opt;
357 /* Number of options (including aliases). */
360 /* A pointers into the HOL's short_options field, to the first short option
361 letter for this entry. The order of the characters following this point
362 corresponds to the order of options pointed to by OPT, and there are at
363 most NUM. A short option recorded in a option following OPT is only
364 valid if it occurs in the right place in SHORT_OPTIONS (otherwise it's
365 probably been shadowed by some other entry). */
368 /* Entries are sorted by their group first, in the order:
369 1, 2, ..., n, 0, -m, ..., -2, -1
370 and then alphabetically within each group. The default is 0. */
373 /* The cluster of options this entry belongs to, or 0 if none. */
374 struct hol_cluster *cluster;
376 /* The argp from which this option came. */
377 const struct argp *argp;
380 /* A cluster of entries to reflect the argp tree structure. */
383 /* A descriptive header printed before options in this cluster. */
386 /* Used to order clusters within the same group with the same parent,
387 according to the order in which they occurred in the parent argp's child
391 /* How to sort this cluster with respect to options and other clusters at the
392 same depth (clusters always follow options in the same group). */
395 /* The cluster to which this cluster belongs, or 0 if it's at the base
397 struct hol_cluster *parent;
399 /* The argp from which this cluster is (eventually) derived. */
400 const struct argp *argp;
402 /* The distance this cluster is from the root. */
405 /* Clusters in a given hol are kept in a linked list, to make freeing them
407 struct hol_cluster *next;
410 /* A list of options for help. */
413 /* An array of hol_entry's. */
414 struct hol_entry *entries;
415 /* The number of entries in this hol. If this field is zero, the others
417 unsigned num_entries;
419 /* A string containing all short options in this HOL. Each entry contains
420 pointers into this string, so the order can't be messed with blindly. */
423 /* Clusters of entries in this hol. */
424 struct hol_cluster *clusters;
427 /* Create a struct hol from the options in ARGP. CLUSTER is the
428 hol_cluster in which these entries occur, or 0, if at the root. */
430 make_hol (const struct argp *argp, struct hol_cluster *cluster)
433 const struct argp_option *o;
434 const struct argp_option *opts = argp->options;
435 struct hol_entry *entry;
436 unsigned num_short_options = 0;
437 struct hol *hol = malloc (sizeof (struct hol));
441 hol->num_entries = 0;
448 /* The first option must not be an alias. */
449 assert (! oalias (opts));
451 /* Calculate the space needed. */
452 for (o = opts; ! oend (o); o++)
457 num_short_options++; /* This is an upper bound. */
460 hol->entries = malloc (sizeof (struct hol_entry) * hol->num_entries);
461 hol->short_options = malloc (num_short_options + 1);
463 assert (hol->entries && hol->short_options);
464 if (SIZE_MAX <= UINT_MAX)
465 assert (hol->num_entries <= SIZE_MAX / sizeof (struct hol_entry));
467 /* Fill in the entries. */
468 so = hol->short_options;
469 for (o = opts, entry = hol->entries; ! oend (o); entry++)
473 entry->short_options = so;
474 entry->group = cur_group =
477 : ((!o->name && !o->key)
480 entry->cluster = cluster;
486 if (oshort (o) && ! find_char (o->key, hol->short_options, so))
487 /* O has a valid short option which hasn't already been used.*/
491 while (! oend (o) && oalias (o));
493 *so = '\0'; /* null terminated so we can find the length */
499 /* Add a new cluster to HOL, with the given GROUP and HEADER (taken from the
500 associated argp child list entry), INDEX, and PARENT, and return a pointer
501 to it. ARGP is the argp that this cluster results from. */
502 static struct hol_cluster *
503 hol_add_cluster (struct hol *hol, int group, const char *header, int index,
504 struct hol_cluster *parent, const struct argp *argp)
506 struct hol_cluster *cl = malloc (sizeof (struct hol_cluster));
515 cl->depth = parent ? parent->depth + 1 : 0;
517 cl->next = hol->clusters;
523 /* Free HOL and any resources it uses. */
525 hol_free (struct hol *hol)
527 struct hol_cluster *cl = hol->clusters;
531 struct hol_cluster *next = cl->next;
536 if (hol->num_entries > 0)
539 free (hol->short_options);
546 hol_entry_short_iterate (const struct hol_entry *entry,
547 int (*func)(const struct argp_option *opt,
548 const struct argp_option *real,
549 const char *domain, void *cookie),
550 const char *domain, void *cookie)
554 const struct argp_option *opt, *real = entry->opt;
555 char *so = entry->short_options;
557 for (opt = real, nopts = entry->num; nopts > 0 && !val; opt++, nopts--)
558 if (oshort (opt) && *so == opt->key)
563 val = (*func)(opt, real, domain, cookie);
571 __attribute__ ((always_inline))
572 hol_entry_long_iterate (const struct hol_entry *entry,
573 int (*func)(const struct argp_option *opt,
574 const struct argp_option *real,
575 const char *domain, void *cookie),
576 const char *domain, void *cookie)
580 const struct argp_option *opt, *real = entry->opt;
582 for (opt = real, nopts = entry->num; nopts > 0 && !val; opt++, nopts--)
588 val = (*func)(opt, real, domain, cookie);
594 /* Iterator that returns true for the first short option. */
596 until_short (const struct argp_option *opt, const struct argp_option *real,
597 const char *domain, void *cookie)
599 return oshort (opt) ? opt->key : 0;
602 /* Returns the first valid short option in ENTRY, or 0 if there is none. */
604 hol_entry_first_short (const struct hol_entry *entry)
606 return hol_entry_short_iterate (entry, until_short,
607 entry->argp->argp_domain, 0);
610 /* Returns the first valid long option in ENTRY, or 0 if there is none. */
612 hol_entry_first_long (const struct hol_entry *entry)
614 const struct argp_option *opt;
616 for (opt = entry->opt, num = entry->num; num > 0; opt++, num--)
617 if (opt->name && ovisible (opt))
622 /* Returns the entry in HOL with the long option name NAME, or 0 if there is
624 static struct hol_entry *
625 hol_find_entry (struct hol *hol, const char *name)
627 struct hol_entry *entry = hol->entries;
628 unsigned num_entries = hol->num_entries;
630 while (num_entries-- > 0)
632 const struct argp_option *opt = entry->opt;
633 unsigned num_opts = entry->num;
635 while (num_opts-- > 0)
636 if (opt->name && ovisible (opt) && strcmp (opt->name, name) == 0)
647 /* If an entry with the long option NAME occurs in HOL, set it's special
648 sort position to GROUP. */
650 hol_set_group (struct hol *hol, const char *name, int group)
652 struct hol_entry *entry = hol_find_entry (hol, name);
654 entry->group = group;
657 /* Order by group: 0, 1, 2, ..., n, -m, ..., -2, -1.
658 EQ is what to return if GROUP1 and GROUP2 are the same. */
660 group_cmp (int group1, int group2, int eq)
662 if (group1 == group2)
664 else if ((group1 < 0 && group2 < 0) || (group1 >= 0 && group2 >= 0))
665 return group1 - group2;
667 return group2 - group1;
670 /* Compare clusters CL1 & CL2 by the order that they should appear in
673 hol_cluster_cmp (const struct hol_cluster *cl1, const struct hol_cluster *cl2)
675 /* If one cluster is deeper than the other, use its ancestor at the same
676 level, so that finding the common ancestor is straightforward. */
677 while (cl1->depth < cl2->depth)
679 while (cl2->depth < cl1->depth)
682 /* Now reduce both clusters to their ancestors at the point where both have
683 a common parent; these can be directly compared. */
684 while (cl1->parent != cl2->parent)
685 cl1 = cl1->parent, cl2 = cl2->parent;
687 return group_cmp (cl1->group, cl2->group, cl2->index - cl1->index);
690 /* Return the ancestor of CL that's just below the root (i.e., has a parent
692 static struct hol_cluster *
693 hol_cluster_base (struct hol_cluster *cl)
700 /* Return true if CL1 is a child of CL2. */
702 hol_cluster_is_child (const struct hol_cluster *cl1,
703 const struct hol_cluster *cl2)
705 while (cl1 && cl1 != cl2)
710 /* Given the name of a OPTION_DOC option, modifies NAME to start at the tail
711 that should be used for comparisons, and returns true iff it should be
712 treated as a non-option. */
714 canon_doc_option (const char **name)
722 /* Skip initial whitespace. */
723 while (isspace (**name))
725 /* Decide whether this looks like an option (leading `-') or not. */
726 non_opt = (**name != '-');
727 /* Skip until part of name used for sorting. */
728 while (**name && !isalnum (**name))
734 /* Order ENTRY1 & ENTRY2 by the order which they should appear in a help
737 hol_entry_cmp (const struct hol_entry *entry1,
738 const struct hol_entry *entry2)
740 /* The group numbers by which the entries should be ordered; if either is
741 in a cluster, then this is just the group within the cluster. */
742 int group1 = entry1->group, group2 = entry2->group;
744 if (entry1->cluster != entry2->cluster)
746 /* The entries are not within the same cluster, so we can't compare them
747 directly, we have to use the appropiate clustering level too. */
748 if (! entry1->cluster)
749 /* ENTRY1 is at the `base level', not in a cluster, so we have to
750 compare it's group number with that of the base cluster in which
751 ENTRY2 resides. Note that if they're in the same group, the
752 clustered option always comes laster. */
753 return group_cmp (group1, hol_cluster_base (entry2->cluster)->group, -1);
754 else if (! entry2->cluster)
755 /* Likewise, but ENTRY2's not in a cluster. */
756 return group_cmp (hol_cluster_base (entry1->cluster)->group, group2, 1);
758 /* Both entries are in clusters, we can just compare the clusters. */
759 return hol_cluster_cmp (entry1->cluster, entry2->cluster);
761 else if (group1 == group2)
762 /* The entries are both in the same cluster and group, so compare them
765 int short1 = hol_entry_first_short (entry1);
766 int short2 = hol_entry_first_short (entry2);
767 int doc1 = odoc (entry1->opt);
768 int doc2 = odoc (entry2->opt);
769 const char *long1 = hol_entry_first_long (entry1);
770 const char *long2 = hol_entry_first_long (entry2);
773 doc1 = canon_doc_option (&long1);
775 doc2 = canon_doc_option (&long2);
778 /* `documentation' options always follow normal options (or
779 documentation options that *look* like normal options). */
781 else if (!short1 && !short2 && long1 && long2)
782 /* Only long options. */
783 return __strcasecmp (long1, long2);
785 /* Compare short/short, long/short, short/long, using the first
786 character of long options. Entries without *any* valid
787 options (such as options with OPTION_HIDDEN set) will be put
788 first, but as they're not displayed, it doesn't matter where
791 char first1 = short1 ? short1 : long1 ? *long1 : 0;
792 char first2 = short2 ? short2 : long2 ? *long2 : 0;
794 int lower_cmp = _tolower (first1) - _tolower (first2);
796 int lower_cmp = tolower (first1) - tolower (first2);
798 /* Compare ignoring case, except when the options are both the
799 same letter, in which case lower-case always comes first. */
800 return lower_cmp ? lower_cmp : first2 - first1;
804 /* Within the same cluster, but not the same group, so just compare
806 return group_cmp (group1, group2, 0);
809 /* Version of hol_entry_cmp with correct signature for qsort. */
811 hol_entry_qcmp (const void *entry1_v, const void *entry2_v)
813 return hol_entry_cmp (entry1_v, entry2_v);
816 /* Sort HOL by group and alphabetically by option name (with short options
817 taking precedence over long). Since the sorting is for display purposes
818 only, the shadowing of options isn't effected. */
820 hol_sort (struct hol *hol)
822 if (hol->num_entries > 0)
823 qsort (hol->entries, hol->num_entries, sizeof (struct hol_entry),
827 /* Append MORE to HOL, destroying MORE in the process. Options in HOL shadow
828 any in MORE with the same name. */
830 hol_append (struct hol *hol, struct hol *more)
832 struct hol_cluster **cl_end = &hol->clusters;
834 /* Steal MORE's cluster list, and add it to the end of HOL's. */
836 cl_end = &(*cl_end)->next;
837 *cl_end = more->clusters;
841 if (more->num_entries > 0)
843 if (hol->num_entries == 0)
845 hol->num_entries = more->num_entries;
846 hol->entries = more->entries;
847 hol->short_options = more->short_options;
848 more->num_entries = 0; /* Mark MORE's fields as invalid. */
851 /* Append the entries in MORE to those in HOL, taking care to only add
852 non-shadowed SHORT_OPTIONS values. */
857 unsigned num_entries = hol->num_entries + more->num_entries;
858 struct hol_entry *entries =
859 malloc (num_entries * sizeof (struct hol_entry));
860 unsigned hol_so_len = strlen (hol->short_options);
861 char *short_options =
862 malloc (hol_so_len + strlen (more->short_options) + 1);
864 assert (entries && short_options);
865 if (SIZE_MAX <= UINT_MAX)
866 assert (num_entries <= SIZE_MAX / sizeof (struct hol_entry));
868 __mempcpy (__mempcpy (entries, hol->entries,
869 hol->num_entries * sizeof (struct hol_entry)),
871 more->num_entries * sizeof (struct hol_entry));
873 __mempcpy (short_options, hol->short_options, hol_so_len);
875 /* Fix up the short options pointers from HOL. */
876 for (e = entries, left = hol->num_entries; left > 0; e++, left--)
877 e->short_options += (short_options - hol->short_options);
879 /* Now add the short options from MORE, fixing up its entries
881 so = short_options + hol_so_len;
882 more_so = more->short_options;
883 for (left = more->num_entries; left > 0; e++, left--)
886 const struct argp_option *opt;
888 e->short_options = so;
890 for (opts_left = e->num, opt = e->opt; opts_left; opt++, opts_left--)
893 if (oshort (opt) && ch == opt->key)
894 /* The next short option in MORE_SO, CH, is from OPT. */
896 if (! find_char (ch, short_options,
897 short_options + hol_so_len))
898 /* The short option CH isn't shadowed by HOL's options,
899 so add it to the sum. */
909 free (hol->short_options);
911 hol->entries = entries;
912 hol->num_entries = num_entries;
913 hol->short_options = short_options;
920 /* Inserts enough spaces to make sure STREAM is at column COL. */
922 indent_to (argp_fmtstream_t stream, unsigned col)
924 int needed = col - __argp_fmtstream_point (stream);
926 __argp_fmtstream_putc (stream, ' ');
929 /* Output to STREAM either a space, or a newline if there isn't room for at
930 least ENSURE characters before the right margin. */
932 space (argp_fmtstream_t stream, size_t ensure)
934 if (__argp_fmtstream_point (stream) + ensure
935 >= __argp_fmtstream_rmargin (stream))
936 __argp_fmtstream_putc (stream, '\n');
938 __argp_fmtstream_putc (stream, ' ');
941 /* If the option REAL has an argument, we print it in using the printf
942 format REQ_FMT or OPT_FMT depending on whether it's a required or
943 optional argument. */
945 arg (const struct argp_option *real, const char *req_fmt, const char *opt_fmt,
946 const char *domain, argp_fmtstream_t stream)
950 if (real->flags & OPTION_ARG_OPTIONAL)
951 __argp_fmtstream_printf (stream, opt_fmt,
952 dgettext (domain, real->arg));
954 __argp_fmtstream_printf (stream, req_fmt,
955 dgettext (domain, real->arg));
959 /* Helper functions for hol_entry_help. */
961 /* State used during the execution of hol_help. */
962 struct hol_help_state
964 /* PREV_ENTRY should contain the previous entry printed, or 0. */
965 struct hol_entry *prev_entry;
967 /* If an entry is in a different group from the previous one, and SEP_GROUPS
968 is true, then a blank line will be printed before any output. */
971 /* True if a duplicate option argument was suppressed (only ever set if
972 UPARAMS.dup_args is false). */
973 int suppressed_dup_arg;
976 /* Some state used while printing a help entry (used to communicate with
977 helper functions). See the doc for hol_entry_help for more info, as most
978 of the fields are copied from its arguments. */
981 const struct hol_entry *entry;
982 argp_fmtstream_t stream;
983 struct hol_help_state *hhstate;
985 /* True if nothing's been printed so far. */
988 /* If non-zero, the state that was used to print this help. */
989 const struct argp_state *state;
992 /* If a user doc filter should be applied to DOC, do so. */
994 filter_doc (const char *doc, int key, const struct argp *argp,
995 const struct argp_state *state)
997 if (argp->help_filter)
998 /* We must apply a user filter to this output. */
1000 void *input = __argp_input (argp, state);
1001 return (*argp->help_filter) (key, doc, input);
1008 /* Prints STR as a header line, with the margin lines set appropiately, and
1009 notes the fact that groups should be separated with a blank line. ARGP is
1010 the argp that should dictate any user doc filtering to take place. Note
1011 that the previous wrap margin isn't restored, but the left margin is reset
1014 print_header (const char *str, const struct argp *argp,
1015 struct pentry_state *pest)
1017 const char *tstr = dgettext (argp->argp_domain, str);
1018 const char *fstr = filter_doc (tstr, ARGP_KEY_HELP_HEADER, argp, pest->state);
1024 if (pest->hhstate->prev_entry)
1025 /* Precede with a blank line. */
1026 __argp_fmtstream_putc (pest->stream, '\n');
1027 indent_to (pest->stream, uparams.header_col);
1028 __argp_fmtstream_set_lmargin (pest->stream, uparams.header_col);
1029 __argp_fmtstream_set_wmargin (pest->stream, uparams.header_col);
1030 __argp_fmtstream_puts (pest->stream, fstr);
1031 __argp_fmtstream_set_lmargin (pest->stream, 0);
1032 __argp_fmtstream_putc (pest->stream, '\n');
1035 pest->hhstate->sep_groups = 1; /* Separate subsequent groups. */
1039 free ((char *) fstr);
1042 /* Inserts a comma if this isn't the first item on the line, and then makes
1043 sure we're at least to column COL. If this *is* the first item on a line,
1044 prints any pending whitespace/headers that should precede this line. Also
1047 comma (unsigned col, struct pentry_state *pest)
1051 const struct hol_entry *pe = pest->hhstate->prev_entry;
1052 const struct hol_cluster *cl = pest->entry->cluster;
1054 if (pest->hhstate->sep_groups && pe && pest->entry->group != pe->group)
1055 __argp_fmtstream_putc (pest->stream, '\n');
1057 if (cl && cl->header && *cl->header
1059 || (pe->cluster != cl
1060 && !hol_cluster_is_child (pe->cluster, cl))))
1061 /* If we're changing clusters, then this must be the start of the
1062 ENTRY's cluster unless that is an ancestor of the previous one
1063 (in which case we had just popped into a sub-cluster for a bit).
1064 If so, then print the cluster's header line. */
1066 int old_wm = __argp_fmtstream_wmargin (pest->stream);
1067 print_header (cl->header, cl->argp, pest);
1068 __argp_fmtstream_set_wmargin (pest->stream, old_wm);
1074 __argp_fmtstream_puts (pest->stream, ", ");
1076 indent_to (pest->stream, col);
1079 /* Print help for ENTRY to STREAM. */
1081 hol_entry_help (struct hol_entry *entry, const struct argp_state *state,
1082 argp_fmtstream_t stream, struct hol_help_state *hhstate)
1085 const struct argp_option *real = entry->opt, *opt;
1086 char *so = entry->short_options;
1087 int have_long_opt = 0; /* We have any long options. */
1088 /* Saved margins. */
1089 int old_lm = __argp_fmtstream_set_lmargin (stream, 0);
1090 int old_wm = __argp_fmtstream_wmargin (stream);
1091 /* PEST is a state block holding some of our variables that we'd like to
1092 share with helper functions. */
1093 struct pentry_state pest;
1096 pest.stream = stream;
1097 pest.hhstate = hhstate;
1102 for (opt = real, num = entry->num; num > 0; opt++, num--)
1103 if (opt->name && ovisible (opt))
1109 /* First emit short options. */
1110 __argp_fmtstream_set_wmargin (stream, uparams.short_opt_col); /* For truly bizarre cases. */
1111 for (opt = real, num = entry->num; num > 0; opt++, num--)
1112 if (oshort (opt) && opt->key == *so)
1113 /* OPT has a valid (non shadowed) short option. */
1117 comma (uparams.short_opt_col, &pest);
1118 __argp_fmtstream_putc (stream, '-');
1119 __argp_fmtstream_putc (stream, *so);
1120 if (!have_long_opt || uparams.dup_args)
1121 arg (real, " %s", "[%s]", state->root_argp->argp_domain, stream);
1123 hhstate->suppressed_dup_arg = 1;
1128 /* Now, long options. */
1130 /* A `documentation' option. */
1132 __argp_fmtstream_set_wmargin (stream, uparams.doc_opt_col);
1133 for (opt = real, num = entry->num; num > 0; opt++, num--)
1134 if (opt->name && *opt->name && ovisible (opt))
1136 comma (uparams.doc_opt_col, &pest);
1137 /* Calling dgettext here isn't quite right, since sorting will
1138 have been done on the original; but documentation options
1139 should be pretty rare anyway... */
1140 __argp_fmtstream_puts (stream,
1143 dgettext (state->root_argp->argp_domain,
1148 /* A real long option. */
1150 int first_long_opt = 1;
1152 __argp_fmtstream_set_wmargin (stream, uparams.long_opt_col);
1153 for (opt = real, num = entry->num; num > 0; opt++, num--)
1154 if (opt->name && ovisible (opt))
1156 comma (uparams.long_opt_col, &pest);
1157 __argp_fmtstream_printf (stream, "--%s", opt->name);
1158 if (first_long_opt || uparams.dup_args)
1159 arg (real, "=%s", "[=%s]", state->root_argp->argp_domain,
1162 hhstate->suppressed_dup_arg = 1;
1166 /* Next, documentation strings. */
1167 __argp_fmtstream_set_lmargin (stream, 0);
1171 /* Didn't print any switches, what's up? */
1172 if (!oshort (real) && !real->name)
1173 /* This is a group header, print it nicely. */
1174 print_header (real->doc, entry->argp, &pest);
1176 /* Just a totally shadowed option or null header; print nothing. */
1177 goto cleanup; /* Just return, after cleaning up. */
1181 const char *tstr = real->doc ? dgettext (state->root_argp->argp_domain,
1183 const char *fstr = filter_doc (tstr, real->key, entry->argp, state);
1186 unsigned int col = __argp_fmtstream_point (stream);
1188 __argp_fmtstream_set_lmargin (stream, uparams.opt_doc_col);
1189 __argp_fmtstream_set_wmargin (stream, uparams.opt_doc_col);
1191 if (col > (unsigned int) (uparams.opt_doc_col + 3))
1192 __argp_fmtstream_putc (stream, '\n');
1193 else if (col >= (unsigned int) uparams.opt_doc_col)
1194 __argp_fmtstream_puts (stream, " ");
1196 indent_to (stream, uparams.opt_doc_col);
1198 __argp_fmtstream_puts (stream, fstr);
1200 if (fstr && fstr != tstr)
1201 free ((char *) fstr);
1203 /* Reset the left margin. */
1204 __argp_fmtstream_set_lmargin (stream, 0);
1205 __argp_fmtstream_putc (stream, '\n');
1208 hhstate->prev_entry = entry;
1211 __argp_fmtstream_set_lmargin (stream, old_lm);
1212 __argp_fmtstream_set_wmargin (stream, old_wm);
1215 /* Output a long help message about the options in HOL to STREAM. */
1217 hol_help (struct hol *hol, const struct argp_state *state,
1218 argp_fmtstream_t stream)
1221 struct hol_entry *entry;
1222 struct hol_help_state hhstate = { 0, 0, 0 };
1224 for (entry = hol->entries, num = hol->num_entries; num > 0; entry++, num--)
1225 hol_entry_help (entry, state, stream, &hhstate);
1227 if (hhstate.suppressed_dup_arg && uparams.dup_args_note)
1229 const char *tstr = dgettext (state->root_argp->argp_domain, "\
1230 Mandatory or optional arguments to long options are also mandatory or \
1231 optional for any corresponding short options.");
1232 const char *fstr = filter_doc (tstr, ARGP_KEY_HELP_DUP_ARGS_NOTE,
1233 state ? state->root_argp : 0, state);
1236 __argp_fmtstream_putc (stream, '\n');
1237 __argp_fmtstream_puts (stream, fstr);
1238 __argp_fmtstream_putc (stream, '\n');
1240 if (fstr && fstr != tstr)
1241 free ((char *) fstr);
1245 /* Helper functions for hol_usage. */
1247 /* If OPT is a short option without an arg, append its key to the string
1248 pointer pointer to by COOKIE, and advance the pointer. */
1250 add_argless_short_opt (const struct argp_option *opt,
1251 const struct argp_option *real,
1252 const char *domain, void *cookie)
1254 char **snao_end = cookie;
1255 if (!(opt->arg || real->arg)
1256 && !((opt->flags | real->flags) & OPTION_NO_USAGE))
1257 *(*snao_end)++ = opt->key;
1261 /* If OPT is a short option with an arg, output a usage entry for it to the
1262 stream pointed at by COOKIE. */
1264 usage_argful_short_opt (const struct argp_option *opt,
1265 const struct argp_option *real,
1266 const char *domain, void *cookie)
1268 argp_fmtstream_t stream = cookie;
1269 const char *arg = opt->arg;
1270 int flags = opt->flags | real->flags;
1275 if (arg && !(flags & OPTION_NO_USAGE))
1277 arg = dgettext (domain, arg);
1279 if (flags & OPTION_ARG_OPTIONAL)
1280 __argp_fmtstream_printf (stream, " [-%c[%s]]", opt->key, arg);
1283 /* Manually do line wrapping so that it (probably) won't
1284 get wrapped at the embedded space. */
1285 space (stream, 6 + strlen (arg));
1286 __argp_fmtstream_printf (stream, "[-%c %s]", opt->key, arg);
1293 /* Output a usage entry for the long option opt to the stream pointed at by
1296 usage_long_opt (const struct argp_option *opt,
1297 const struct argp_option *real,
1298 const char *domain, void *cookie)
1300 argp_fmtstream_t stream = cookie;
1301 const char *arg = opt->arg;
1302 int flags = opt->flags | real->flags;
1307 if (! (flags & OPTION_NO_USAGE) && !odoc (opt))
1311 arg = dgettext (domain, arg);
1312 if (flags & OPTION_ARG_OPTIONAL)
1313 __argp_fmtstream_printf (stream, " [--%s[=%s]]", opt->name, arg);
1315 __argp_fmtstream_printf (stream, " [--%s=%s]", opt->name, arg);
1318 __argp_fmtstream_printf (stream, " [--%s]", opt->name);
1324 /* Print a short usage description for the arguments in HOL to STREAM. */
1326 hol_usage (struct hol *hol, argp_fmtstream_t stream)
1328 if (hol->num_entries > 0)
1331 struct hol_entry *entry;
1332 char *short_no_arg_opts = alloca (strlen (hol->short_options) + 1);
1333 char *snao_end = short_no_arg_opts;
1335 /* First we put a list of short options without arguments. */
1336 for (entry = hol->entries, nentries = hol->num_entries
1338 ; entry++, nentries--)
1339 hol_entry_short_iterate (entry, add_argless_short_opt,
1340 entry->argp->argp_domain, &snao_end);
1341 if (snao_end > short_no_arg_opts)
1344 __argp_fmtstream_printf (stream, " [-%s]", short_no_arg_opts);
1347 /* Now a list of short options *with* arguments. */
1348 for (entry = hol->entries, nentries = hol->num_entries
1350 ; entry++, nentries--)
1351 hol_entry_short_iterate (entry, usage_argful_short_opt,
1352 entry->argp->argp_domain, stream);
1354 /* Finally, a list of long options (whew!). */
1355 for (entry = hol->entries, nentries = hol->num_entries
1357 ; entry++, nentries--)
1358 hol_entry_long_iterate (entry, usage_long_opt,
1359 entry->argp->argp_domain, stream);
1363 /* Make a HOL containing all levels of options in ARGP. CLUSTER is the
1364 cluster in which ARGP's entries should be clustered, or 0. */
1366 argp_hol (const struct argp *argp, struct hol_cluster *cluster)
1368 const struct argp_child *child = argp->children;
1369 struct hol *hol = make_hol (argp, cluster);
1373 struct hol_cluster *child_cluster =
1374 ((child->group || child->header)
1375 /* Put CHILD->argp within its own cluster. */
1376 ? hol_add_cluster (hol, child->group, child->header,
1377 child - argp->children, cluster, argp)
1378 /* Just merge it into the parent's cluster. */
1380 hol_append (hol, argp_hol (child->argp, child_cluster)) ;
1386 /* Calculate how many different levels with alternative args strings exist in
1389 argp_args_levels (const struct argp *argp)
1392 const struct argp_child *child = argp->children;
1394 if (argp->args_doc && strchr (argp->args_doc, '\n'))
1399 levels += argp_args_levels ((child++)->argp);
1404 /* Print all the non-option args documented in ARGP to STREAM. Any output is
1405 preceded by a space. LEVELS is a pointer to a byte vector the length
1406 returned by argp_args_levels; it should be initialized to zero, and
1407 updated by this routine for the next call if ADVANCE is true. True is
1408 returned as long as there are more patterns to output. */
1410 argp_args_usage (const struct argp *argp, const struct argp_state *state,
1411 char **levels, int advance, argp_fmtstream_t stream)
1413 char *our_level = *levels;
1415 const struct argp_child *child = argp->children;
1416 const char *tdoc = dgettext (argp->argp_domain, argp->args_doc), *nl = 0;
1417 const char *fdoc = filter_doc (tdoc, ARGP_KEY_HELP_ARGS_DOC, argp, state);
1421 const char *cp = fdoc;
1422 nl = __strchrnul (cp, '\n');
1424 /* This is a `multi-level' args doc; advance to the correct position
1425 as determined by our state in LEVELS, and update LEVELS. */
1429 for (i = 0; i < *our_level; i++)
1430 cp = nl + 1, nl = __strchrnul (cp, '\n');
1434 /* Manually do line wrapping so that it (probably) won't get wrapped at
1435 any embedded spaces. */
1436 space (stream, 1 + nl - cp);
1438 __argp_fmtstream_write (stream, cp, nl - cp);
1440 if (fdoc && fdoc != tdoc)
1441 free ((char *)fdoc); /* Free user's modified doc string. */
1445 advance = !argp_args_usage ((child++)->argp, state, levels, advance, stream);
1447 if (advance && multiple)
1449 /* Need to increment our level. */
1451 /* There's more we can do here. */
1454 advance = 0; /* Our parent shouldn't advance also. */
1456 else if (*our_level > 0)
1457 /* We had multiple levels, but used them up; reset to zero. */
1464 /* Print the documentation for ARGP to STREAM; if POST is false, then
1465 everything preceeding a `\v' character in the documentation strings (or
1466 the whole string, for those with none) is printed, otherwise, everything
1467 following the `\v' character (nothing for strings without). Each separate
1468 bit of documentation is separated a blank line, and if PRE_BLANK is true,
1469 then the first is as well. If FIRST_ONLY is true, only the first
1470 occurrence is output. Returns true if anything was output. */
1472 argp_doc (const struct argp *argp, const struct argp_state *state,
1473 int post, int pre_blank, int first_only,
1474 argp_fmtstream_t stream)
1477 const char *inp_text;
1480 size_t inp_text_limit = 0;
1481 const char *doc = dgettext (argp->argp_domain, argp->doc);
1482 const struct argp_child *child = argp->children;
1486 char *vt = strchr (doc, '\v');
1487 inp_text = post ? (vt ? vt + 1 : 0) : doc;
1488 inp_text_limit = (!post && vt) ? (vt - doc) : 0;
1493 if (argp->help_filter)
1494 /* We have to filter the doc strings. */
1497 /* Copy INP_TEXT so that it's nul-terminated. */
1498 inp_text = __strndup (inp_text, inp_text_limit);
1499 input = __argp_input (argp, state);
1501 (*argp->help_filter) (post
1502 ? ARGP_KEY_HELP_POST_DOC
1503 : ARGP_KEY_HELP_PRE_DOC,
1507 text = (const char *) inp_text;
1512 __argp_fmtstream_putc (stream, '\n');
1514 if (text == inp_text && inp_text_limit)
1515 __argp_fmtstream_write (stream, inp_text, inp_text_limit);
1517 __argp_fmtstream_puts (stream, text);
1519 if (__argp_fmtstream_point (stream) > __argp_fmtstream_lmargin (stream))
1520 __argp_fmtstream_putc (stream, '\n');
1525 if (text && text != inp_text)
1526 free ((char *) text); /* Free TEXT returned from the help filter. */
1527 if (inp_text && inp_text_limit && argp->help_filter)
1528 free ((char *) inp_text); /* We copied INP_TEXT, so free it now. */
1530 if (post && argp->help_filter)
1531 /* Now see if we have to output a ARGP_KEY_HELP_EXTRA text. */
1533 text = (*argp->help_filter) (ARGP_KEY_HELP_EXTRA, 0, input);
1536 if (anything || pre_blank)
1537 __argp_fmtstream_putc (stream, '\n');
1538 __argp_fmtstream_puts (stream, text);
1539 free ((char *) text);
1540 if (__argp_fmtstream_point (stream)
1541 > __argp_fmtstream_lmargin (stream))
1542 __argp_fmtstream_putc (stream, '\n');
1548 while (child->argp && !(first_only && anything))
1550 argp_doc ((child++)->argp, state,
1551 post, anything || pre_blank, first_only,
1557 /* Output a usage message for ARGP to STREAM. If called from
1558 argp_state_help, STATE is the relevent parsing state. FLAGS are from the
1559 set ARGP_HELP_*. NAME is what to use wherever a `program name' is
1562 _help (const struct argp *argp, const struct argp_state *state, FILE *stream,
1563 unsigned flags, char *name)
1565 int anything = 0; /* Whether we've output anything. */
1566 struct hol *hol = 0;
1567 argp_fmtstream_t fs;
1572 #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE)
1573 __flockfile (stream);
1576 if (! uparams.valid)
1577 fill_in_uparams (state);
1579 fs = __argp_make_fmtstream (stream, 0, uparams.rmargin, 0);
1582 #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE)
1583 __funlockfile (stream);
1588 if (flags & (ARGP_HELP_USAGE | ARGP_HELP_SHORT_USAGE | ARGP_HELP_LONG))
1590 hol = argp_hol (argp, 0);
1592 /* If present, these options always come last. */
1593 hol_set_group (hol, "help", -1);
1594 hol_set_group (hol, "version", -1);
1599 if (flags & (ARGP_HELP_USAGE | ARGP_HELP_SHORT_USAGE))
1600 /* Print a short `Usage:' message. */
1602 int first_pattern = 1, more_patterns;
1603 size_t num_pattern_levels = argp_args_levels (argp);
1604 char *pattern_levels = alloca (num_pattern_levels);
1606 memset (pattern_levels, 0, num_pattern_levels);
1611 int old_wm = __argp_fmtstream_set_wmargin (fs, uparams.usage_indent);
1612 char *levels = pattern_levels;
1615 __argp_fmtstream_printf (fs, "%s %s",
1616 dgettext (argp->argp_domain, "Usage:"),
1619 __argp_fmtstream_printf (fs, "%s %s",
1620 dgettext (argp->argp_domain, " or: "),
1623 /* We set the lmargin as well as the wmargin, because hol_usage
1624 manually wraps options with newline to avoid annoying breaks. */
1625 old_lm = __argp_fmtstream_set_lmargin (fs, uparams.usage_indent);
1627 if (flags & ARGP_HELP_SHORT_USAGE)
1628 /* Just show where the options go. */
1630 if (hol->num_entries > 0)
1631 __argp_fmtstream_puts (fs, dgettext (argp->argp_domain,
1635 /* Actually print the options. */
1637 hol_usage (hol, fs);
1638 flags |= ARGP_HELP_SHORT_USAGE; /* But only do so once. */
1641 more_patterns = argp_args_usage (argp, state, &levels, 1, fs);
1643 __argp_fmtstream_set_wmargin (fs, old_wm);
1644 __argp_fmtstream_set_lmargin (fs, old_lm);
1646 __argp_fmtstream_putc (fs, '\n');
1651 while (more_patterns);
1654 if (flags & ARGP_HELP_PRE_DOC)
1655 anything |= argp_doc (argp, state, 0, 0, 1, fs);
1657 if (flags & ARGP_HELP_SEE)
1659 __argp_fmtstream_printf (fs, dgettext (argp->argp_domain, "\
1660 Try `%s --help' or `%s --usage' for more information.\n"),
1665 if (flags & ARGP_HELP_LONG)
1666 /* Print a long, detailed help message. */
1668 /* Print info about all the options. */
1669 if (hol->num_entries > 0)
1672 __argp_fmtstream_putc (fs, '\n');
1673 hol_help (hol, state, fs);
1678 if (flags & ARGP_HELP_POST_DOC)
1679 /* Print any documentation strings at the end. */
1680 anything |= argp_doc (argp, state, 1, anything, 0, fs);
1682 if ((flags & ARGP_HELP_BUG_ADDR) && argp_program_bug_address)
1685 __argp_fmtstream_putc (fs, '\n');
1686 __argp_fmtstream_printf (fs, dgettext (argp->argp_domain,
1687 "Report bugs to %s.\n"),
1688 argp_program_bug_address);
1692 #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE)
1693 __funlockfile (stream);
1699 __argp_fmtstream_free (fs);
1702 /* Output a usage message for ARGP to STREAM. FLAGS are from the set
1703 ARGP_HELP_*. NAME is what to use wherever a `program name' is needed. */
1704 void __argp_help (const struct argp *argp, FILE *stream,
1705 unsigned flags, char *name)
1707 struct argp_state state;
1708 memset (&state, 0, sizeof state);
1709 state.root_argp = argp;
1710 _help (argp, &state, stream, flags, name);
1713 weak_alias (__argp_help, argp_help)
1716 #if ! (defined _LIBC || HAVE_DECL_PROGRAM_INVOCATION_SHORT_NAME)
1718 __argp_short_program_name (void)
1720 # if HAVE_DECL_PROGRAM_INVOCATION_NAME
1721 return __argp_base_name (program_invocation_name);
1723 /* FIXME: What now? Miles suggests that it is better to use NULL,
1724 but currently the value is passed on directly to fputs_unlocked,
1725 so that requires more changes. */
1727 # warning No reasonable value to return
1728 # endif /* __GNUC__ */
1734 /* Output, if appropriate, a usage message for STATE to STREAM. FLAGS are
1735 from the set ARGP_HELP_*. */
1737 __argp_state_help (const struct argp_state *state, FILE *stream, unsigned flags)
1739 if ((!state || ! (state->flags & ARGP_NO_ERRS)) && stream)
1741 if (state && (state->flags & ARGP_LONG_ONLY))
1742 flags |= ARGP_HELP_LONG_ONLY;
1744 _help (state ? state->root_argp : 0, state, stream, flags,
1745 state ? state->name : __argp_short_program_name ());
1747 if (!state || ! (state->flags & ARGP_NO_EXIT))
1749 if (flags & ARGP_HELP_EXIT_ERR)
1750 exit (argp_err_exit_status);
1751 if (flags & ARGP_HELP_EXIT_OK)
1757 weak_alias (__argp_state_help, argp_state_help)
1760 /* If appropriate, print the printf string FMT and following args, preceded
1761 by the program name and `:', to stderr, and followed by a `Try ... --help'
1762 message, then exit (1). */
1764 __argp_error (const struct argp_state *state, const char *fmt, ...)
1766 if (!state || !(state->flags & ARGP_NO_ERRS))
1768 FILE *stream = state ? state->err_stream : stderr;
1774 #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE)
1775 __flockfile (stream);
1781 if (_IO_fwide (stream, 0) > 0)
1785 if (__asprintf (&buf, fmt, ap) < 0)
1788 __fwprintf (stream, L"%s: %s\n",
1789 state ? state->name : __argp_short_program_name (),
1797 fputs_unlocked (state
1798 ? state->name : __argp_short_program_name (),
1800 putc_unlocked (':', stream);
1801 putc_unlocked (' ', stream);
1803 vfprintf (stream, fmt, ap);
1805 putc_unlocked ('\n', stream);
1808 __argp_state_help (state, stream, ARGP_HELP_STD_ERR);
1812 #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE)
1813 __funlockfile (stream);
1819 weak_alias (__argp_error, argp_error)
1822 /* Similar to the standard gnu error-reporting function error(), but will
1823 respect the ARGP_NO_EXIT and ARGP_NO_ERRS flags in STATE, and will print
1824 to STATE->err_stream. This is useful for argument parsing code that is
1825 shared between program startup (when exiting is desired) and runtime
1826 option parsing (when typically an error code is returned instead). The
1827 difference between this function and argp_error is that the latter is for
1828 *parsing errors*, and the former is for other problems that occur during
1829 parsing but don't reflect a (syntactic) problem with the input. */
1831 __argp_failure (const struct argp_state *state, int status, int errnum,
1832 const char *fmt, ...)
1834 if (!state || !(state->flags & ARGP_NO_ERRS))
1836 FILE *stream = state ? state->err_stream : stderr;
1840 #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE)
1841 __flockfile (stream);
1845 if (_IO_fwide (stream, 0) > 0)
1846 __fwprintf (stream, L"%s",
1847 state ? state->name : __argp_short_program_name ());
1850 fputs_unlocked (state
1851 ? state->name : __argp_short_program_name (),
1860 if (_IO_fwide (stream, 0) > 0)
1864 if (__asprintf (&buf, fmt, ap) < 0)
1867 __fwprintf (stream, L": %s", buf);
1874 putc_unlocked (':', stream);
1875 putc_unlocked (' ', stream);
1877 vfprintf (stream, fmt, ap);
1888 if (_IO_fwide (stream, 0) > 0)
1889 __fwprintf (stream, L": %s",
1890 __strerror_r (errnum, buf, sizeof (buf)));
1894 char const *s = NULL;
1895 putc_unlocked (':', stream);
1896 putc_unlocked (' ', stream);
1897 #if _LIBC || (HAVE_DECL_STRERROR_R && STRERROR_R_CHAR_P)
1898 s = __strerror_r (errnum, buf, sizeof buf);
1899 #elif HAVE_DECL_STRERROR_R
1900 if (__strerror_r (errnum, buf, sizeof buf) == 0)
1904 if (! s && ! (s = strerror (errnum)))
1905 s = dgettext (state->root_argp->argp_domain,
1906 "Unknown system error");
1913 if (_IO_fwide (stream, 0) > 0)
1914 putwc_unlocked (L'\n', stream);
1917 putc_unlocked ('\n', stream);
1919 #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE)
1920 __funlockfile (stream);
1923 if (status && (!state || !(state->flags & ARGP_NO_EXIT)))
1929 weak_alias (__argp_failure, argp_failure)