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