Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Handle lists of commands, their decoding and documentation, for GDB. |
8926118c | 2 | |
42a4f53d | 3 | Copyright (C) 1986-2019 Free Software Foundation, Inc. |
c906108c | 4 | |
c5aa993b JM |
5 | This program is free software; you can redistribute it and/or modify |
6 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 7 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 8 | (at your option) any later version. |
c906108c | 9 | |
c5aa993b JM |
10 | This program is distributed in the hope that it will be useful, |
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | GNU General Public License for more details. | |
c906108c | 14 | |
c5aa993b | 15 | You should have received a copy of the GNU General Public License |
a9762ec7 | 16 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
17 | |
18 | #include "defs.h" | |
c906108c | 19 | #include "symtab.h" |
c906108c | 20 | #include <ctype.h> |
f77b92bf | 21 | #include "gdb_regex.h" |
f397e303 | 22 | #include "completer.h" |
8b93c638 | 23 | #include "ui-out.h" |
d318976c FN |
24 | #include "cli/cli-cmds.h" |
25 | #include "cli/cli-decode.h" | |
66d8c862 | 26 | #include "cli/cli-style.h" |
268a13a5 | 27 | #include "gdbsupport/gdb_optional.h" |
b2875cc0 | 28 | |
ebcd3b23 | 29 | /* Prototypes for local functions. */ |
c906108c | 30 | |
6f937416 | 31 | static void undef_cmd_error (const char *, const char *); |
c906108c | 32 | |
6f937416 | 33 | static struct cmd_list_element *delete_cmd (const char *name, |
fad6eecd TT |
34 | struct cmd_list_element **list, |
35 | struct cmd_list_element **prehook, | |
36 | struct cmd_list_element **prehookee, | |
37 | struct cmd_list_element **posthook, | |
38 | struct cmd_list_element **posthookee); | |
b05dcbb7 | 39 | |
6f937416 | 40 | static struct cmd_list_element *find_cmd (const char *command, |
a14ed312 KB |
41 | int len, |
42 | struct cmd_list_element *clist, | |
43 | int ignore_help_classes, | |
44 | int *nfound); | |
6837a0a2 | 45 | |
c85871a3 | 46 | static void help_all (struct ui_file *stream); |
6e381ba0 | 47 | |
5b9afe8a YQ |
48 | /* Look up a command whose 'prefixlist' is KEY. Return the command if found, |
49 | otherwise return NULL. */ | |
50 | ||
51 | static struct cmd_list_element * | |
52 | lookup_cmd_for_prefixlist (struct cmd_list_element **key, | |
53 | struct cmd_list_element *list) | |
54 | { | |
55 | struct cmd_list_element *p = NULL; | |
56 | ||
57 | for (p = list; p != NULL; p = p->next) | |
58 | { | |
59 | struct cmd_list_element *q; | |
60 | ||
61 | if (p->prefixlist == NULL) | |
62 | continue; | |
63 | else if (p->prefixlist == key) | |
64 | return p; | |
65 | ||
66 | q = lookup_cmd_for_prefixlist (key, *(p->prefixlist)); | |
67 | if (q != NULL) | |
68 | return q; | |
69 | } | |
70 | ||
71 | return NULL; | |
72 | } | |
73 | ||
74 | static void | |
75 | set_cmd_prefix (struct cmd_list_element *c, struct cmd_list_element **list) | |
76 | { | |
77 | struct cmd_list_element *p; | |
78 | ||
79 | /* Check to see if *LIST contains any element other than C. */ | |
80 | for (p = *list; p != NULL; p = p->next) | |
81 | if (p != c) | |
82 | break; | |
83 | ||
84 | if (p == NULL) | |
85 | { | |
86 | /* *SET_LIST only contains SET. */ | |
87 | p = lookup_cmd_for_prefixlist (list, setlist); | |
88 | ||
89 | c->prefix = p ? (p->cmd_pointer ? p->cmd_pointer : p) : p; | |
90 | } | |
91 | else | |
92 | c->prefix = p->prefix; | |
93 | } | |
94 | ||
6e381ba0 | 95 | static void |
64e61d29 TT |
96 | print_help_for_command (struct cmd_list_element *c, const char *prefix, |
97 | int recurse, struct ui_file *stream); | |
6e381ba0 | 98 | |
d318976c | 99 | \f |
9f60d481 AC |
100 | /* Set the callback function for the specified command. For each both |
101 | the commands callback and func() are set. The latter set to a | |
102 | bounce function (unless cfunc / sfunc is NULL that is). */ | |
103 | ||
0450cc4c | 104 | static void |
95a6b0a1 | 105 | do_const_cfunc (struct cmd_list_element *c, const char *args, int from_tty) |
0450cc4c TT |
106 | { |
107 | c->function.const_cfunc (args, from_tty); | |
108 | } | |
109 | ||
c2252c0d | 110 | static void |
0450cc4c TT |
111 | set_cmd_cfunc (struct cmd_list_element *cmd, cmd_const_cfunc_ftype *cfunc) |
112 | { | |
113 | if (cfunc == NULL) | |
114 | cmd->func = NULL; | |
115 | else | |
116 | cmd->func = do_const_cfunc; | |
117 | cmd->function.const_cfunc = cfunc; | |
9f60d481 AC |
118 | } |
119 | ||
120 | static void | |
95a6b0a1 | 121 | do_sfunc (struct cmd_list_element *c, const char *args, int from_tty) |
9f60d481 | 122 | { |
0450cc4c | 123 | c->function.sfunc (args, from_tty, c); |
9f60d481 AC |
124 | } |
125 | ||
126 | void | |
eb4c3f4a | 127 | set_cmd_sfunc (struct cmd_list_element *cmd, cmd_const_sfunc_ftype *sfunc) |
9f60d481 AC |
128 | { |
129 | if (sfunc == NULL) | |
130 | cmd->func = NULL; | |
131 | else | |
132 | cmd->func = do_sfunc; | |
0450cc4c | 133 | cmd->function.sfunc = sfunc; |
9f60d481 AC |
134 | } |
135 | ||
0450cc4c TT |
136 | int |
137 | cmd_cfunc_eq (struct cmd_list_element *cmd, cmd_const_cfunc_ftype *cfunc) | |
138 | { | |
139 | return cmd->func == do_const_cfunc && cmd->function.const_cfunc == cfunc; | |
140 | } | |
141 | ||
7d0766f3 AC |
142 | void |
143 | set_cmd_context (struct cmd_list_element *cmd, void *context) | |
144 | { | |
145 | cmd->context = context; | |
146 | } | |
147 | ||
148 | void * | |
149 | get_cmd_context (struct cmd_list_element *cmd) | |
150 | { | |
151 | return cmd->context; | |
152 | } | |
153 | ||
1868c04e AC |
154 | enum cmd_types |
155 | cmd_type (struct cmd_list_element *cmd) | |
156 | { | |
157 | return cmd->type; | |
158 | } | |
159 | ||
5ba2abeb | 160 | void |
625e8578 | 161 | set_cmd_completer (struct cmd_list_element *cmd, completer_ftype *completer) |
5ba2abeb AC |
162 | { |
163 | cmd->completer = completer; /* Ok. */ | |
164 | } | |
165 | ||
7d793aa9 SDJ |
166 | /* See definition in commands.h. */ |
167 | ||
168 | void | |
169 | set_cmd_completer_handle_brkchars (struct cmd_list_element *cmd, | |
6e1dbf8c | 170 | completer_handle_brkchars_ftype *func) |
7d793aa9 | 171 | { |
6e1dbf8c | 172 | cmd->completer_handle_brkchars = func; |
7d793aa9 SDJ |
173 | } |
174 | ||
c906108c | 175 | /* Add element named NAME. |
bc587a6b | 176 | Space for NAME and DOC must be allocated by the caller. |
c906108c SS |
177 | CLASS is the top level category into which commands are broken down |
178 | for "help" purposes. | |
179 | FUN should be the function to execute the command; | |
180 | it will get a character string as argument, with leading | |
181 | and trailing blanks already eliminated. | |
182 | ||
183 | DOC is a documentation string for the command. | |
184 | Its first line should be a complete sentence. | |
185 | It should start with ? for a command that is an abbreviation | |
186 | or with * for a command that most users don't need to know about. | |
187 | ||
ebcd3b23 | 188 | Add this command to command list *LIST. |
c906108c SS |
189 | |
190 | Returns a pointer to the added command (not necessarily the head | |
ebcd3b23 | 191 | of *LIST). */ |
c906108c | 192 | |
0450cc4c TT |
193 | static struct cmd_list_element * |
194 | do_add_cmd (const char *name, enum command_class theclass, | |
195 | const char *doc, struct cmd_list_element **list) | |
c906108c | 196 | { |
e2fc72e2 TT |
197 | struct cmd_list_element *c = new struct cmd_list_element (name, theclass, |
198 | doc); | |
b05dcbb7 | 199 | struct cmd_list_element *p, *iter; |
c906108c | 200 | |
b05dcbb7 TT |
201 | /* Turn each alias of the old command into an alias of the new |
202 | command. */ | |
fad6eecd TT |
203 | c->aliases = delete_cmd (name, list, &c->hook_pre, &c->hookee_pre, |
204 | &c->hook_post, &c->hookee_post); | |
b05dcbb7 TT |
205 | for (iter = c->aliases; iter; iter = iter->alias_chain) |
206 | iter->cmd_pointer = c; | |
fad6eecd TT |
207 | if (c->hook_pre) |
208 | c->hook_pre->hookee_pre = c; | |
209 | if (c->hookee_pre) | |
210 | c->hookee_pre->hook_pre = c; | |
211 | if (c->hook_post) | |
212 | c->hook_post->hookee_post = c; | |
213 | if (c->hookee_post) | |
214 | c->hookee_post->hook_post = c; | |
c906108c | 215 | |
494b7ec9 | 216 | if (*list == NULL || strcmp ((*list)->name, name) >= 0) |
c906108c SS |
217 | { |
218 | c->next = *list; | |
219 | *list = c; | |
220 | } | |
221 | else | |
222 | { | |
223 | p = *list; | |
494b7ec9 | 224 | while (p->next && strcmp (p->next->name, name) <= 0) |
c5aa993b JM |
225 | { |
226 | p = p->next; | |
227 | } | |
c906108c SS |
228 | c->next = p->next; |
229 | p->next = c; | |
230 | } | |
231 | ||
c906108c SS |
232 | return c; |
233 | } | |
234 | ||
0450cc4c TT |
235 | struct cmd_list_element * |
236 | add_cmd (const char *name, enum command_class theclass, | |
237 | const char *doc, struct cmd_list_element **list) | |
238 | { | |
239 | cmd_list_element *result = do_add_cmd (name, theclass, doc, list); | |
240 | result->func = NULL; | |
5fed81ff | 241 | result->function.const_cfunc = NULL; |
0450cc4c TT |
242 | return result; |
243 | } | |
244 | ||
245 | struct cmd_list_element * | |
246 | add_cmd (const char *name, enum command_class theclass, | |
247 | cmd_const_cfunc_ftype *fun, | |
248 | const char *doc, struct cmd_list_element **list) | |
249 | { | |
250 | cmd_list_element *result = do_add_cmd (name, theclass, doc, list); | |
251 | set_cmd_cfunc (result, fun); | |
252 | return result; | |
253 | } | |
254 | ||
f67ffa6a AB |
255 | /* Add an element with a suppress notification to the LIST of commands. */ |
256 | ||
257 | struct cmd_list_element * | |
258 | add_cmd_suppress_notification (const char *name, enum command_class theclass, | |
259 | cmd_const_cfunc_ftype *fun, const char *doc, | |
260 | struct cmd_list_element **list, | |
261 | int *suppress_notification) | |
262 | { | |
263 | struct cmd_list_element *element; | |
264 | ||
265 | element = add_cmd (name, theclass, fun, doc, list); | |
266 | element->suppress_notification = suppress_notification; | |
267 | ||
268 | return element; | |
269 | } | |
270 | ||
271 | ||
56382845 | 272 | /* Deprecates a command CMD. |
ebcd3b23 MS |
273 | REPLACEMENT is the name of the command which should be used in |
274 | place of this command, or NULL if no such command exists. | |
56382845 FN |
275 | |
276 | This function does not check to see if command REPLACEMENT exists | |
ebcd3b23 MS |
277 | since gdb may not have gotten around to adding REPLACEMENT when |
278 | this function is called. | |
56382845 FN |
279 | |
280 | Returns a pointer to the deprecated command. */ | |
281 | ||
282 | struct cmd_list_element * | |
429e55ea | 283 | deprecate_cmd (struct cmd_list_element *cmd, const char *replacement) |
56382845 | 284 | { |
1f2bdf09 TT |
285 | cmd->cmd_deprecated = 1; |
286 | cmd->deprecated_warn_user = 1; | |
56382845 FN |
287 | |
288 | if (replacement != NULL) | |
289 | cmd->replacement = replacement; | |
290 | else | |
291 | cmd->replacement = NULL; | |
292 | ||
293 | return cmd; | |
294 | } | |
295 | ||
c906108c | 296 | struct cmd_list_element * |
21873064 YQ |
297 | add_alias_cmd (const char *name, cmd_list_element *old, |
298 | enum command_class theclass, int abbrev_flag, | |
299 | struct cmd_list_element **list) | |
c906108c | 300 | { |
c906108c SS |
301 | if (old == 0) |
302 | { | |
fad6eecd TT |
303 | struct cmd_list_element *prehook, *prehookee, *posthook, *posthookee; |
304 | struct cmd_list_element *aliases = delete_cmd (name, list, | |
305 | &prehook, &prehookee, | |
306 | &posthook, &posthookee); | |
cdb27c12 | 307 | |
b05dcbb7 | 308 | /* If this happens, it means a programmer error somewhere. */ |
300d0284 | 309 | gdb_assert (!aliases && !prehook && !prehookee |
fad6eecd | 310 | && !posthook && ! posthookee); |
c906108c SS |
311 | return 0; |
312 | } | |
313 | ||
0450cc4c | 314 | struct cmd_list_element *c = add_cmd (name, theclass, old->doc, list); |
5bc81a00 PM |
315 | |
316 | /* If OLD->DOC can be freed, we should make another copy. */ | |
1f2bdf09 | 317 | if (old->doc_allocated) |
5bc81a00 PM |
318 | { |
319 | c->doc = xstrdup (old->doc); | |
1f2bdf09 | 320 | c->doc_allocated = 1; |
5bc81a00 | 321 | } |
9f60d481 AC |
322 | /* NOTE: Both FUNC and all the FUNCTIONs need to be copied. */ |
323 | c->func = old->func; | |
324 | c->function = old->function; | |
c906108c SS |
325 | c->prefixlist = old->prefixlist; |
326 | c->prefixname = old->prefixname; | |
327 | c->allow_unknown = old->allow_unknown; | |
328 | c->abbrev_flag = abbrev_flag; | |
329 | c->cmd_pointer = old; | |
b05dcbb7 TT |
330 | c->alias_chain = old->aliases; |
331 | old->aliases = c; | |
5b9afe8a YQ |
332 | |
333 | set_cmd_prefix (c, list); | |
c906108c SS |
334 | return c; |
335 | } | |
336 | ||
21873064 YQ |
337 | struct cmd_list_element * |
338 | add_alias_cmd (const char *name, const char *oldname, | |
339 | enum command_class theclass, int abbrev_flag, | |
340 | struct cmd_list_element **list) | |
341 | { | |
342 | const char *tmp; | |
343 | struct cmd_list_element *old; | |
344 | ||
345 | tmp = oldname; | |
346 | old = lookup_cmd (&tmp, *list, "", 1, 1); | |
347 | ||
348 | return add_alias_cmd (name, old, theclass, abbrev_flag, list); | |
349 | } | |
350 | ||
351 | ||
ebcd3b23 MS |
352 | /* Like add_cmd but adds an element for a command prefix: a name that |
353 | should be followed by a subcommand to be looked up in another | |
354 | command list. PREFIXLIST should be the address of the variable | |
355 | containing that list. */ | |
c906108c SS |
356 | |
357 | struct cmd_list_element * | |
fe978cb0 | 358 | add_prefix_cmd (const char *name, enum command_class theclass, |
981a3fb3 | 359 | cmd_const_cfunc_ftype *fun, |
1947513d | 360 | const char *doc, struct cmd_list_element **prefixlist, |
64e61d29 | 361 | const char *prefixname, int allow_unknown, |
af1c1752 | 362 | struct cmd_list_element **list) |
c906108c | 363 | { |
fe978cb0 | 364 | struct cmd_list_element *c = add_cmd (name, theclass, fun, doc, list); |
5b9afe8a | 365 | struct cmd_list_element *p; |
cdb27c12 | 366 | |
c906108c SS |
367 | c->prefixlist = prefixlist; |
368 | c->prefixname = prefixname; | |
369 | c->allow_unknown = allow_unknown; | |
5b9afe8a YQ |
370 | |
371 | if (list == &cmdlist) | |
372 | c->prefix = NULL; | |
373 | else | |
374 | set_cmd_prefix (c, list); | |
375 | ||
376 | /* Update the field 'prefix' of each cmd_list_element in *PREFIXLIST. */ | |
377 | for (p = *prefixlist; p != NULL; p = p->next) | |
378 | p->prefix = c; | |
379 | ||
c906108c SS |
380 | return c; |
381 | } | |
382 | ||
f67ffa6a AB |
383 | /* Like ADD_PREFIX_CMD but sets the suppress_notification pointer on the |
384 | new command list element. */ | |
385 | ||
386 | struct cmd_list_element * | |
387 | add_prefix_cmd_suppress_notification | |
388 | (const char *name, enum command_class theclass, | |
389 | cmd_const_cfunc_ftype *fun, | |
390 | const char *doc, struct cmd_list_element **prefixlist, | |
391 | const char *prefixname, int allow_unknown, | |
392 | struct cmd_list_element **list, | |
393 | int *suppress_notification) | |
394 | { | |
395 | struct cmd_list_element *element | |
396 | = add_prefix_cmd (name, theclass, fun, doc, prefixlist, | |
397 | prefixname, allow_unknown, list); | |
398 | element->suppress_notification = suppress_notification; | |
399 | return element; | |
400 | } | |
401 | ||
ebcd3b23 | 402 | /* Like add_prefix_cmd but sets the abbrev_flag on the new command. */ |
c5aa993b | 403 | |
c906108c | 404 | struct cmd_list_element * |
fe978cb0 | 405 | add_abbrev_prefix_cmd (const char *name, enum command_class theclass, |
ee7ddd71 | 406 | cmd_const_cfunc_ftype *fun, const char *doc, |
64e61d29 TT |
407 | struct cmd_list_element **prefixlist, |
408 | const char *prefixname, | |
af1c1752 | 409 | int allow_unknown, struct cmd_list_element **list) |
c906108c | 410 | { |
fe978cb0 | 411 | struct cmd_list_element *c = add_cmd (name, theclass, fun, doc, list); |
cdb27c12 | 412 | |
c906108c SS |
413 | c->prefixlist = prefixlist; |
414 | c->prefixname = prefixname; | |
415 | c->allow_unknown = allow_unknown; | |
416 | c->abbrev_flag = 1; | |
417 | return c; | |
418 | } | |
419 | ||
420 | /* This is an empty "cfunc". */ | |
421 | void | |
eb7c454d | 422 | not_just_help_class_command (const char *args, int from_tty) |
c906108c SS |
423 | { |
424 | } | |
425 | ||
426 | /* This is an empty "sfunc". */ | |
c906108c SS |
427 | |
428 | static void | |
eb4c3f4a | 429 | empty_sfunc (const char *args, int from_tty, struct cmd_list_element *c) |
c906108c SS |
430 | { |
431 | } | |
432 | ||
b2875cc0 | 433 | /* Add element named NAME to command list LIST (the list for set/show |
c906108c | 434 | or some sublist thereof). |
b2875cc0 | 435 | TYPE is set_cmd or show_cmd. |
c906108c SS |
436 | CLASS is as in add_cmd. |
437 | VAR_TYPE is the kind of thing we are setting. | |
438 | VAR is address of the variable being controlled by this command. | |
439 | DOC is the documentation string. */ | |
440 | ||
b2875cc0 | 441 | static struct cmd_list_element * |
6f937416 | 442 | add_set_or_show_cmd (const char *name, |
b2875cc0 | 443 | enum cmd_types type, |
fe978cb0 | 444 | enum command_class theclass, |
b2875cc0 AC |
445 | var_types var_type, |
446 | void *var, | |
1947513d | 447 | const char *doc, |
b2875cc0 | 448 | struct cmd_list_element **list) |
c906108c | 449 | { |
0450cc4c | 450 | struct cmd_list_element *c = add_cmd (name, theclass, doc, list); |
cdb27c12 | 451 | |
b2875cc0 AC |
452 | gdb_assert (type == set_cmd || type == show_cmd); |
453 | c->type = type; | |
c906108c SS |
454 | c->var_type = var_type; |
455 | c->var = var; | |
e00d1dc8 | 456 | /* This needs to be something besides NULL so that this isn't |
c906108c | 457 | treated as a help class. */ |
9f60d481 | 458 | set_cmd_sfunc (c, empty_sfunc); |
c906108c SS |
459 | return c; |
460 | } | |
461 | ||
e707bbc2 AC |
462 | /* Add element named NAME to both the command SET_LIST and SHOW_LIST. |
463 | CLASS is as in add_cmd. VAR_TYPE is the kind of thing we are | |
464 | setting. VAR is address of the variable being controlled by this | |
465 | command. SET_FUNC and SHOW_FUNC are the callback functions (if | |
3b64bf98 AC |
466 | non-NULL). SET_DOC, SHOW_DOC and HELP_DOC are the documentation |
467 | strings. PRINT the format string to print the value. SET_RESULT | |
468 | and SHOW_RESULT, if not NULL, are set to the resulting command | |
469 | structures. */ | |
e707bbc2 | 470 | |
b3f42336 | 471 | static void |
6f937416 | 472 | add_setshow_cmd_full (const char *name, |
fe978cb0 | 473 | enum command_class theclass, |
9f064c95 | 474 | var_types var_type, void *var, |
3b64bf98 | 475 | const char *set_doc, const char *show_doc, |
335cca0d | 476 | const char *help_doc, |
eb4c3f4a | 477 | cmd_const_sfunc_ftype *set_func, |
08546159 | 478 | show_value_ftype *show_func, |
9f064c95 TT |
479 | struct cmd_list_element **set_list, |
480 | struct cmd_list_element **show_list, | |
481 | struct cmd_list_element **set_result, | |
482 | struct cmd_list_element **show_result) | |
e707bbc2 AC |
483 | { |
484 | struct cmd_list_element *set; | |
485 | struct cmd_list_element *show; | |
be7d7357 AC |
486 | char *full_set_doc; |
487 | char *full_show_doc; | |
488 | ||
489 | if (help_doc != NULL) | |
490 | { | |
491 | full_set_doc = xstrprintf ("%s\n%s", set_doc, help_doc); | |
492 | full_show_doc = xstrprintf ("%s\n%s", show_doc, help_doc); | |
493 | } | |
494 | else | |
495 | { | |
496 | full_set_doc = xstrdup (set_doc); | |
497 | full_show_doc = xstrdup (show_doc); | |
498 | } | |
fe978cb0 | 499 | set = add_set_or_show_cmd (name, set_cmd, theclass, var_type, var, |
3b64bf98 | 500 | full_set_doc, set_list); |
1f2bdf09 | 501 | set->doc_allocated = 1; |
5bc81a00 | 502 | |
e707bbc2 AC |
503 | if (set_func != NULL) |
504 | set_cmd_sfunc (set, set_func); | |
5b9afe8a YQ |
505 | |
506 | set_cmd_prefix (set, set_list); | |
507 | ||
fe978cb0 | 508 | show = add_set_or_show_cmd (name, show_cmd, theclass, var_type, var, |
3b64bf98 | 509 | full_show_doc, show_list); |
1f2bdf09 | 510 | show->doc_allocated = 1; |
08546159 | 511 | show->show_value_func = show_func; |
597bf39d PA |
512 | /* Disable the default symbol completer. Doesn't make much sense |
513 | for the "show" command to complete on anything. */ | |
514 | set_cmd_completer (show, nullptr); | |
9f064c95 TT |
515 | |
516 | if (set_result != NULL) | |
517 | *set_result = set; | |
518 | if (show_result != NULL) | |
519 | *show_result = show; | |
520 | } | |
521 | ||
1b295c3d AC |
522 | /* Add element named NAME to command list LIST (the list for set or |
523 | some sublist thereof). CLASS is as in add_cmd. ENUMLIST is a list | |
524 | of strings which may follow NAME. VAR is address of the variable | |
525 | which will contain the matching string (from ENUMLIST). */ | |
526 | ||
527 | void | |
6f937416 | 528 | add_setshow_enum_cmd (const char *name, |
fe978cb0 | 529 | enum command_class theclass, |
40478521 | 530 | const char *const *enumlist, |
1b295c3d AC |
531 | const char **var, |
532 | const char *set_doc, | |
533 | const char *show_doc, | |
534 | const char *help_doc, | |
eb4c3f4a | 535 | cmd_const_sfunc_ftype *set_func, |
08546159 | 536 | show_value_ftype *show_func, |
1b295c3d | 537 | struct cmd_list_element **set_list, |
7170dadf TT |
538 | struct cmd_list_element **show_list, |
539 | void *context) | |
1b295c3d | 540 | { |
7170dadf | 541 | struct cmd_list_element *c, *show; |
cdb27c12 | 542 | |
fe978cb0 | 543 | add_setshow_cmd_full (name, theclass, var_enum, var, |
335cca0d | 544 | set_doc, show_doc, help_doc, |
1b295c3d AC |
545 | set_func, show_func, |
546 | set_list, show_list, | |
7170dadf | 547 | &c, &show); |
1b295c3d | 548 | c->enums = enumlist; |
7170dadf TT |
549 | |
550 | set_cmd_context (c, context); | |
551 | set_cmd_context (show, context); | |
1b295c3d AC |
552 | } |
553 | ||
9d0faba9 | 554 | /* See cli-decode.h. */ |
5b9afe8a YQ |
555 | const char * const auto_boolean_enums[] = { "on", "off", "auto", NULL }; |
556 | ||
e9e68a56 AC |
557 | /* Add an auto-boolean command named NAME to both the set and show |
558 | command list lists. CLASS is as in add_cmd. VAR is address of the | |
559 | variable which will contain the value. DOC is the documentation | |
560 | string. FUNC is the corresponding callback. */ | |
561 | void | |
6f937416 | 562 | add_setshow_auto_boolean_cmd (const char *name, |
fe978cb0 | 563 | enum command_class theclass, |
e9e68a56 | 564 | enum auto_boolean *var, |
3b64bf98 | 565 | const char *set_doc, const char *show_doc, |
335cca0d | 566 | const char *help_doc, |
eb4c3f4a | 567 | cmd_const_sfunc_ftype *set_func, |
08546159 | 568 | show_value_ftype *show_func, |
e9e68a56 AC |
569 | struct cmd_list_element **set_list, |
570 | struct cmd_list_element **show_list) | |
97c3646f | 571 | { |
97c3646f | 572 | struct cmd_list_element *c; |
cdb27c12 | 573 | |
fe978cb0 | 574 | add_setshow_cmd_full (name, theclass, var_auto_boolean, var, |
2c5b56ce | 575 | set_doc, show_doc, help_doc, |
3b64bf98 | 576 | set_func, show_func, |
9f064c95 TT |
577 | set_list, show_list, |
578 | &c, NULL); | |
97c3646f | 579 | c->enums = auto_boolean_enums; |
97c3646f AC |
580 | } |
581 | ||
9d0faba9 PA |
582 | /* See cli-decode.h. */ |
583 | const char * const boolean_enums[] = { "on", "off", NULL }; | |
584 | ||
e707bbc2 AC |
585 | /* Add element named NAME to both the set and show command LISTs (the |
586 | list for set/show or some sublist thereof). CLASS is as in | |
587 | add_cmd. VAR is address of the variable which will contain the | |
2daf894e PA |
588 | value. SET_DOC and SHOW_DOC are the documentation strings. |
589 | Returns the new command element. */ | |
590 | ||
591 | cmd_list_element * | |
fe978cb0 | 592 | add_setshow_boolean_cmd (const char *name, enum command_class theclass, int *var, |
3b64bf98 | 593 | const char *set_doc, const char *show_doc, |
335cca0d | 594 | const char *help_doc, |
eb4c3f4a | 595 | cmd_const_sfunc_ftype *set_func, |
08546159 | 596 | show_value_ftype *show_func, |
e707bbc2 AC |
597 | struct cmd_list_element **set_list, |
598 | struct cmd_list_element **show_list) | |
f3796e26 | 599 | { |
f3796e26 | 600 | struct cmd_list_element *c; |
cdb27c12 | 601 | |
fe978cb0 | 602 | add_setshow_cmd_full (name, theclass, var_boolean, var, |
2c5b56ce | 603 | set_doc, show_doc, help_doc, |
9f064c95 TT |
604 | set_func, show_func, |
605 | set_list, show_list, | |
606 | &c, NULL); | |
f3796e26 | 607 | c->enums = boolean_enums; |
2daf894e PA |
608 | |
609 | return c; | |
f3796e26 AC |
610 | } |
611 | ||
b3f42336 AC |
612 | /* Add element named NAME to both the set and show command LISTs (the |
613 | list for set/show or some sublist thereof). */ | |
614 | void | |
fe978cb0 | 615 | add_setshow_filename_cmd (const char *name, enum command_class theclass, |
b3f42336 AC |
616 | char **var, |
617 | const char *set_doc, const char *show_doc, | |
335cca0d | 618 | const char *help_doc, |
eb4c3f4a | 619 | cmd_const_sfunc_ftype *set_func, |
08546159 | 620 | show_value_ftype *show_func, |
b3f42336 AC |
621 | struct cmd_list_element **set_list, |
622 | struct cmd_list_element **show_list) | |
623 | { | |
f397e303 | 624 | struct cmd_list_element *set_result; |
cdb27c12 | 625 | |
fe978cb0 | 626 | add_setshow_cmd_full (name, theclass, var_filename, var, |
2c5b56ce | 627 | set_doc, show_doc, help_doc, |
b3f42336 AC |
628 | set_func, show_func, |
629 | set_list, show_list, | |
f397e303 AC |
630 | &set_result, NULL); |
631 | set_cmd_completer (set_result, filename_completer); | |
b3f42336 AC |
632 | } |
633 | ||
634 | /* Add element named NAME to both the set and show command LISTs (the | |
5efd5804 PA |
635 | list for set/show or some sublist thereof). */ |
636 | void | |
fe978cb0 | 637 | add_setshow_string_cmd (const char *name, enum command_class theclass, |
6df3bc68 MS |
638 | char **var, |
639 | const char *set_doc, const char *show_doc, | |
640 | const char *help_doc, | |
eb4c3f4a | 641 | cmd_const_sfunc_ftype *set_func, |
6df3bc68 MS |
642 | show_value_ftype *show_func, |
643 | struct cmd_list_element **set_list, | |
644 | struct cmd_list_element **show_list) | |
b3f42336 | 645 | { |
597bf39d PA |
646 | cmd_list_element *set_cmd; |
647 | ||
fe978cb0 | 648 | add_setshow_cmd_full (name, theclass, var_string, var, |
2c5b56ce | 649 | set_doc, show_doc, help_doc, |
b3f42336 AC |
650 | set_func, show_func, |
651 | set_list, show_list, | |
597bf39d PA |
652 | &set_cmd, NULL); |
653 | ||
654 | /* Disable the default symbol completer. */ | |
655 | set_cmd_completer (set_cmd, nullptr); | |
b3f42336 AC |
656 | } |
657 | ||
26c41df3 | 658 | /* Add element named NAME to both the set and show command LISTs (the |
5efd5804 | 659 | list for set/show or some sublist thereof). */ |
44478ab3 | 660 | struct cmd_list_element * |
fe978cb0 | 661 | add_setshow_string_noescape_cmd (const char *name, enum command_class theclass, |
26c41df3 AC |
662 | char **var, |
663 | const char *set_doc, const char *show_doc, | |
664 | const char *help_doc, | |
eb4c3f4a | 665 | cmd_const_sfunc_ftype *set_func, |
26c41df3 AC |
666 | show_value_ftype *show_func, |
667 | struct cmd_list_element **set_list, | |
668 | struct cmd_list_element **show_list) | |
669 | { | |
44478ab3 TT |
670 | struct cmd_list_element *set_cmd; |
671 | ||
fe978cb0 | 672 | add_setshow_cmd_full (name, theclass, var_string_noescape, var, |
26c41df3 AC |
673 | set_doc, show_doc, help_doc, |
674 | set_func, show_func, | |
675 | set_list, show_list, | |
44478ab3 | 676 | &set_cmd, NULL); |
597bf39d PA |
677 | |
678 | /* Disable the default symbol completer. */ | |
679 | set_cmd_completer (set_cmd, nullptr); | |
680 | ||
44478ab3 | 681 | return set_cmd; |
26c41df3 AC |
682 | } |
683 | ||
b4b4ac0b AC |
684 | /* Add element named NAME to both the set and show command LISTs (the |
685 | list for set/show or some sublist thereof). */ | |
686 | void | |
fe978cb0 | 687 | add_setshow_optional_filename_cmd (const char *name, enum command_class theclass, |
b4b4ac0b AC |
688 | char **var, |
689 | const char *set_doc, const char *show_doc, | |
690 | const char *help_doc, | |
eb4c3f4a | 691 | cmd_const_sfunc_ftype *set_func, |
b4b4ac0b AC |
692 | show_value_ftype *show_func, |
693 | struct cmd_list_element **set_list, | |
694 | struct cmd_list_element **show_list) | |
695 | { | |
7f6a6314 PM |
696 | struct cmd_list_element *set_result; |
697 | ||
fe978cb0 | 698 | add_setshow_cmd_full (name, theclass, var_optional_filename, var, |
b4b4ac0b AC |
699 | set_doc, show_doc, help_doc, |
700 | set_func, show_func, | |
701 | set_list, show_list, | |
7f6a6314 PM |
702 | &set_result, NULL); |
703 | ||
704 | set_cmd_completer (set_result, filename_completer); | |
705 | ||
b4b4ac0b AC |
706 | } |
707 | ||
f81d1120 PA |
708 | /* Completes on literal "unlimited". Used by integer commands that |
709 | support a special "unlimited" value. */ | |
710 | ||
eb3ff9a5 | 711 | static void |
f81d1120 | 712 | integer_unlimited_completer (struct cmd_list_element *ignore, |
eb3ff9a5 | 713 | completion_tracker &tracker, |
f81d1120 PA |
714 | const char *text, const char *word) |
715 | { | |
716 | static const char * const keywords[] = | |
717 | { | |
718 | "unlimited", | |
719 | NULL, | |
720 | }; | |
721 | ||
eb3ff9a5 | 722 | complete_on_enum (tracker, keywords, text, word); |
f81d1120 PA |
723 | } |
724 | ||
c0d88b1b AC |
725 | /* Add element named NAME to both the set and show command LISTs (the |
726 | list for set/show or some sublist thereof). CLASS is as in | |
727 | add_cmd. VAR is address of the variable which will contain the | |
6fc1c773 YQ |
728 | value. SET_DOC and SHOW_DOC are the documentation strings. This |
729 | function is only used in Python API. Please don't use it elsewhere. */ | |
5efd5804 | 730 | void |
fe978cb0 | 731 | add_setshow_integer_cmd (const char *name, enum command_class theclass, |
47b667de | 732 | int *var, |
6df3bc68 MS |
733 | const char *set_doc, const char *show_doc, |
734 | const char *help_doc, | |
eb4c3f4a | 735 | cmd_const_sfunc_ftype *set_func, |
6df3bc68 MS |
736 | show_value_ftype *show_func, |
737 | struct cmd_list_element **set_list, | |
738 | struct cmd_list_element **show_list) | |
c0d88b1b | 739 | { |
f81d1120 PA |
740 | struct cmd_list_element *set; |
741 | ||
fe978cb0 | 742 | add_setshow_cmd_full (name, theclass, var_integer, var, |
c0d88b1b AC |
743 | set_doc, show_doc, help_doc, |
744 | set_func, show_func, | |
745 | set_list, show_list, | |
f81d1120 PA |
746 | &set, NULL); |
747 | ||
748 | set_cmd_completer (set, integer_unlimited_completer); | |
c0d88b1b AC |
749 | } |
750 | ||
25d29d70 AC |
751 | /* Add element named NAME to both the set and show command LISTs (the |
752 | list for set/show or some sublist thereof). CLASS is as in | |
753 | add_cmd. VAR is address of the variable which will contain the | |
5efd5804 PA |
754 | value. SET_DOC and SHOW_DOC are the documentation strings. */ |
755 | void | |
fe978cb0 | 756 | add_setshow_uinteger_cmd (const char *name, enum command_class theclass, |
3b64bf98 AC |
757 | unsigned int *var, |
758 | const char *set_doc, const char *show_doc, | |
335cca0d | 759 | const char *help_doc, |
eb4c3f4a | 760 | cmd_const_sfunc_ftype *set_func, |
08546159 | 761 | show_value_ftype *show_func, |
25d29d70 AC |
762 | struct cmd_list_element **set_list, |
763 | struct cmd_list_element **show_list) | |
764 | { | |
f81d1120 PA |
765 | struct cmd_list_element *set; |
766 | ||
fe978cb0 | 767 | add_setshow_cmd_full (name, theclass, var_uinteger, var, |
2c5b56ce | 768 | set_doc, show_doc, help_doc, |
25d29d70 AC |
769 | set_func, show_func, |
770 | set_list, show_list, | |
f81d1120 PA |
771 | &set, NULL); |
772 | ||
773 | set_cmd_completer (set, integer_unlimited_completer); | |
25d29d70 AC |
774 | } |
775 | ||
15170568 AC |
776 | /* Add element named NAME to both the set and show command LISTs (the |
777 | list for set/show or some sublist thereof). CLASS is as in | |
778 | add_cmd. VAR is address of the variable which will contain the | |
5efd5804 PA |
779 | value. SET_DOC and SHOW_DOC are the documentation strings. */ |
780 | void | |
fe978cb0 | 781 | add_setshow_zinteger_cmd (const char *name, enum command_class theclass, |
3b64bf98 AC |
782 | int *var, |
783 | const char *set_doc, const char *show_doc, | |
335cca0d | 784 | const char *help_doc, |
eb4c3f4a | 785 | cmd_const_sfunc_ftype *set_func, |
08546159 | 786 | show_value_ftype *show_func, |
15170568 AC |
787 | struct cmd_list_element **set_list, |
788 | struct cmd_list_element **show_list) | |
789 | { | |
fe978cb0 | 790 | add_setshow_cmd_full (name, theclass, var_zinteger, var, |
2c5b56ce | 791 | set_doc, show_doc, help_doc, |
15170568 AC |
792 | set_func, show_func, |
793 | set_list, show_list, | |
5efd5804 | 794 | NULL, NULL); |
15170568 AC |
795 | } |
796 | ||
6fc1c773 | 797 | void |
6f937416 | 798 | add_setshow_zuinteger_unlimited_cmd (const char *name, |
fe978cb0 | 799 | enum command_class theclass, |
b69b1fb1 | 800 | int *var, |
6fc1c773 YQ |
801 | const char *set_doc, |
802 | const char *show_doc, | |
803 | const char *help_doc, | |
eb4c3f4a | 804 | cmd_const_sfunc_ftype *set_func, |
6fc1c773 YQ |
805 | show_value_ftype *show_func, |
806 | struct cmd_list_element **set_list, | |
807 | struct cmd_list_element **show_list) | |
808 | { | |
f81d1120 PA |
809 | struct cmd_list_element *set; |
810 | ||
fe978cb0 | 811 | add_setshow_cmd_full (name, theclass, var_zuinteger_unlimited, var, |
6fc1c773 YQ |
812 | set_doc, show_doc, help_doc, |
813 | set_func, show_func, | |
814 | set_list, show_list, | |
f81d1120 PA |
815 | &set, NULL); |
816 | ||
817 | set_cmd_completer (set, integer_unlimited_completer); | |
6fc1c773 YQ |
818 | } |
819 | ||
1e8fb976 PA |
820 | /* Add element named NAME to both the set and show command LISTs (the |
821 | list for set/show or some sublist thereof). CLASS is as in | |
822 | add_cmd. VAR is address of the variable which will contain the | |
5efd5804 PA |
823 | value. SET_DOC and SHOW_DOC are the documentation strings. */ |
824 | void | |
fe978cb0 | 825 | add_setshow_zuinteger_cmd (const char *name, enum command_class theclass, |
1e8fb976 PA |
826 | unsigned int *var, |
827 | const char *set_doc, const char *show_doc, | |
828 | const char *help_doc, | |
eb4c3f4a | 829 | cmd_const_sfunc_ftype *set_func, |
1e8fb976 PA |
830 | show_value_ftype *show_func, |
831 | struct cmd_list_element **set_list, | |
832 | struct cmd_list_element **show_list) | |
833 | { | |
fe978cb0 | 834 | add_setshow_cmd_full (name, theclass, var_zuinteger, var, |
1e8fb976 PA |
835 | set_doc, show_doc, help_doc, |
836 | set_func, show_func, | |
837 | set_list, show_list, | |
5efd5804 | 838 | NULL, NULL); |
1e8fb976 PA |
839 | } |
840 | ||
b05dcbb7 TT |
841 | /* Remove the command named NAME from the command list. Return the |
842 | list commands which were aliased to the deleted command. If the | |
fad6eecd TT |
843 | command had no aliases, return NULL. The various *HOOKs are set to |
844 | the pre- and post-hook commands for the deleted command. If the | |
845 | command does not have a hook, the corresponding out parameter is | |
846 | set to NULL. */ | |
c906108c | 847 | |
b05dcbb7 | 848 | static struct cmd_list_element * |
6f937416 | 849 | delete_cmd (const char *name, struct cmd_list_element **list, |
fad6eecd TT |
850 | struct cmd_list_element **prehook, |
851 | struct cmd_list_element **prehookee, | |
852 | struct cmd_list_element **posthook, | |
853 | struct cmd_list_element **posthookee) | |
c906108c | 854 | { |
b05dcbb7 TT |
855 | struct cmd_list_element *iter; |
856 | struct cmd_list_element **previous_chain_ptr; | |
857 | struct cmd_list_element *aliases = NULL; | |
c906108c | 858 | |
fad6eecd TT |
859 | *prehook = NULL; |
860 | *prehookee = NULL; | |
861 | *posthook = NULL; | |
862 | *posthookee = NULL; | |
b05dcbb7 TT |
863 | previous_chain_ptr = list; |
864 | ||
865 | for (iter = *previous_chain_ptr; iter; iter = *previous_chain_ptr) | |
c906108c | 866 | { |
b05dcbb7 TT |
867 | if (strcmp (iter->name, name) == 0) |
868 | { | |
d8906c6f TJB |
869 | if (iter->destroyer) |
870 | iter->destroyer (iter, iter->context); | |
b05dcbb7 TT |
871 | if (iter->hookee_pre) |
872 | iter->hookee_pre->hook_pre = 0; | |
fad6eecd TT |
873 | *prehook = iter->hook_pre; |
874 | *prehookee = iter->hookee_pre; | |
b05dcbb7 TT |
875 | if (iter->hookee_post) |
876 | iter->hookee_post->hook_post = 0; | |
fad6eecd TT |
877 | *posthook = iter->hook_post; |
878 | *posthookee = iter->hookee_post; | |
b05dcbb7 TT |
879 | |
880 | /* Update the link. */ | |
881 | *previous_chain_ptr = iter->next; | |
882 | ||
883 | aliases = iter->aliases; | |
884 | ||
885 | /* If this command was an alias, remove it from the list of | |
886 | aliases. */ | |
887 | if (iter->cmd_pointer) | |
888 | { | |
889 | struct cmd_list_element **prevp = &iter->cmd_pointer->aliases; | |
890 | struct cmd_list_element *a = *prevp; | |
891 | ||
892 | while (a != iter) | |
893 | { | |
894 | prevp = &a->alias_chain; | |
895 | a = *prevp; | |
896 | } | |
897 | *prevp = iter->alias_chain; | |
898 | } | |
899 | ||
e2fc72e2 | 900 | delete iter; |
b05dcbb7 TT |
901 | |
902 | /* We won't see another command with the same name. */ | |
903 | break; | |
904 | } | |
905 | else | |
906 | previous_chain_ptr = &iter->next; | |
c906108c SS |
907 | } |
908 | ||
b05dcbb7 | 909 | return aliases; |
c906108c | 910 | } |
d318976c | 911 | \f |
ebcd3b23 | 912 | /* Shorthands to the commands above. */ |
d318976c FN |
913 | |
914 | /* Add an element to the list of info subcommands. */ | |
915 | ||
916 | struct cmd_list_element * | |
1d12d88f | 917 | add_info (const char *name, cmd_const_cfunc_ftype *fun, const char *doc) |
d318976c | 918 | { |
f3575e08 | 919 | return add_cmd (name, class_info, fun, doc, &infolist); |
d318976c FN |
920 | } |
921 | ||
922 | /* Add an alias to the list of info subcommands. */ | |
923 | ||
924 | struct cmd_list_element * | |
1947513d | 925 | add_info_alias (const char *name, const char *oldname, int abbrev_flag) |
d318976c | 926 | { |
f486487f | 927 | return add_alias_cmd (name, oldname, class_run, abbrev_flag, &infolist); |
d318976c FN |
928 | } |
929 | ||
930 | /* Add an element to the list of commands. */ | |
931 | ||
932 | struct cmd_list_element * | |
0b39b52e TT |
933 | add_com (const char *name, enum command_class theclass, |
934 | cmd_const_cfunc_ftype *fun, | |
1947513d | 935 | const char *doc) |
d318976c | 936 | { |
fe978cb0 | 937 | return add_cmd (name, theclass, fun, doc, &cmdlist); |
d318976c FN |
938 | } |
939 | ||
940 | /* Add an alias or abbreviation command to the list of commands. */ | |
941 | ||
942 | struct cmd_list_element * | |
fe978cb0 | 943 | add_com_alias (const char *name, const char *oldname, enum command_class theclass, |
d318976c FN |
944 | int abbrev_flag) |
945 | { | |
fe978cb0 | 946 | return add_alias_cmd (name, oldname, theclass, abbrev_flag, &cmdlist); |
d318976c | 947 | } |
4034d0ff AT |
948 | |
949 | /* Add an element with a suppress notification to the list of commands. */ | |
950 | ||
951 | struct cmd_list_element * | |
952 | add_com_suppress_notification (const char *name, enum command_class theclass, | |
1ee870c5 | 953 | cmd_const_cfunc_ftype *fun, const char *doc, |
4034d0ff AT |
954 | int *suppress_notification) |
955 | { | |
f67ffa6a AB |
956 | return add_cmd_suppress_notification (name, theclass, fun, doc, |
957 | &cmdlist, suppress_notification); | |
4034d0ff AT |
958 | } |
959 | ||
66d8c862 PW |
960 | /* If VERBOSE, print the full help for command C and highlight the |
961 | documentation parts matching HIGHLIGHT, | |
962 | otherwise print only one-line help for command C. */ | |
963 | ||
964 | static void | |
965 | print_doc_of_command (struct cmd_list_element *c, const char *prefix, | |
966 | bool verbose, compiled_regex &highlight, | |
967 | struct ui_file *stream) | |
968 | { | |
969 | /* When printing the full documentation, add a line to separate | |
970 | this documentation from the previous command help, in the likely | |
971 | case that apropos finds several commands. */ | |
972 | if (verbose) | |
973 | fputs_filtered ("\n", stream); | |
974 | ||
975 | fprintf_styled (stream, title_style.style (), | |
976 | "%s%s", prefix, c->name); | |
977 | fputs_filtered (" -- ", stream); | |
978 | if (verbose) | |
979 | fputs_highlighted (c->doc, highlight, stream); | |
980 | else | |
590042fc | 981 | print_doc_line (stream, c->doc, false); |
66d8c862 PW |
982 | fputs_filtered ("\n", stream); |
983 | } | |
984 | ||
6837a0a2 DB |
985 | /* Recursively walk the commandlist structures, and print out the |
986 | documentation of commands that match our regex in either their | |
987 | name, or their documentation. | |
66d8c862 PW |
988 | If VERBOSE, prints the complete documentation and highlight the |
989 | documentation parts matching REGEX, otherwise prints only | |
990 | the first line. | |
6837a0a2 | 991 | */ |
66d8c862 PW |
992 | void |
993 | apropos_cmd (struct ui_file *stream, | |
ebcd3b23 | 994 | struct cmd_list_element *commandlist, |
66d8c862 | 995 | bool verbose, compiled_regex ®ex, const char *prefix) |
6837a0a2 | 996 | { |
d5b5ac79 | 997 | struct cmd_list_element *c; |
4a98be19 | 998 | int returnvalue; |
cdb27c12 | 999 | |
ebcd3b23 | 1000 | /* Walk through the commands. */ |
6837a0a2 DB |
1001 | for (c=commandlist;c;c=c->next) |
1002 | { | |
ebcd3b23 | 1003 | returnvalue = -1; /* Needed to avoid double printing. */ |
6837a0a2 DB |
1004 | if (c->name != NULL) |
1005 | { | |
2d7cc5c7 PA |
1006 | size_t name_len = strlen (c->name); |
1007 | ||
ebcd3b23 | 1008 | /* Try to match against the name. */ |
2d7cc5c7 | 1009 | returnvalue = regex.search (c->name, name_len, 0, name_len, NULL); |
6837a0a2 | 1010 | if (returnvalue >= 0) |
66d8c862 | 1011 | print_doc_of_command (c, prefix, verbose, regex, stream); |
6837a0a2 | 1012 | } |
4a98be19 | 1013 | if (c->doc != NULL && returnvalue < 0) |
6837a0a2 | 1014 | { |
2d7cc5c7 PA |
1015 | size_t doc_len = strlen (c->doc); |
1016 | ||
ebcd3b23 | 1017 | /* Try to match against documentation. */ |
2d7cc5c7 | 1018 | if (regex.search (c->doc, doc_len, 0, doc_len, NULL) >= 0) |
66d8c862 | 1019 | print_doc_of_command (c, prefix, verbose, regex, stream); |
6837a0a2 | 1020 | } |
ebcd3b23 MS |
1021 | /* Check if this command has subcommands and is not an |
1022 | abbreviation. We skip listing subcommands of abbreviations | |
1023 | in order to avoid duplicates in the output. */ | |
5d2c29b8 | 1024 | if (c->prefixlist != NULL && !c->abbrev_flag) |
6837a0a2 DB |
1025 | { |
1026 | /* Recursively call ourselves on the subcommand list, | |
ebcd3b23 | 1027 | passing the right prefix in. */ |
66d8c862 | 1028 | apropos_cmd (stream, *c->prefixlist, verbose, regex, c->prefixname); |
6837a0a2 DB |
1029 | } |
1030 | } | |
1031 | } | |
c906108c SS |
1032 | |
1033 | /* This command really has to deal with two things: | |
ebcd3b23 MS |
1034 | 1) I want documentation on *this string* (usually called by |
1035 | "help commandname"). | |
1036 | ||
1037 | 2) I want documentation on *this list* (usually called by giving a | |
1038 | command that requires subcommands. Also called by saying just | |
1039 | "help".) | |
1040 | ||
1041 | I am going to split this into two seperate comamnds, help_cmd and | |
1042 | help_list. */ | |
c906108c SS |
1043 | |
1044 | void | |
64669f3b | 1045 | help_cmd (const char *command, struct ui_file *stream) |
c906108c SS |
1046 | { |
1047 | struct cmd_list_element *c; | |
c906108c SS |
1048 | |
1049 | if (!command) | |
1050 | { | |
1051 | help_list (cmdlist, "", all_classes, stream); | |
1052 | return; | |
1053 | } | |
1054 | ||
49a5a3a3 GM |
1055 | if (strcmp (command, "all") == 0) |
1056 | { | |
1057 | help_all (stream); | |
1058 | return; | |
1059 | } | |
1060 | ||
c906108c SS |
1061 | c = lookup_cmd (&command, cmdlist, "", 0, 0); |
1062 | ||
1063 | if (c == 0) | |
1064 | return; | |
1065 | ||
1066 | /* There are three cases here. | |
1067 | If c->prefixlist is nonzero, we have a prefix command. | |
1068 | Print its documentation, then list its subcommands. | |
c5aa993b | 1069 | |
9f60d481 AC |
1070 | If c->func is non NULL, we really have a command. Print its |
1071 | documentation and return. | |
c5aa993b | 1072 | |
9f60d481 AC |
1073 | If c->func is NULL, we have a class name. Print its |
1074 | documentation (as if it were a command) and then set class to the | |
1075 | number of this class so that the commands in the class will be | |
1076 | listed. */ | |
c906108c SS |
1077 | |
1078 | fputs_filtered (c->doc, stream); | |
1079 | fputs_filtered ("\n", stream); | |
1080 | ||
9f60d481 | 1081 | if (c->prefixlist == 0 && c->func != NULL) |
c906108c SS |
1082 | return; |
1083 | fprintf_filtered (stream, "\n"); | |
1084 | ||
ebcd3b23 | 1085 | /* If this is a prefix command, print it's subcommands. */ |
c906108c SS |
1086 | if (c->prefixlist) |
1087 | help_list (*c->prefixlist, c->prefixname, all_commands, stream); | |
1088 | ||
ebcd3b23 | 1089 | /* If this is a class name, print all of the commands in the class. */ |
9f60d481 | 1090 | if (c->func == NULL) |
fe978cb0 | 1091 | help_list (cmdlist, "", c->theclass, stream); |
c906108c | 1092 | |
73bc900d FN |
1093 | if (c->hook_pre || c->hook_post) |
1094 | fprintf_filtered (stream, | |
1095 | "\nThis command has a hook (or hooks) defined:\n"); | |
1096 | ||
1097 | if (c->hook_pre) | |
327529e9 | 1098 | fprintf_filtered (stream, |
72fe0832 | 1099 | "\tThis command is run after : %s (pre hook)\n", |
73bc900d FN |
1100 | c->hook_pre->name); |
1101 | if (c->hook_post) | |
327529e9 | 1102 | fprintf_filtered (stream, |
72fe0832 | 1103 | "\tThis command is run before : %s (post hook)\n", |
73bc900d | 1104 | c->hook_post->name); |
c906108c SS |
1105 | } |
1106 | ||
1107 | /* | |
1108 | * Get a specific kind of help on a command list. | |
1109 | * | |
1110 | * LIST is the list. | |
1111 | * CMDTYPE is the prefix to use in the title string. | |
1112 | * CLASS is the class with which to list the nodes of this list (see | |
1113 | * documentation for help_cmd_list below), As usual, ALL_COMMANDS for | |
1114 | * everything, ALL_CLASSES for just classes, and non-negative for only things | |
1115 | * in a specific class. | |
1116 | * and STREAM is the output stream on which to print things. | |
1117 | * If you call this routine with a class >= 0, it recurses. | |
1118 | */ | |
1119 | void | |
64e61d29 | 1120 | help_list (struct cmd_list_element *list, const char *cmdtype, |
fe978cb0 | 1121 | enum command_class theclass, struct ui_file *stream) |
c906108c SS |
1122 | { |
1123 | int len; | |
1124 | char *cmdtype1, *cmdtype2; | |
c5aa993b | 1125 | |
ebcd3b23 MS |
1126 | /* If CMDTYPE is "foo ", CMDTYPE1 gets " foo" and CMDTYPE2 gets "foo sub". |
1127 | */ | |
c906108c SS |
1128 | len = strlen (cmdtype); |
1129 | cmdtype1 = (char *) alloca (len + 1); | |
1130 | cmdtype1[0] = 0; | |
1131 | cmdtype2 = (char *) alloca (len + 4); | |
1132 | cmdtype2[0] = 0; | |
1133 | if (len) | |
1134 | { | |
1135 | cmdtype1[0] = ' '; | |
29f9a567 | 1136 | memcpy (cmdtype1 + 1, cmdtype, len - 1); |
c906108c | 1137 | cmdtype1[len] = 0; |
29f9a567 | 1138 | memcpy (cmdtype2, cmdtype, len - 1); |
c906108c SS |
1139 | strcpy (cmdtype2 + len - 1, " sub"); |
1140 | } | |
1141 | ||
fe978cb0 | 1142 | if (theclass == all_classes) |
c906108c SS |
1143 | fprintf_filtered (stream, "List of classes of %scommands:\n\n", cmdtype2); |
1144 | else | |
1145 | fprintf_filtered (stream, "List of %scommands:\n\n", cmdtype2); | |
1146 | ||
fe978cb0 | 1147 | help_cmd_list (list, theclass, cmdtype, (int) theclass >= 0, stream); |
c906108c | 1148 | |
fe978cb0 | 1149 | if (theclass == all_classes) |
de74f71f MS |
1150 | { |
1151 | fprintf_filtered (stream, "\n\ | |
1152 | Type \"help%s\" followed by a class name for a list of commands in ", | |
1153 | cmdtype1); | |
1154 | wrap_here (""); | |
1155 | fprintf_filtered (stream, "that class."); | |
6e381ba0 VP |
1156 | |
1157 | fprintf_filtered (stream, "\n\ | |
1158 | Type \"help all\" for the list of all commands."); | |
de74f71f | 1159 | } |
c906108c | 1160 | |
de74f71f | 1161 | fprintf_filtered (stream, "\nType \"help%s\" followed by %scommand name ", |
c5aa993b | 1162 | cmdtype1, cmdtype2); |
de74f71f MS |
1163 | wrap_here (""); |
1164 | fputs_filtered ("for ", stream); | |
1165 | wrap_here (""); | |
1166 | fputs_filtered ("full ", stream); | |
1167 | wrap_here (""); | |
1168 | fputs_filtered ("documentation.\n", stream); | |
6e381ba0 | 1169 | fputs_filtered ("Type \"apropos word\" to search " |
ebcd3b23 | 1170 | "for commands related to \"word\".\n", stream); |
66d8c862 PW |
1171 | fputs_filtered ("Type \"apropos -v word\" for full documentation", stream); |
1172 | wrap_here (""); | |
1173 | fputs_filtered (" of commands related to \"word\".\n", stream); | |
de74f71f MS |
1174 | fputs_filtered ("Command name abbreviations are allowed if unambiguous.\n", |
1175 | stream); | |
c906108c | 1176 | } |
c5aa993b | 1177 | |
49a5a3a3 | 1178 | static void |
c85871a3 | 1179 | help_all (struct ui_file *stream) |
49a5a3a3 GM |
1180 | { |
1181 | struct cmd_list_element *c; | |
6e381ba0 | 1182 | int seen_unclassified = 0; |
49a5a3a3 GM |
1183 | |
1184 | for (c = cmdlist; c; c = c->next) | |
1185 | { | |
1186 | if (c->abbrev_flag) | |
1187 | continue; | |
ebcd3b23 MS |
1188 | /* If this is a class name, print all of the commands in the |
1189 | class. */ | |
6e381ba0 VP |
1190 | |
1191 | if (c->func == NULL) | |
1192 | { | |
1193 | fprintf_filtered (stream, "\nCommand class: %s\n\n", c->name); | |
fe978cb0 | 1194 | help_cmd_list (cmdlist, c->theclass, "", 1, stream); |
6e381ba0 | 1195 | } |
49a5a3a3 | 1196 | } |
6e381ba0 VP |
1197 | |
1198 | /* While it's expected that all commands are in some class, | |
1199 | as a safety measure, we'll print commands outside of any | |
1200 | class at the end. */ | |
1201 | ||
1202 | for (c = cmdlist; c; c = c->next) | |
1203 | { | |
1204 | if (c->abbrev_flag) | |
1205 | continue; | |
1206 | ||
fe978cb0 | 1207 | if (c->theclass == no_class) |
6e381ba0 VP |
1208 | { |
1209 | if (!seen_unclassified) | |
1210 | { | |
1211 | fprintf_filtered (stream, "\nUnclassified commands\n\n"); | |
1212 | seen_unclassified = 1; | |
1213 | } | |
1214 | print_help_for_command (c, "", 1, stream); | |
1215 | } | |
1216 | } | |
1217 | ||
49a5a3a3 GM |
1218 | } |
1219 | ||
590042fc PW |
1220 | /* See cli-decode.h. */ |
1221 | ||
d318976c | 1222 | void |
590042fc PW |
1223 | print_doc_line (struct ui_file *stream, const char *str, |
1224 | bool for_value_prefix) | |
c906108c SS |
1225 | { |
1226 | static char *line_buffer = 0; | |
1227 | static int line_size; | |
1947513d | 1228 | const char *p; |
c906108c SS |
1229 | |
1230 | if (!line_buffer) | |
1231 | { | |
1232 | line_size = 80; | |
1233 | line_buffer = (char *) xmalloc (line_size); | |
1234 | } | |
1235 | ||
590042fc | 1236 | /* Searches for the first end of line or the end of STR. */ |
c906108c | 1237 | p = str; |
590042fc | 1238 | while (*p && *p != '\n') |
c906108c SS |
1239 | p++; |
1240 | if (p - str > line_size - 1) | |
1241 | { | |
1242 | line_size = p - str + 1; | |
b8c9b27d | 1243 | xfree (line_buffer); |
c906108c SS |
1244 | line_buffer = (char *) xmalloc (line_size); |
1245 | } | |
1246 | strncpy (line_buffer, str, p - str); | |
590042fc PW |
1247 | if (for_value_prefix) |
1248 | { | |
1249 | if (islower (line_buffer[0])) | |
1250 | line_buffer[0] = toupper (line_buffer[0]); | |
1251 | gdb_assert (p > str); | |
1252 | if (line_buffer[p - str - 1] == '.') | |
1253 | line_buffer[p - str - 1] = '\0'; | |
1254 | else | |
1255 | line_buffer[p - str] = '\0'; | |
1256 | } | |
1257 | else | |
1258 | line_buffer[p - str] = '\0'; | |
b6201d44 | 1259 | fputs_filtered (line_buffer, stream); |
c906108c SS |
1260 | } |
1261 | ||
6e381ba0 VP |
1262 | /* Print one-line help for command C. |
1263 | If RECURSE is non-zero, also print one-line descriptions | |
ebcd3b23 | 1264 | of all prefixed subcommands. */ |
6e381ba0 | 1265 | static void |
64e61d29 TT |
1266 | print_help_for_command (struct cmd_list_element *c, const char *prefix, |
1267 | int recurse, struct ui_file *stream) | |
6e381ba0 | 1268 | { |
66d8c862 PW |
1269 | fprintf_styled (stream, title_style.style (), |
1270 | "%s%s", prefix, c->name); | |
1271 | fputs_filtered (" -- ", stream); | |
590042fc | 1272 | print_doc_line (stream, c->doc, false); |
6e381ba0 | 1273 | fputs_filtered ("\n", stream); |
66d8c862 | 1274 | |
6e381ba0 VP |
1275 | if (recurse |
1276 | && c->prefixlist != 0 | |
1277 | && c->abbrev_flag == 0) | |
1278 | /* Subcommands of a prefix command typically have 'all_commands' | |
1279 | as class. If we pass CLASS to recursive invocation, | |
ebcd3b23 | 1280 | most often we won't see anything. */ |
6e381ba0 VP |
1281 | help_cmd_list (*c->prefixlist, all_commands, c->prefixname, 1, stream); |
1282 | } | |
1283 | ||
c906108c SS |
1284 | /* |
1285 | * Implement a help command on command list LIST. | |
1286 | * RECURSE should be non-zero if this should be done recursively on | |
1287 | * all sublists of LIST. | |
1288 | * PREFIX is the prefix to print before each command name. | |
1289 | * STREAM is the stream upon which the output should be written. | |
2aa08bd1 | 1290 | * THECLASS should be: |
c5aa993b | 1291 | * A non-negative class number to list only commands in that |
c906108c | 1292 | * class. |
c5aa993b JM |
1293 | * ALL_COMMANDS to list all commands in list. |
1294 | * ALL_CLASSES to list all classes in list. | |
c906108c SS |
1295 | * |
1296 | * Note that RECURSE will be active on *all* sublists, not just the | |
1297 | * ones selected by the criteria above (ie. the selection mechanism | |
1298 | * is at the low level, not the high-level). | |
1299 | */ | |
1300 | void | |
fe978cb0 | 1301 | help_cmd_list (struct cmd_list_element *list, enum command_class theclass, |
64e61d29 | 1302 | const char *prefix, int recurse, struct ui_file *stream) |
c906108c | 1303 | { |
d5b5ac79 | 1304 | struct cmd_list_element *c; |
c906108c SS |
1305 | |
1306 | for (c = list; c; c = c->next) | |
2aa08bd1 | 1307 | { |
5aafa1cc | 1308 | if (c->abbrev_flag == 0 |
0400cf2f | 1309 | && !c->cmd_deprecated |
fe978cb0 PA |
1310 | && (theclass == all_commands |
1311 | || (theclass == all_classes && c->func == NULL) | |
1312 | || (theclass == c->theclass && c->func != NULL))) | |
c906108c | 1313 | { |
6e381ba0 | 1314 | print_help_for_command (c, prefix, recurse, stream); |
c906108c | 1315 | } |
0400cf2f SM |
1316 | else if (c->abbrev_flag == 0 |
1317 | && recurse | |
1318 | && !c->cmd_deprecated | |
fe978cb0 | 1319 | && theclass == class_user && c->prefixlist != NULL) |
adb483fe | 1320 | /* User-defined commands may be subcommands. */ |
fe978cb0 | 1321 | help_cmd_list (*c->prefixlist, theclass, c->prefixname, |
ebcd3b23 | 1322 | recurse, stream); |
c906108c SS |
1323 | } |
1324 | } | |
c906108c | 1325 | \f |
c5aa993b | 1326 | |
c906108c SS |
1327 | /* Search the input clist for 'command'. Return the command if |
1328 | found (or NULL if not), and return the number of commands | |
ebcd3b23 | 1329 | found in nfound. */ |
c906108c SS |
1330 | |
1331 | static struct cmd_list_element * | |
6f937416 | 1332 | find_cmd (const char *command, int len, struct cmd_list_element *clist, |
fba45db2 | 1333 | int ignore_help_classes, int *nfound) |
c906108c SS |
1334 | { |
1335 | struct cmd_list_element *found, *c; | |
1336 | ||
b03e6ad9 | 1337 | found = NULL; |
c906108c SS |
1338 | *nfound = 0; |
1339 | for (c = clist; c; c = c->next) | |
1340 | if (!strncmp (command, c->name, len) | |
9f60d481 | 1341 | && (!ignore_help_classes || c->func)) |
c906108c | 1342 | { |
c5aa993b JM |
1343 | found = c; |
1344 | (*nfound)++; | |
1345 | if (c->name[len] == '\0') | |
1346 | { | |
1347 | *nfound = 1; | |
1348 | break; | |
1349 | } | |
c906108c SS |
1350 | } |
1351 | return found; | |
1352 | } | |
1353 | ||
604c4576 JG |
1354 | /* Return the length of command name in TEXT. */ |
1355 | ||
1356 | int | |
3386243e AS |
1357 | find_command_name_length (const char *text) |
1358 | { | |
1359 | const char *p = text; | |
1360 | ||
1361 | /* Treating underscores as part of command words is important | |
1362 | so that "set args_foo()" doesn't get interpreted as | |
1363 | "set args _foo()". */ | |
ebcd3b23 MS |
1364 | /* Some characters are only used for TUI specific commands. |
1365 | However, they are always allowed for the sake of consistency. | |
1366 | ||
ebcd3b23 MS |
1367 | Note that this is larger than the character set allowed when |
1368 | creating user-defined commands. */ | |
1369 | ||
947d3946 | 1370 | /* Recognize the single character commands so that, e.g., "!ls" |
ed59ded5 | 1371 | works as expected. */ |
947d3946 | 1372 | if (*p == '!' || *p == '|') |
ed59ded5 DE |
1373 | return 1; |
1374 | ||
5aafa1cc | 1375 | while (isalnum (*p) || *p == '-' || *p == '_' |
3386243e | 1376 | /* Characters used by TUI specific commands. */ |
4f45d445 | 1377 | || *p == '+' || *p == '<' || *p == '>' || *p == '$') |
3386243e AS |
1378 | p++; |
1379 | ||
1380 | return p - text; | |
1381 | } | |
1382 | ||
5a56e9c5 DE |
1383 | /* Return TRUE if NAME is a valid user-defined command name. |
1384 | This is a stricter subset of all gdb commands, | |
1385 | see find_command_name_length. */ | |
1386 | ||
7f008c9e | 1387 | bool |
5a56e9c5 DE |
1388 | valid_user_defined_cmd_name_p (const char *name) |
1389 | { | |
1390 | const char *p; | |
1391 | ||
1392 | if (*name == '\0') | |
7f008c9e | 1393 | return false; |
5a56e9c5 DE |
1394 | |
1395 | /* Alas "42" is a legitimate user-defined command. | |
1396 | In the interests of not breaking anything we preserve that. */ | |
1397 | ||
1398 | for (p = name; *p != '\0'; ++p) | |
1399 | { | |
1400 | if (isalnum (*p) | |
1401 | || *p == '-' | |
1402 | || *p == '_') | |
1403 | ; /* Ok. */ | |
1404 | else | |
7f008c9e | 1405 | return false; |
5a56e9c5 DE |
1406 | } |
1407 | ||
7f008c9e | 1408 | return true; |
5a56e9c5 DE |
1409 | } |
1410 | ||
c906108c SS |
1411 | /* This routine takes a line of TEXT and a CLIST in which to start the |
1412 | lookup. When it returns it will have incremented the text pointer past | |
1413 | the section of text it matched, set *RESULT_LIST to point to the list in | |
1414 | which the last word was matched, and will return a pointer to the cmd | |
1415 | list element which the text matches. It will return NULL if no match at | |
1416 | all was possible. It will return -1 (cast appropriately, ick) if ambigous | |
1417 | matches are possible; in this case *RESULT_LIST will be set to point to | |
1418 | the list in which there are ambiguous choices (and *TEXT will be set to | |
1419 | the ambiguous text string). | |
1420 | ||
1421 | If the located command was an abbreviation, this routine returns the base | |
1422 | command of the abbreviation. | |
1423 | ||
1424 | It does no error reporting whatsoever; control will always return | |
1425 | to the superior routine. | |
1426 | ||
1427 | In the case of an ambiguous return (-1), *RESULT_LIST will be set to point | |
1428 | at the prefix_command (ie. the best match) *or* (special case) will be NULL | |
1429 | if no prefix command was ever found. For example, in the case of "info a", | |
1430 | "info" matches without ambiguity, but "a" could be "args" or "address", so | |
1431 | *RESULT_LIST is set to the cmd_list_element for "info". So in this case | |
4ad2da73 | 1432 | RESULT_LIST should not be interpreted as a pointer to the beginning of a |
c906108c SS |
1433 | list; it simply points to a specific command. In the case of an ambiguous |
1434 | return *TEXT is advanced past the last non-ambiguous prefix (e.g. | |
1435 | "info t" can be "info types" or "info target"; upon return *TEXT has been | |
1436 | advanced past "info "). | |
1437 | ||
1438 | If RESULT_LIST is NULL, don't set *RESULT_LIST (but don't otherwise | |
1439 | affect the operation). | |
1440 | ||
1441 | This routine does *not* modify the text pointed to by TEXT. | |
c5aa993b | 1442 | |
c906108c SS |
1443 | If IGNORE_HELP_CLASSES is nonzero, ignore any command list elements which |
1444 | are actually help classes rather than commands (i.e. the function field of | |
1445 | the struct cmd_list_element is NULL). */ | |
1446 | ||
1447 | struct cmd_list_element * | |
6f937416 | 1448 | lookup_cmd_1 (const char **text, struct cmd_list_element *clist, |
fba45db2 | 1449 | struct cmd_list_element **result_list, int ignore_help_classes) |
c906108c | 1450 | { |
3386243e | 1451 | char *command; |
798a7429 | 1452 | int len, nfound; |
c906108c | 1453 | struct cmd_list_element *found, *c; |
6f937416 | 1454 | const char *line = *text; |
c906108c SS |
1455 | |
1456 | while (**text == ' ' || **text == '\t') | |
1457 | (*text)++; | |
1458 | ||
3386243e AS |
1459 | /* Identify the name of the command. */ |
1460 | len = find_command_name_length (*text); | |
c906108c SS |
1461 | |
1462 | /* If nothing but whitespace, return 0. */ | |
3386243e | 1463 | if (len == 0) |
c906108c | 1464 | return 0; |
c5aa993b | 1465 | |
c906108c | 1466 | /* *text and p now bracket the first command word to lookup (and |
ebcd3b23 | 1467 | it's length is len). We copy this into a local temporary. */ |
c906108c SS |
1468 | |
1469 | ||
1470 | command = (char *) alloca (len + 1); | |
22ad7fee | 1471 | memcpy (command, *text, len); |
c906108c SS |
1472 | command[len] = '\0'; |
1473 | ||
1474 | /* Look it up. */ | |
1475 | found = 0; | |
1476 | nfound = 0; | |
c5aa993b | 1477 | found = find_cmd (command, len, clist, ignore_help_classes, &nfound); |
c906108c | 1478 | |
c906108c SS |
1479 | /* If nothing matches, we have a simple failure. */ |
1480 | if (nfound == 0) | |
1481 | return 0; | |
1482 | ||
1483 | if (nfound > 1) | |
1484 | { | |
1485 | if (result_list != NULL) | |
1486 | /* Will be modified in calling routine | |
1487 | if we know what the prefix command is. */ | |
c5aa993b | 1488 | *result_list = 0; |
1427fe5e | 1489 | return CMD_LIST_AMBIGUOUS; /* Ambiguous. */ |
c906108c SS |
1490 | } |
1491 | ||
ebcd3b23 | 1492 | /* We've matched something on this list. Move text pointer forward. */ |
c906108c | 1493 | |
3386243e | 1494 | *text += len; |
c906108c | 1495 | |
c906108c | 1496 | if (found->cmd_pointer) |
56382845 | 1497 | { |
ebcd3b23 MS |
1498 | /* We drop the alias (abbreviation) in favor of the command it |
1499 | is pointing to. If the alias is deprecated, though, we need to | |
56382845 FN |
1500 | warn the user about it before we drop it. Note that while we |
1501 | are warning about the alias, we may also warn about the command | |
1502 | itself and we will adjust the appropriate DEPRECATED_WARN_USER | |
ebcd3b23 | 1503 | flags. */ |
56382845 | 1504 | |
1f2bdf09 | 1505 | if (found->deprecated_warn_user) |
6f937416 | 1506 | deprecated_cmd_warning (line); |
56382845 FN |
1507 | found = found->cmd_pointer; |
1508 | } | |
c906108c SS |
1509 | /* If we found a prefix command, keep looking. */ |
1510 | ||
1511 | if (found->prefixlist) | |
1512 | { | |
1513 | c = lookup_cmd_1 (text, *found->prefixlist, result_list, | |
1514 | ignore_help_classes); | |
1515 | if (!c) | |
1516 | { | |
1517 | /* Didn't find anything; this is as far as we got. */ | |
1518 | if (result_list != NULL) | |
1519 | *result_list = clist; | |
1520 | return found; | |
1521 | } | |
1427fe5e | 1522 | else if (c == CMD_LIST_AMBIGUOUS) |
c906108c | 1523 | { |
ebcd3b23 MS |
1524 | /* We've gotten this far properly, but the next step is |
1525 | ambiguous. We need to set the result list to the best | |
c906108c SS |
1526 | we've found (if an inferior hasn't already set it). */ |
1527 | if (result_list != NULL) | |
1528 | if (!*result_list) | |
ebcd3b23 | 1529 | /* This used to say *result_list = *found->prefixlist. |
c5aa993b | 1530 | If that was correct, need to modify the documentation |
ebcd3b23 MS |
1531 | at the top of this function to clarify what is |
1532 | supposed to be going on. */ | |
c906108c SS |
1533 | *result_list = found; |
1534 | return c; | |
1535 | } | |
1536 | else | |
1537 | { | |
1538 | /* We matched! */ | |
1539 | return c; | |
1540 | } | |
1541 | } | |
1542 | else | |
1543 | { | |
1544 | if (result_list != NULL) | |
1545 | *result_list = clist; | |
1546 | return found; | |
1547 | } | |
1548 | } | |
1549 | ||
1550 | /* All this hair to move the space to the front of cmdtype */ | |
1551 | ||
1552 | static void | |
6f937416 | 1553 | undef_cmd_error (const char *cmdtype, const char *q) |
c906108c | 1554 | { |
8a3fe4f8 | 1555 | error (_("Undefined %scommand: \"%s\". Try \"help%s%.*s\"."), |
c5aa993b JM |
1556 | cmdtype, |
1557 | q, | |
1558 | *cmdtype ? " " : "", | |
823ca731 | 1559 | (int) strlen (cmdtype) - 1, |
c5aa993b | 1560 | cmdtype); |
c906108c SS |
1561 | } |
1562 | ||
1563 | /* Look up the contents of *LINE as a command in the command list LIST. | |
1564 | LIST is a chain of struct cmd_list_element's. | |
1565 | If it is found, return the struct cmd_list_element for that command | |
1566 | and update *LINE to point after the command name, at the first argument. | |
1567 | If not found, call error if ALLOW_UNKNOWN is zero | |
1568 | otherwise (or if error returns) return zero. | |
1569 | Call error if specified command is ambiguous, | |
1570 | unless ALLOW_UNKNOWN is negative. | |
1571 | CMDTYPE precedes the word "command" in the error message. | |
1572 | ||
1573 | If INGNORE_HELP_CLASSES is nonzero, ignore any command list | |
1574 | elements which are actually help classes rather than commands (i.e. | |
1575 | the function field of the struct cmd_list_element is 0). */ | |
1576 | ||
1577 | struct cmd_list_element * | |
a121b7c1 PA |
1578 | lookup_cmd (const char **line, struct cmd_list_element *list, |
1579 | const char *cmdtype, | |
fba45db2 | 1580 | int allow_unknown, int ignore_help_classes) |
c906108c SS |
1581 | { |
1582 | struct cmd_list_element *last_list = 0; | |
3cebf8d8 | 1583 | struct cmd_list_element *c; |
c64601c7 FN |
1584 | |
1585 | /* Note: Do not remove trailing whitespace here because this | |
1586 | would be wrong for complete_command. Jim Kingdon */ | |
c5aa993b | 1587 | |
3cebf8d8 MS |
1588 | if (!*line) |
1589 | error (_("Lack of needed %scommand"), cmdtype); | |
1590 | ||
1591 | c = lookup_cmd_1 (line, list, &last_list, ignore_help_classes); | |
1592 | ||
c906108c SS |
1593 | if (!c) |
1594 | { | |
1595 | if (!allow_unknown) | |
1596 | { | |
3cebf8d8 MS |
1597 | char *q; |
1598 | int len = find_command_name_length (*line); | |
c906108c | 1599 | |
3cebf8d8 MS |
1600 | q = (char *) alloca (len + 1); |
1601 | strncpy (q, *line, len); | |
1602 | q[len] = '\0'; | |
1603 | undef_cmd_error (cmdtype, q); | |
c906108c SS |
1604 | } |
1605 | else | |
1606 | return 0; | |
1607 | } | |
1427fe5e | 1608 | else if (c == CMD_LIST_AMBIGUOUS) |
c906108c SS |
1609 | { |
1610 | /* Ambigous. Local values should be off prefixlist or called | |
c5aa993b | 1611 | values. */ |
c906108c SS |
1612 | int local_allow_unknown = (last_list ? last_list->allow_unknown : |
1613 | allow_unknown); | |
64e61d29 | 1614 | const char *local_cmdtype = last_list ? last_list->prefixname : cmdtype; |
c906108c | 1615 | struct cmd_list_element *local_list = |
cdb27c12 | 1616 | (last_list ? *(last_list->prefixlist) : list); |
c5aa993b | 1617 | |
c906108c SS |
1618 | if (local_allow_unknown < 0) |
1619 | { | |
1620 | if (last_list) | |
1621 | return last_list; /* Found something. */ | |
1622 | else | |
1623 | return 0; /* Found nothing. */ | |
1624 | } | |
1625 | else | |
1626 | { | |
1627 | /* Report as error. */ | |
1628 | int amb_len; | |
1629 | char ambbuf[100]; | |
1630 | ||
1631 | for (amb_len = 0; | |
1632 | ((*line)[amb_len] && (*line)[amb_len] != ' ' | |
1633 | && (*line)[amb_len] != '\t'); | |
1634 | amb_len++) | |
1635 | ; | |
c5aa993b | 1636 | |
c906108c SS |
1637 | ambbuf[0] = 0; |
1638 | for (c = local_list; c; c = c->next) | |
1639 | if (!strncmp (*line, c->name, amb_len)) | |
1640 | { | |
9a2b4c1b MS |
1641 | if (strlen (ambbuf) + strlen (c->name) + 6 |
1642 | < (int) sizeof ambbuf) | |
c906108c SS |
1643 | { |
1644 | if (strlen (ambbuf)) | |
1645 | strcat (ambbuf, ", "); | |
1646 | strcat (ambbuf, c->name); | |
1647 | } | |
1648 | else | |
1649 | { | |
1650 | strcat (ambbuf, ".."); | |
1651 | break; | |
1652 | } | |
1653 | } | |
8a3fe4f8 | 1654 | error (_("Ambiguous %scommand \"%s\": %s."), local_cmdtype, |
c906108c | 1655 | *line, ambbuf); |
c906108c SS |
1656 | } |
1657 | } | |
1658 | else | |
1659 | { | |
bf9e4d0c MB |
1660 | if (c->type == set_cmd && **line != '\0' && !isspace (**line)) |
1661 | error (_("Argument must be preceded by space.")); | |
1662 | ||
c906108c SS |
1663 | /* We've got something. It may still not be what the caller |
1664 | wants (if this command *needs* a subcommand). */ | |
1665 | while (**line == ' ' || **line == '\t') | |
1666 | (*line)++; | |
1667 | ||
1668 | if (c->prefixlist && **line && !c->allow_unknown) | |
1669 | undef_cmd_error (c->prefixname, *line); | |
1670 | ||
1671 | /* Seems to be what he wants. Return it. */ | |
1672 | return c; | |
1673 | } | |
1674 | return 0; | |
1675 | } | |
c5aa993b | 1676 | |
6f937416 | 1677 | /* We are here presumably because an alias or command in TEXT is |
ebcd3b23 | 1678 | deprecated and a warning message should be generated. This |
6f937416 | 1679 | function decodes TEXT and potentially generates a warning message |
ebcd3b23 | 1680 | as outlined below. |
56382845 FN |
1681 | |
1682 | Example for 'set endian big' which has a fictitious alias 'seb'. | |
1683 | ||
6f937416 | 1684 | If alias wasn't used in TEXT, and the command is deprecated: |
56382845 FN |
1685 | "warning: 'set endian big' is deprecated." |
1686 | ||
1687 | If alias was used, and only the alias is deprecated: | |
1688 | "warning: 'seb' an alias for the command 'set endian big' is deprecated." | |
1689 | ||
ebcd3b23 MS |
1690 | If alias was used and command is deprecated (regardless of whether |
1691 | the alias itself is deprecated: | |
56382845 FN |
1692 | |
1693 | "warning: 'set endian big' (seb) is deprecated." | |
1694 | ||
1695 | After the message has been sent, clear the appropriate flags in the | |
1696 | command and/or the alias so the user is no longer bothered. | |
1697 | ||
1698 | */ | |
1699 | void | |
6f937416 | 1700 | deprecated_cmd_warning (const char *text) |
56382845 FN |
1701 | { |
1702 | struct cmd_list_element *alias = NULL; | |
1703 | struct cmd_list_element *prefix_cmd = NULL; | |
1704 | struct cmd_list_element *cmd = NULL; | |
edefbb7c | 1705 | |
6f937416 | 1706 | if (!lookup_cmd_composition (text, &alias, &prefix_cmd, &cmd)) |
ebcd3b23 | 1707 | /* Return if text doesn't evaluate to a command. */ |
56382845 FN |
1708 | return; |
1709 | ||
1f2bdf09 TT |
1710 | if (!((alias ? alias->deprecated_warn_user : 0) |
1711 | || cmd->deprecated_warn_user) ) | |
ebcd3b23 | 1712 | /* Return if nothing is deprecated. */ |
56382845 FN |
1713 | return; |
1714 | ||
1715 | printf_filtered ("Warning:"); | |
1716 | ||
1f2bdf09 | 1717 | if (alias && !cmd->cmd_deprecated) |
56382845 FN |
1718 | printf_filtered (" '%s', an alias for the", alias->name); |
1719 | ||
1720 | printf_filtered (" command '"); | |
1721 | ||
1722 | if (prefix_cmd) | |
1723 | printf_filtered ("%s", prefix_cmd->prefixname); | |
1724 | ||
1725 | printf_filtered ("%s", cmd->name); | |
1726 | ||
1f2bdf09 | 1727 | if (alias && cmd->cmd_deprecated) |
56382845 FN |
1728 | printf_filtered ("' (%s) is deprecated.\n", alias->name); |
1729 | else | |
1730 | printf_filtered ("' is deprecated.\n"); | |
1731 | ||
1732 | ||
ebcd3b23 MS |
1733 | /* If it is only the alias that is deprecated, we want to indicate |
1734 | the new alias, otherwise we'll indicate the new command. */ | |
56382845 | 1735 | |
1f2bdf09 | 1736 | if (alias && !cmd->cmd_deprecated) |
56382845 FN |
1737 | { |
1738 | if (alias->replacement) | |
cdb27c12 | 1739 | printf_filtered ("Use '%s'.\n\n", alias->replacement); |
56382845 | 1740 | else |
cdb27c12 | 1741 | printf_filtered ("No alternative known.\n\n"); |
56382845 FN |
1742 | } |
1743 | else | |
1744 | { | |
1745 | if (cmd->replacement) | |
cdb27c12 | 1746 | printf_filtered ("Use '%s'.\n\n", cmd->replacement); |
56382845 | 1747 | else |
cdb27c12 | 1748 | printf_filtered ("No alternative known.\n\n"); |
56382845 FN |
1749 | } |
1750 | ||
ebcd3b23 | 1751 | /* We've warned you, now we'll keep quiet. */ |
56382845 | 1752 | if (alias) |
1f2bdf09 | 1753 | alias->deprecated_warn_user = 0; |
56382845 | 1754 | |
1f2bdf09 | 1755 | cmd->deprecated_warn_user = 0; |
56382845 FN |
1756 | } |
1757 | ||
1758 | ||
ebcd3b23 | 1759 | /* Look up the contents of LINE as a command in the command list 'cmdlist'. |
56382845 FN |
1760 | Return 1 on success, 0 on failure. |
1761 | ||
1762 | If LINE refers to an alias, *alias will point to that alias. | |
1763 | ||
177b42fe | 1764 | If LINE is a postfix command (i.e. one that is preceded by a prefix |
56382845 FN |
1765 | command) set *prefix_cmd. |
1766 | ||
1767 | Set *cmd to point to the command LINE indicates. | |
1768 | ||
1769 | If any of *alias, *prefix_cmd, or *cmd cannot be determined or do not | |
1770 | exist, they are NULL when we return. | |
1771 | ||
1772 | */ | |
1773 | int | |
6f937416 | 1774 | lookup_cmd_composition (const char *text, |
56382845 FN |
1775 | struct cmd_list_element **alias, |
1776 | struct cmd_list_element **prefix_cmd, | |
1777 | struct cmd_list_element **cmd) | |
1778 | { | |
3386243e | 1779 | char *command; |
798a7429 | 1780 | int len, nfound; |
56382845 FN |
1781 | struct cmd_list_element *cur_list; |
1782 | struct cmd_list_element *prev_cmd; | |
cdb27c12 | 1783 | |
56382845 FN |
1784 | *alias = NULL; |
1785 | *prefix_cmd = NULL; | |
1786 | *cmd = NULL; | |
1787 | ||
1788 | cur_list = cmdlist; | |
1789 | ||
1790 | while (1) | |
1791 | { | |
7a9dd1b2 | 1792 | /* Go through as many command lists as we need to, |
ebcd3b23 | 1793 | to find the command TEXT refers to. */ |
56382845 FN |
1794 | |
1795 | prev_cmd = *cmd; | |
1796 | ||
1797 | while (*text == ' ' || *text == '\t') | |
cdb27c12 | 1798 | (text)++; |
56382845 | 1799 | |
3386243e AS |
1800 | /* Identify the name of the command. */ |
1801 | len = find_command_name_length (text); | |
56382845 FN |
1802 | |
1803 | /* If nothing but whitespace, return. */ | |
3386243e AS |
1804 | if (len == 0) |
1805 | return 0; | |
56382845 | 1806 | |
cdb27c12 MS |
1807 | /* Text is the start of the first command word to lookup (and |
1808 | it's length is len). We copy this into a local temporary. */ | |
56382845 FN |
1809 | |
1810 | command = (char *) alloca (len + 1); | |
22ad7fee | 1811 | memcpy (command, text, len); |
56382845 FN |
1812 | command[len] = '\0'; |
1813 | ||
1814 | /* Look it up. */ | |
1815 | *cmd = 0; | |
1816 | nfound = 0; | |
1817 | *cmd = find_cmd (command, len, cur_list, 1, &nfound); | |
1818 | ||
1427fe5e | 1819 | if (*cmd == CMD_LIST_AMBIGUOUS) |
cdb27c12 MS |
1820 | { |
1821 | return 0; /* ambiguous */ | |
1822 | } | |
56382845 FN |
1823 | |
1824 | if (*cmd == NULL) | |
cdb27c12 | 1825 | return 0; /* nothing found */ |
56382845 | 1826 | else |
cdb27c12 MS |
1827 | { |
1828 | if ((*cmd)->cmd_pointer) | |
1829 | { | |
ebcd3b23 MS |
1830 | /* cmd was actually an alias, we note that an alias was |
1831 | used (by assigning *alais) and we set *cmd. */ | |
cdb27c12 MS |
1832 | *alias = *cmd; |
1833 | *cmd = (*cmd)->cmd_pointer; | |
1834 | } | |
1835 | *prefix_cmd = prev_cmd; | |
1836 | } | |
56382845 | 1837 | if ((*cmd)->prefixlist) |
cdb27c12 | 1838 | cur_list = *(*cmd)->prefixlist; |
56382845 | 1839 | else |
cdb27c12 | 1840 | return 1; |
56382845 | 1841 | |
3386243e | 1842 | text += len; |
56382845 FN |
1843 | } |
1844 | } | |
1845 | ||
c906108c SS |
1846 | /* Helper function for SYMBOL_COMPLETION_FUNCTION. */ |
1847 | ||
1848 | /* Return a vector of char pointers which point to the different | |
ebcd3b23 | 1849 | possible completions in LIST of TEXT. |
c906108c SS |
1850 | |
1851 | WORD points in the same buffer as TEXT, and completions should be | |
ebcd3b23 MS |
1852 | returned relative to this position. For example, suppose TEXT is |
1853 | "foo" and we want to complete to "foobar". If WORD is "oo", return | |
c906108c SS |
1854 | "oobar"; if WORD is "baz/foo", return "baz/foobar". */ |
1855 | ||
eb3ff9a5 | 1856 | void |
6f937416 | 1857 | complete_on_cmdlist (struct cmd_list_element *list, |
eb3ff9a5 | 1858 | completion_tracker &tracker, |
6f937416 | 1859 | const char *text, const char *word, |
ace21957 | 1860 | int ignore_help_classes) |
c906108c SS |
1861 | { |
1862 | struct cmd_list_element *ptr; | |
c906108c | 1863 | int textlen = strlen (text); |
3f172e24 TT |
1864 | int pass; |
1865 | int saw_deprecated_match = 0; | |
c906108c | 1866 | |
3f172e24 TT |
1867 | /* We do one or two passes. In the first pass, we skip deprecated |
1868 | commands. If we see no matching commands in the first pass, and | |
1869 | if we did happen to see a matching deprecated command, we do | |
1870 | another loop to collect those. */ | |
eb3ff9a5 | 1871 | for (pass = 0; pass < 2; ++pass) |
3f172e24 | 1872 | { |
eb3ff9a5 PA |
1873 | bool got_matches = false; |
1874 | ||
3f172e24 TT |
1875 | for (ptr = list; ptr; ptr = ptr->next) |
1876 | if (!strncmp (ptr->name, text, textlen) | |
1877 | && !ptr->abbrev_flag | |
ace21957 | 1878 | && (!ignore_help_classes || ptr->func |
3f172e24 | 1879 | || ptr->prefixlist)) |
c906108c | 1880 | { |
3f172e24 TT |
1881 | if (pass == 0) |
1882 | { | |
1f2bdf09 | 1883 | if (ptr->cmd_deprecated) |
3f172e24 TT |
1884 | { |
1885 | saw_deprecated_match = 1; | |
1886 | continue; | |
1887 | } | |
1888 | } | |
c906108c | 1889 | |
60a20c19 PA |
1890 | tracker.add_completion |
1891 | (make_completion_match_str (ptr->name, text, word)); | |
eb3ff9a5 | 1892 | got_matches = true; |
c906108c | 1893 | } |
eb3ff9a5 PA |
1894 | |
1895 | if (got_matches) | |
1896 | break; | |
1897 | ||
3f172e24 TT |
1898 | /* If we saw no matching deprecated commands in the first pass, |
1899 | just bail out. */ | |
1900 | if (!saw_deprecated_match) | |
1901 | break; | |
1902 | } | |
c906108c SS |
1903 | } |
1904 | ||
1905 | /* Helper function for SYMBOL_COMPLETION_FUNCTION. */ | |
1906 | ||
eb3ff9a5 | 1907 | /* Add the different possible completions in ENUMLIST of TEXT. |
c906108c SS |
1908 | |
1909 | WORD points in the same buffer as TEXT, and completions should be | |
1910 | returned relative to this position. For example, suppose TEXT is "foo" | |
1911 | and we want to complete to "foobar". If WORD is "oo", return | |
1912 | "oobar"; if WORD is "baz/foo", return "baz/foobar". */ | |
1913 | ||
eb3ff9a5 PA |
1914 | void |
1915 | complete_on_enum (completion_tracker &tracker, | |
1916 | const char *const *enumlist, | |
6f937416 | 1917 | const char *text, const char *word) |
c906108c | 1918 | { |
c906108c SS |
1919 | int textlen = strlen (text); |
1920 | int i; | |
53904c9e | 1921 | const char *name; |
c906108c | 1922 | |
c906108c SS |
1923 | for (i = 0; (name = enumlist[i]) != NULL; i++) |
1924 | if (strncmp (name, text, textlen) == 0) | |
60a20c19 | 1925 | tracker.add_completion (make_completion_match_str (name, text, word)); |
c906108c SS |
1926 | } |
1927 | ||
f436dd25 | 1928 | |
ebcd3b23 | 1929 | /* Check function pointer. */ |
f436dd25 MH |
1930 | int |
1931 | cmd_func_p (struct cmd_list_element *cmd) | |
1932 | { | |
1933 | return (cmd->func != NULL); | |
1934 | } | |
1935 | ||
1936 | ||
ebcd3b23 | 1937 | /* Call the command function. */ |
f436dd25 | 1938 | void |
95a6b0a1 | 1939 | cmd_func (struct cmd_list_element *cmd, const char *args, int from_tty) |
f436dd25 MH |
1940 | { |
1941 | if (cmd_func_p (cmd)) | |
4034d0ff | 1942 | { |
156d9eab | 1943 | gdb::optional<scoped_restore_tmpl<int>> restore_suppress; |
4034d0ff AT |
1944 | |
1945 | if (cmd->suppress_notification != NULL) | |
156d9eab | 1946 | restore_suppress.emplace (cmd->suppress_notification, 1); |
4034d0ff AT |
1947 | |
1948 | (*cmd->func) (cmd, args, from_tty); | |
4034d0ff | 1949 | } |
f436dd25 | 1950 | else |
8a3fe4f8 | 1951 | error (_("Invalid command")); |
f436dd25 | 1952 | } |
a9f116cb GKB |
1953 | |
1954 | int | |
1955 | cli_user_command_p (struct cmd_list_element *cmd) | |
1956 | { | |
fe978cb0 | 1957 | return (cmd->theclass == class_user |
5fed81ff | 1958 | && (cmd->func == do_const_cfunc || cmd->func == do_sfunc)); |
a9f116cb | 1959 | } |