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