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