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