]>
Commit | Line | Data |
---|---|---|
c84142e8 | 1 | /* Hierarchial argument parsing help output |
56d25bb8 | 2 | Copyright (C) 1995-2012 Free Software Foundation, Inc. |
c84142e8 UD |
3 | This file is part of the GNU C Library. |
4 | Written by Miles Bader <miles@gnu.ai.mit.edu>. | |
5 | ||
6 | The GNU C Library is free software; you can redistribute it and/or | |
41bdb6e2 AJ |
7 | modify it under the terms of the GNU Lesser General Public |
8 | License as published by the Free Software Foundation; either | |
9 | version 2.1 of the License, or (at your option) any later version. | |
c84142e8 UD |
10 | |
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 | |
41bdb6e2 | 14 | Lesser General Public License for more details. |
c84142e8 | 15 | |
41bdb6e2 | 16 | You should have received a copy of the GNU Lesser General Public |
59ba27a6 PE |
17 | License along with the GNU C Library; if not, see |
18 | <http://www.gnu.org/licenses/>. */ | |
c84142e8 | 19 | |
3f62b69a UD |
20 | #ifndef _GNU_SOURCE |
21 | # define _GNU_SOURCE 1 | |
22 | #endif | |
23 | ||
c84142e8 UD |
24 | #ifdef HAVE_CONFIG_H |
25 | #include <config.h> | |
26 | #endif | |
27 | ||
c5af724c UD |
28 | /* AIX requires this to be the first thing in the file. */ |
29 | #ifndef __GNUC__ | |
30 | # if HAVE_ALLOCA_H || defined _LIBC | |
31 | # include <alloca.h> | |
7ce241a0 | 32 | # else |
c5af724c UD |
33 | # ifdef _AIX |
34 | #pragma alloca | |
7ce241a0 | 35 | # else |
c5af724c | 36 | # ifndef alloca /* predefined by HP cc +Olibcalls */ |
7ce241a0 | 37 | char *alloca (); |
7ce241a0 UD |
38 | # endif |
39 | # endif | |
40 | # endif | |
41 | #endif | |
42 | ||
5a97622d | 43 | #include <stddef.h> |
c84142e8 UD |
44 | #include <stdlib.h> |
45 | #include <string.h> | |
46 | #include <assert.h> | |
47 | #include <stdarg.h> | |
c84142e8 | 48 | #include <ctype.h> |
abca9f7f | 49 | #include <limits.h> |
a7c684a2 UD |
50 | #ifdef _LIBC |
51 | # include <../libio/libioP.h> | |
9af652f6 UD |
52 | # include <wchar.h> |
53 | #endif | |
c84142e8 UD |
54 | |
55 | #ifndef _ | |
b7296fd4 | 56 | /* This is for other GNU distributions with internationalized messages. */ |
883ba315 | 57 | # if defined HAVE_LIBINTL_H || defined _LIBC |
50304ef0 | 58 | # include <libintl.h> |
0bb258e3 UD |
59 | # ifdef _LIBC |
60 | # undef dgettext | |
71319b9c | 61 | # define dgettext(domain, msgid) \ |
56d25bb8 | 62 | __dcgettext (domain, msgid, LC_MESSAGES) |
0bb258e3 | 63 | # endif |
50304ef0 UD |
64 | # else |
65 | # define dgettext(domain, msgid) (msgid) | |
66 | # endif | |
c84142e8 | 67 | #endif |
50304ef0 | 68 | |
f39941e4 UD |
69 | #ifndef _LIBC |
70 | # if HAVE_STRERROR_R | |
71 | # if !HAVE_DECL_STRERROR_R | |
72 | char *strerror_r (int errnum, char *buf, size_t buflen); | |
73 | # endif | |
74 | # else | |
75 | # if !HAVE_DECL_STRERROR | |
76 | char *strerror (int errnum); | |
77 | # endif | |
78 | # endif | |
79 | #endif | |
80 | ||
c84142e8 UD |
81 | #include "argp.h" |
82 | #include "argp-fmtstream.h" | |
83 | #include "argp-namefrob.h" | |
32868f88 UD |
84 | |
85 | #ifndef SIZE_MAX | |
86 | # define SIZE_MAX ((size_t) -1) | |
d6e68295 | 87 | #endif |
5a97622d UD |
88 | \f |
89 | /* User-selectable (using an environment variable) formatting parameters. | |
90 | ||
91 | These may be specified in an environment variable called `ARGP_HELP_FMT', | |
92 | with a contents like: VAR1=VAL1,VAR2=VAL2,BOOLVAR2,no-BOOLVAR2 | |
93 | Where VALn must be a positive integer. The list of variables is in the | |
94 | UPARAM_NAMES vector, below. */ | |
c84142e8 | 95 | |
5a97622d UD |
96 | /* Default parameters. */ |
97 | #define DUP_ARGS 0 /* True if option argument can be duplicated. */ | |
98 | #define DUP_ARGS_NOTE 1 /* True to print a note about duplicate args. */ | |
c84142e8 UD |
99 | #define SHORT_OPT_COL 2 /* column in which short options start */ |
100 | #define LONG_OPT_COL 6 /* column in which long options start */ | |
101 | #define DOC_OPT_COL 2 /* column in which doc options start */ | |
102 | #define OPT_DOC_COL 29 /* column in which option text starts */ | |
103 | #define HEADER_COL 1 /* column in which group headers are printed */ | |
104 | #define USAGE_INDENT 12 /* indentation of wrapped usage lines */ | |
105 | #define RMARGIN 79 /* right margin used for wrapping */ | |
106 | ||
5a97622d UD |
107 | /* User-selectable (using an environment variable) formatting parameters. |
108 | They must all be of type `int' for the parsing code to work. */ | |
109 | struct uparams | |
110 | { | |
111 | /* If true, arguments for an option are shown with both short and long | |
112 | options, even when a given option has both, e.g. `-x ARG, --longx=ARG'. | |
113 | If false, then if an option has both, the argument is only shown with | |
114 | the long one, e.g., `-x, --longx=ARG', and a message indicating that | |
115 | this really means both is printed below the options. */ | |
116 | int dup_args; | |
117 | ||
118 | /* This is true if when DUP_ARGS is false, and some duplicate arguments have | |
119 | been suppressed, an explanatory message should be printed. */ | |
120 | int dup_args_note; | |
121 | ||
122 | /* Various output columns. */ | |
123 | int short_opt_col; | |
124 | int long_opt_col; | |
125 | int doc_opt_col; | |
126 | int opt_doc_col; | |
127 | int header_col; | |
128 | int usage_indent; | |
129 | int rmargin; | |
5a97622d UD |
130 | }; |
131 | ||
132 | /* This is a global variable, as user options are only ever read once. */ | |
133 | static struct uparams uparams = { | |
134 | DUP_ARGS, DUP_ARGS_NOTE, | |
135 | SHORT_OPT_COL, LONG_OPT_COL, DOC_OPT_COL, OPT_DOC_COL, HEADER_COL, | |
e7c8359e | 136 | USAGE_INDENT, RMARGIN |
5a97622d UD |
137 | }; |
138 | ||
139 | /* A particular uparam, and what the user name is. */ | |
140 | struct uparam_name | |
141 | { | |
e7c8359e UD |
142 | const char name[14]; /* User name. */ |
143 | bool is_bool; /* Whether it's `boolean'. */ | |
144 | uint8_t uparams_offs; /* Location of the (int) field in UPARAMS. */ | |
5a97622d UD |
145 | }; |
146 | ||
147 | /* The name-field mappings we know about. */ | |
148 | static const struct uparam_name uparam_names[] = | |
149 | { | |
e7c8359e UD |
150 | { "dup-args", true, offsetof (struct uparams, dup_args) }, |
151 | { "dup-args-note", true, offsetof (struct uparams, dup_args_note) }, | |
152 | { "short-opt-col", false, offsetof (struct uparams, short_opt_col) }, | |
153 | { "long-opt-col", false, offsetof (struct uparams, long_opt_col) }, | |
154 | { "doc-opt-col", false, offsetof (struct uparams, doc_opt_col) }, | |
155 | { "opt-doc-col", false, offsetof (struct uparams, opt_doc_col) }, | |
156 | { "header-col", false, offsetof (struct uparams, header_col) }, | |
157 | { "usage-indent", false, offsetof (struct uparams, usage_indent) }, | |
158 | { "rmargin", false, offsetof (struct uparams, rmargin) } | |
5a97622d | 159 | }; |
e7c8359e | 160 | #define nuparam_names (sizeof (uparam_names) / sizeof (uparam_names[0])) |
5a97622d UD |
161 | |
162 | /* Read user options from the environment, and fill in UPARAMS appropiately. */ | |
163 | static void | |
164 | fill_in_uparams (const struct argp_state *state) | |
165 | { | |
166 | const char *var = getenv ("ARGP_HELP_FMT"); | |
167 | ||
168 | #define SKIPWS(p) do { while (isspace (*p)) p++; } while (0); | |
169 | ||
170 | if (var) | |
171 | /* Parse var. */ | |
172 | while (*var) | |
173 | { | |
174 | SKIPWS (var); | |
175 | ||
176 | if (isalpha (*var)) | |
177 | { | |
178 | size_t var_len; | |
179 | const struct uparam_name *un; | |
180 | int unspec = 0, val = 0; | |
181 | const char *arg = var; | |
182 | ||
183 | while (isalnum (*arg) || *arg == '-' || *arg == '_') | |
184 | arg++; | |
185 | var_len = arg - var; | |
186 | ||
187 | SKIPWS (arg); | |
188 | ||
189 | if (*arg == '\0' || *arg == ',') | |
190 | unspec = 1; | |
191 | else if (*arg == '=') | |
192 | { | |
193 | arg++; | |
194 | SKIPWS (arg); | |
195 | } | |
4cca6b86 | 196 | |
5a97622d | 197 | if (unspec) |
6e4c40ba UD |
198 | { |
199 | if (var[0] == 'n' && var[1] == 'o' && var[2] == '-') | |
200 | { | |
201 | val = 0; | |
202 | var += 3; | |
203 | var_len -= 3; | |
204 | } | |
205 | else | |
206 | val = 1; | |
207 | } | |
5a97622d UD |
208 | else if (isdigit (*arg)) |
209 | { | |
210 | val = atoi (arg); | |
211 | while (isdigit (*arg)) | |
212 | arg++; | |
213 | SKIPWS (arg); | |
214 | } | |
215 | ||
e7c8359e UD |
216 | un = uparam_names; |
217 | size_t u; | |
218 | for (u = 0; u < nuparam_names; ++un, ++u) | |
5a97622d UD |
219 | if (strlen (un->name) == var_len |
220 | && strncmp (var, un->name, var_len) == 0) | |
221 | { | |
222 | if (unspec && !un->is_bool) | |
223 | __argp_failure (state, 0, 0, | |
e7c8359e UD |
224 | dgettext (state == NULL ? NULL |
225 | : state->root_argp->argp_domain, | |
226 | "\ | |
9184d3db UD |
227 | %.*s: ARGP_HELP_FMT parameter requires a value"), |
228 | (int) var_len, var); | |
5a97622d UD |
229 | else |
230 | *(int *)((char *)&uparams + un->uparams_offs) = val; | |
231 | break; | |
232 | } | |
e7c8359e | 233 | if (u == nuparam_names) |
5a97622d | 234 | __argp_failure (state, 0, 0, |
e7c8359e UD |
235 | dgettext (state == NULL ? NULL |
236 | : state->root_argp->argp_domain, "\ | |
9184d3db UD |
237 | %.*s: Unknown ARGP_HELP_FMT parameter"), |
238 | (int) var_len, var); | |
5a97622d UD |
239 | |
240 | var = arg; | |
241 | if (*var == ',') | |
242 | var++; | |
243 | } | |
244 | else if (*var) | |
245 | { | |
246 | __argp_failure (state, 0, 0, | |
e7c8359e UD |
247 | dgettext (state == NULL ? NULL |
248 | : state->root_argp->argp_domain, | |
9184d3db | 249 | "Garbage in ARGP_HELP_FMT: %s"), var); |
5a97622d UD |
250 | break; |
251 | } | |
252 | } | |
253 | } | |
254 | \f | |
c84142e8 UD |
255 | /* Returns true if OPT hasn't been marked invisible. Visibility only affects |
256 | whether OPT is displayed or used in sorting, not option shadowing. */ | |
257 | #define ovisible(opt) (! ((opt)->flags & OPTION_HIDDEN)) | |
258 | ||
259 | /* Returns true if OPT is an alias for an earlier option. */ | |
260 | #define oalias(opt) ((opt)->flags & OPTION_ALIAS) | |
261 | ||
262 | /* Returns true if OPT is an documentation-only entry. */ | |
263 | #define odoc(opt) ((opt)->flags & OPTION_DOC) | |
264 | ||
265 | /* Returns true if OPT is the end-of-list marker for a list of options. */ | |
266 | #define oend(opt) __option_is_end (opt) | |
267 | ||
268 | /* Returns true if OPT has a short option. */ | |
269 | #define oshort(opt) __option_is_short (opt) | |
270 | \f | |
271 | /* | |
272 | The help format for a particular option is like: | |
273 | ||
274 | -xARG, -yARG, --long1=ARG, --long2=ARG Documentation... | |
275 | ||
276 | Where ARG will be omitted if there's no argument, for this option, or | |
277 | will be surrounded by "[" and "]" appropiately if the argument is | |
278 | optional. The documentation string is word-wrapped appropiately, and if | |
279 | the list of options is long enough, it will be started on a separate line. | |
280 | If there are no short options for a given option, the first long option is | |
281 | indented slighly in a way that's supposed to make most long options appear | |
282 | to be in a separate column. | |
283 | ||
284 | For example, the following output (from ps): | |
285 | ||
286 | -p PID, --pid=PID List the process PID | |
287 | --pgrp=PGRP List processes in the process group PGRP | |
288 | -P, -x, --no-parent Include processes without parents | |
289 | -Q, --all-fields Don't elide unusable fields (normally if there's | |
290 | some reason ps can't print a field for any | |
291 | process, it's removed from the output entirely) | |
292 | -r, --reverse, --gratuitously-long-reverse-option | |
293 | Reverse the order of any sort | |
294 | --session[=SID] Add the processes from the session SID (which | |
295 | defaults to the sid of the current process) | |
296 | ||
297 | Here are some more options: | |
298 | -f ZOT, --foonly=ZOT Glork a foonly | |
299 | -z, --zaza Snit a zar | |
300 | ||
301 | -?, --help Give this help list | |
302 | --usage Give a short usage message | |
303 | -V, --version Print program version | |
304 | ||
305 | The struct argp_option array for the above could look like: | |
306 | ||
307 | { | |
308 | {"pid", 'p', "PID", 0, "List the process PID"}, | |
309 | {"pgrp", OPT_PGRP, "PGRP", 0, "List processes in the process group PGRP"}, | |
310 | {"no-parent", 'P', 0, 0, "Include processes without parents"}, | |
311 | {0, 'x', 0, OPTION_ALIAS}, | |
312 | {"all-fields",'Q', 0, 0, "Don't elide unusable fields (normally" | |
3ce1f295 | 313 | " if there's some reason ps can't" |
c84142e8 | 314 | " print a field for any process, it's" |
3ce1f295 | 315 | " removed from the output entirely)" }, |
c84142e8 UD |
316 | {"reverse", 'r', 0, 0, "Reverse the order of any sort"}, |
317 | {"gratuitously-long-reverse-option", 0, 0, OPTION_ALIAS}, | |
318 | {"session", OPT_SESS, "SID", OPTION_ARG_OPTIONAL, | |
3ce1f295 | 319 | "Add the processes from the session" |
c84142e8 UD |
320 | " SID (which defaults to the sid of" |
321 | " the current process)" }, | |
322 | ||
323 | {0,0,0,0, "Here are some more options:"}, | |
324 | {"foonly", 'f', "ZOT", 0, "Glork a foonly"}, | |
325 | {"zaza", 'z', 0, 0, "Snit a zar"}, | |
326 | ||
327 | {0} | |
328 | } | |
329 | ||
330 | Note that the last three options are automatically supplied by argp_parse, | |
331 | unless you tell it not to with ARGP_NO_HELP. | |
332 | ||
333 | */ | |
334 | \f | |
335 | /* Returns true if CH occurs between BEG and END. */ | |
336 | static int | |
337 | find_char (char ch, char *beg, char *end) | |
338 | { | |
339 | while (beg < end) | |
340 | if (*beg == ch) | |
341 | return 1; | |
342 | else | |
343 | beg++; | |
344 | return 0; | |
345 | } | |
346 | \f | |
347 | struct hol_cluster; /* fwd decl */ | |
348 | ||
349 | struct hol_entry | |
350 | { | |
351 | /* First option. */ | |
352 | const struct argp_option *opt; | |
353 | /* Number of options (including aliases). */ | |
354 | unsigned num; | |
355 | ||
356 | /* A pointers into the HOL's short_options field, to the first short option | |
357 | letter for this entry. The order of the characters following this point | |
358 | corresponds to the order of options pointed to by OPT, and there are at | |
359 | most NUM. A short option recorded in a option following OPT is only | |
360 | valid if it occurs in the right place in SHORT_OPTIONS (otherwise it's | |
361 | probably been shadowed by some other entry). */ | |
362 | char *short_options; | |
363 | ||
364 | /* Entries are sorted by their group first, in the order: | |
365 | 1, 2, ..., n, 0, -m, ..., -2, -1 | |
366 | and then alphabetically within each group. The default is 0. */ | |
367 | int group; | |
368 | ||
369 | /* The cluster of options this entry belongs to, or 0 if none. */ | |
370 | struct hol_cluster *cluster; | |
1fb05e3d UD |
371 | |
372 | /* The argp from which this option came. */ | |
373 | const struct argp *argp; | |
c84142e8 UD |
374 | }; |
375 | ||
376 | /* A cluster of entries to reflect the argp tree structure. */ | |
377 | struct hol_cluster | |
378 | { | |
379 | /* A descriptive header printed before options in this cluster. */ | |
380 | const char *header; | |
381 | ||
382 | /* Used to order clusters within the same group with the same parent, | |
49c091e5 | 383 | according to the order in which they occurred in the parent argp's child |
c84142e8 UD |
384 | list. */ |
385 | int index; | |
386 | ||
387 | /* How to sort this cluster with respect to options and other clusters at the | |
388 | same depth (clusters always follow options in the same group). */ | |
389 | int group; | |
390 | ||
391 | /* The cluster to which this cluster belongs, or 0 if it's at the base | |
392 | level. */ | |
393 | struct hol_cluster *parent; | |
394 | ||
1fb05e3d UD |
395 | /* The argp from which this cluster is (eventually) derived. */ |
396 | const struct argp *argp; | |
397 | ||
c84142e8 UD |
398 | /* The distance this cluster is from the root. */ |
399 | int depth; | |
400 | ||
401 | /* Clusters in a given hol are kept in a linked list, to make freeing them | |
402 | possible. */ | |
403 | struct hol_cluster *next; | |
404 | }; | |
405 | ||
406 | /* A list of options for help. */ | |
407 | struct hol | |
408 | { | |
409 | /* An array of hol_entry's. */ | |
410 | struct hol_entry *entries; | |
411 | /* The number of entries in this hol. If this field is zero, the others | |
412 | are undefined. */ | |
413 | unsigned num_entries; | |
414 | ||
415 | /* A string containing all short options in this HOL. Each entry contains | |
416 | pointers into this string, so the order can't be messed with blindly. */ | |
417 | char *short_options; | |
418 | ||
419 | /* Clusters of entries in this hol. */ | |
420 | struct hol_cluster *clusters; | |
421 | }; | |
422 | \f | |
1fb05e3d | 423 | /* Create a struct hol from the options in ARGP. CLUSTER is the |
c84142e8 UD |
424 | hol_cluster in which these entries occur, or 0, if at the root. */ |
425 | static struct hol * | |
1fb05e3d | 426 | make_hol (const struct argp *argp, struct hol_cluster *cluster) |
c84142e8 UD |
427 | { |
428 | char *so; | |
429 | const struct argp_option *o; | |
1fb05e3d | 430 | const struct argp_option *opts = argp->options; |
c84142e8 UD |
431 | struct hol_entry *entry; |
432 | unsigned num_short_options = 0; | |
433 | struct hol *hol = malloc (sizeof (struct hol)); | |
434 | ||
435 | assert (hol); | |
436 | ||
437 | hol->num_entries = 0; | |
438 | hol->clusters = 0; | |
439 | ||
1fb05e3d | 440 | if (opts) |
c84142e8 UD |
441 | { |
442 | int cur_group = 0; | |
443 | ||
444 | /* The first option must not be an alias. */ | |
1fb05e3d | 445 | assert (! oalias (opts)); |
c84142e8 UD |
446 | |
447 | /* Calculate the space needed. */ | |
1fb05e3d | 448 | for (o = opts; ! oend (o); o++) |
c84142e8 UD |
449 | { |
450 | if (! oalias (o)) | |
451 | hol->num_entries++; | |
452 | if (oshort (o)) | |
453 | num_short_options++; /* This is an upper bound. */ | |
454 | } | |
455 | ||
456 | hol->entries = malloc (sizeof (struct hol_entry) * hol->num_entries); | |
457 | hol->short_options = malloc (num_short_options + 1); | |
458 | ||
abca9f7f UD |
459 | assert (hol->entries && hol->short_options); |
460 | #if SIZE_MAX <= UINT_MAX | |
461 | assert (hol->num_entries <= SIZE_MAX / sizeof (struct hol_entry)); | |
462 | #endif | |
c84142e8 UD |
463 | |
464 | /* Fill in the entries. */ | |
465 | so = hol->short_options; | |
1fb05e3d | 466 | for (o = opts, entry = hol->entries; ! oend (o); entry++) |
c84142e8 UD |
467 | { |
468 | entry->opt = o; | |
469 | entry->num = 0; | |
470 | entry->short_options = so; | |
471 | entry->group = cur_group = | |
472 | o->group | |
473 | ? o->group | |
474 | : ((!o->name && !o->key) | |
475 | ? cur_group + 1 | |
476 | : cur_group); | |
477 | entry->cluster = cluster; | |
1fb05e3d | 478 | entry->argp = argp; |
c84142e8 UD |
479 | |
480 | do | |
481 | { | |
482 | entry->num++; | |
483 | if (oshort (o) && ! find_char (o->key, hol->short_options, so)) | |
484 | /* O has a valid short option which hasn't already been used.*/ | |
485 | *so++ = o->key; | |
486 | o++; | |
487 | } | |
488 | while (! oend (o) && oalias (o)); | |
489 | } | |
490 | *so = '\0'; /* null terminated so we can find the length */ | |
491 | } | |
492 | ||
493 | return hol; | |
494 | } | |
495 | \f | |
496 | /* Add a new cluster to HOL, with the given GROUP and HEADER (taken from the | |
497 | associated argp child list entry), INDEX, and PARENT, and return a pointer | |
1fb05e3d | 498 | to it. ARGP is the argp that this cluster results from. */ |
c84142e8 UD |
499 | static struct hol_cluster * |
500 | hol_add_cluster (struct hol *hol, int group, const char *header, int index, | |
1fb05e3d | 501 | struct hol_cluster *parent, const struct argp *argp) |
c84142e8 UD |
502 | { |
503 | struct hol_cluster *cl = malloc (sizeof (struct hol_cluster)); | |
504 | if (cl) | |
505 | { | |
506 | cl->group = group; | |
507 | cl->header = header; | |
508 | ||
509 | cl->index = index; | |
510 | cl->parent = parent; | |
1fb05e3d | 511 | cl->argp = argp; |
a133e7a4 | 512 | cl->depth = parent ? parent->depth + 1 : 0; |
c84142e8 UD |
513 | |
514 | cl->next = hol->clusters; | |
515 | hol->clusters = cl; | |
516 | } | |
517 | return cl; | |
518 | } | |
519 | \f | |
520 | /* Free HOL and any resources it uses. */ | |
521 | static void | |
522 | hol_free (struct hol *hol) | |
523 | { | |
524 | struct hol_cluster *cl = hol->clusters; | |
525 | ||
526 | while (cl) | |
527 | { | |
528 | struct hol_cluster *next = cl->next; | |
529 | free (cl); | |
530 | cl = next; | |
531 | } | |
532 | ||
533 | if (hol->num_entries > 0) | |
534 | { | |
535 | free (hol->entries); | |
536 | free (hol->short_options); | |
537 | } | |
538 | ||
539 | free (hol); | |
540 | } | |
541 | \f | |
dd9423a6 | 542 | static int |
c84142e8 UD |
543 | hol_entry_short_iterate (const struct hol_entry *entry, |
544 | int (*func)(const struct argp_option *opt, | |
545 | const struct argp_option *real, | |
9184d3db UD |
546 | const char *domain, void *cookie), |
547 | const char *domain, void *cookie) | |
c84142e8 UD |
548 | { |
549 | unsigned nopts; | |
550 | int val = 0; | |
551 | const struct argp_option *opt, *real = entry->opt; | |
552 | char *so = entry->short_options; | |
553 | ||
554 | for (opt = real, nopts = entry->num; nopts > 0 && !val; opt++, nopts--) | |
555 | if (oshort (opt) && *so == opt->key) | |
556 | { | |
557 | if (!oalias (opt)) | |
558 | real = opt; | |
559 | if (ovisible (opt)) | |
9184d3db | 560 | val = (*func)(opt, real, domain, cookie); |
c84142e8 UD |
561 | so++; |
562 | } | |
563 | ||
564 | return val; | |
565 | } | |
566 | ||
567 | static inline int | |
f39941e4 | 568 | __attribute__ ((always_inline)) |
c84142e8 UD |
569 | hol_entry_long_iterate (const struct hol_entry *entry, |
570 | int (*func)(const struct argp_option *opt, | |
571 | const struct argp_option *real, | |
9184d3db UD |
572 | const char *domain, void *cookie), |
573 | const char *domain, void *cookie) | |
c84142e8 UD |
574 | { |
575 | unsigned nopts; | |
576 | int val = 0; | |
577 | const struct argp_option *opt, *real = entry->opt; | |
578 | ||
579 | for (opt = real, nopts = entry->num; nopts > 0 && !val; opt++, nopts--) | |
580 | if (opt->name) | |
581 | { | |
582 | if (!oalias (opt)) | |
583 | real = opt; | |
584 | if (ovisible (opt)) | |
9184d3db | 585 | val = (*func)(opt, real, domain, cookie); |
c84142e8 UD |
586 | } |
587 | ||
588 | return val; | |
589 | } | |
590 | \f | |
591 | /* Iterator that returns true for the first short option. */ | |
592 | static inline int | |
593 | until_short (const struct argp_option *opt, const struct argp_option *real, | |
9184d3db | 594 | const char *domain, void *cookie) |
c84142e8 UD |
595 | { |
596 | return oshort (opt) ? opt->key : 0; | |
597 | } | |
598 | ||
599 | /* Returns the first valid short option in ENTRY, or 0 if there is none. */ | |
600 | static char | |
601 | hol_entry_first_short (const struct hol_entry *entry) | |
602 | { | |
9184d3db UD |
603 | return hol_entry_short_iterate (entry, until_short, |
604 | entry->argp->argp_domain, 0); | |
c84142e8 UD |
605 | } |
606 | ||
607 | /* Returns the first valid long option in ENTRY, or 0 if there is none. */ | |
608 | static const char * | |
609 | hol_entry_first_long (const struct hol_entry *entry) | |
610 | { | |
611 | const struct argp_option *opt; | |
612 | unsigned num; | |
613 | for (opt = entry->opt, num = entry->num; num > 0; opt++, num--) | |
614 | if (opt->name && ovisible (opt)) | |
615 | return opt->name; | |
616 | return 0; | |
617 | } | |
618 | ||
619 | /* Returns the entry in HOL with the long option name NAME, or 0 if there is | |
620 | none. */ | |
621 | static struct hol_entry * | |
622 | hol_find_entry (struct hol *hol, const char *name) | |
623 | { | |
624 | struct hol_entry *entry = hol->entries; | |
625 | unsigned num_entries = hol->num_entries; | |
626 | ||
627 | while (num_entries-- > 0) | |
628 | { | |
629 | const struct argp_option *opt = entry->opt; | |
630 | unsigned num_opts = entry->num; | |
631 | ||
632 | while (num_opts-- > 0) | |
633 | if (opt->name && ovisible (opt) && strcmp (opt->name, name) == 0) | |
634 | return entry; | |
635 | else | |
636 | opt++; | |
637 | ||
638 | entry++; | |
639 | } | |
640 | ||
641 | return 0; | |
642 | } | |
643 | \f | |
644 | /* If an entry with the long option NAME occurs in HOL, set it's special | |
645 | sort position to GROUP. */ | |
646 | static void | |
647 | hol_set_group (struct hol *hol, const char *name, int group) | |
648 | { | |
649 | struct hol_entry *entry = hol_find_entry (hol, name); | |
650 | if (entry) | |
651 | entry->group = group; | |
652 | } | |
653 | \f | |
654 | /* Order by group: 0, 1, 2, ..., n, -m, ..., -2, -1. | |
655 | EQ is what to return if GROUP1 and GROUP2 are the same. */ | |
656 | static int | |
657 | group_cmp (int group1, int group2, int eq) | |
658 | { | |
659 | if (group1 == group2) | |
660 | return eq; | |
661 | else if ((group1 < 0 && group2 < 0) || (group1 >= 0 && group2 >= 0)) | |
662 | return group1 - group2; | |
663 | else | |
664 | return group2 - group1; | |
665 | } | |
666 | ||
667 | /* Compare clusters CL1 & CL2 by the order that they should appear in | |
668 | output. */ | |
669 | static int | |
670 | hol_cluster_cmp (const struct hol_cluster *cl1, const struct hol_cluster *cl2) | |
671 | { | |
672 | /* If one cluster is deeper than the other, use its ancestor at the same | |
673 | level, so that finding the common ancestor is straightforward. */ | |
44969f17 | 674 | while (cl1->depth > cl2->depth) |
c84142e8 | 675 | cl1 = cl1->parent; |
44969f17 | 676 | while (cl2->depth > cl1->depth) |
c84142e8 UD |
677 | cl2 = cl2->parent; |
678 | ||
679 | /* Now reduce both clusters to their ancestors at the point where both have | |
680 | a common parent; these can be directly compared. */ | |
681 | while (cl1->parent != cl2->parent) | |
682 | cl1 = cl1->parent, cl2 = cl2->parent; | |
683 | ||
684 | return group_cmp (cl1->group, cl2->group, cl2->index - cl1->index); | |
685 | } | |
686 | ||
687 | /* Return the ancestor of CL that's just below the root (i.e., has a parent | |
688 | of 0). */ | |
689 | static struct hol_cluster * | |
690 | hol_cluster_base (struct hol_cluster *cl) | |
691 | { | |
692 | while (cl->parent) | |
693 | cl = cl->parent; | |
694 | return cl; | |
695 | } | |
696 | ||
697 | /* Return true if CL1 is a child of CL2. */ | |
698 | static int | |
699 | hol_cluster_is_child (const struct hol_cluster *cl1, | |
700 | const struct hol_cluster *cl2) | |
701 | { | |
702 | while (cl1 && cl1 != cl2) | |
703 | cl1 = cl1->parent; | |
704 | return cl1 == cl2; | |
705 | } | |
706 | \f | |
707 | /* Given the name of a OPTION_DOC option, modifies NAME to start at the tail | |
708 | that should be used for comparisons, and returns true iff it should be | |
709 | treated as a non-option. */ | |
710 | static int | |
711 | canon_doc_option (const char **name) | |
712 | { | |
713 | int non_opt; | |
714 | /* Skip initial whitespace. */ | |
43b0e40f | 715 | while (isspace (**name)) |
c84142e8 UD |
716 | (*name)++; |
717 | /* Decide whether this looks like an option (leading `-') or not. */ | |
718 | non_opt = (**name != '-'); | |
719 | /* Skip until part of name used for sorting. */ | |
43b0e40f | 720 | while (**name && !isalnum (**name)) |
c84142e8 UD |
721 | (*name)++; |
722 | return non_opt; | |
723 | } | |
724 | ||
725 | /* Order ENTRY1 & ENTRY2 by the order which they should appear in a help | |
726 | listing. */ | |
727 | static int | |
9184d3db UD |
728 | hol_entry_cmp (const struct hol_entry *entry1, |
729 | const struct hol_entry *entry2) | |
c84142e8 UD |
730 | { |
731 | /* The group numbers by which the entries should be ordered; if either is | |
732 | in a cluster, then this is just the group within the cluster. */ | |
733 | int group1 = entry1->group, group2 = entry2->group; | |
734 | ||
735 | if (entry1->cluster != entry2->cluster) | |
6e4c40ba UD |
736 | { |
737 | /* The entries are not within the same cluster, so we can't compare them | |
738 | directly, we have to use the appropiate clustering level too. */ | |
739 | if (! entry1->cluster) | |
740 | /* ENTRY1 is at the `base level', not in a cluster, so we have to | |
741 | compare it's group number with that of the base cluster in which | |
742 | ENTRY2 resides. Note that if they're in the same group, the | |
743 | clustered option always comes laster. */ | |
744 | return group_cmp (group1, hol_cluster_base (entry2->cluster)->group, -1); | |
745 | else if (! entry2->cluster) | |
746 | /* Likewise, but ENTRY2's not in a cluster. */ | |
747 | return group_cmp (hol_cluster_base (entry1->cluster)->group, group2, 1); | |
748 | else | |
749 | /* Both entries are in clusters, we can just compare the clusters. */ | |
750 | return hol_cluster_cmp (entry1->cluster, entry2->cluster); | |
751 | } | |
c84142e8 UD |
752 | else if (group1 == group2) |
753 | /* The entries are both in the same cluster and group, so compare them | |
754 | alphabetically. */ | |
755 | { | |
756 | int short1 = hol_entry_first_short (entry1); | |
757 | int short2 = hol_entry_first_short (entry2); | |
758 | int doc1 = odoc (entry1->opt); | |
759 | int doc2 = odoc (entry2->opt); | |
760 | const char *long1 = hol_entry_first_long (entry1); | |
761 | const char *long2 = hol_entry_first_long (entry2); | |
762 | ||
763 | if (doc1) | |
e7c8359e | 764 | doc1 = long1 != NULL && canon_doc_option (&long1); |
c84142e8 | 765 | if (doc2) |
e7c8359e | 766 | doc2 = long2 != NULL && canon_doc_option (&long2); |
c84142e8 UD |
767 | |
768 | if (doc1 != doc2) | |
769 | /* `documentation' options always follow normal options (or | |
770 | documentation options that *look* like normal options). */ | |
771 | return doc1 - doc2; | |
772 | else if (!short1 && !short2 && long1 && long2) | |
773 | /* Only long options. */ | |
774 | return __strcasecmp (long1, long2); | |
775 | else | |
776 | /* Compare short/short, long/short, short/long, using the first | |
777 | character of long options. Entries without *any* valid | |
778 | options (such as options with OPTION_HIDDEN set) will be put | |
779 | first, but as they're not displayed, it doesn't matter where | |
780 | they are. */ | |
781 | { | |
782 | char first1 = short1 ? short1 : long1 ? *long1 : 0; | |
783 | char first2 = short2 ? short2 : long2 ? *long2 : 0; | |
4caef86c UD |
784 | #ifdef _tolower |
785 | int lower_cmp = _tolower (first1) - _tolower (first2); | |
786 | #else | |
c84142e8 | 787 | int lower_cmp = tolower (first1) - tolower (first2); |
4caef86c | 788 | #endif |
c84142e8 UD |
789 | /* Compare ignoring case, except when the options are both the |
790 | same letter, in which case lower-case always comes first. */ | |
791 | return lower_cmp ? lower_cmp : first2 - first1; | |
792 | } | |
793 | } | |
794 | else | |
795 | /* Within the same cluster, but not the same group, so just compare | |
796 | groups. */ | |
797 | return group_cmp (group1, group2, 0); | |
798 | } | |
799 | ||
800 | /* Version of hol_entry_cmp with correct signature for qsort. */ | |
801 | static int | |
802 | hol_entry_qcmp (const void *entry1_v, const void *entry2_v) | |
803 | { | |
804 | return hol_entry_cmp (entry1_v, entry2_v); | |
805 | } | |
806 | ||
807 | /* Sort HOL by group and alphabetically by option name (with short options | |
808 | taking precedence over long). Since the sorting is for display purposes | |
809 | only, the shadowing of options isn't effected. */ | |
810 | static void | |
811 | hol_sort (struct hol *hol) | |
812 | { | |
813 | if (hol->num_entries > 0) | |
814 | qsort (hol->entries, hol->num_entries, sizeof (struct hol_entry), | |
815 | hol_entry_qcmp); | |
816 | } | |
817 | \f | |
818 | /* Append MORE to HOL, destroying MORE in the process. Options in HOL shadow | |
819 | any in MORE with the same name. */ | |
820 | static void | |
821 | hol_append (struct hol *hol, struct hol *more) | |
822 | { | |
823 | struct hol_cluster **cl_end = &hol->clusters; | |
824 | ||
825 | /* Steal MORE's cluster list, and add it to the end of HOL's. */ | |
826 | while (*cl_end) | |
827 | cl_end = &(*cl_end)->next; | |
828 | *cl_end = more->clusters; | |
829 | more->clusters = 0; | |
830 | ||
831 | /* Merge entries. */ | |
832 | if (more->num_entries > 0) | |
94b78bb2 UD |
833 | { |
834 | if (hol->num_entries == 0) | |
835 | { | |
836 | hol->num_entries = more->num_entries; | |
837 | hol->entries = more->entries; | |
838 | hol->short_options = more->short_options; | |
839 | more->num_entries = 0; /* Mark MORE's fields as invalid. */ | |
840 | } | |
841 | else | |
842 | /* Append the entries in MORE to those in HOL, taking care to only add | |
843 | non-shadowed SHORT_OPTIONS values. */ | |
844 | { | |
845 | unsigned left; | |
846 | char *so, *more_so; | |
847 | struct hol_entry *e; | |
848 | unsigned num_entries = hol->num_entries + more->num_entries; | |
849 | struct hol_entry *entries = | |
850 | malloc (num_entries * sizeof (struct hol_entry)); | |
851 | unsigned hol_so_len = strlen (hol->short_options); | |
852 | char *short_options = | |
853 | malloc (hol_so_len + strlen (more->short_options) + 1); | |
854 | ||
abca9f7f UD |
855 | assert (entries && short_options); |
856 | #if SIZE_MAX <= UINT_MAX | |
857 | assert (num_entries <= SIZE_MAX / sizeof (struct hol_entry)); | |
858 | #endif | |
32868f88 | 859 | |
94b78bb2 UD |
860 | __mempcpy (__mempcpy (entries, hol->entries, |
861 | hol->num_entries * sizeof (struct hol_entry)), | |
862 | more->entries, | |
863 | more->num_entries * sizeof (struct hol_entry)); | |
864 | ||
865 | __mempcpy (short_options, hol->short_options, hol_so_len); | |
c84142e8 | 866 | |
7ef90c15 | 867 | /* Fix up the short options pointers from HOL. */ |
94b78bb2 UD |
868 | for (e = entries, left = hol->num_entries; left > 0; e++, left--) |
869 | e->short_options += (short_options - hol->short_options); | |
c84142e8 | 870 | |
7ef90c15 UD |
871 | /* Now add the short options from MORE, fixing up its entries |
872 | too. */ | |
94b78bb2 UD |
873 | so = short_options + hol_so_len; |
874 | more_so = more->short_options; | |
875 | for (left = more->num_entries; left > 0; e++, left--) | |
876 | { | |
877 | int opts_left; | |
878 | const struct argp_option *opt; | |
c84142e8 | 879 | |
94b78bb2 | 880 | e->short_options = so; |
c84142e8 | 881 | |
94b78bb2 UD |
882 | for (opts_left = e->num, opt = e->opt; opts_left; opt++, opts_left--) |
883 | { | |
884 | int ch = *more_so; | |
885 | if (oshort (opt) && ch == opt->key) | |
886 | /* The next short option in MORE_SO, CH, is from OPT. */ | |
887 | { | |
888 | if (! find_char (ch, short_options, | |
889 | short_options + hol_so_len)) | |
890 | /* The short option CH isn't shadowed by HOL's options, | |
891 | so add it to the sum. */ | |
892 | *so++ = ch; | |
893 | more_so++; | |
894 | } | |
895 | } | |
896 | } | |
c84142e8 | 897 | |
8ea4a95a | 898 | *so = '\0'; |
c84142e8 | 899 | |
8ea4a95a UD |
900 | free (hol->entries); |
901 | free (hol->short_options); | |
c84142e8 | 902 | |
8ea4a95a UD |
903 | hol->entries = entries; |
904 | hol->num_entries = num_entries; | |
905 | hol->short_options = short_options; | |
906 | } | |
7ef90c15 | 907 | } |
c84142e8 UD |
908 | |
909 | hol_free (more); | |
910 | } | |
911 | \f | |
912 | /* Inserts enough spaces to make sure STREAM is at column COL. */ | |
913 | static void | |
914 | indent_to (argp_fmtstream_t stream, unsigned col) | |
915 | { | |
916 | int needed = col - __argp_fmtstream_point (stream); | |
917 | while (needed-- > 0) | |
918 | __argp_fmtstream_putc (stream, ' '); | |
919 | } | |
920 | ||
1fb05e3d UD |
921 | /* Output to STREAM either a space, or a newline if there isn't room for at |
922 | least ENSURE characters before the right margin. */ | |
923 | static void | |
924 | space (argp_fmtstream_t stream, size_t ensure) | |
925 | { | |
926 | if (__argp_fmtstream_point (stream) + ensure | |
927 | >= __argp_fmtstream_rmargin (stream)) | |
928 | __argp_fmtstream_putc (stream, '\n'); | |
929 | else | |
930 | __argp_fmtstream_putc (stream, ' '); | |
931 | } | |
932 | ||
c84142e8 UD |
933 | /* If the option REAL has an argument, we print it in using the printf |
934 | format REQ_FMT or OPT_FMT depending on whether it's a required or | |
935 | optional argument. */ | |
936 | static void | |
937 | arg (const struct argp_option *real, const char *req_fmt, const char *opt_fmt, | |
9184d3db | 938 | const char *domain, argp_fmtstream_t stream) |
c84142e8 UD |
939 | { |
940 | if (real->arg) | |
94b78bb2 UD |
941 | { |
942 | if (real->flags & OPTION_ARG_OPTIONAL) | |
943 | __argp_fmtstream_printf (stream, opt_fmt, | |
944 | dgettext (domain, real->arg)); | |
945 | else | |
946 | __argp_fmtstream_printf (stream, req_fmt, | |
947 | dgettext (domain, real->arg)); | |
948 | } | |
c84142e8 UD |
949 | } |
950 | \f | |
951 | /* Helper functions for hol_entry_help. */ | |
952 | ||
5a97622d | 953 | /* State used during the execution of hol_help. */ |
4cca6b86 | 954 | struct hol_help_state |
5a97622d UD |
955 | { |
956 | /* PREV_ENTRY should contain the previous entry printed, or 0. */ | |
957 | struct hol_entry *prev_entry; | |
958 | ||
959 | /* If an entry is in a different group from the previous one, and SEP_GROUPS | |
960 | is true, then a blank line will be printed before any output. */ | |
961 | int sep_groups; | |
962 | ||
963 | /* True if a duplicate option argument was suppressed (only ever set if | |
964 | UPARAMS.dup_args is false). */ | |
965 | int suppressed_dup_arg; | |
966 | }; | |
967 | ||
c84142e8 UD |
968 | /* Some state used while printing a help entry (used to communicate with |
969 | helper functions). See the doc for hol_entry_help for more info, as most | |
970 | of the fields are copied from its arguments. */ | |
971 | struct pentry_state | |
972 | { | |
973 | const struct hol_entry *entry; | |
974 | argp_fmtstream_t stream; | |
5a97622d | 975 | struct hol_help_state *hhstate; |
c84142e8 | 976 | |
1fb05e3d UD |
977 | /* True if nothing's been printed so far. */ |
978 | int first; | |
979 | ||
980 | /* If non-zero, the state that was used to print this help. */ | |
981 | const struct argp_state *state; | |
c84142e8 UD |
982 | }; |
983 | ||
1fb05e3d UD |
984 | /* If a user doc filter should be applied to DOC, do so. */ |
985 | static const char * | |
986 | filter_doc (const char *doc, int key, const struct argp *argp, | |
5a97622d | 987 | const struct argp_state *state) |
1fb05e3d | 988 | { |
44969f17 | 989 | if (argp && argp->help_filter) |
1fb05e3d UD |
990 | /* We must apply a user filter to this output. */ |
991 | { | |
5a97622d | 992 | void *input = __argp_input (argp, state); |
1fb05e3d UD |
993 | return (*argp->help_filter) (key, doc, input); |
994 | } | |
995 | else | |
996 | /* No filter. */ | |
714a562f | 997 | return doc; |
1fb05e3d UD |
998 | } |
999 | ||
c84142e8 | 1000 | /* Prints STR as a header line, with the margin lines set appropiately, and |
1fb05e3d UD |
1001 | notes the fact that groups should be separated with a blank line. ARGP is |
1002 | the argp that should dictate any user doc filtering to take place. Note | |
c84142e8 UD |
1003 | that the previous wrap margin isn't restored, but the left margin is reset |
1004 | to 0. */ | |
1005 | static void | |
1fb05e3d UD |
1006 | print_header (const char *str, const struct argp *argp, |
1007 | struct pentry_state *pest) | |
c84142e8 | 1008 | { |
9184d3db | 1009 | const char *tstr = dgettext (argp->argp_domain, str); |
5a97622d | 1010 | const char *fstr = filter_doc (tstr, ARGP_KEY_HELP_HEADER, argp, pest->state); |
1fb05e3d UD |
1011 | |
1012 | if (fstr) | |
c84142e8 | 1013 | { |
1fb05e3d UD |
1014 | if (*fstr) |
1015 | { | |
5a97622d | 1016 | if (pest->hhstate->prev_entry) |
1fb05e3d UD |
1017 | /* Precede with a blank line. */ |
1018 | __argp_fmtstream_putc (pest->stream, '\n'); | |
5a97622d UD |
1019 | indent_to (pest->stream, uparams.header_col); |
1020 | __argp_fmtstream_set_lmargin (pest->stream, uparams.header_col); | |
1021 | __argp_fmtstream_set_wmargin (pest->stream, uparams.header_col); | |
1fb05e3d UD |
1022 | __argp_fmtstream_puts (pest->stream, fstr); |
1023 | __argp_fmtstream_set_lmargin (pest->stream, 0); | |
1024 | __argp_fmtstream_putc (pest->stream, '\n'); | |
1025 | } | |
1026 | ||
5a97622d | 1027 | pest->hhstate->sep_groups = 1; /* Separate subsequent groups. */ |
c84142e8 UD |
1028 | } |
1029 | ||
1fb05e3d UD |
1030 | if (fstr != tstr) |
1031 | free ((char *) fstr); | |
c84142e8 UD |
1032 | } |
1033 | ||
1034 | /* Inserts a comma if this isn't the first item on the line, and then makes | |
1fb05e3d UD |
1035 | sure we're at least to column COL. If this *is* the first item on a line, |
1036 | prints any pending whitespace/headers that should precede this line. Also | |
1037 | clears FIRST. */ | |
c84142e8 | 1038 | static void |
1fb05e3d | 1039 | comma (unsigned col, struct pentry_state *pest) |
c84142e8 | 1040 | { |
1fb05e3d | 1041 | if (pest->first) |
c84142e8 | 1042 | { |
5a97622d | 1043 | const struct hol_entry *pe = pest->hhstate->prev_entry; |
1fb05e3d | 1044 | const struct hol_cluster *cl = pest->entry->cluster; |
c84142e8 | 1045 | |
5a97622d | 1046 | if (pest->hhstate->sep_groups && pe && pest->entry->group != pe->group) |
1fb05e3d | 1047 | __argp_fmtstream_putc (pest->stream, '\n'); |
c84142e8 | 1048 | |
9498096c UD |
1049 | if (cl && cl->header && *cl->header |
1050 | && (!pe | |
1051 | || (pe->cluster != cl | |
1052 | && !hol_cluster_is_child (pe->cluster, cl)))) | |
c84142e8 UD |
1053 | /* If we're changing clusters, then this must be the start of the |
1054 | ENTRY's cluster unless that is an ancestor of the previous one | |
1055 | (in which case we had just popped into a sub-cluster for a bit). | |
1056 | If so, then print the cluster's header line. */ | |
1057 | { | |
1fb05e3d UD |
1058 | int old_wm = __argp_fmtstream_wmargin (pest->stream); |
1059 | print_header (cl->header, cl->argp, pest); | |
1060 | __argp_fmtstream_set_wmargin (pest->stream, old_wm); | |
c84142e8 UD |
1061 | } |
1062 | ||
1fb05e3d | 1063 | pest->first = 0; |
c84142e8 UD |
1064 | } |
1065 | else | |
1fb05e3d | 1066 | __argp_fmtstream_puts (pest->stream, ", "); |
c84142e8 | 1067 | |
1fb05e3d | 1068 | indent_to (pest->stream, col); |
c84142e8 UD |
1069 | } |
1070 | \f | |
5a97622d | 1071 | /* Print help for ENTRY to STREAM. */ |
c84142e8 | 1072 | static void |
1fb05e3d | 1073 | hol_entry_help (struct hol_entry *entry, const struct argp_state *state, |
5a97622d | 1074 | argp_fmtstream_t stream, struct hol_help_state *hhstate) |
c84142e8 UD |
1075 | { |
1076 | unsigned num; | |
1077 | const struct argp_option *real = entry->opt, *opt; | |
1078 | char *so = entry->short_options; | |
5a97622d | 1079 | int have_long_opt = 0; /* We have any long options. */ |
1fb05e3d | 1080 | /* Saved margins. */ |
c84142e8 UD |
1081 | int old_lm = __argp_fmtstream_set_lmargin (stream, 0); |
1082 | int old_wm = __argp_fmtstream_wmargin (stream); | |
1fb05e3d UD |
1083 | /* PEST is a state block holding some of our variables that we'd like to |
1084 | share with helper functions. */ | |
5a97622d UD |
1085 | struct pentry_state pest = { entry, stream, hhstate, 1, state }; |
1086 | ||
1087 | if (! odoc (real)) | |
1088 | for (opt = real, num = entry->num; num > 0; opt++, num--) | |
1089 | if (opt->name && ovisible (opt)) | |
1090 | { | |
1091 | have_long_opt = 1; | |
1092 | break; | |
1093 | } | |
c84142e8 UD |
1094 | |
1095 | /* First emit short options. */ | |
5a97622d | 1096 | __argp_fmtstream_set_wmargin (stream, uparams.short_opt_col); /* For truly bizarre cases. */ |
c84142e8 UD |
1097 | for (opt = real, num = entry->num; num > 0; opt++, num--) |
1098 | if (oshort (opt) && opt->key == *so) | |
1099 | /* OPT has a valid (non shadowed) short option. */ | |
1100 | { | |
1101 | if (ovisible (opt)) | |
1102 | { | |
5a97622d | 1103 | comma (uparams.short_opt_col, &pest); |
c84142e8 UD |
1104 | __argp_fmtstream_putc (stream, '-'); |
1105 | __argp_fmtstream_putc (stream, *so); | |
5a97622d | 1106 | if (!have_long_opt || uparams.dup_args) |
400cc70a UD |
1107 | arg (real, " %s", "[%s]", |
1108 | state == NULL ? NULL : state->root_argp->argp_domain, | |
1109 | stream); | |
5a97622d UD |
1110 | else if (real->arg) |
1111 | hhstate->suppressed_dup_arg = 1; | |
c84142e8 UD |
1112 | } |
1113 | so++; | |
1114 | } | |
1115 | ||
1116 | /* Now, long options. */ | |
1117 | if (odoc (real)) | |
1fb05e3d | 1118 | /* A `documentation' option. */ |
c84142e8 | 1119 | { |
5a97622d | 1120 | __argp_fmtstream_set_wmargin (stream, uparams.doc_opt_col); |
c84142e8 UD |
1121 | for (opt = real, num = entry->num; num > 0; opt++, num--) |
1122 | if (opt->name && ovisible (opt)) | |
1123 | { | |
5a97622d | 1124 | comma (uparams.doc_opt_col, &pest); |
c84142e8 UD |
1125 | /* Calling gettext here isn't quite right, since sorting will |
1126 | have been done on the original; but documentation options | |
1127 | should be pretty rare anyway... */ | |
9184d3db | 1128 | __argp_fmtstream_puts (stream, |
400cc70a UD |
1129 | dgettext (state == NULL ? NULL |
1130 | : state->root_argp->argp_domain, | |
9184d3db | 1131 | opt->name)); |
c84142e8 UD |
1132 | } |
1133 | } | |
1134 | else | |
1fb05e3d | 1135 | /* A real long option. */ |
c84142e8 | 1136 | { |
5a97622d | 1137 | __argp_fmtstream_set_wmargin (stream, uparams.long_opt_col); |
c84142e8 UD |
1138 | for (opt = real, num = entry->num; num > 0; opt++, num--) |
1139 | if (opt->name && ovisible (opt)) | |
1140 | { | |
5a97622d | 1141 | comma (uparams.long_opt_col, &pest); |
c84142e8 | 1142 | __argp_fmtstream_printf (stream, "--%s", opt->name); |
400cc70a UD |
1143 | arg (real, "=%s", "[=%s]", |
1144 | state == NULL ? NULL : state->root_argp->argp_domain, stream); | |
c84142e8 UD |
1145 | } |
1146 | } | |
1147 | ||
1fb05e3d | 1148 | /* Next, documentation strings. */ |
c84142e8 | 1149 | __argp_fmtstream_set_lmargin (stream, 0); |
1fb05e3d | 1150 | |
c84142e8 | 1151 | if (pest.first) |
6e4c40ba UD |
1152 | { |
1153 | /* Didn't print any switches, what's up? */ | |
1154 | if (!oshort (real) && !real->name) | |
1155 | /* This is a group header, print it nicely. */ | |
1156 | print_header (real->doc, entry->argp, &pest); | |
1157 | else | |
1158 | /* Just a totally shadowed option or null header; print nothing. */ | |
1159 | goto cleanup; /* Just return, after cleaning up. */ | |
1160 | } | |
1fb05e3d | 1161 | else |
c84142e8 | 1162 | { |
400cc70a UD |
1163 | const char *tstr = real->doc ? dgettext (state == NULL ? NULL |
1164 | : state->root_argp->argp_domain, | |
9184d3db | 1165 | real->doc) : 0; |
5a97622d | 1166 | const char *fstr = filter_doc (tstr, real->key, entry->argp, state); |
1fb05e3d UD |
1167 | if (fstr && *fstr) |
1168 | { | |
c131718c | 1169 | unsigned int col = __argp_fmtstream_point (stream); |
c84142e8 | 1170 | |
5a97622d UD |
1171 | __argp_fmtstream_set_lmargin (stream, uparams.opt_doc_col); |
1172 | __argp_fmtstream_set_wmargin (stream, uparams.opt_doc_col); | |
c84142e8 | 1173 | |
c131718c | 1174 | if (col > (unsigned int) (uparams.opt_doc_col + 3)) |
1fb05e3d | 1175 | __argp_fmtstream_putc (stream, '\n'); |
c131718c | 1176 | else if (col >= (unsigned int) uparams.opt_doc_col) |
1fb05e3d UD |
1177 | __argp_fmtstream_puts (stream, " "); |
1178 | else | |
5a97622d | 1179 | indent_to (stream, uparams.opt_doc_col); |
c84142e8 | 1180 | |
1fb05e3d UD |
1181 | __argp_fmtstream_puts (stream, fstr); |
1182 | } | |
1183 | if (fstr && fstr != tstr) | |
1184 | free ((char *) fstr); | |
c84142e8 UD |
1185 | |
1186 | /* Reset the left margin. */ | |
1187 | __argp_fmtstream_set_lmargin (stream, 0); | |
1fb05e3d | 1188 | __argp_fmtstream_putc (stream, '\n'); |
c84142e8 UD |
1189 | } |
1190 | ||
5a97622d | 1191 | hhstate->prev_entry = entry; |
c84142e8 UD |
1192 | |
1193 | cleanup: | |
1194 | __argp_fmtstream_set_lmargin (stream, old_lm); | |
1195 | __argp_fmtstream_set_wmargin (stream, old_wm); | |
1196 | } | |
1197 | \f | |
1198 | /* Output a long help message about the options in HOL to STREAM. */ | |
1199 | static void | |
1fb05e3d UD |
1200 | hol_help (struct hol *hol, const struct argp_state *state, |
1201 | argp_fmtstream_t stream) | |
c84142e8 UD |
1202 | { |
1203 | unsigned num; | |
1204 | struct hol_entry *entry; | |
5a97622d UD |
1205 | struct hol_help_state hhstate = { 0, 0, 0 }; |
1206 | ||
c84142e8 | 1207 | for (entry = hol->entries, num = hol->num_entries; num > 0; entry++, num--) |
5a97622d UD |
1208 | hol_entry_help (entry, state, stream, &hhstate); |
1209 | ||
1210 | if (hhstate.suppressed_dup_arg && uparams.dup_args_note) | |
1211 | { | |
400cc70a UD |
1212 | const char *tstr = dgettext (state == NULL ? NULL |
1213 | : state->root_argp->argp_domain, "\ | |
5a97622d UD |
1214 | Mandatory or optional arguments to long options are also mandatory or \ |
1215 | optional for any corresponding short options."); | |
1216 | const char *fstr = filter_doc (tstr, ARGP_KEY_HELP_DUP_ARGS_NOTE, | |
ebbad4cc | 1217 | state ? state->root_argp : 0, state); |
5a97622d UD |
1218 | if (fstr && *fstr) |
1219 | { | |
1220 | __argp_fmtstream_putc (stream, '\n'); | |
1221 | __argp_fmtstream_puts (stream, fstr); | |
1222 | __argp_fmtstream_putc (stream, '\n'); | |
1223 | } | |
1224 | if (fstr && fstr != tstr) | |
1225 | free ((char *) fstr); | |
1226 | } | |
c84142e8 UD |
1227 | } |
1228 | \f | |
1229 | /* Helper functions for hol_usage. */ | |
1230 | ||
1231 | /* If OPT is a short option without an arg, append its key to the string | |
1232 | pointer pointer to by COOKIE, and advance the pointer. */ | |
1233 | static int | |
1234 | add_argless_short_opt (const struct argp_option *opt, | |
1235 | const struct argp_option *real, | |
9184d3db | 1236 | const char *domain, void *cookie) |
c84142e8 UD |
1237 | { |
1238 | char **snao_end = cookie; | |
5a97622d UD |
1239 | if (!(opt->arg || real->arg) |
1240 | && !((opt->flags | real->flags) & OPTION_NO_USAGE)) | |
c84142e8 UD |
1241 | *(*snao_end)++ = opt->key; |
1242 | return 0; | |
1243 | } | |
1244 | ||
1245 | /* If OPT is a short option with an arg, output a usage entry for it to the | |
1246 | stream pointed at by COOKIE. */ | |
1247 | static int | |
1248 | usage_argful_short_opt (const struct argp_option *opt, | |
1249 | const struct argp_option *real, | |
9184d3db | 1250 | const char *domain, void *cookie) |
c84142e8 UD |
1251 | { |
1252 | argp_fmtstream_t stream = cookie; | |
1253 | const char *arg = opt->arg; | |
5a97622d | 1254 | int flags = opt->flags | real->flags; |
c84142e8 UD |
1255 | |
1256 | if (! arg) | |
1257 | arg = real->arg; | |
1258 | ||
5a97622d | 1259 | if (arg && !(flags & OPTION_NO_USAGE)) |
c84142e8 | 1260 | { |
9184d3db | 1261 | arg = dgettext (domain, arg); |
c84142e8 | 1262 | |
5a97622d | 1263 | if (flags & OPTION_ARG_OPTIONAL) |
c84142e8 UD |
1264 | __argp_fmtstream_printf (stream, " [-%c[%s]]", opt->key, arg); |
1265 | else | |
1266 | { | |
1267 | /* Manually do line wrapping so that it (probably) won't | |
1268 | get wrapped at the embedded space. */ | |
1fb05e3d | 1269 | space (stream, 6 + strlen (arg)); |
c84142e8 UD |
1270 | __argp_fmtstream_printf (stream, "[-%c %s]", opt->key, arg); |
1271 | } | |
1272 | } | |
1273 | ||
1274 | return 0; | |
1275 | } | |
1276 | ||
1277 | /* Output a usage entry for the long option opt to the stream pointed at by | |
1278 | COOKIE. */ | |
1279 | static int | |
1280 | usage_long_opt (const struct argp_option *opt, | |
1281 | const struct argp_option *real, | |
9184d3db | 1282 | const char *domain, void *cookie) |
c84142e8 UD |
1283 | { |
1284 | argp_fmtstream_t stream = cookie; | |
1285 | const char *arg = opt->arg; | |
5a97622d | 1286 | int flags = opt->flags | real->flags; |
c84142e8 UD |
1287 | |
1288 | if (! arg) | |
1289 | arg = real->arg; | |
1290 | ||
5a97622d | 1291 | if (! (flags & OPTION_NO_USAGE)) |
94b78bb2 UD |
1292 | { |
1293 | if (arg) | |
1294 | { | |
1295 | arg = dgettext (domain, arg); | |
1296 | if (flags & OPTION_ARG_OPTIONAL) | |
1297 | __argp_fmtstream_printf (stream, " [--%s[=%s]]", opt->name, arg); | |
1298 | else | |
1299 | __argp_fmtstream_printf (stream, " [--%s=%s]", opt->name, arg); | |
1300 | } | |
1301 | else | |
1302 | __argp_fmtstream_printf (stream, " [--%s]", opt->name); | |
1303 | } | |
c84142e8 UD |
1304 | |
1305 | return 0; | |
1306 | } | |
1307 | \f | |
1308 | /* Print a short usage description for the arguments in HOL to STREAM. */ | |
1309 | static void | |
1310 | hol_usage (struct hol *hol, argp_fmtstream_t stream) | |
1311 | { | |
1312 | if (hol->num_entries > 0) | |
1313 | { | |
1314 | unsigned nentries; | |
1315 | struct hol_entry *entry; | |
1316 | char *short_no_arg_opts = alloca (strlen (hol->short_options) + 1); | |
1317 | char *snao_end = short_no_arg_opts; | |
1318 | ||
1319 | /* First we put a list of short options without arguments. */ | |
1320 | for (entry = hol->entries, nentries = hol->num_entries | |
1321 | ; nentries > 0 | |
1322 | ; entry++, nentries--) | |
9184d3db UD |
1323 | hol_entry_short_iterate (entry, add_argless_short_opt, |
1324 | entry->argp->argp_domain, &snao_end); | |
c84142e8 UD |
1325 | if (snao_end > short_no_arg_opts) |
1326 | { | |
1327 | *snao_end++ = 0; | |
1328 | __argp_fmtstream_printf (stream, " [-%s]", short_no_arg_opts); | |
1329 | } | |
1330 | ||
1331 | /* Now a list of short options *with* arguments. */ | |
1332 | for (entry = hol->entries, nentries = hol->num_entries | |
1333 | ; nentries > 0 | |
1334 | ; entry++, nentries--) | |
9184d3db UD |
1335 | hol_entry_short_iterate (entry, usage_argful_short_opt, |
1336 | entry->argp->argp_domain, stream); | |
c84142e8 UD |
1337 | |
1338 | /* Finally, a list of long options (whew!). */ | |
1339 | for (entry = hol->entries, nentries = hol->num_entries | |
1340 | ; nentries > 0 | |
1341 | ; entry++, nentries--) | |
9184d3db UD |
1342 | hol_entry_long_iterate (entry, usage_long_opt, |
1343 | entry->argp->argp_domain, stream); | |
c84142e8 UD |
1344 | } |
1345 | } | |
1346 | \f | |
1347 | /* Make a HOL containing all levels of options in ARGP. CLUSTER is the | |
1348 | cluster in which ARGP's entries should be clustered, or 0. */ | |
1349 | static struct hol * | |
1350 | argp_hol (const struct argp *argp, struct hol_cluster *cluster) | |
1351 | { | |
1352 | const struct argp_child *child = argp->children; | |
1fb05e3d | 1353 | struct hol *hol = make_hol (argp, cluster); |
c84142e8 UD |
1354 | if (child) |
1355 | while (child->argp) | |
1356 | { | |
1357 | struct hol_cluster *child_cluster = | |
1358 | ((child->group || child->header) | |
1359 | /* Put CHILD->argp within its own cluster. */ | |
1360 | ? hol_add_cluster (hol, child->group, child->header, | |
1fb05e3d | 1361 | child - argp->children, cluster, argp) |
c84142e8 UD |
1362 | /* Just merge it into the parent's cluster. */ |
1363 | : cluster); | |
1364 | hol_append (hol, argp_hol (child->argp, child_cluster)) ; | |
1365 | child++; | |
1366 | } | |
1367 | return hol; | |
1368 | } | |
1369 | \f | |
1370 | /* Calculate how many different levels with alternative args strings exist in | |
1371 | ARGP. */ | |
1372 | static size_t | |
1373 | argp_args_levels (const struct argp *argp) | |
1374 | { | |
1375 | size_t levels = 0; | |
1376 | const struct argp_child *child = argp->children; | |
1377 | ||
1378 | if (argp->args_doc && strchr (argp->args_doc, '\n')) | |
1379 | levels++; | |
1380 | ||
1381 | if (child) | |
1382 | while (child->argp) | |
1383 | levels += argp_args_levels ((child++)->argp); | |
1384 | ||
1385 | return levels; | |
1386 | } | |
1387 | ||
1388 | /* Print all the non-option args documented in ARGP to STREAM. Any output is | |
1389 | preceded by a space. LEVELS is a pointer to a byte vector the length | |
1390 | returned by argp_args_levels; it should be initialized to zero, and | |
1391 | updated by this routine for the next call if ADVANCE is true. True is | |
1392 | returned as long as there are more patterns to output. */ | |
1393 | static int | |
9498096c UD |
1394 | argp_args_usage (const struct argp *argp, const struct argp_state *state, |
1395 | char **levels, int advance, argp_fmtstream_t stream) | |
c84142e8 UD |
1396 | { |
1397 | char *our_level = *levels; | |
1398 | int multiple = 0; | |
1399 | const struct argp_child *child = argp->children; | |
9184d3db | 1400 | const char *tdoc = dgettext (argp->argp_domain, argp->args_doc), *nl = 0; |
76b87c03 | 1401 | const char *fdoc = filter_doc (tdoc, ARGP_KEY_HELP_ARGS_DOC, argp, state); |
c84142e8 | 1402 | |
9498096c | 1403 | if (fdoc) |
c84142e8 | 1404 | { |
714a562f | 1405 | const char *cp = fdoc; |
390500b1 UD |
1406 | nl = __strchrnul (cp, '\n'); |
1407 | if (*nl != '\0') | |
c84142e8 UD |
1408 | /* This is a `multi-level' args doc; advance to the correct position |
1409 | as determined by our state in LEVELS, and update LEVELS. */ | |
1410 | { | |
1411 | int i; | |
1412 | multiple = 1; | |
1413 | for (i = 0; i < *our_level; i++) | |
390500b1 | 1414 | cp = nl + 1, nl = __strchrnul (cp, '\n'); |
c84142e8 UD |
1415 | (*levels)++; |
1416 | } | |
c84142e8 UD |
1417 | |
1418 | /* Manually do line wrapping so that it (probably) won't get wrapped at | |
1419 | any embedded spaces. */ | |
714a562f | 1420 | space (stream, 1 + nl - cp); |
c84142e8 | 1421 | |
714a562f | 1422 | __argp_fmtstream_write (stream, cp, nl - cp); |
c84142e8 | 1423 | } |
9498096c UD |
1424 | if (fdoc && fdoc != tdoc) |
1425 | free ((char *)fdoc); /* Free user's modified doc string. */ | |
c84142e8 UD |
1426 | |
1427 | if (child) | |
1428 | while (child->argp) | |
9498096c | 1429 | advance = !argp_args_usage ((child++)->argp, state, levels, advance, stream); |
c84142e8 UD |
1430 | |
1431 | if (advance && multiple) | |
94b78bb2 UD |
1432 | { |
1433 | /* Need to increment our level. */ | |
1434 | if (*nl) | |
1435 | /* There's more we can do here. */ | |
1436 | { | |
1437 | (*our_level)++; | |
1438 | advance = 0; /* Our parent shouldn't advance also. */ | |
1439 | } | |
1440 | else if (*our_level > 0) | |
1441 | /* We had multiple levels, but used them up; reset to zero. */ | |
1442 | *our_level = 0; | |
1443 | } | |
c84142e8 UD |
1444 | |
1445 | return !advance; | |
1446 | } | |
1447 | \f | |
1448 | /* Print the documentation for ARGP to STREAM; if POST is false, then | |
1449 | everything preceeding a `\v' character in the documentation strings (or | |
1450 | the whole string, for those with none) is printed, otherwise, everything | |
1451 | following the `\v' character (nothing for strings without). Each separate | |
1452 | bit of documentation is separated a blank line, and if PRE_BLANK is true, | |
1453 | then the first is as well. If FIRST_ONLY is true, only the first | |
49c091e5 | 1454 | occurrence is output. Returns true if anything was output. */ |
c84142e8 | 1455 | static int |
1fb05e3d UD |
1456 | argp_doc (const struct argp *argp, const struct argp_state *state, |
1457 | int post, int pre_blank, int first_only, | |
c84142e8 UD |
1458 | argp_fmtstream_t stream) |
1459 | { | |
1fb05e3d UD |
1460 | const char *text; |
1461 | const char *inp_text; | |
1462 | void *input = 0; | |
c84142e8 | 1463 | int anything = 0; |
1fb05e3d | 1464 | size_t inp_text_limit = 0; |
9184d3db | 1465 | const char *doc = dgettext (argp->argp_domain, argp->doc); |
1fb05e3d | 1466 | const struct argp_child *child = argp->children; |
c84142e8 UD |
1467 | |
1468 | if (doc) | |
1469 | { | |
1470 | char *vt = strchr (doc, '\v'); | |
1fb05e3d UD |
1471 | inp_text = post ? (vt ? vt + 1 : 0) : doc; |
1472 | inp_text_limit = (!post && vt) ? (vt - doc) : 0; | |
1473 | } | |
1474 | else | |
1475 | inp_text = 0; | |
c84142e8 | 1476 | |
1fb05e3d UD |
1477 | if (argp->help_filter) |
1478 | /* We have to filter the doc strings. */ | |
1479 | { | |
1480 | if (inp_text_limit) | |
1481 | /* Copy INP_TEXT so that it's nul-terminated. */ | |
50304ef0 | 1482 | inp_text = __strndup (inp_text, inp_text_limit); |
1fb05e3d UD |
1483 | input = __argp_input (argp, state); |
1484 | text = | |
1485 | (*argp->help_filter) (post | |
1486 | ? ARGP_KEY_HELP_POST_DOC | |
1487 | : ARGP_KEY_HELP_PRE_DOC, | |
1488 | inp_text, input); | |
1489 | } | |
1490 | else | |
1491 | text = (const char *) inp_text; | |
1492 | ||
1493 | if (text) | |
1494 | { | |
1495 | if (pre_blank) | |
c84142e8 UD |
1496 | __argp_fmtstream_putc (stream, '\n'); |
1497 | ||
1fb05e3d UD |
1498 | if (text == inp_text && inp_text_limit) |
1499 | __argp_fmtstream_write (stream, inp_text, inp_text_limit); | |
c84142e8 | 1500 | else |
1fb05e3d UD |
1501 | __argp_fmtstream_puts (stream, text); |
1502 | ||
c84142e8 UD |
1503 | if (__argp_fmtstream_point (stream) > __argp_fmtstream_lmargin (stream)) |
1504 | __argp_fmtstream_putc (stream, '\n'); | |
1505 | ||
1506 | anything = 1; | |
1507 | } | |
1fb05e3d UD |
1508 | |
1509 | if (text && text != inp_text) | |
1510 | free ((char *) text); /* Free TEXT returned from the help filter. */ | |
1511 | if (inp_text && inp_text_limit && argp->help_filter) | |
1512 | free ((char *) inp_text); /* We copied INP_TEXT, so free it now. */ | |
1513 | ||
1514 | if (post && argp->help_filter) | |
1515 | /* Now see if we have to output a ARGP_KEY_HELP_EXTRA text. */ | |
1516 | { | |
1517 | text = (*argp->help_filter) (ARGP_KEY_HELP_EXTRA, 0, input); | |
1518 | if (text) | |
1519 | { | |
1520 | if (anything || pre_blank) | |
1521 | __argp_fmtstream_putc (stream, '\n'); | |
1522 | __argp_fmtstream_puts (stream, text); | |
1523 | free ((char *) text); | |
1524 | if (__argp_fmtstream_point (stream) | |
1525 | > __argp_fmtstream_lmargin (stream)) | |
1526 | __argp_fmtstream_putc (stream, '\n'); | |
1527 | anything = 1; | |
1528 | } | |
1529 | } | |
1530 | ||
c84142e8 UD |
1531 | if (child) |
1532 | while (child->argp && !(first_only && anything)) | |
1533 | anything |= | |
1fb05e3d UD |
1534 | argp_doc ((child++)->argp, state, |
1535 | post, anything || pre_blank, first_only, | |
c84142e8 UD |
1536 | stream); |
1537 | ||
1538 | return anything; | |
1539 | } | |
1540 | \f | |
1fb05e3d UD |
1541 | /* Output a usage message for ARGP to STREAM. If called from |
1542 | argp_state_help, STATE is the relevent parsing state. FLAGS are from the | |
1543 | set ARGP_HELP_*. NAME is what to use wherever a `program name' is | |
1544 | needed. */ | |
1545 | static void | |
1546 | _help (const struct argp *argp, const struct argp_state *state, FILE *stream, | |
1547 | unsigned flags, char *name) | |
c84142e8 UD |
1548 | { |
1549 | int anything = 0; /* Whether we've output anything. */ | |
1550 | struct hol *hol = 0; | |
1551 | argp_fmtstream_t fs; | |
1552 | ||
1553 | if (! stream) | |
1554 | return; | |
1555 | ||
f39941e4 | 1556 | #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE) |
4aebaa6b | 1557 | __flockfile (stream); |
f39941e4 | 1558 | #endif |
50304ef0 | 1559 | |
e7c8359e | 1560 | fill_in_uparams (state); |
5a97622d UD |
1561 | |
1562 | fs = __argp_make_fmtstream (stream, 0, uparams.rmargin, 0); | |
c84142e8 | 1563 | if (! fs) |
50304ef0 | 1564 | { |
f39941e4 | 1565 | #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE) |
4aebaa6b | 1566 | __funlockfile (stream); |
f39941e4 | 1567 | #endif |
50304ef0 UD |
1568 | return; |
1569 | } | |
c84142e8 UD |
1570 | |
1571 | if (flags & (ARGP_HELP_USAGE | ARGP_HELP_SHORT_USAGE | ARGP_HELP_LONG)) | |
1572 | { | |
1573 | hol = argp_hol (argp, 0); | |
1574 | ||
1575 | /* If present, these options always come last. */ | |
1576 | hol_set_group (hol, "help", -1); | |
1577 | hol_set_group (hol, "version", -1); | |
1578 | ||
1579 | hol_sort (hol); | |
1580 | } | |
1581 | ||
1582 | if (flags & (ARGP_HELP_USAGE | ARGP_HELP_SHORT_USAGE)) | |
1583 | /* Print a short `Usage:' message. */ | |
1584 | { | |
1585 | int first_pattern = 1, more_patterns; | |
1586 | size_t num_pattern_levels = argp_args_levels (argp); | |
1587 | char *pattern_levels = alloca (num_pattern_levels); | |
1588 | ||
1589 | memset (pattern_levels, 0, num_pattern_levels); | |
1590 | ||
1591 | do | |
1592 | { | |
1593 | int old_lm; | |
b0de3e9e | 1594 | int old_wm = __argp_fmtstream_set_wmargin (fs, uparams.usage_indent); |
c84142e8 UD |
1595 | char *levels = pattern_levels; |
1596 | ||
9184d3db UD |
1597 | if (first_pattern) |
1598 | __argp_fmtstream_printf (fs, "%s %s", | |
1599 | dgettext (argp->argp_domain, "Usage:"), | |
1600 | name); | |
1601 | else | |
1602 | __argp_fmtstream_printf (fs, "%s %s", | |
1603 | dgettext (argp->argp_domain, " or: "), | |
1604 | name); | |
c84142e8 UD |
1605 | |
1606 | /* We set the lmargin as well as the wmargin, because hol_usage | |
1607 | manually wraps options with newline to avoid annoying breaks. */ | |
b0de3e9e | 1608 | old_lm = __argp_fmtstream_set_lmargin (fs, uparams.usage_indent); |
c84142e8 UD |
1609 | |
1610 | if (flags & ARGP_HELP_SHORT_USAGE) | |
1611 | /* Just show where the options go. */ | |
1612 | { | |
1613 | if (hol->num_entries > 0) | |
9184d3db UD |
1614 | __argp_fmtstream_puts (fs, dgettext (argp->argp_domain, |
1615 | " [OPTION...]")); | |
c84142e8 UD |
1616 | } |
1617 | else | |
1618 | /* Actually print the options. */ | |
1619 | { | |
1620 | hol_usage (hol, fs); | |
1621 | flags |= ARGP_HELP_SHORT_USAGE; /* But only do so once. */ | |
1622 | } | |
1623 | ||
9498096c | 1624 | more_patterns = argp_args_usage (argp, state, &levels, 1, fs); |
c84142e8 UD |
1625 | |
1626 | __argp_fmtstream_set_wmargin (fs, old_wm); | |
1627 | __argp_fmtstream_set_lmargin (fs, old_lm); | |
1628 | ||
1629 | __argp_fmtstream_putc (fs, '\n'); | |
1630 | anything = 1; | |
1631 | ||
1632 | first_pattern = 0; | |
1633 | } | |
1634 | while (more_patterns); | |
1635 | } | |
1636 | ||
1637 | if (flags & ARGP_HELP_PRE_DOC) | |
1fb05e3d | 1638 | anything |= argp_doc (argp, state, 0, 0, 1, fs); |
c84142e8 UD |
1639 | |
1640 | if (flags & ARGP_HELP_SEE) | |
1641 | { | |
9184d3db | 1642 | __argp_fmtstream_printf (fs, dgettext (argp->argp_domain, "\ |
1fb05e3d UD |
1643 | Try `%s --help' or `%s --usage' for more information.\n"), |
1644 | name, name); | |
c84142e8 UD |
1645 | anything = 1; |
1646 | } | |
1647 | ||
1648 | if (flags & ARGP_HELP_LONG) | |
1649 | /* Print a long, detailed help message. */ | |
1650 | { | |
1651 | /* Print info about all the options. */ | |
1652 | if (hol->num_entries > 0) | |
1653 | { | |
1654 | if (anything) | |
1655 | __argp_fmtstream_putc (fs, '\n'); | |
1fb05e3d | 1656 | hol_help (hol, state, fs); |
c84142e8 UD |
1657 | anything = 1; |
1658 | } | |
1659 | } | |
1660 | ||
1661 | if (flags & ARGP_HELP_POST_DOC) | |
1662 | /* Print any documentation strings at the end. */ | |
1fb05e3d | 1663 | anything |= argp_doc (argp, state, 1, anything, 0, fs); |
c84142e8 UD |
1664 | |
1665 | if ((flags & ARGP_HELP_BUG_ADDR) && argp_program_bug_address) | |
1666 | { | |
1667 | if (anything) | |
1668 | __argp_fmtstream_putc (fs, '\n'); | |
9184d3db UD |
1669 | __argp_fmtstream_printf (fs, dgettext (argp->argp_domain, |
1670 | "Report bugs to %s.\n"), | |
1fb05e3d | 1671 | argp_program_bug_address); |
c84142e8 UD |
1672 | anything = 1; |
1673 | } | |
1674 | ||
f39941e4 | 1675 | #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE) |
4aebaa6b | 1676 | __funlockfile (stream); |
f39941e4 | 1677 | #endif |
50304ef0 | 1678 | |
c84142e8 UD |
1679 | if (hol) |
1680 | hol_free (hol); | |
1681 | ||
1682 | __argp_fmtstream_free (fs); | |
1683 | } | |
1fb05e3d UD |
1684 | \f |
1685 | /* Output a usage message for ARGP to STREAM. FLAGS are from the set | |
1686 | ARGP_HELP_*. NAME is what to use wherever a `program name' is needed. */ | |
1687 | void __argp_help (const struct argp *argp, FILE *stream, | |
1688 | unsigned flags, char *name) | |
1689 | { | |
1690 | _help (argp, 0, stream, flags, name); | |
1691 | } | |
c84142e8 UD |
1692 | #ifdef weak_alias |
1693 | weak_alias (__argp_help, argp_help) | |
1694 | #endif | |
1695 | ||
f39941e4 UD |
1696 | #ifndef _LIBC |
1697 | char *__argp_basename (char *name) | |
1698 | { | |
1699 | char *short_name = strrchr (name, '/'); | |
1700 | return short_name ? short_name + 1 : name; | |
1701 | } | |
f39941e4 UD |
1702 | |
1703 | char * | |
1704 | __argp_short_program_name (void) | |
1705 | { | |
d6e68295 | 1706 | # if HAVE_DECL_PROGRAM_INVOCATION_SHORT_NAME |
f39941e4 | 1707 | return program_invocation_short_name; |
d6e68295 | 1708 | # elif HAVE_DECL_PROGRAM_INVOCATION_NAME |
f39941e4 | 1709 | return __argp_basename (program_invocation_name); |
d6e68295 | 1710 | # else |
f39941e4 UD |
1711 | /* FIXME: What now? Miles suggests that it is better to use NULL, |
1712 | but currently the value is passed on directly to fputs_unlocked, | |
1713 | so that requires more changes. */ | |
d6e68295 RM |
1714 | # if __GNUC__ |
1715 | # warning No reasonable value to return | |
1716 | # endif /* __GNUC__ */ | |
f39941e4 | 1717 | return ""; |
d6e68295 | 1718 | # endif |
f39941e4 | 1719 | } |
d6e68295 | 1720 | #endif |
f39941e4 | 1721 | |
c84142e8 UD |
1722 | /* Output, if appropriate, a usage message for STATE to STREAM. FLAGS are |
1723 | from the set ARGP_HELP_*. */ | |
1724 | void | |
5a97622d | 1725 | __argp_state_help (const struct argp_state *state, FILE *stream, unsigned flags) |
c84142e8 UD |
1726 | { |
1727 | if ((!state || ! (state->flags & ARGP_NO_ERRS)) && stream) | |
1728 | { | |
1729 | if (state && (state->flags & ARGP_LONG_ONLY)) | |
1730 | flags |= ARGP_HELP_LONG_ONLY; | |
1731 | ||
ebbad4cc | 1732 | _help (state ? state->root_argp : 0, state, stream, flags, |
f39941e4 | 1733 | state ? state->name : __argp_short_program_name ()); |
c84142e8 UD |
1734 | |
1735 | if (!state || ! (state->flags & ARGP_NO_EXIT)) | |
1736 | { | |
1737 | if (flags & ARGP_HELP_EXIT_ERR) | |
4cca6b86 | 1738 | exit (argp_err_exit_status); |
c84142e8 UD |
1739 | if (flags & ARGP_HELP_EXIT_OK) |
1740 | exit (0); | |
1741 | } | |
1742 | } | |
1743 | } | |
1744 | #ifdef weak_alias | |
1745 | weak_alias (__argp_state_help, argp_state_help) | |
1746 | #endif | |
1747 | \f | |
1748 | /* If appropriate, print the printf string FMT and following args, preceded | |
1749 | by the program name and `:', to stderr, and followed by a `Try ... --help' | |
43b0e40f | 1750 | message, then exit (1). */ |
c84142e8 | 1751 | void |
5a97622d | 1752 | __argp_error (const struct argp_state *state, const char *fmt, ...) |
c84142e8 UD |
1753 | { |
1754 | if (!state || !(state->flags & ARGP_NO_ERRS)) | |
1755 | { | |
1756 | FILE *stream = state ? state->err_stream : stderr; | |
1757 | ||
1758 | if (stream) | |
1759 | { | |
1760 | va_list ap; | |
1761 | ||
f39941e4 | 1762 | #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE) |
4aebaa6b | 1763 | __flockfile (stream); |
f39941e4 | 1764 | #endif |
50304ef0 | 1765 | |
c84142e8 | 1766 | va_start (ap, fmt); |
c84142e8 | 1767 | |
df6f8969 UD |
1768 | #ifdef _LIBC |
1769 | char *buf; | |
9af652f6 | 1770 | |
a7c684a2 | 1771 | if (_IO_vasprintf (&buf, fmt, ap) < 0) |
df6f8969 | 1772 | buf = NULL; |
9af652f6 | 1773 | |
8a259a23 | 1774 | __fxprintf (stream, "%s: %s\n", |
df6f8969 | 1775 | state ? state->name : __argp_short_program_name (), buf); |
9af652f6 | 1776 | |
df6f8969 UD |
1777 | free (buf); |
1778 | #else | |
1779 | fputs_unlocked (state ? state->name : __argp_short_program_name (), | |
1780 | stream); | |
1781 | putc_unlocked (':', stream); | |
1782 | putc_unlocked (' ', stream); | |
9af652f6 | 1783 | |
df6f8969 | 1784 | vfprintf (stream, fmt, ap); |
9af652f6 | 1785 | |
df6f8969 UD |
1786 | putc_unlocked ('\n', stream); |
1787 | #endif | |
c84142e8 UD |
1788 | |
1789 | __argp_state_help (state, stream, ARGP_HELP_STD_ERR); | |
50304ef0 | 1790 | |
9af652f6 UD |
1791 | va_end (ap); |
1792 | ||
f39941e4 | 1793 | #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE) |
4aebaa6b | 1794 | __funlockfile (stream); |
f39941e4 | 1795 | #endif |
c84142e8 UD |
1796 | } |
1797 | } | |
1798 | } | |
1799 | #ifdef weak_alias | |
1800 | weak_alias (__argp_error, argp_error) | |
1801 | #endif | |
1802 | \f | |
1803 | /* Similar to the standard gnu error-reporting function error(), but will | |
1804 | respect the ARGP_NO_EXIT and ARGP_NO_ERRS flags in STATE, and will print | |
1805 | to STATE->err_stream. This is useful for argument parsing code that is | |
1806 | shared between program startup (when exiting is desired) and runtime | |
1807 | option parsing (when typically an error code is returned instead). The | |
1808 | difference between this function and argp_error is that the latter is for | |
1809 | *parsing errors*, and the former is for other problems that occur during | |
1810 | parsing but don't reflect a (syntactic) problem with the input. */ | |
1811 | void | |
5a97622d UD |
1812 | __argp_failure (const struct argp_state *state, int status, int errnum, |
1813 | const char *fmt, ...) | |
c84142e8 UD |
1814 | { |
1815 | if (!state || !(state->flags & ARGP_NO_ERRS)) | |
1816 | { | |
1817 | FILE *stream = state ? state->err_stream : stderr; | |
1818 | ||
1819 | if (stream) | |
1820 | { | |
f39941e4 | 1821 | #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE) |
4aebaa6b | 1822 | __flockfile (stream); |
f39941e4 | 1823 | #endif |
50304ef0 | 1824 | |
df6f8969 | 1825 | #ifdef _LIBC |
8a259a23 | 1826 | __fxprintf (stream, "%s", |
df6f8969 UD |
1827 | state ? state->name : __argp_short_program_name ()); |
1828 | #else | |
1829 | fputs_unlocked (state ? state->name : __argp_short_program_name (), | |
1830 | stream); | |
9af652f6 | 1831 | #endif |
c84142e8 UD |
1832 | |
1833 | if (fmt) | |
1834 | { | |
1835 | va_list ap; | |
1836 | ||
c84142e8 | 1837 | va_start (ap, fmt); |
df6f8969 UD |
1838 | #ifdef _LIBC |
1839 | char *buf; | |
9af652f6 | 1840 | |
a7c684a2 | 1841 | if (_IO_vasprintf (&buf, fmt, ap) < 0) |
df6f8969 | 1842 | buf = NULL; |
9af652f6 | 1843 | |
8a259a23 | 1844 | __fxprintf (stream, ": %s", buf); |
9af652f6 | 1845 | |
df6f8969 UD |
1846 | free (buf); |
1847 | #else | |
1848 | putc_unlocked (':', stream); | |
1849 | putc_unlocked (' ', stream); | |
a334319f | 1850 | |
df6f8969 UD |
1851 | vfprintf (stream, fmt, ap); |
1852 | #endif | |
9af652f6 | 1853 | |
c84142e8 UD |
1854 | va_end (ap); |
1855 | } | |
1856 | ||
1857 | if (errnum) | |
1858 | { | |
9af652f6 UD |
1859 | char buf[200]; |
1860 | ||
df6f8969 | 1861 | #ifdef _LIBC |
8a259a23 | 1862 | __fxprintf (stream, ": %s", |
df6f8969 | 1863 | __strerror_r (errnum, buf, sizeof (buf))); |
f39941e4 | 1864 | #else |
df6f8969 UD |
1865 | putc_unlocked (':', stream); |
1866 | putc_unlocked (' ', stream); | |
1867 | # ifdef HAVE_STRERROR_R | |
1868 | fputs (__strerror_r (errnum, buf, sizeof (buf)), stream); | |
1869 | # else | |
1870 | fputs (strerror (errnum), stream); | |
1871 | # endif | |
f39941e4 | 1872 | #endif |
c84142e8 UD |
1873 | } |
1874 | ||
9af652f6 UD |
1875 | if (_IO_fwide (stream, 0) > 0) |
1876 | putwc_unlocked (L'\n', stream); | |
1877 | else | |
9af652f6 | 1878 | putc_unlocked ('\n', stream); |
50304ef0 | 1879 | |
f39941e4 | 1880 | #if _LIBC || (HAVE_FLOCKFILE && HAVE_FUNLOCKFILE) |
4aebaa6b | 1881 | __funlockfile (stream); |
f39941e4 | 1882 | #endif |
c84142e8 | 1883 | |
5a97622d | 1884 | if (status && (!state || !(state->flags & ARGP_NO_EXIT))) |
c84142e8 UD |
1885 | exit (status); |
1886 | } | |
1887 | } | |
1888 | } | |
1889 | #ifdef weak_alias | |
1890 | weak_alias (__argp_failure, argp_failure) | |
1891 | #endif |