1 /* Handle lists of commands, their decoding and documentation, for GDB.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "gdb_regex.h"
22 #include "completer.h"
24 #include "cli/cli-cmds.h"
25 #include "cli/cli-decode.h"
26 #include "cli/cli-style.h"
27 #include "common/gdb_optional.h"
29 /* Prototypes for local functions. */
31 static void undef_cmd_error (const char *, const char *);
33 static struct cmd_list_element
*delete_cmd (const char *name
,
34 struct cmd_list_element
**list
,
35 struct cmd_list_element
**prehook
,
36 struct cmd_list_element
**prehookee
,
37 struct cmd_list_element
**posthook
,
38 struct cmd_list_element
**posthookee
);
40 static struct cmd_list_element
*find_cmd (const char *command
,
42 struct cmd_list_element
*clist
,
43 int ignore_help_classes
,
46 static void help_all (struct ui_file
*stream
);
48 /* Look up a command whose 'prefixlist' is KEY. Return the command if found,
49 otherwise return NULL. */
51 static struct cmd_list_element
*
52 lookup_cmd_for_prefixlist (struct cmd_list_element
**key
,
53 struct cmd_list_element
*list
)
55 struct cmd_list_element
*p
= NULL
;
57 for (p
= list
; p
!= NULL
; p
= p
->next
)
59 struct cmd_list_element
*q
;
61 if (p
->prefixlist
== NULL
)
63 else if (p
->prefixlist
== key
)
66 q
= lookup_cmd_for_prefixlist (key
, *(p
->prefixlist
));
75 set_cmd_prefix (struct cmd_list_element
*c
, struct cmd_list_element
**list
)
77 struct cmd_list_element
*p
;
79 /* Check to see if *LIST contains any element other than C. */
80 for (p
= *list
; p
!= NULL
; p
= p
->next
)
86 /* *SET_LIST only contains SET. */
87 p
= lookup_cmd_for_prefixlist (list
, setlist
);
89 c
->prefix
= p
? (p
->cmd_pointer
? p
->cmd_pointer
: p
) : p
;
92 c
->prefix
= p
->prefix
;
96 print_help_for_command (struct cmd_list_element
*c
, const char *prefix
,
97 int recurse
, struct ui_file
*stream
);
100 /* Set the callback function for the specified command. For each both
101 the commands callback and func() are set. The latter set to a
102 bounce function (unless cfunc / sfunc is NULL that is). */
105 do_const_cfunc (struct cmd_list_element
*c
, const char *args
, int from_tty
)
107 c
->function
.const_cfunc (args
, from_tty
);
111 set_cmd_cfunc (struct cmd_list_element
*cmd
, cmd_const_cfunc_ftype
*cfunc
)
116 cmd
->func
= do_const_cfunc
;
117 cmd
->function
.const_cfunc
= cfunc
;
121 do_sfunc (struct cmd_list_element
*c
, const char *args
, int from_tty
)
123 c
->function
.sfunc (args
, from_tty
, c
);
127 set_cmd_sfunc (struct cmd_list_element
*cmd
, cmd_const_sfunc_ftype
*sfunc
)
132 cmd
->func
= do_sfunc
;
133 cmd
->function
.sfunc
= sfunc
;
137 cmd_cfunc_eq (struct cmd_list_element
*cmd
, cmd_const_cfunc_ftype
*cfunc
)
139 return cmd
->func
== do_const_cfunc
&& cmd
->function
.const_cfunc
== cfunc
;
143 set_cmd_context (struct cmd_list_element
*cmd
, void *context
)
145 cmd
->context
= context
;
149 get_cmd_context (struct cmd_list_element
*cmd
)
155 cmd_type (struct cmd_list_element
*cmd
)
161 set_cmd_completer (struct cmd_list_element
*cmd
, completer_ftype
*completer
)
163 cmd
->completer
= completer
; /* Ok. */
166 /* See definition in commands.h. */
169 set_cmd_completer_handle_brkchars (struct cmd_list_element
*cmd
,
170 completer_handle_brkchars_ftype
*func
)
172 cmd
->completer_handle_brkchars
= func
;
175 /* Add element named NAME.
176 Space for NAME and DOC must be allocated by the caller.
177 CLASS is the top level category into which commands are broken down
179 FUN should be the function to execute the command;
180 it will get a character string as argument, with leading
181 and trailing blanks already eliminated.
183 DOC is a documentation string for the command.
184 Its first line should be a complete sentence.
185 It should start with ? for a command that is an abbreviation
186 or with * for a command that most users don't need to know about.
188 Add this command to command list *LIST.
190 Returns a pointer to the added command (not necessarily the head
193 static struct cmd_list_element
*
194 do_add_cmd (const char *name
, enum command_class theclass
,
195 const char *doc
, struct cmd_list_element
**list
)
197 struct cmd_list_element
*c
= new struct cmd_list_element (name
, theclass
,
199 struct cmd_list_element
*p
, *iter
;
201 /* Turn each alias of the old command into an alias of the new
203 c
->aliases
= delete_cmd (name
, list
, &c
->hook_pre
, &c
->hookee_pre
,
204 &c
->hook_post
, &c
->hookee_post
);
205 for (iter
= c
->aliases
; iter
; iter
= iter
->alias_chain
)
206 iter
->cmd_pointer
= c
;
208 c
->hook_pre
->hookee_pre
= c
;
210 c
->hookee_pre
->hook_pre
= c
;
212 c
->hook_post
->hookee_post
= c
;
214 c
->hookee_post
->hook_post
= c
;
216 if (*list
== NULL
|| strcmp ((*list
)->name
, name
) >= 0)
224 while (p
->next
&& strcmp (p
->next
->name
, name
) <= 0)
235 struct cmd_list_element
*
236 add_cmd (const char *name
, enum command_class theclass
,
237 const char *doc
, struct cmd_list_element
**list
)
239 cmd_list_element
*result
= do_add_cmd (name
, theclass
, doc
, list
);
241 result
->function
.const_cfunc
= NULL
;
245 struct cmd_list_element
*
246 add_cmd (const char *name
, enum command_class theclass
,
247 cmd_const_cfunc_ftype
*fun
,
248 const char *doc
, struct cmd_list_element
**list
)
250 cmd_list_element
*result
= do_add_cmd (name
, theclass
, doc
, list
);
251 set_cmd_cfunc (result
, fun
);
255 /* Add an element with a suppress notification to the LIST of commands. */
257 struct cmd_list_element
*
258 add_cmd_suppress_notification (const char *name
, enum command_class theclass
,
259 cmd_const_cfunc_ftype
*fun
, const char *doc
,
260 struct cmd_list_element
**list
,
261 int *suppress_notification
)
263 struct cmd_list_element
*element
;
265 element
= add_cmd (name
, theclass
, fun
, doc
, list
);
266 element
->suppress_notification
= suppress_notification
;
272 /* Deprecates a command CMD.
273 REPLACEMENT is the name of the command which should be used in
274 place of this command, or NULL if no such command exists.
276 This function does not check to see if command REPLACEMENT exists
277 since gdb may not have gotten around to adding REPLACEMENT when
278 this function is called.
280 Returns a pointer to the deprecated command. */
282 struct cmd_list_element
*
283 deprecate_cmd (struct cmd_list_element
*cmd
, const char *replacement
)
285 cmd
->cmd_deprecated
= 1;
286 cmd
->deprecated_warn_user
= 1;
288 if (replacement
!= NULL
)
289 cmd
->replacement
= replacement
;
291 cmd
->replacement
= NULL
;
296 struct cmd_list_element
*
297 add_alias_cmd (const char *name
, cmd_list_element
*old
,
298 enum command_class theclass
, int abbrev_flag
,
299 struct cmd_list_element
**list
)
303 struct cmd_list_element
*prehook
, *prehookee
, *posthook
, *posthookee
;
304 struct cmd_list_element
*aliases
= delete_cmd (name
, list
,
305 &prehook
, &prehookee
,
306 &posthook
, &posthookee
);
308 /* If this happens, it means a programmer error somewhere. */
309 gdb_assert (!aliases
&& !prehook
&& !prehookee
310 && !posthook
&& ! posthookee
);
314 struct cmd_list_element
*c
= add_cmd (name
, theclass
, old
->doc
, list
);
316 /* If OLD->DOC can be freed, we should make another copy. */
317 if (old
->doc_allocated
)
319 c
->doc
= xstrdup (old
->doc
);
320 c
->doc_allocated
= 1;
322 /* NOTE: Both FUNC and all the FUNCTIONs need to be copied. */
324 c
->function
= old
->function
;
325 c
->prefixlist
= old
->prefixlist
;
326 c
->prefixname
= old
->prefixname
;
327 c
->allow_unknown
= old
->allow_unknown
;
328 c
->abbrev_flag
= abbrev_flag
;
329 c
->cmd_pointer
= old
;
330 c
->alias_chain
= old
->aliases
;
333 set_cmd_prefix (c
, list
);
337 struct cmd_list_element
*
338 add_alias_cmd (const char *name
, const char *oldname
,
339 enum command_class theclass
, int abbrev_flag
,
340 struct cmd_list_element
**list
)
343 struct cmd_list_element
*old
;
346 old
= lookup_cmd (&tmp
, *list
, "", 1, 1);
348 return add_alias_cmd (name
, old
, theclass
, abbrev_flag
, list
);
352 /* Like add_cmd but adds an element for a command prefix: a name that
353 should be followed by a subcommand to be looked up in another
354 command list. PREFIXLIST should be the address of the variable
355 containing that list. */
357 struct cmd_list_element
*
358 add_prefix_cmd (const char *name
, enum command_class theclass
,
359 cmd_const_cfunc_ftype
*fun
,
360 const char *doc
, struct cmd_list_element
**prefixlist
,
361 const char *prefixname
, int allow_unknown
,
362 struct cmd_list_element
**list
)
364 struct cmd_list_element
*c
= add_cmd (name
, theclass
, fun
, doc
, list
);
365 struct cmd_list_element
*p
;
367 c
->prefixlist
= prefixlist
;
368 c
->prefixname
= prefixname
;
369 c
->allow_unknown
= allow_unknown
;
371 if (list
== &cmdlist
)
374 set_cmd_prefix (c
, list
);
376 /* Update the field 'prefix' of each cmd_list_element in *PREFIXLIST. */
377 for (p
= *prefixlist
; p
!= NULL
; p
= p
->next
)
383 /* Like ADD_PREFIX_CMD but sets the suppress_notification pointer on the
384 new command list element. */
386 struct cmd_list_element
*
387 add_prefix_cmd_suppress_notification
388 (const char *name
, enum command_class theclass
,
389 cmd_const_cfunc_ftype
*fun
,
390 const char *doc
, struct cmd_list_element
**prefixlist
,
391 const char *prefixname
, int allow_unknown
,
392 struct cmd_list_element
**list
,
393 int *suppress_notification
)
395 struct cmd_list_element
*element
396 = add_prefix_cmd (name
, theclass
, fun
, doc
, prefixlist
,
397 prefixname
, allow_unknown
, list
);
398 element
->suppress_notification
= suppress_notification
;
402 /* Like add_prefix_cmd but sets the abbrev_flag on the new command. */
404 struct cmd_list_element
*
405 add_abbrev_prefix_cmd (const char *name
, enum command_class theclass
,
406 cmd_const_cfunc_ftype
*fun
, const char *doc
,
407 struct cmd_list_element
**prefixlist
,
408 const char *prefixname
,
409 int allow_unknown
, struct cmd_list_element
**list
)
411 struct cmd_list_element
*c
= add_cmd (name
, theclass
, fun
, doc
, list
);
413 c
->prefixlist
= prefixlist
;
414 c
->prefixname
= prefixname
;
415 c
->allow_unknown
= allow_unknown
;
420 /* This is an empty "cfunc". */
422 not_just_help_class_command (const char *args
, int from_tty
)
426 /* This is an empty "sfunc". */
429 empty_sfunc (const char *args
, int from_tty
, struct cmd_list_element
*c
)
433 /* Add element named NAME to command list LIST (the list for set/show
434 or some sublist thereof).
435 TYPE is set_cmd or show_cmd.
436 CLASS is as in add_cmd.
437 VAR_TYPE is the kind of thing we are setting.
438 VAR is address of the variable being controlled by this command.
439 DOC is the documentation string. */
441 static struct cmd_list_element
*
442 add_set_or_show_cmd (const char *name
,
444 enum command_class theclass
,
448 struct cmd_list_element
**list
)
450 struct cmd_list_element
*c
= add_cmd (name
, theclass
, doc
, list
);
452 gdb_assert (type
== set_cmd
|| type
== show_cmd
);
454 c
->var_type
= var_type
;
456 /* This needs to be something besides NULL so that this isn't
457 treated as a help class. */
458 set_cmd_sfunc (c
, empty_sfunc
);
462 /* Add element named NAME to both the command SET_LIST and SHOW_LIST.
463 CLASS is as in add_cmd. VAR_TYPE is the kind of thing we are
464 setting. VAR is address of the variable being controlled by this
465 command. SET_FUNC and SHOW_FUNC are the callback functions (if
466 non-NULL). SET_DOC, SHOW_DOC and HELP_DOC are the documentation
467 strings. PRINT the format string to print the value. SET_RESULT
468 and SHOW_RESULT, if not NULL, are set to the resulting command
472 add_setshow_cmd_full (const char *name
,
473 enum command_class theclass
,
474 var_types var_type
, void *var
,
475 const char *set_doc
, const char *show_doc
,
476 const char *help_doc
,
477 cmd_const_sfunc_ftype
*set_func
,
478 show_value_ftype
*show_func
,
479 struct cmd_list_element
**set_list
,
480 struct cmd_list_element
**show_list
,
481 struct cmd_list_element
**set_result
,
482 struct cmd_list_element
**show_result
)
484 struct cmd_list_element
*set
;
485 struct cmd_list_element
*show
;
489 if (help_doc
!= NULL
)
491 full_set_doc
= xstrprintf ("%s\n%s", set_doc
, help_doc
);
492 full_show_doc
= xstrprintf ("%s\n%s", show_doc
, help_doc
);
496 full_set_doc
= xstrdup (set_doc
);
497 full_show_doc
= xstrdup (show_doc
);
499 set
= add_set_or_show_cmd (name
, set_cmd
, theclass
, var_type
, var
,
500 full_set_doc
, set_list
);
501 set
->doc_allocated
= 1;
503 if (set_func
!= NULL
)
504 set_cmd_sfunc (set
, set_func
);
506 set_cmd_prefix (set
, set_list
);
508 show
= add_set_or_show_cmd (name
, show_cmd
, theclass
, var_type
, var
,
509 full_show_doc
, show_list
);
510 show
->doc_allocated
= 1;
511 show
->show_value_func
= show_func
;
512 /* Disable the default symbol completer. Doesn't make much sense
513 for the "show" command to complete on anything. */
514 set_cmd_completer (show
, nullptr);
516 if (set_result
!= NULL
)
518 if (show_result
!= NULL
)
522 /* Add element named NAME to command list LIST (the list for set or
523 some sublist thereof). CLASS is as in add_cmd. ENUMLIST is a list
524 of strings which may follow NAME. VAR is address of the variable
525 which will contain the matching string (from ENUMLIST). */
528 add_setshow_enum_cmd (const char *name
,
529 enum command_class theclass
,
530 const char *const *enumlist
,
533 const char *show_doc
,
534 const char *help_doc
,
535 cmd_const_sfunc_ftype
*set_func
,
536 show_value_ftype
*show_func
,
537 struct cmd_list_element
**set_list
,
538 struct cmd_list_element
**show_list
,
541 struct cmd_list_element
*c
, *show
;
543 add_setshow_cmd_full (name
, theclass
, var_enum
, var
,
544 set_doc
, show_doc
, help_doc
,
550 set_cmd_context (c
, context
);
551 set_cmd_context (show
, context
);
554 /* See cli-decode.h. */
555 const char * const auto_boolean_enums
[] = { "on", "off", "auto", NULL
};
557 /* Add an auto-boolean command named NAME to both the set and show
558 command list lists. CLASS is as in add_cmd. VAR is address of the
559 variable which will contain the value. DOC is the documentation
560 string. FUNC is the corresponding callback. */
562 add_setshow_auto_boolean_cmd (const char *name
,
563 enum command_class theclass
,
564 enum auto_boolean
*var
,
565 const char *set_doc
, const char *show_doc
,
566 const char *help_doc
,
567 cmd_const_sfunc_ftype
*set_func
,
568 show_value_ftype
*show_func
,
569 struct cmd_list_element
**set_list
,
570 struct cmd_list_element
**show_list
)
572 struct cmd_list_element
*c
;
574 add_setshow_cmd_full (name
, theclass
, var_auto_boolean
, var
,
575 set_doc
, show_doc
, help_doc
,
579 c
->enums
= auto_boolean_enums
;
582 /* See cli-decode.h. */
583 const char * const boolean_enums
[] = { "on", "off", NULL
};
585 /* Add element named NAME to both the set and show command LISTs (the
586 list for set/show or some sublist thereof). CLASS is as in
587 add_cmd. VAR is address of the variable which will contain the
588 value. SET_DOC and SHOW_DOC are the documentation strings. */
590 add_setshow_boolean_cmd (const char *name
, enum command_class theclass
, int *var
,
591 const char *set_doc
, const char *show_doc
,
592 const char *help_doc
,
593 cmd_const_sfunc_ftype
*set_func
,
594 show_value_ftype
*show_func
,
595 struct cmd_list_element
**set_list
,
596 struct cmd_list_element
**show_list
)
598 struct cmd_list_element
*c
;
600 add_setshow_cmd_full (name
, theclass
, var_boolean
, var
,
601 set_doc
, show_doc
, help_doc
,
605 c
->enums
= boolean_enums
;
608 /* Add element named NAME to both the set and show command LISTs (the
609 list for set/show or some sublist thereof). */
611 add_setshow_filename_cmd (const char *name
, enum command_class theclass
,
613 const char *set_doc
, const char *show_doc
,
614 const char *help_doc
,
615 cmd_const_sfunc_ftype
*set_func
,
616 show_value_ftype
*show_func
,
617 struct cmd_list_element
**set_list
,
618 struct cmd_list_element
**show_list
)
620 struct cmd_list_element
*set_result
;
622 add_setshow_cmd_full (name
, theclass
, var_filename
, var
,
623 set_doc
, show_doc
, help_doc
,
627 set_cmd_completer (set_result
, filename_completer
);
630 /* Add element named NAME to both the set and show command LISTs (the
631 list for set/show or some sublist thereof). */
633 add_setshow_string_cmd (const char *name
, enum command_class theclass
,
635 const char *set_doc
, const char *show_doc
,
636 const char *help_doc
,
637 cmd_const_sfunc_ftype
*set_func
,
638 show_value_ftype
*show_func
,
639 struct cmd_list_element
**set_list
,
640 struct cmd_list_element
**show_list
)
642 cmd_list_element
*set_cmd
;
644 add_setshow_cmd_full (name
, theclass
, var_string
, var
,
645 set_doc
, show_doc
, help_doc
,
650 /* Disable the default symbol completer. */
651 set_cmd_completer (set_cmd
, nullptr);
654 /* Add element named NAME to both the set and show command LISTs (the
655 list for set/show or some sublist thereof). */
656 struct cmd_list_element
*
657 add_setshow_string_noescape_cmd (const char *name
, enum command_class theclass
,
659 const char *set_doc
, const char *show_doc
,
660 const char *help_doc
,
661 cmd_const_sfunc_ftype
*set_func
,
662 show_value_ftype
*show_func
,
663 struct cmd_list_element
**set_list
,
664 struct cmd_list_element
**show_list
)
666 struct cmd_list_element
*set_cmd
;
668 add_setshow_cmd_full (name
, theclass
, var_string_noescape
, var
,
669 set_doc
, show_doc
, help_doc
,
674 /* Disable the default symbol completer. */
675 set_cmd_completer (set_cmd
, nullptr);
680 /* Add element named NAME to both the set and show command LISTs (the
681 list for set/show or some sublist thereof). */
683 add_setshow_optional_filename_cmd (const char *name
, enum command_class theclass
,
685 const char *set_doc
, const char *show_doc
,
686 const char *help_doc
,
687 cmd_const_sfunc_ftype
*set_func
,
688 show_value_ftype
*show_func
,
689 struct cmd_list_element
**set_list
,
690 struct cmd_list_element
**show_list
)
692 struct cmd_list_element
*set_result
;
694 add_setshow_cmd_full (name
, theclass
, var_optional_filename
, var
,
695 set_doc
, show_doc
, help_doc
,
700 set_cmd_completer (set_result
, filename_completer
);
704 /* Completes on literal "unlimited". Used by integer commands that
705 support a special "unlimited" value. */
708 integer_unlimited_completer (struct cmd_list_element
*ignore
,
709 completion_tracker
&tracker
,
710 const char *text
, const char *word
)
712 static const char * const keywords
[] =
718 complete_on_enum (tracker
, keywords
, text
, word
);
721 /* Add element named NAME to both the set and show command LISTs (the
722 list for set/show or some sublist thereof). CLASS is as in
723 add_cmd. VAR is address of the variable which will contain the
724 value. SET_DOC and SHOW_DOC are the documentation strings. This
725 function is only used in Python API. Please don't use it elsewhere. */
727 add_setshow_integer_cmd (const char *name
, enum command_class theclass
,
729 const char *set_doc
, const char *show_doc
,
730 const char *help_doc
,
731 cmd_const_sfunc_ftype
*set_func
,
732 show_value_ftype
*show_func
,
733 struct cmd_list_element
**set_list
,
734 struct cmd_list_element
**show_list
)
736 struct cmd_list_element
*set
;
738 add_setshow_cmd_full (name
, theclass
, var_integer
, var
,
739 set_doc
, show_doc
, help_doc
,
744 set_cmd_completer (set
, integer_unlimited_completer
);
747 /* Add element named NAME to both the set and show command LISTs (the
748 list for set/show or some sublist thereof). CLASS is as in
749 add_cmd. VAR is address of the variable which will contain the
750 value. SET_DOC and SHOW_DOC are the documentation strings. */
752 add_setshow_uinteger_cmd (const char *name
, enum command_class theclass
,
754 const char *set_doc
, const char *show_doc
,
755 const char *help_doc
,
756 cmd_const_sfunc_ftype
*set_func
,
757 show_value_ftype
*show_func
,
758 struct cmd_list_element
**set_list
,
759 struct cmd_list_element
**show_list
)
761 struct cmd_list_element
*set
;
763 add_setshow_cmd_full (name
, theclass
, var_uinteger
, var
,
764 set_doc
, show_doc
, help_doc
,
769 set_cmd_completer (set
, integer_unlimited_completer
);
772 /* Add element named NAME to both the set and show command LISTs (the
773 list for set/show or some sublist thereof). CLASS is as in
774 add_cmd. VAR is address of the variable which will contain the
775 value. SET_DOC and SHOW_DOC are the documentation strings. */
777 add_setshow_zinteger_cmd (const char *name
, enum command_class theclass
,
779 const char *set_doc
, const char *show_doc
,
780 const char *help_doc
,
781 cmd_const_sfunc_ftype
*set_func
,
782 show_value_ftype
*show_func
,
783 struct cmd_list_element
**set_list
,
784 struct cmd_list_element
**show_list
)
786 add_setshow_cmd_full (name
, theclass
, var_zinteger
, var
,
787 set_doc
, show_doc
, help_doc
,
794 add_setshow_zuinteger_unlimited_cmd (const char *name
,
795 enum command_class theclass
,
798 const char *show_doc
,
799 const char *help_doc
,
800 cmd_const_sfunc_ftype
*set_func
,
801 show_value_ftype
*show_func
,
802 struct cmd_list_element
**set_list
,
803 struct cmd_list_element
**show_list
)
805 struct cmd_list_element
*set
;
807 add_setshow_cmd_full (name
, theclass
, var_zuinteger_unlimited
, var
,
808 set_doc
, show_doc
, help_doc
,
813 set_cmd_completer (set
, integer_unlimited_completer
);
816 /* Add element named NAME to both the set and show command LISTs (the
817 list for set/show or some sublist thereof). CLASS is as in
818 add_cmd. VAR is address of the variable which will contain the
819 value. SET_DOC and SHOW_DOC are the documentation strings. */
821 add_setshow_zuinteger_cmd (const char *name
, enum command_class theclass
,
823 const char *set_doc
, const char *show_doc
,
824 const char *help_doc
,
825 cmd_const_sfunc_ftype
*set_func
,
826 show_value_ftype
*show_func
,
827 struct cmd_list_element
**set_list
,
828 struct cmd_list_element
**show_list
)
830 add_setshow_cmd_full (name
, theclass
, var_zuinteger
, var
,
831 set_doc
, show_doc
, help_doc
,
837 /* Remove the command named NAME from the command list. Return the
838 list commands which were aliased to the deleted command. If the
839 command had no aliases, return NULL. The various *HOOKs are set to
840 the pre- and post-hook commands for the deleted command. If the
841 command does not have a hook, the corresponding out parameter is
844 static struct cmd_list_element
*
845 delete_cmd (const char *name
, struct cmd_list_element
**list
,
846 struct cmd_list_element
**prehook
,
847 struct cmd_list_element
**prehookee
,
848 struct cmd_list_element
**posthook
,
849 struct cmd_list_element
**posthookee
)
851 struct cmd_list_element
*iter
;
852 struct cmd_list_element
**previous_chain_ptr
;
853 struct cmd_list_element
*aliases
= NULL
;
859 previous_chain_ptr
= list
;
861 for (iter
= *previous_chain_ptr
; iter
; iter
= *previous_chain_ptr
)
863 if (strcmp (iter
->name
, name
) == 0)
866 iter
->destroyer (iter
, iter
->context
);
867 if (iter
->hookee_pre
)
868 iter
->hookee_pre
->hook_pre
= 0;
869 *prehook
= iter
->hook_pre
;
870 *prehookee
= iter
->hookee_pre
;
871 if (iter
->hookee_post
)
872 iter
->hookee_post
->hook_post
= 0;
873 *posthook
= iter
->hook_post
;
874 *posthookee
= iter
->hookee_post
;
876 /* Update the link. */
877 *previous_chain_ptr
= iter
->next
;
879 aliases
= iter
->aliases
;
881 /* If this command was an alias, remove it from the list of
883 if (iter
->cmd_pointer
)
885 struct cmd_list_element
**prevp
= &iter
->cmd_pointer
->aliases
;
886 struct cmd_list_element
*a
= *prevp
;
890 prevp
= &a
->alias_chain
;
893 *prevp
= iter
->alias_chain
;
898 /* We won't see another command with the same name. */
902 previous_chain_ptr
= &iter
->next
;
908 /* Shorthands to the commands above. */
910 /* Add an element to the list of info subcommands. */
912 struct cmd_list_element
*
913 add_info (const char *name
, cmd_const_cfunc_ftype
*fun
, const char *doc
)
915 return add_cmd (name
, class_info
, fun
, doc
, &infolist
);
918 /* Add an alias to the list of info subcommands. */
920 struct cmd_list_element
*
921 add_info_alias (const char *name
, const char *oldname
, int abbrev_flag
)
923 return add_alias_cmd (name
, oldname
, class_run
, abbrev_flag
, &infolist
);
926 /* Add an element to the list of commands. */
928 struct cmd_list_element
*
929 add_com (const char *name
, enum command_class theclass
,
930 cmd_const_cfunc_ftype
*fun
,
933 return add_cmd (name
, theclass
, fun
, doc
, &cmdlist
);
936 /* Add an alias or abbreviation command to the list of commands. */
938 struct cmd_list_element
*
939 add_com_alias (const char *name
, const char *oldname
, enum command_class theclass
,
942 return add_alias_cmd (name
, oldname
, theclass
, abbrev_flag
, &cmdlist
);
945 /* Add an element with a suppress notification to the list of commands. */
947 struct cmd_list_element
*
948 add_com_suppress_notification (const char *name
, enum command_class theclass
,
949 cmd_const_cfunc_ftype
*fun
, const char *doc
,
950 int *suppress_notification
)
952 return add_cmd_suppress_notification (name
, theclass
, fun
, doc
,
953 &cmdlist
, suppress_notification
);
956 /* If VERBOSE, print the full help for command C and highlight the
957 documentation parts matching HIGHLIGHT,
958 otherwise print only one-line help for command C. */
961 print_doc_of_command (struct cmd_list_element
*c
, const char *prefix
,
962 bool verbose
, compiled_regex
&highlight
,
963 struct ui_file
*stream
)
965 /* When printing the full documentation, add a line to separate
966 this documentation from the previous command help, in the likely
967 case that apropos finds several commands. */
969 fputs_filtered ("\n", stream
);
971 fprintf_styled (stream
, title_style
.style (),
972 "%s%s", prefix
, c
->name
);
973 fputs_filtered (" -- ", stream
);
975 fputs_highlighted (c
->doc
, highlight
, stream
);
977 print_doc_line (stream
, c
->doc
);
978 fputs_filtered ("\n", stream
);
981 /* Recursively walk the commandlist structures, and print out the
982 documentation of commands that match our regex in either their
983 name, or their documentation.
984 If VERBOSE, prints the complete documentation and highlight the
985 documentation parts matching REGEX, otherwise prints only
989 apropos_cmd (struct ui_file
*stream
,
990 struct cmd_list_element
*commandlist
,
991 bool verbose
, compiled_regex
®ex
, const char *prefix
)
993 struct cmd_list_element
*c
;
996 /* Walk through the commands. */
997 for (c
=commandlist
;c
;c
=c
->next
)
999 returnvalue
= -1; /* Needed to avoid double printing. */
1000 if (c
->name
!= NULL
)
1002 size_t name_len
= strlen (c
->name
);
1004 /* Try to match against the name. */
1005 returnvalue
= regex
.search (c
->name
, name_len
, 0, name_len
, NULL
);
1006 if (returnvalue
>= 0)
1007 print_doc_of_command (c
, prefix
, verbose
, regex
, stream
);
1009 if (c
->doc
!= NULL
&& returnvalue
< 0)
1011 size_t doc_len
= strlen (c
->doc
);
1013 /* Try to match against documentation. */
1014 if (regex
.search (c
->doc
, doc_len
, 0, doc_len
, NULL
) >= 0)
1015 print_doc_of_command (c
, prefix
, verbose
, regex
, stream
);
1017 /* Check if this command has subcommands and is not an
1018 abbreviation. We skip listing subcommands of abbreviations
1019 in order to avoid duplicates in the output. */
1020 if (c
->prefixlist
!= NULL
&& !c
->abbrev_flag
)
1022 /* Recursively call ourselves on the subcommand list,
1023 passing the right prefix in. */
1024 apropos_cmd (stream
, *c
->prefixlist
, verbose
, regex
, c
->prefixname
);
1029 /* This command really has to deal with two things:
1030 1) I want documentation on *this string* (usually called by
1031 "help commandname").
1033 2) I want documentation on *this list* (usually called by giving a
1034 command that requires subcommands. Also called by saying just
1037 I am going to split this into two seperate comamnds, help_cmd and
1041 help_cmd (const char *command
, struct ui_file
*stream
)
1043 struct cmd_list_element
*c
;
1047 help_list (cmdlist
, "", all_classes
, stream
);
1051 if (strcmp (command
, "all") == 0)
1057 c
= lookup_cmd (&command
, cmdlist
, "", 0, 0);
1062 /* There are three cases here.
1063 If c->prefixlist is nonzero, we have a prefix command.
1064 Print its documentation, then list its subcommands.
1066 If c->func is non NULL, we really have a command. Print its
1067 documentation and return.
1069 If c->func is NULL, we have a class name. Print its
1070 documentation (as if it were a command) and then set class to the
1071 number of this class so that the commands in the class will be
1074 fputs_filtered (c
->doc
, stream
);
1075 fputs_filtered ("\n", stream
);
1077 if (c
->prefixlist
== 0 && c
->func
!= NULL
)
1079 fprintf_filtered (stream
, "\n");
1081 /* If this is a prefix command, print it's subcommands. */
1083 help_list (*c
->prefixlist
, c
->prefixname
, all_commands
, stream
);
1085 /* If this is a class name, print all of the commands in the class. */
1086 if (c
->func
== NULL
)
1087 help_list (cmdlist
, "", c
->theclass
, stream
);
1089 if (c
->hook_pre
|| c
->hook_post
)
1090 fprintf_filtered (stream
,
1091 "\nThis command has a hook (or hooks) defined:\n");
1094 fprintf_filtered (stream
,
1095 "\tThis command is run after : %s (pre hook)\n",
1098 fprintf_filtered (stream
,
1099 "\tThis command is run before : %s (post hook)\n",
1100 c
->hook_post
->name
);
1104 * Get a specific kind of help on a command list.
1107 * CMDTYPE is the prefix to use in the title string.
1108 * CLASS is the class with which to list the nodes of this list (see
1109 * documentation for help_cmd_list below), As usual, ALL_COMMANDS for
1110 * everything, ALL_CLASSES for just classes, and non-negative for only things
1111 * in a specific class.
1112 * and STREAM is the output stream on which to print things.
1113 * If you call this routine with a class >= 0, it recurses.
1116 help_list (struct cmd_list_element
*list
, const char *cmdtype
,
1117 enum command_class theclass
, struct ui_file
*stream
)
1120 char *cmdtype1
, *cmdtype2
;
1122 /* If CMDTYPE is "foo ", CMDTYPE1 gets " foo" and CMDTYPE2 gets "foo sub".
1124 len
= strlen (cmdtype
);
1125 cmdtype1
= (char *) alloca (len
+ 1);
1127 cmdtype2
= (char *) alloca (len
+ 4);
1132 memcpy (cmdtype1
+ 1, cmdtype
, len
- 1);
1134 memcpy (cmdtype2
, cmdtype
, len
- 1);
1135 strcpy (cmdtype2
+ len
- 1, " sub");
1138 if (theclass
== all_classes
)
1139 fprintf_filtered (stream
, "List of classes of %scommands:\n\n", cmdtype2
);
1141 fprintf_filtered (stream
, "List of %scommands:\n\n", cmdtype2
);
1143 help_cmd_list (list
, theclass
, cmdtype
, (int) theclass
>= 0, stream
);
1145 if (theclass
== all_classes
)
1147 fprintf_filtered (stream
, "\n\
1148 Type \"help%s\" followed by a class name for a list of commands in ",
1151 fprintf_filtered (stream
, "that class.");
1153 fprintf_filtered (stream
, "\n\
1154 Type \"help all\" for the list of all commands.");
1157 fprintf_filtered (stream
, "\nType \"help%s\" followed by %scommand name ",
1158 cmdtype1
, cmdtype2
);
1160 fputs_filtered ("for ", stream
);
1162 fputs_filtered ("full ", stream
);
1164 fputs_filtered ("documentation.\n", stream
);
1165 fputs_filtered ("Type \"apropos word\" to search "
1166 "for commands related to \"word\".\n", stream
);
1167 fputs_filtered ("Type \"apropos -v word\" for full documentation", stream
);
1169 fputs_filtered (" of commands related to \"word\".\n", stream
);
1170 fputs_filtered ("Command name abbreviations are allowed if unambiguous.\n",
1175 help_all (struct ui_file
*stream
)
1177 struct cmd_list_element
*c
;
1178 int seen_unclassified
= 0;
1180 for (c
= cmdlist
; c
; c
= c
->next
)
1184 /* If this is a class name, print all of the commands in the
1187 if (c
->func
== NULL
)
1189 fprintf_filtered (stream
, "\nCommand class: %s\n\n", c
->name
);
1190 help_cmd_list (cmdlist
, c
->theclass
, "", 1, stream
);
1194 /* While it's expected that all commands are in some class,
1195 as a safety measure, we'll print commands outside of any
1196 class at the end. */
1198 for (c
= cmdlist
; c
; c
= c
->next
)
1203 if (c
->theclass
== no_class
)
1205 if (!seen_unclassified
)
1207 fprintf_filtered (stream
, "\nUnclassified commands\n\n");
1208 seen_unclassified
= 1;
1210 print_help_for_command (c
, "", 1, stream
);
1216 /* Print only the first line of STR on STREAM. */
1218 print_doc_line (struct ui_file
*stream
, const char *str
)
1220 static char *line_buffer
= 0;
1221 static int line_size
;
1227 line_buffer
= (char *) xmalloc (line_size
);
1230 /* Keep printing '.' or ',' not followed by a whitespace for embedded strings
1233 while (*p
&& *p
!= '\n'
1234 && ((*p
!= '.' && *p
!= ',') || (p
[1] && !isspace (p
[1]))))
1236 if (p
- str
> line_size
- 1)
1238 line_size
= p
- str
+ 1;
1239 xfree (line_buffer
);
1240 line_buffer
= (char *) xmalloc (line_size
);
1242 strncpy (line_buffer
, str
, p
- str
);
1243 line_buffer
[p
- str
] = '\0';
1244 if (islower (line_buffer
[0]))
1245 line_buffer
[0] = toupper (line_buffer
[0]);
1246 fputs_filtered (line_buffer
, stream
);
1249 /* Print one-line help for command C.
1250 If RECURSE is non-zero, also print one-line descriptions
1251 of all prefixed subcommands. */
1253 print_help_for_command (struct cmd_list_element
*c
, const char *prefix
,
1254 int recurse
, struct ui_file
*stream
)
1256 fprintf_styled (stream
, title_style
.style (),
1257 "%s%s", prefix
, c
->name
);
1258 fputs_filtered (" -- ", stream
);
1259 print_doc_line (stream
, c
->doc
);
1260 fputs_filtered ("\n", stream
);
1263 && c
->prefixlist
!= 0
1264 && c
->abbrev_flag
== 0)
1265 /* Subcommands of a prefix command typically have 'all_commands'
1266 as class. If we pass CLASS to recursive invocation,
1267 most often we won't see anything. */
1268 help_cmd_list (*c
->prefixlist
, all_commands
, c
->prefixname
, 1, stream
);
1272 * Implement a help command on command list LIST.
1273 * RECURSE should be non-zero if this should be done recursively on
1274 * all sublists of LIST.
1275 * PREFIX is the prefix to print before each command name.
1276 * STREAM is the stream upon which the output should be written.
1277 * THECLASS should be:
1278 * A non-negative class number to list only commands in that
1280 * ALL_COMMANDS to list all commands in list.
1281 * ALL_CLASSES to list all classes in list.
1283 * Note that RECURSE will be active on *all* sublists, not just the
1284 * ones selected by the criteria above (ie. the selection mechanism
1285 * is at the low level, not the high-level).
1288 help_cmd_list (struct cmd_list_element
*list
, enum command_class theclass
,
1289 const char *prefix
, int recurse
, struct ui_file
*stream
)
1291 struct cmd_list_element
*c
;
1293 for (c
= list
; c
; c
= c
->next
)
1295 if (c
->abbrev_flag
== 0
1296 && !c
->cmd_deprecated
1297 && (theclass
== all_commands
1298 || (theclass
== all_classes
&& c
->func
== NULL
)
1299 || (theclass
== c
->theclass
&& c
->func
!= NULL
)))
1301 print_help_for_command (c
, prefix
, recurse
, stream
);
1303 else if (c
->abbrev_flag
== 0
1305 && !c
->cmd_deprecated
1306 && theclass
== class_user
&& c
->prefixlist
!= NULL
)
1307 /* User-defined commands may be subcommands. */
1308 help_cmd_list (*c
->prefixlist
, theclass
, c
->prefixname
,
1314 /* Search the input clist for 'command'. Return the command if
1315 found (or NULL if not), and return the number of commands
1318 static struct cmd_list_element
*
1319 find_cmd (const char *command
, int len
, struct cmd_list_element
*clist
,
1320 int ignore_help_classes
, int *nfound
)
1322 struct cmd_list_element
*found
, *c
;
1326 for (c
= clist
; c
; c
= c
->next
)
1327 if (!strncmp (command
, c
->name
, len
)
1328 && (!ignore_help_classes
|| c
->func
))
1332 if (c
->name
[len
] == '\0')
1341 /* Return the length of command name in TEXT. */
1344 find_command_name_length (const char *text
)
1346 const char *p
= text
;
1348 /* Treating underscores as part of command words is important
1349 so that "set args_foo()" doesn't get interpreted as
1350 "set args _foo()". */
1351 /* Some characters are only used for TUI specific commands.
1352 However, they are always allowed for the sake of consistency.
1354 Note that this is larger than the character set allowed when
1355 creating user-defined commands. */
1357 /* Recognize the single character commands so that, e.g., "!ls"
1358 works as expected. */
1359 if (*p
== '!' || *p
== '|')
1362 while (isalnum (*p
) || *p
== '-' || *p
== '_'
1363 /* Characters used by TUI specific commands. */
1364 || *p
== '+' || *p
== '<' || *p
== '>' || *p
== '$')
1370 /* Return TRUE if NAME is a valid user-defined command name.
1371 This is a stricter subset of all gdb commands,
1372 see find_command_name_length. */
1375 valid_user_defined_cmd_name_p (const char *name
)
1382 /* Alas "42" is a legitimate user-defined command.
1383 In the interests of not breaking anything we preserve that. */
1385 for (p
= name
; *p
!= '\0'; ++p
)
1398 /* This routine takes a line of TEXT and a CLIST in which to start the
1399 lookup. When it returns it will have incremented the text pointer past
1400 the section of text it matched, set *RESULT_LIST to point to the list in
1401 which the last word was matched, and will return a pointer to the cmd
1402 list element which the text matches. It will return NULL if no match at
1403 all was possible. It will return -1 (cast appropriately, ick) if ambigous
1404 matches are possible; in this case *RESULT_LIST will be set to point to
1405 the list in which there are ambiguous choices (and *TEXT will be set to
1406 the ambiguous text string).
1408 If the located command was an abbreviation, this routine returns the base
1409 command of the abbreviation.
1411 It does no error reporting whatsoever; control will always return
1412 to the superior routine.
1414 In the case of an ambiguous return (-1), *RESULT_LIST will be set to point
1415 at the prefix_command (ie. the best match) *or* (special case) will be NULL
1416 if no prefix command was ever found. For example, in the case of "info a",
1417 "info" matches without ambiguity, but "a" could be "args" or "address", so
1418 *RESULT_LIST is set to the cmd_list_element for "info". So in this case
1419 RESULT_LIST should not be interpreted as a pointer to the beginning of a
1420 list; it simply points to a specific command. In the case of an ambiguous
1421 return *TEXT is advanced past the last non-ambiguous prefix (e.g.
1422 "info t" can be "info types" or "info target"; upon return *TEXT has been
1423 advanced past "info ").
1425 If RESULT_LIST is NULL, don't set *RESULT_LIST (but don't otherwise
1426 affect the operation).
1428 This routine does *not* modify the text pointed to by TEXT.
1430 If IGNORE_HELP_CLASSES is nonzero, ignore any command list elements which
1431 are actually help classes rather than commands (i.e. the function field of
1432 the struct cmd_list_element is NULL). */
1434 struct cmd_list_element
*
1435 lookup_cmd_1 (const char **text
, struct cmd_list_element
*clist
,
1436 struct cmd_list_element
**result_list
, int ignore_help_classes
)
1440 struct cmd_list_element
*found
, *c
;
1441 const char *line
= *text
;
1443 while (**text
== ' ' || **text
== '\t')
1446 /* Identify the name of the command. */
1447 len
= find_command_name_length (*text
);
1449 /* If nothing but whitespace, return 0. */
1453 /* *text and p now bracket the first command word to lookup (and
1454 it's length is len). We copy this into a local temporary. */
1457 command
= (char *) alloca (len
+ 1);
1458 memcpy (command
, *text
, len
);
1459 command
[len
] = '\0';
1464 found
= find_cmd (command
, len
, clist
, ignore_help_classes
, &nfound
);
1466 /* If nothing matches, we have a simple failure. */
1472 if (result_list
!= NULL
)
1473 /* Will be modified in calling routine
1474 if we know what the prefix command is. */
1476 return CMD_LIST_AMBIGUOUS
; /* Ambiguous. */
1479 /* We've matched something on this list. Move text pointer forward. */
1483 if (found
->cmd_pointer
)
1485 /* We drop the alias (abbreviation) in favor of the command it
1486 is pointing to. If the alias is deprecated, though, we need to
1487 warn the user about it before we drop it. Note that while we
1488 are warning about the alias, we may also warn about the command
1489 itself and we will adjust the appropriate DEPRECATED_WARN_USER
1492 if (found
->deprecated_warn_user
)
1493 deprecated_cmd_warning (line
);
1494 found
= found
->cmd_pointer
;
1496 /* If we found a prefix command, keep looking. */
1498 if (found
->prefixlist
)
1500 c
= lookup_cmd_1 (text
, *found
->prefixlist
, result_list
,
1501 ignore_help_classes
);
1504 /* Didn't find anything; this is as far as we got. */
1505 if (result_list
!= NULL
)
1506 *result_list
= clist
;
1509 else if (c
== CMD_LIST_AMBIGUOUS
)
1511 /* We've gotten this far properly, but the next step is
1512 ambiguous. We need to set the result list to the best
1513 we've found (if an inferior hasn't already set it). */
1514 if (result_list
!= NULL
)
1516 /* This used to say *result_list = *found->prefixlist.
1517 If that was correct, need to modify the documentation
1518 at the top of this function to clarify what is
1519 supposed to be going on. */
1520 *result_list
= found
;
1531 if (result_list
!= NULL
)
1532 *result_list
= clist
;
1537 /* All this hair to move the space to the front of cmdtype */
1540 undef_cmd_error (const char *cmdtype
, const char *q
)
1542 error (_("Undefined %scommand: \"%s\". Try \"help%s%.*s\"."),
1545 *cmdtype
? " " : "",
1546 (int) strlen (cmdtype
) - 1,
1550 /* Look up the contents of *LINE as a command in the command list LIST.
1551 LIST is a chain of struct cmd_list_element's.
1552 If it is found, return the struct cmd_list_element for that command
1553 and update *LINE to point after the command name, at the first argument.
1554 If not found, call error if ALLOW_UNKNOWN is zero
1555 otherwise (or if error returns) return zero.
1556 Call error if specified command is ambiguous,
1557 unless ALLOW_UNKNOWN is negative.
1558 CMDTYPE precedes the word "command" in the error message.
1560 If INGNORE_HELP_CLASSES is nonzero, ignore any command list
1561 elements which are actually help classes rather than commands (i.e.
1562 the function field of the struct cmd_list_element is 0). */
1564 struct cmd_list_element
*
1565 lookup_cmd (const char **line
, struct cmd_list_element
*list
,
1566 const char *cmdtype
,
1567 int allow_unknown
, int ignore_help_classes
)
1569 struct cmd_list_element
*last_list
= 0;
1570 struct cmd_list_element
*c
;
1572 /* Note: Do not remove trailing whitespace here because this
1573 would be wrong for complete_command. Jim Kingdon */
1576 error (_("Lack of needed %scommand"), cmdtype
);
1578 c
= lookup_cmd_1 (line
, list
, &last_list
, ignore_help_classes
);
1585 int len
= find_command_name_length (*line
);
1587 q
= (char *) alloca (len
+ 1);
1588 strncpy (q
, *line
, len
);
1590 undef_cmd_error (cmdtype
, q
);
1595 else if (c
== CMD_LIST_AMBIGUOUS
)
1597 /* Ambigous. Local values should be off prefixlist or called
1599 int local_allow_unknown
= (last_list
? last_list
->allow_unknown
:
1601 const char *local_cmdtype
= last_list
? last_list
->prefixname
: cmdtype
;
1602 struct cmd_list_element
*local_list
=
1603 (last_list
? *(last_list
->prefixlist
) : list
);
1605 if (local_allow_unknown
< 0)
1608 return last_list
; /* Found something. */
1610 return 0; /* Found nothing. */
1614 /* Report as error. */
1619 ((*line
)[amb_len
] && (*line
)[amb_len
] != ' '
1620 && (*line
)[amb_len
] != '\t');
1625 for (c
= local_list
; c
; c
= c
->next
)
1626 if (!strncmp (*line
, c
->name
, amb_len
))
1628 if (strlen (ambbuf
) + strlen (c
->name
) + 6
1629 < (int) sizeof ambbuf
)
1631 if (strlen (ambbuf
))
1632 strcat (ambbuf
, ", ");
1633 strcat (ambbuf
, c
->name
);
1637 strcat (ambbuf
, "..");
1641 error (_("Ambiguous %scommand \"%s\": %s."), local_cmdtype
,
1647 if (c
->type
== set_cmd
&& **line
!= '\0' && !isspace (**line
))
1648 error (_("Argument must be preceded by space."));
1650 /* We've got something. It may still not be what the caller
1651 wants (if this command *needs* a subcommand). */
1652 while (**line
== ' ' || **line
== '\t')
1655 if (c
->prefixlist
&& **line
&& !c
->allow_unknown
)
1656 undef_cmd_error (c
->prefixname
, *line
);
1658 /* Seems to be what he wants. Return it. */
1664 /* We are here presumably because an alias or command in TEXT is
1665 deprecated and a warning message should be generated. This
1666 function decodes TEXT and potentially generates a warning message
1669 Example for 'set endian big' which has a fictitious alias 'seb'.
1671 If alias wasn't used in TEXT, and the command is deprecated:
1672 "warning: 'set endian big' is deprecated."
1674 If alias was used, and only the alias is deprecated:
1675 "warning: 'seb' an alias for the command 'set endian big' is deprecated."
1677 If alias was used and command is deprecated (regardless of whether
1678 the alias itself is deprecated:
1680 "warning: 'set endian big' (seb) is deprecated."
1682 After the message has been sent, clear the appropriate flags in the
1683 command and/or the alias so the user is no longer bothered.
1687 deprecated_cmd_warning (const char *text
)
1689 struct cmd_list_element
*alias
= NULL
;
1690 struct cmd_list_element
*prefix_cmd
= NULL
;
1691 struct cmd_list_element
*cmd
= NULL
;
1693 if (!lookup_cmd_composition (text
, &alias
, &prefix_cmd
, &cmd
))
1694 /* Return if text doesn't evaluate to a command. */
1697 if (!((alias
? alias
->deprecated_warn_user
: 0)
1698 || cmd
->deprecated_warn_user
) )
1699 /* Return if nothing is deprecated. */
1702 printf_filtered ("Warning:");
1704 if (alias
&& !cmd
->cmd_deprecated
)
1705 printf_filtered (" '%s', an alias for the", alias
->name
);
1707 printf_filtered (" command '");
1710 printf_filtered ("%s", prefix_cmd
->prefixname
);
1712 printf_filtered ("%s", cmd
->name
);
1714 if (alias
&& cmd
->cmd_deprecated
)
1715 printf_filtered ("' (%s) is deprecated.\n", alias
->name
);
1717 printf_filtered ("' is deprecated.\n");
1720 /* If it is only the alias that is deprecated, we want to indicate
1721 the new alias, otherwise we'll indicate the new command. */
1723 if (alias
&& !cmd
->cmd_deprecated
)
1725 if (alias
->replacement
)
1726 printf_filtered ("Use '%s'.\n\n", alias
->replacement
);
1728 printf_filtered ("No alternative known.\n\n");
1732 if (cmd
->replacement
)
1733 printf_filtered ("Use '%s'.\n\n", cmd
->replacement
);
1735 printf_filtered ("No alternative known.\n\n");
1738 /* We've warned you, now we'll keep quiet. */
1740 alias
->deprecated_warn_user
= 0;
1742 cmd
->deprecated_warn_user
= 0;
1746 /* Look up the contents of LINE as a command in the command list 'cmdlist'.
1747 Return 1 on success, 0 on failure.
1749 If LINE refers to an alias, *alias will point to that alias.
1751 If LINE is a postfix command (i.e. one that is preceded by a prefix
1752 command) set *prefix_cmd.
1754 Set *cmd to point to the command LINE indicates.
1756 If any of *alias, *prefix_cmd, or *cmd cannot be determined or do not
1757 exist, they are NULL when we return.
1761 lookup_cmd_composition (const char *text
,
1762 struct cmd_list_element
**alias
,
1763 struct cmd_list_element
**prefix_cmd
,
1764 struct cmd_list_element
**cmd
)
1768 struct cmd_list_element
*cur_list
;
1769 struct cmd_list_element
*prev_cmd
;
1779 /* Go through as many command lists as we need to,
1780 to find the command TEXT refers to. */
1784 while (*text
== ' ' || *text
== '\t')
1787 /* Identify the name of the command. */
1788 len
= find_command_name_length (text
);
1790 /* If nothing but whitespace, return. */
1794 /* Text is the start of the first command word to lookup (and
1795 it's length is len). We copy this into a local temporary. */
1797 command
= (char *) alloca (len
+ 1);
1798 memcpy (command
, text
, len
);
1799 command
[len
] = '\0';
1804 *cmd
= find_cmd (command
, len
, cur_list
, 1, &nfound
);
1806 if (*cmd
== CMD_LIST_AMBIGUOUS
)
1808 return 0; /* ambiguous */
1812 return 0; /* nothing found */
1815 if ((*cmd
)->cmd_pointer
)
1817 /* cmd was actually an alias, we note that an alias was
1818 used (by assigning *alais) and we set *cmd. */
1820 *cmd
= (*cmd
)->cmd_pointer
;
1822 *prefix_cmd
= prev_cmd
;
1824 if ((*cmd
)->prefixlist
)
1825 cur_list
= *(*cmd
)->prefixlist
;
1833 /* Helper function for SYMBOL_COMPLETION_FUNCTION. */
1835 /* Return a vector of char pointers which point to the different
1836 possible completions in LIST of TEXT.
1838 WORD points in the same buffer as TEXT, and completions should be
1839 returned relative to this position. For example, suppose TEXT is
1840 "foo" and we want to complete to "foobar". If WORD is "oo", return
1841 "oobar"; if WORD is "baz/foo", return "baz/foobar". */
1844 complete_on_cmdlist (struct cmd_list_element
*list
,
1845 completion_tracker
&tracker
,
1846 const char *text
, const char *word
,
1847 int ignore_help_classes
)
1849 struct cmd_list_element
*ptr
;
1850 int textlen
= strlen (text
);
1852 int saw_deprecated_match
= 0;
1854 /* We do one or two passes. In the first pass, we skip deprecated
1855 commands. If we see no matching commands in the first pass, and
1856 if we did happen to see a matching deprecated command, we do
1857 another loop to collect those. */
1858 for (pass
= 0; pass
< 2; ++pass
)
1860 bool got_matches
= false;
1862 for (ptr
= list
; ptr
; ptr
= ptr
->next
)
1863 if (!strncmp (ptr
->name
, text
, textlen
)
1864 && !ptr
->abbrev_flag
1865 && (!ignore_help_classes
|| ptr
->func
1866 || ptr
->prefixlist
))
1870 if (ptr
->cmd_deprecated
)
1872 saw_deprecated_match
= 1;
1877 tracker
.add_completion
1878 (make_completion_match_str (ptr
->name
, text
, word
));
1885 /* If we saw no matching deprecated commands in the first pass,
1887 if (!saw_deprecated_match
)
1892 /* Helper function for SYMBOL_COMPLETION_FUNCTION. */
1894 /* Add the different possible completions in ENUMLIST of TEXT.
1896 WORD points in the same buffer as TEXT, and completions should be
1897 returned relative to this position. For example, suppose TEXT is "foo"
1898 and we want to complete to "foobar". If WORD is "oo", return
1899 "oobar"; if WORD is "baz/foo", return "baz/foobar". */
1902 complete_on_enum (completion_tracker
&tracker
,
1903 const char *const *enumlist
,
1904 const char *text
, const char *word
)
1906 int textlen
= strlen (text
);
1910 for (i
= 0; (name
= enumlist
[i
]) != NULL
; i
++)
1911 if (strncmp (name
, text
, textlen
) == 0)
1912 tracker
.add_completion (make_completion_match_str (name
, text
, word
));
1916 /* Check function pointer. */
1918 cmd_func_p (struct cmd_list_element
*cmd
)
1920 return (cmd
->func
!= NULL
);
1924 /* Call the command function. */
1926 cmd_func (struct cmd_list_element
*cmd
, const char *args
, int from_tty
)
1928 if (cmd_func_p (cmd
))
1930 gdb::optional
<scoped_restore_tmpl
<int>> restore_suppress
;
1932 if (cmd
->suppress_notification
!= NULL
)
1933 restore_suppress
.emplace (cmd
->suppress_notification
, 1);
1935 (*cmd
->func
) (cmd
, args
, from_tty
);
1938 error (_("Invalid command"));
1942 cli_user_command_p (struct cmd_list_element
*cmd
)
1944 return (cmd
->theclass
== class_user
1945 && (cmd
->func
== do_const_cfunc
|| cmd
->func
== do_sfunc
));