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