1 /* Handle lists of commands, their decoding and documentation, for GDB.
3 Copyright (C) 1986-2020 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 "gdbsupport/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_cmd_list (struct cmd_list_element
*list
,
47 enum command_class theclass
,
49 struct ui_file
*stream
);
51 static void help_all (struct ui_file
*stream
);
53 /* Look up a command whose 'prefixlist' is KEY. Return the command if found,
54 otherwise return NULL. */
56 static struct cmd_list_element
*
57 lookup_cmd_for_prefixlist (struct cmd_list_element
**key
,
58 struct cmd_list_element
*list
)
60 struct cmd_list_element
*p
= NULL
;
62 for (p
= list
; p
!= NULL
; p
= p
->next
)
64 struct cmd_list_element
*q
;
66 if (p
->prefixlist
== NULL
)
68 else if (p
->prefixlist
== key
)
70 /* If we found an alias, we must return the aliased
72 return p
->cmd_pointer
? p
->cmd_pointer
: p
;
75 q
= lookup_cmd_for_prefixlist (key
, *(p
->prefixlist
));
84 print_help_for_command (struct cmd_list_element
*c
,
85 bool recurse
, struct ui_file
*stream
);
88 /* Set the callback function for the specified command. For each both
89 the commands callback and func() are set. The latter set to a
90 bounce function (unless cfunc / sfunc is NULL that is). */
93 do_const_cfunc (struct cmd_list_element
*c
, const char *args
, int from_tty
)
95 c
->function
.const_cfunc (args
, from_tty
);
99 set_cmd_cfunc (struct cmd_list_element
*cmd
, cmd_const_cfunc_ftype
*cfunc
)
104 cmd
->func
= do_const_cfunc
;
105 cmd
->function
.const_cfunc
= cfunc
;
109 do_sfunc (struct cmd_list_element
*c
, const char *args
, int from_tty
)
111 c
->function
.sfunc (args
, from_tty
, c
);
115 set_cmd_sfunc (struct cmd_list_element
*cmd
, cmd_const_sfunc_ftype
*sfunc
)
120 cmd
->func
= do_sfunc
;
121 cmd
->function
.sfunc
= sfunc
;
125 cmd_cfunc_eq (struct cmd_list_element
*cmd
, cmd_const_cfunc_ftype
*cfunc
)
127 return cmd
->func
== do_const_cfunc
&& cmd
->function
.const_cfunc
== cfunc
;
131 set_cmd_context (struct cmd_list_element
*cmd
, void *context
)
133 cmd
->context
= context
;
137 get_cmd_context (struct cmd_list_element
*cmd
)
143 cmd_type (struct cmd_list_element
*cmd
)
149 set_cmd_completer (struct cmd_list_element
*cmd
, completer_ftype
*completer
)
151 cmd
->completer
= completer
; /* Ok. */
154 /* See definition in commands.h. */
157 set_cmd_completer_handle_brkchars (struct cmd_list_element
*cmd
,
158 completer_handle_brkchars_ftype
*func
)
160 cmd
->completer_handle_brkchars
= func
;
163 /* Add element named NAME.
164 Space for NAME and DOC must be allocated by the caller.
165 CLASS is the top level category into which commands are broken down
167 FUN should be the function to execute the command;
168 it will get a character string as argument, with leading
169 and trailing blanks already eliminated.
171 DOC is a documentation string for the command.
172 Its first line should be a complete sentence.
173 It should start with ? for a command that is an abbreviation
174 or with * for a command that most users don't need to know about.
176 Add this command to command list *LIST.
178 Returns a pointer to the added command (not necessarily the head
181 static struct cmd_list_element
*
182 do_add_cmd (const char *name
, enum command_class theclass
,
183 const char *doc
, struct cmd_list_element
**list
)
185 struct cmd_list_element
*c
= new struct cmd_list_element (name
, theclass
,
187 struct cmd_list_element
*p
, *iter
;
189 /* Turn each alias of the old command into an alias of the new
191 c
->aliases
= delete_cmd (name
, list
, &c
->hook_pre
, &c
->hookee_pre
,
192 &c
->hook_post
, &c
->hookee_post
);
193 for (iter
= c
->aliases
; iter
; iter
= iter
->alias_chain
)
194 iter
->cmd_pointer
= c
;
196 c
->hook_pre
->hookee_pre
= c
;
198 c
->hookee_pre
->hook_pre
= c
;
200 c
->hook_post
->hookee_post
= c
;
202 c
->hookee_post
->hook_post
= c
;
204 if (*list
== NULL
|| strcmp ((*list
)->name
, name
) >= 0)
212 while (p
->next
&& strcmp (p
->next
->name
, name
) <= 0)
220 /* Search the prefix cmd of C, and assigns it to C->prefix.
221 See also add_prefix_cmd and update_prefix_field_of_prefixed_commands. */
222 struct cmd_list_element
*prefixcmd
= lookup_cmd_for_prefixlist (list
,
224 c
->prefix
= prefixcmd
;
230 struct cmd_list_element
*
231 add_cmd (const char *name
, enum command_class theclass
,
232 const char *doc
, struct cmd_list_element
**list
)
234 cmd_list_element
*result
= do_add_cmd (name
, theclass
, doc
, list
);
236 result
->function
.const_cfunc
= NULL
;
240 struct cmd_list_element
*
241 add_cmd (const char *name
, enum command_class theclass
,
242 cmd_const_cfunc_ftype
*fun
,
243 const char *doc
, struct cmd_list_element
**list
)
245 cmd_list_element
*result
= do_add_cmd (name
, theclass
, doc
, list
);
246 set_cmd_cfunc (result
, fun
);
250 /* Add an element with a suppress notification to the LIST of commands. */
252 struct cmd_list_element
*
253 add_cmd_suppress_notification (const char *name
, enum command_class theclass
,
254 cmd_const_cfunc_ftype
*fun
, const char *doc
,
255 struct cmd_list_element
**list
,
256 int *suppress_notification
)
258 struct cmd_list_element
*element
;
260 element
= add_cmd (name
, theclass
, fun
, doc
, list
);
261 element
->suppress_notification
= suppress_notification
;
267 /* Deprecates a command CMD.
268 REPLACEMENT is the name of the command which should be used in
269 place of this command, or NULL if no such command exists.
271 This function does not check to see if command REPLACEMENT exists
272 since gdb may not have gotten around to adding REPLACEMENT when
273 this function is called.
275 Returns a pointer to the deprecated command. */
277 struct cmd_list_element
*
278 deprecate_cmd (struct cmd_list_element
*cmd
, const char *replacement
)
280 cmd
->cmd_deprecated
= 1;
281 cmd
->deprecated_warn_user
= 1;
283 if (replacement
!= NULL
)
284 cmd
->replacement
= replacement
;
286 cmd
->replacement
= NULL
;
291 struct cmd_list_element
*
292 add_alias_cmd (const char *name
, cmd_list_element
*old
,
293 enum command_class theclass
, int abbrev_flag
,
294 struct cmd_list_element
**list
)
298 struct cmd_list_element
*prehook
, *prehookee
, *posthook
, *posthookee
;
299 struct cmd_list_element
*aliases
= delete_cmd (name
, list
,
300 &prehook
, &prehookee
,
301 &posthook
, &posthookee
);
303 /* If this happens, it means a programmer error somewhere. */
304 gdb_assert (!aliases
&& !prehook
&& !prehookee
305 && !posthook
&& ! posthookee
);
309 struct cmd_list_element
*c
= add_cmd (name
, theclass
, old
->doc
, list
);
311 /* If OLD->DOC can be freed, we should make another copy. */
312 if (old
->doc_allocated
)
314 c
->doc
= xstrdup (old
->doc
);
315 c
->doc_allocated
= 1;
317 /* NOTE: Both FUNC and all the FUNCTIONs need to be copied. */
319 c
->function
= old
->function
;
320 c
->prefixlist
= old
->prefixlist
;
321 c
->prefixname
= old
->prefixname
;
322 c
->allow_unknown
= old
->allow_unknown
;
323 c
->abbrev_flag
= abbrev_flag
;
324 c
->cmd_pointer
= old
;
325 c
->alias_chain
= old
->aliases
;
331 struct cmd_list_element
*
332 add_alias_cmd (const char *name
, const char *oldname
,
333 enum command_class theclass
, int abbrev_flag
,
334 struct cmd_list_element
**list
)
337 struct cmd_list_element
*old
;
340 old
= lookup_cmd (&tmp
, *list
, "", 1, 1);
342 return add_alias_cmd (name
, old
, theclass
, abbrev_flag
, list
);
346 /* Update the prefix field of all sub-commands of the prefix command C.
347 We must do this when a prefix command is defined as the GDB init sequence
348 does not guarantee that a prefix command is created before its sub-commands.
349 For example, break-catch-sig.c initialization runs before breakpoint.c
350 initialization, but it is breakpoint.c that creates the "catch" command used
351 by the "catch signal" command created by break-catch-sig.c. */
354 update_prefix_field_of_prefixed_commands (struct cmd_list_element
*c
)
356 for (cmd_list_element
*p
= *c
->prefixlist
; p
!= NULL
; p
= p
->next
)
360 /* We must recursively update the prefix field to cover
361 e.g. 'info auto-load libthread-db' where the creation
366 In such a case, when 'auto-load' was created by do_add_cmd,
367 the 'libthread-db' prefix field could not be updated, as the
368 'auto-load' command was not yet reachable by
369 lookup_cmd_for_prefixlist (list, cmdlist)
370 that searches from the top level 'cmdlist'. */
371 if (p
->prefixlist
!= nullptr)
372 update_prefix_field_of_prefixed_commands (p
);
377 /* Like add_cmd but adds an element for a command prefix: a name that
378 should be followed by a subcommand to be looked up in another
379 command list. PREFIXLIST should be the address of the variable
380 containing that list. */
382 struct cmd_list_element
*
383 add_prefix_cmd (const char *name
, enum command_class theclass
,
384 cmd_const_cfunc_ftype
*fun
,
385 const char *doc
, struct cmd_list_element
**prefixlist
,
386 const char *prefixname
, int allow_unknown
,
387 struct cmd_list_element
**list
)
389 struct cmd_list_element
*c
= add_cmd (name
, theclass
, fun
, doc
, list
);
391 c
->prefixlist
= prefixlist
;
392 c
->prefixname
= prefixname
;
393 c
->allow_unknown
= allow_unknown
;
395 /* Now that prefix command C is defined, we need to set the prefix field
396 of all prefixed commands that were defined before C itself was defined. */
397 update_prefix_field_of_prefixed_commands (c
);
402 /* A helper function for add_basic_prefix_cmd. This is a command
403 function that just forwards to help_list. */
406 do_prefix_cmd (const char *args
, int from_tty
, struct cmd_list_element
*c
)
408 /* Look past all aliases. */
409 while (c
->cmd_pointer
!= nullptr)
412 help_list (*c
->prefixlist
, c
->prefixname
, all_commands
, gdb_stdout
);
417 struct cmd_list_element
*
418 add_basic_prefix_cmd (const char *name
, enum command_class theclass
,
419 const char *doc
, struct cmd_list_element
**prefixlist
,
420 const char *prefixname
, int allow_unknown
,
421 struct cmd_list_element
**list
)
423 struct cmd_list_element
*cmd
= add_prefix_cmd (name
, theclass
, nullptr,
424 doc
, prefixlist
, prefixname
,
425 allow_unknown
, list
);
426 set_cmd_sfunc (cmd
, do_prefix_cmd
);
430 /* A helper function for add_show_prefix_cmd. This is a command
431 function that just forwards to cmd_show_list. */
434 do_show_prefix_cmd (const char *args
, int from_tty
, struct cmd_list_element
*c
)
436 cmd_show_list (*c
->prefixlist
, from_tty
);
441 struct cmd_list_element
*
442 add_show_prefix_cmd (const char *name
, enum command_class theclass
,
443 const char *doc
, struct cmd_list_element
**prefixlist
,
444 const char *prefixname
, int allow_unknown
,
445 struct cmd_list_element
**list
)
447 struct cmd_list_element
*cmd
= add_prefix_cmd (name
, theclass
, nullptr,
448 doc
, prefixlist
, prefixname
,
449 allow_unknown
, list
);
450 set_cmd_sfunc (cmd
, do_show_prefix_cmd
);
454 /* Like ADD_PREFIX_CMD but sets the suppress_notification pointer on the
455 new command list element. */
457 struct cmd_list_element
*
458 add_prefix_cmd_suppress_notification
459 (const char *name
, enum command_class theclass
,
460 cmd_const_cfunc_ftype
*fun
,
461 const char *doc
, struct cmd_list_element
**prefixlist
,
462 const char *prefixname
, int allow_unknown
,
463 struct cmd_list_element
**list
,
464 int *suppress_notification
)
466 struct cmd_list_element
*element
467 = add_prefix_cmd (name
, theclass
, fun
, doc
, prefixlist
,
468 prefixname
, allow_unknown
, list
);
469 element
->suppress_notification
= suppress_notification
;
473 /* Like add_prefix_cmd but sets the abbrev_flag on the new command. */
475 struct cmd_list_element
*
476 add_abbrev_prefix_cmd (const char *name
, enum command_class theclass
,
477 cmd_const_cfunc_ftype
*fun
, const char *doc
,
478 struct cmd_list_element
**prefixlist
,
479 const char *prefixname
,
480 int allow_unknown
, struct cmd_list_element
**list
)
482 struct cmd_list_element
*c
= add_cmd (name
, theclass
, fun
, doc
, list
);
484 c
->prefixlist
= prefixlist
;
485 c
->prefixname
= prefixname
;
486 c
->allow_unknown
= allow_unknown
;
491 /* This is an empty "cfunc". */
493 not_just_help_class_command (const char *args
, int from_tty
)
497 /* This is an empty "sfunc". */
500 empty_sfunc (const char *args
, int from_tty
, struct cmd_list_element
*c
)
504 /* Add element named NAME to command list LIST (the list for set/show
505 or some sublist thereof).
506 TYPE is set_cmd or show_cmd.
507 CLASS is as in add_cmd.
508 VAR_TYPE is the kind of thing we are setting.
509 VAR is address of the variable being controlled by this command.
510 DOC is the documentation string. */
512 static struct cmd_list_element
*
513 add_set_or_show_cmd (const char *name
,
515 enum command_class theclass
,
519 struct cmd_list_element
**list
)
521 struct cmd_list_element
*c
= add_cmd (name
, theclass
, doc
, list
);
523 gdb_assert (type
== set_cmd
|| type
== show_cmd
);
525 c
->var_type
= var_type
;
527 /* This needs to be something besides NULL so that this isn't
528 treated as a help class. */
529 set_cmd_sfunc (c
, empty_sfunc
);
533 /* Add element named NAME to both the command SET_LIST and SHOW_LIST.
534 CLASS is as in add_cmd. VAR_TYPE is the kind of thing we are
535 setting. VAR is address of the variable being controlled by this
536 command. SET_FUNC and SHOW_FUNC are the callback functions (if
537 non-NULL). SET_DOC, SHOW_DOC and HELP_DOC are the documentation
538 strings. PRINT the format string to print the value. SET_RESULT
539 and SHOW_RESULT, if not NULL, are set to the resulting command
543 add_setshow_cmd_full (const char *name
,
544 enum command_class theclass
,
545 var_types var_type
, void *var
,
546 const char *set_doc
, const char *show_doc
,
547 const char *help_doc
,
548 cmd_const_sfunc_ftype
*set_func
,
549 show_value_ftype
*show_func
,
550 struct cmd_list_element
**set_list
,
551 struct cmd_list_element
**show_list
,
552 struct cmd_list_element
**set_result
,
553 struct cmd_list_element
**show_result
)
555 struct cmd_list_element
*set
;
556 struct cmd_list_element
*show
;
560 if (help_doc
!= NULL
)
562 full_set_doc
= xstrprintf ("%s\n%s", set_doc
, help_doc
);
563 full_show_doc
= xstrprintf ("%s\n%s", show_doc
, help_doc
);
567 full_set_doc
= xstrdup (set_doc
);
568 full_show_doc
= xstrdup (show_doc
);
570 set
= add_set_or_show_cmd (name
, set_cmd
, theclass
, var_type
, var
,
571 full_set_doc
, set_list
);
572 set
->doc_allocated
= 1;
574 if (set_func
!= NULL
)
575 set_cmd_sfunc (set
, set_func
);
577 show
= add_set_or_show_cmd (name
, show_cmd
, theclass
, var_type
, var
,
578 full_show_doc
, show_list
);
579 show
->doc_allocated
= 1;
580 show
->show_value_func
= show_func
;
581 /* Disable the default symbol completer. Doesn't make much sense
582 for the "show" command to complete on anything. */
583 set_cmd_completer (show
, nullptr);
585 if (set_result
!= NULL
)
587 if (show_result
!= NULL
)
591 /* Add element named NAME to command list LIST (the list for set or
592 some sublist thereof). CLASS is as in add_cmd. ENUMLIST is a list
593 of strings which may follow NAME. VAR is address of the variable
594 which will contain the matching string (from ENUMLIST). */
597 add_setshow_enum_cmd (const char *name
,
598 enum command_class theclass
,
599 const char *const *enumlist
,
602 const char *show_doc
,
603 const char *help_doc
,
604 cmd_const_sfunc_ftype
*set_func
,
605 show_value_ftype
*show_func
,
606 struct cmd_list_element
**set_list
,
607 struct cmd_list_element
**show_list
,
610 struct cmd_list_element
*c
, *show
;
612 add_setshow_cmd_full (name
, theclass
, var_enum
, var
,
613 set_doc
, show_doc
, help_doc
,
619 set_cmd_context (c
, context
);
620 set_cmd_context (show
, context
);
623 /* See cli-decode.h. */
624 const char * const auto_boolean_enums
[] = { "on", "off", "auto", NULL
};
626 /* Add an auto-boolean command named NAME to both the set and show
627 command list lists. CLASS is as in add_cmd. VAR is address of the
628 variable which will contain the value. DOC is the documentation
629 string. FUNC is the corresponding callback. */
631 add_setshow_auto_boolean_cmd (const char *name
,
632 enum command_class theclass
,
633 enum auto_boolean
*var
,
634 const char *set_doc
, const char *show_doc
,
635 const char *help_doc
,
636 cmd_const_sfunc_ftype
*set_func
,
637 show_value_ftype
*show_func
,
638 struct cmd_list_element
**set_list
,
639 struct cmd_list_element
**show_list
)
641 struct cmd_list_element
*c
;
643 add_setshow_cmd_full (name
, theclass
, var_auto_boolean
, var
,
644 set_doc
, show_doc
, help_doc
,
648 c
->enums
= auto_boolean_enums
;
651 /* See cli-decode.h. */
652 const char * const boolean_enums
[] = { "on", "off", NULL
};
654 /* Add element named NAME to both the set and show command LISTs (the
655 list for set/show or some sublist thereof). CLASS is as in
656 add_cmd. VAR is address of the variable which will contain the
657 value. SET_DOC and SHOW_DOC are the documentation strings.
658 Returns the new command element. */
661 add_setshow_boolean_cmd (const char *name
, enum command_class theclass
, bool *var
,
662 const char *set_doc
, const char *show_doc
,
663 const char *help_doc
,
664 cmd_const_sfunc_ftype
*set_func
,
665 show_value_ftype
*show_func
,
666 struct cmd_list_element
**set_list
,
667 struct cmd_list_element
**show_list
)
669 struct cmd_list_element
*c
;
671 add_setshow_cmd_full (name
, theclass
, var_boolean
, var
,
672 set_doc
, show_doc
, help_doc
,
676 c
->enums
= boolean_enums
;
681 /* Add element named NAME to both the set and show command LISTs (the
682 list for set/show or some sublist thereof). */
684 add_setshow_filename_cmd (const char *name
, enum command_class theclass
,
686 const char *set_doc
, const char *show_doc
,
687 const char *help_doc
,
688 cmd_const_sfunc_ftype
*set_func
,
689 show_value_ftype
*show_func
,
690 struct cmd_list_element
**set_list
,
691 struct cmd_list_element
**show_list
)
693 struct cmd_list_element
*set_result
;
695 add_setshow_cmd_full (name
, theclass
, var_filename
, var
,
696 set_doc
, show_doc
, help_doc
,
700 set_cmd_completer (set_result
, filename_completer
);
703 /* Add element named NAME to both the set and show command LISTs (the
704 list for set/show or some sublist thereof). */
706 add_setshow_string_cmd (const char *name
, enum command_class theclass
,
708 const char *set_doc
, const char *show_doc
,
709 const char *help_doc
,
710 cmd_const_sfunc_ftype
*set_func
,
711 show_value_ftype
*show_func
,
712 struct cmd_list_element
**set_list
,
713 struct cmd_list_element
**show_list
)
715 cmd_list_element
*set_cmd
;
717 add_setshow_cmd_full (name
, theclass
, var_string
, var
,
718 set_doc
, show_doc
, help_doc
,
723 /* Disable the default symbol completer. */
724 set_cmd_completer (set_cmd
, nullptr);
727 /* Add element named NAME to both the set and show command LISTs (the
728 list for set/show or some sublist thereof). */
729 struct cmd_list_element
*
730 add_setshow_string_noescape_cmd (const char *name
, enum command_class theclass
,
732 const char *set_doc
, const char *show_doc
,
733 const char *help_doc
,
734 cmd_const_sfunc_ftype
*set_func
,
735 show_value_ftype
*show_func
,
736 struct cmd_list_element
**set_list
,
737 struct cmd_list_element
**show_list
)
739 struct cmd_list_element
*set_cmd
;
741 add_setshow_cmd_full (name
, theclass
, var_string_noescape
, var
,
742 set_doc
, show_doc
, help_doc
,
747 /* Disable the default symbol completer. */
748 set_cmd_completer (set_cmd
, nullptr);
753 /* Add element named NAME to both the set and show command LISTs (the
754 list for set/show or some sublist thereof). */
756 add_setshow_optional_filename_cmd (const char *name
, enum command_class theclass
,
758 const char *set_doc
, const char *show_doc
,
759 const char *help_doc
,
760 cmd_const_sfunc_ftype
*set_func
,
761 show_value_ftype
*show_func
,
762 struct cmd_list_element
**set_list
,
763 struct cmd_list_element
**show_list
)
765 struct cmd_list_element
*set_result
;
767 add_setshow_cmd_full (name
, theclass
, var_optional_filename
, var
,
768 set_doc
, show_doc
, help_doc
,
773 set_cmd_completer (set_result
, filename_completer
);
777 /* Completes on literal "unlimited". Used by integer commands that
778 support a special "unlimited" value. */
781 integer_unlimited_completer (struct cmd_list_element
*ignore
,
782 completion_tracker
&tracker
,
783 const char *text
, const char *word
)
785 static const char * const keywords
[] =
791 complete_on_enum (tracker
, keywords
, text
, word
);
794 /* Add element named NAME to both the set and show command LISTs (the
795 list for set/show or some sublist thereof). CLASS is as in
796 add_cmd. VAR is address of the variable which will contain the
797 value. SET_DOC and SHOW_DOC are the documentation strings. This
798 function is only used in Python API. Please don't use it elsewhere. */
800 add_setshow_integer_cmd (const char *name
, enum command_class theclass
,
802 const char *set_doc
, const char *show_doc
,
803 const char *help_doc
,
804 cmd_const_sfunc_ftype
*set_func
,
805 show_value_ftype
*show_func
,
806 struct cmd_list_element
**set_list
,
807 struct cmd_list_element
**show_list
)
809 struct cmd_list_element
*set
;
811 add_setshow_cmd_full (name
, theclass
, var_integer
, var
,
812 set_doc
, show_doc
, help_doc
,
817 set_cmd_completer (set
, integer_unlimited_completer
);
820 /* Add element named NAME to both the set and show command LISTs (the
821 list for set/show or some sublist thereof). CLASS is as in
822 add_cmd. VAR is address of the variable which will contain the
823 value. SET_DOC and SHOW_DOC are the documentation strings. */
825 add_setshow_uinteger_cmd (const char *name
, enum command_class theclass
,
827 const char *set_doc
, const char *show_doc
,
828 const char *help_doc
,
829 cmd_const_sfunc_ftype
*set_func
,
830 show_value_ftype
*show_func
,
831 struct cmd_list_element
**set_list
,
832 struct cmd_list_element
**show_list
)
834 struct cmd_list_element
*set
;
836 add_setshow_cmd_full (name
, theclass
, var_uinteger
, var
,
837 set_doc
, show_doc
, help_doc
,
842 set_cmd_completer (set
, integer_unlimited_completer
);
845 /* Add element named NAME to both the set and show command LISTs (the
846 list for set/show or some sublist thereof). CLASS is as in
847 add_cmd. VAR is address of the variable which will contain the
848 value. SET_DOC and SHOW_DOC are the documentation strings. */
850 add_setshow_zinteger_cmd (const char *name
, enum command_class theclass
,
852 const char *set_doc
, const char *show_doc
,
853 const char *help_doc
,
854 cmd_const_sfunc_ftype
*set_func
,
855 show_value_ftype
*show_func
,
856 struct cmd_list_element
**set_list
,
857 struct cmd_list_element
**show_list
)
859 add_setshow_cmd_full (name
, theclass
, var_zinteger
, var
,
860 set_doc
, show_doc
, help_doc
,
867 add_setshow_zuinteger_unlimited_cmd (const char *name
,
868 enum command_class theclass
,
871 const char *show_doc
,
872 const char *help_doc
,
873 cmd_const_sfunc_ftype
*set_func
,
874 show_value_ftype
*show_func
,
875 struct cmd_list_element
**set_list
,
876 struct cmd_list_element
**show_list
)
878 struct cmd_list_element
*set
;
880 add_setshow_cmd_full (name
, theclass
, var_zuinteger_unlimited
, var
,
881 set_doc
, show_doc
, help_doc
,
886 set_cmd_completer (set
, integer_unlimited_completer
);
889 /* Add element named NAME to both the set and show command LISTs (the
890 list for set/show or some sublist thereof). CLASS is as in
891 add_cmd. VAR is address of the variable which will contain the
892 value. SET_DOC and SHOW_DOC are the documentation strings. */
894 add_setshow_zuinteger_cmd (const char *name
, enum command_class theclass
,
896 const char *set_doc
, const char *show_doc
,
897 const char *help_doc
,
898 cmd_const_sfunc_ftype
*set_func
,
899 show_value_ftype
*show_func
,
900 struct cmd_list_element
**set_list
,
901 struct cmd_list_element
**show_list
)
903 add_setshow_cmd_full (name
, theclass
, var_zuinteger
, var
,
904 set_doc
, show_doc
, help_doc
,
910 /* Remove the command named NAME from the command list. Return the
911 list commands which were aliased to the deleted command. If the
912 command had no aliases, return NULL. The various *HOOKs are set to
913 the pre- and post-hook commands for the deleted command. If the
914 command does not have a hook, the corresponding out parameter is
917 static struct cmd_list_element
*
918 delete_cmd (const char *name
, struct cmd_list_element
**list
,
919 struct cmd_list_element
**prehook
,
920 struct cmd_list_element
**prehookee
,
921 struct cmd_list_element
**posthook
,
922 struct cmd_list_element
**posthookee
)
924 struct cmd_list_element
*iter
;
925 struct cmd_list_element
**previous_chain_ptr
;
926 struct cmd_list_element
*aliases
= NULL
;
932 previous_chain_ptr
= list
;
934 for (iter
= *previous_chain_ptr
; iter
; iter
= *previous_chain_ptr
)
936 if (strcmp (iter
->name
, name
) == 0)
939 iter
->destroyer (iter
, iter
->context
);
940 if (iter
->hookee_pre
)
941 iter
->hookee_pre
->hook_pre
= 0;
942 *prehook
= iter
->hook_pre
;
943 *prehookee
= iter
->hookee_pre
;
944 if (iter
->hookee_post
)
945 iter
->hookee_post
->hook_post
= 0;
946 *posthook
= iter
->hook_post
;
947 *posthookee
= iter
->hookee_post
;
949 /* Update the link. */
950 *previous_chain_ptr
= iter
->next
;
952 aliases
= iter
->aliases
;
954 /* If this command was an alias, remove it from the list of
956 if (iter
->cmd_pointer
)
958 struct cmd_list_element
**prevp
= &iter
->cmd_pointer
->aliases
;
959 struct cmd_list_element
*a
= *prevp
;
963 prevp
= &a
->alias_chain
;
966 *prevp
= iter
->alias_chain
;
971 /* We won't see another command with the same name. */
975 previous_chain_ptr
= &iter
->next
;
981 /* Shorthands to the commands above. */
983 /* Add an element to the list of info subcommands. */
985 struct cmd_list_element
*
986 add_info (const char *name
, cmd_const_cfunc_ftype
*fun
, const char *doc
)
988 return add_cmd (name
, class_info
, fun
, doc
, &infolist
);
991 /* Add an alias to the list of info subcommands. */
993 struct cmd_list_element
*
994 add_info_alias (const char *name
, const char *oldname
, int abbrev_flag
)
996 return add_alias_cmd (name
, oldname
, class_run
, abbrev_flag
, &infolist
);
999 /* Add an element to the list of commands. */
1001 struct cmd_list_element
*
1002 add_com (const char *name
, enum command_class theclass
,
1003 cmd_const_cfunc_ftype
*fun
,
1006 return add_cmd (name
, theclass
, fun
, doc
, &cmdlist
);
1009 /* Add an alias or abbreviation command to the list of commands.
1010 For aliases predefined by GDB (such as bt), THECLASS must be
1011 different of class_alias, as class_alias is used to identify
1012 user defined aliases. */
1014 struct cmd_list_element
*
1015 add_com_alias (const char *name
, const char *oldname
, enum command_class theclass
,
1018 return add_alias_cmd (name
, oldname
, theclass
, abbrev_flag
, &cmdlist
);
1021 /* Add an element with a suppress notification to the list of commands. */
1023 struct cmd_list_element
*
1024 add_com_suppress_notification (const char *name
, enum command_class theclass
,
1025 cmd_const_cfunc_ftype
*fun
, const char *doc
,
1026 int *suppress_notification
)
1028 return add_cmd_suppress_notification (name
, theclass
, fun
, doc
,
1029 &cmdlist
, suppress_notification
);
1032 /* Print the prefix of C followed by name of C in title style. */
1035 fput_command_name_styled (struct cmd_list_element
*c
, struct ui_file
*stream
)
1037 const char *prefixname
1038 = c
->prefix
== nullptr ? "" : c
->prefix
->prefixname
;
1040 fprintf_styled (stream
, title_style
.style (), "%s%s", prefixname
, c
->name
);
1043 /* If C has one or more aliases, style print the name of C and
1044 the name of its aliases, separated by commas.
1045 If ALWAYS_FPUT_C_NAME, print the name of C even if it has no aliases.
1046 If one or more names are printed, POSTFIX is printed after the last name.
1050 fput_command_names_styled (struct cmd_list_element
*c
,
1051 bool always_fput_c_name
, const char *postfix
,
1052 struct ui_file
*stream
)
1054 if (always_fput_c_name
|| c
->aliases
!= nullptr)
1055 fput_command_name_styled (c
, stream
);
1056 if (c
->aliases
!= nullptr)
1058 for (cmd_list_element
*iter
= c
->aliases
; iter
; iter
= iter
->alias_chain
)
1060 fputs_filtered (", ", stream
);
1062 fput_command_name_styled (iter
, stream
);
1065 if (always_fput_c_name
|| c
->aliases
!= nullptr)
1066 fputs_filtered (postfix
, stream
);
1069 /* If VERBOSE, print the full help for command C and highlight the
1070 documentation parts matching HIGHLIGHT,
1071 otherwise print only one-line help for command C. */
1074 print_doc_of_command (struct cmd_list_element
*c
, const char *prefix
,
1075 bool verbose
, compiled_regex
&highlight
,
1076 struct ui_file
*stream
)
1078 /* When printing the full documentation, add a line to separate
1079 this documentation from the previous command help, in the likely
1080 case that apropos finds several commands. */
1082 fputs_filtered ("\n", stream
);
1084 fput_command_names_styled (c
, true, " -- ", stream
);
1086 fputs_highlighted (c
->doc
, highlight
, stream
);
1088 print_doc_line (stream
, c
->doc
, false);
1089 fputs_filtered ("\n", stream
);
1092 /* Recursively walk the commandlist structures, and print out the
1093 documentation of commands that match our regex in either their
1094 name, or their documentation.
1095 If VERBOSE, prints the complete documentation and highlight the
1096 documentation parts matching REGEX, otherwise prints only
1100 apropos_cmd (struct ui_file
*stream
,
1101 struct cmd_list_element
*commandlist
,
1102 bool verbose
, compiled_regex
®ex
, const char *prefix
)
1104 struct cmd_list_element
*c
;
1107 /* Walk through the commands. */
1108 for (c
=commandlist
;c
;c
=c
->next
)
1110 if (c
->cmd_pointer
!= nullptr)
1112 /* Command aliases/abbreviations are skipped to ensure we print the
1113 doc of a command only once, when encountering the aliased
1118 returnvalue
= -1; /* Needed to avoid double printing. */
1119 if (c
->name
!= NULL
)
1121 size_t name_len
= strlen (c
->name
);
1123 /* Try to match against the name. */
1124 returnvalue
= regex
.search (c
->name
, name_len
, 0, name_len
, NULL
);
1125 if (returnvalue
>= 0)
1126 print_doc_of_command (c
, prefix
, verbose
, regex
, stream
);
1128 /* Try to match against the name of the aliases. */
1129 for (cmd_list_element
*iter
= c
->aliases
;
1130 returnvalue
< 0 && iter
;
1131 iter
= iter
->alias_chain
)
1133 name_len
= strlen (iter
->name
);
1134 returnvalue
= regex
.search (iter
->name
, name_len
, 0, name_len
, NULL
);
1135 if (returnvalue
>= 0)
1136 print_doc_of_command (c
, prefix
, verbose
, regex
, stream
);
1139 if (c
->doc
!= NULL
&& returnvalue
< 0)
1141 size_t doc_len
= strlen (c
->doc
);
1143 /* Try to match against documentation. */
1144 if (regex
.search (c
->doc
, doc_len
, 0, doc_len
, NULL
) >= 0)
1145 print_doc_of_command (c
, prefix
, verbose
, regex
, stream
);
1147 /* Check if this command has subcommands. */
1148 if (c
->prefixlist
!= NULL
)
1150 /* Recursively call ourselves on the subcommand list,
1151 passing the right prefix in. */
1152 apropos_cmd (stream
, *c
->prefixlist
, verbose
, regex
, c
->prefixname
);
1157 /* This command really has to deal with two things:
1158 1) I want documentation on *this string* (usually called by
1159 "help commandname").
1161 2) I want documentation on *this list* (usually called by giving a
1162 command that requires subcommands. Also called by saying just
1165 I am going to split this into two separate commands, help_cmd and
1169 help_cmd (const char *command
, struct ui_file
*stream
)
1171 struct cmd_list_element
*c
, *alias
, *prefix_cmd
, *c_cmd
;
1175 help_list (cmdlist
, "", all_classes
, stream
);
1179 if (strcmp (command
, "all") == 0)
1185 const char *orig_command
= command
;
1186 c
= lookup_cmd (&command
, cmdlist
, "", 0, 0);
1191 lookup_cmd_composition (orig_command
, &alias
, &prefix_cmd
, &c_cmd
);
1193 /* There are three cases here.
1194 If c->prefixlist is nonzero, we have a prefix command.
1195 Print its documentation, then list its subcommands.
1197 If c->func is non NULL, we really have a command. Print its
1198 documentation and return.
1200 If c->func is NULL, we have a class name. Print its
1201 documentation (as if it were a command) and then set class to the
1202 number of this class so that the commands in the class will be
1205 /* If the user asked 'help somecommand' and there is no alias,
1206 the false indicates to not output the (single) command name. */
1207 fput_command_names_styled (c
, false, "\n", stream
);
1208 fputs_filtered (c
->doc
, stream
);
1209 fputs_filtered ("\n", stream
);
1211 if (c
->prefixlist
== 0 && c
->func
!= NULL
)
1213 fprintf_filtered (stream
, "\n");
1215 /* If this is a prefix command, print it's subcommands. */
1217 help_list (*c
->prefixlist
, c
->prefixname
, all_commands
, stream
);
1219 /* If this is a class name, print all of the commands in the class. */
1220 if (c
->func
== NULL
)
1221 help_list (cmdlist
, "", c
->theclass
, stream
);
1223 if (c
->hook_pre
|| c
->hook_post
)
1224 fprintf_filtered (stream
,
1225 "\nThis command has a hook (or hooks) defined:\n");
1228 fprintf_filtered (stream
,
1229 "\tThis command is run after : %s (pre hook)\n",
1232 fprintf_filtered (stream
,
1233 "\tThis command is run before : %s (post hook)\n",
1234 c
->hook_post
->name
);
1238 * Get a specific kind of help on a command list.
1241 * CMDTYPE is the prefix to use in the title string.
1242 * CLASS is the class with which to list the nodes of this list (see
1243 * documentation for help_cmd_list below), As usual, ALL_COMMANDS for
1244 * everything, ALL_CLASSES for just classes, and non-negative for only things
1245 * in a specific class.
1246 * and STREAM is the output stream on which to print things.
1247 * If you call this routine with a class >= 0, it recurses.
1250 help_list (struct cmd_list_element
*list
, const char *cmdtype
,
1251 enum command_class theclass
, struct ui_file
*stream
)
1254 char *cmdtype1
, *cmdtype2
;
1256 /* If CMDTYPE is "foo ", CMDTYPE1 gets " foo" and CMDTYPE2 gets "foo sub".
1258 len
= strlen (cmdtype
);
1259 cmdtype1
= (char *) alloca (len
+ 1);
1261 cmdtype2
= (char *) alloca (len
+ 4);
1266 memcpy (cmdtype1
+ 1, cmdtype
, len
- 1);
1268 memcpy (cmdtype2
, cmdtype
, len
- 1);
1269 strcpy (cmdtype2
+ len
- 1, " sub");
1272 if (theclass
== all_classes
)
1273 fprintf_filtered (stream
, "List of classes of %scommands:\n\n", cmdtype2
);
1275 fprintf_filtered (stream
, "List of %scommands:\n\n", cmdtype2
);
1277 help_cmd_list (list
, theclass
, theclass
>= 0, stream
);
1279 if (theclass
== all_classes
)
1281 fprintf_filtered (stream
, "\n\
1282 Type \"help%s\" followed by a class name for a list of commands in ",
1285 fprintf_filtered (stream
, "that class.");
1287 fprintf_filtered (stream
, "\n\
1288 Type \"help all\" for the list of all commands.");
1291 fprintf_filtered (stream
, "\nType \"help%s\" followed by %scommand name ",
1292 cmdtype1
, cmdtype2
);
1294 fputs_filtered ("for ", stream
);
1296 fputs_filtered ("full ", stream
);
1298 fputs_filtered ("documentation.\n", stream
);
1299 fputs_filtered ("Type \"apropos word\" to search "
1300 "for commands related to \"word\".\n", stream
);
1301 fputs_filtered ("Type \"apropos -v word\" for full documentation", stream
);
1303 fputs_filtered (" of commands related to \"word\".\n", stream
);
1304 fputs_filtered ("Command name abbreviations are allowed if unambiguous.\n",
1309 help_all (struct ui_file
*stream
)
1311 struct cmd_list_element
*c
;
1312 int seen_unclassified
= 0;
1314 for (c
= cmdlist
; c
; c
= c
->next
)
1318 /* If this is a class name, print all of the commands in the
1321 if (c
->func
== NULL
)
1323 fprintf_filtered (stream
, "\nCommand class: %s\n\n", c
->name
);
1324 help_cmd_list (cmdlist
, c
->theclass
, true, stream
);
1328 /* While it's expected that all commands are in some class,
1329 as a safety measure, we'll print commands outside of any
1330 class at the end. */
1332 for (c
= cmdlist
; c
; c
= c
->next
)
1337 if (c
->theclass
== no_class
)
1339 if (!seen_unclassified
)
1341 fprintf_filtered (stream
, "\nUnclassified commands\n\n");
1342 seen_unclassified
= 1;
1344 print_help_for_command (c
, 1, stream
);
1350 /* See cli-decode.h. */
1353 print_doc_line (struct ui_file
*stream
, const char *str
,
1354 bool for_value_prefix
)
1356 static char *line_buffer
= 0;
1357 static int line_size
;
1363 line_buffer
= (char *) xmalloc (line_size
);
1366 /* Searches for the first end of line or the end of STR. */
1368 while (*p
&& *p
!= '\n')
1370 if (p
- str
> line_size
- 1)
1372 line_size
= p
- str
+ 1;
1373 xfree (line_buffer
);
1374 line_buffer
= (char *) xmalloc (line_size
);
1376 strncpy (line_buffer
, str
, p
- str
);
1377 if (for_value_prefix
)
1379 if (islower (line_buffer
[0]))
1380 line_buffer
[0] = toupper (line_buffer
[0]);
1381 gdb_assert (p
> str
);
1382 if (line_buffer
[p
- str
- 1] == '.')
1383 line_buffer
[p
- str
- 1] = '\0';
1385 line_buffer
[p
- str
] = '\0';
1388 line_buffer
[p
- str
] = '\0';
1389 fputs_filtered (line_buffer
, stream
);
1392 /* Print one-line help for command C.
1393 If RECURSE is non-zero, also print one-line descriptions
1394 of all prefixed subcommands. */
1396 print_help_for_command (struct cmd_list_element
*c
,
1397 bool recurse
, struct ui_file
*stream
)
1399 fput_command_names_styled (c
, true, " -- ", stream
);
1400 print_doc_line (stream
, c
->doc
, false);
1401 fputs_filtered ("\n", stream
);
1404 && c
->prefixlist
!= 0
1405 && c
->abbrev_flag
== 0)
1406 /* Subcommands of a prefix command typically have 'all_commands'
1407 as class. If we pass CLASS to recursive invocation,
1408 most often we won't see anything. */
1409 help_cmd_list (*c
->prefixlist
, all_commands
, true, stream
);
1413 * Implement a help command on command list LIST.
1414 * RECURSE should be non-zero if this should be done recursively on
1415 * all sublists of LIST.
1416 * STREAM is the stream upon which the output should be written.
1417 * THECLASS should be:
1418 * A non-negative class number to list only commands in that
1419 * ALL_COMMANDS to list all commands in list.
1420 * ALL_CLASSES to list all classes in list.
1422 * Note that aliases are only shown when THECLASS is class_alias.
1423 * In the other cases, the aliases will be shown together with their
1426 * Note that RECURSE will be active on *all* sublists, not just the
1427 * ones selected by the criteria above (ie. the selection mechanism
1428 * is at the low level, not the high-level).
1432 help_cmd_list (struct cmd_list_element
*list
, enum command_class theclass
,
1433 bool recurse
, struct ui_file
*stream
)
1435 struct cmd_list_element
*c
;
1437 for (c
= list
; c
; c
= c
->next
)
1439 if (c
->abbrev_flag
== 1 || c
->cmd_deprecated
)
1441 /* Do not show abbreviations or deprecated commands. */
1445 if (c
->cmd_pointer
!= nullptr && theclass
!= class_alias
)
1447 /* Do not show an alias, unless specifically showing the
1448 list of aliases: for all other classes, an alias is
1449 shown (if needed) together with its aliased command. */
1453 if (theclass
== all_commands
1454 || (theclass
== all_classes
&& c
->func
== NULL
)
1455 || (theclass
== c
->theclass
&& c
->func
!= NULL
))
1458 - showing all commands
1459 - showing all classes and C is a help class
1460 - showing commands of THECLASS and C is not the help class */
1462 /* If we show the class_alias and C is an alias, do not recurse,
1463 as this would show the (possibly very long) not very useful
1464 list of sub-commands of the aliased command. */
1465 print_help_for_command
1467 recurse
&& (theclass
!= class_alias
|| c
->cmd_pointer
== nullptr),
1473 && (theclass
== class_user
|| theclass
== class_alias
)
1474 && c
->prefixlist
!= NULL
)
1476 /* User-defined commands or aliases may be subcommands. */
1477 help_cmd_list (*c
->prefixlist
, theclass
, recurse
, stream
);
1481 /* Do not show C or recurse on C, e.g. because C does not belong to
1482 THECLASS or because C is a help class. */
1487 /* Search the input clist for 'command'. Return the command if
1488 found (or NULL if not), and return the number of commands
1491 static struct cmd_list_element
*
1492 find_cmd (const char *command
, int len
, struct cmd_list_element
*clist
,
1493 int ignore_help_classes
, int *nfound
)
1495 struct cmd_list_element
*found
, *c
;
1499 for (c
= clist
; c
; c
= c
->next
)
1500 if (!strncmp (command
, c
->name
, len
)
1501 && (!ignore_help_classes
|| c
->func
))
1505 if (c
->name
[len
] == '\0')
1514 /* Return the length of command name in TEXT. */
1517 find_command_name_length (const char *text
)
1519 const char *p
= text
;
1521 /* Treating underscores as part of command words is important
1522 so that "set args_foo()" doesn't get interpreted as
1523 "set args _foo()". */
1524 /* Some characters are only used for TUI specific commands.
1525 However, they are always allowed for the sake of consistency.
1527 Note that this is larger than the character set allowed when
1528 creating user-defined commands. */
1530 /* Recognize the single character commands so that, e.g., "!ls"
1531 works as expected. */
1532 if (*p
== '!' || *p
== '|')
1535 while (valid_cmd_char_p (*p
)
1536 /* Characters used by TUI specific commands. */
1537 || *p
== '+' || *p
== '<' || *p
== '>' || *p
== '$')
1543 /* See command.h. */
1546 valid_cmd_char_p (int c
)
1548 /* Alas "42" is a legitimate user-defined command.
1549 In the interests of not breaking anything we preserve that. */
1551 return isalnum (c
) || c
== '-' || c
== '_' || c
== '.';
1554 /* See command.h. */
1557 valid_user_defined_cmd_name_p (const char *name
)
1564 for (p
= name
; *p
!= '\0'; ++p
)
1566 if (valid_cmd_char_p (*p
))
1575 /* This routine takes a line of TEXT and a CLIST in which to start the
1576 lookup. When it returns it will have incremented the text pointer past
1577 the section of text it matched, set *RESULT_LIST to point to the list in
1578 which the last word was matched, and will return a pointer to the cmd
1579 list element which the text matches. It will return NULL if no match at
1580 all was possible. It will return -1 (cast appropriately, ick) if ambigous
1581 matches are possible; in this case *RESULT_LIST will be set to point to
1582 the list in which there are ambiguous choices (and *TEXT will be set to
1583 the ambiguous text string).
1585 If the located command was an abbreviation, this routine returns the base
1586 command of the abbreviation.
1588 It does no error reporting whatsoever; control will always return
1589 to the superior routine.
1591 In the case of an ambiguous return (-1), *RESULT_LIST will be set to point
1592 at the prefix_command (ie. the best match) *or* (special case) will be NULL
1593 if no prefix command was ever found. For example, in the case of "info a",
1594 "info" matches without ambiguity, but "a" could be "args" or "address", so
1595 *RESULT_LIST is set to the cmd_list_element for "info". So in this case
1596 RESULT_LIST should not be interpreted as a pointer to the beginning of a
1597 list; it simply points to a specific command. In the case of an ambiguous
1598 return *TEXT is advanced past the last non-ambiguous prefix (e.g.
1599 "info t" can be "info types" or "info target"; upon return *TEXT has been
1600 advanced past "info ").
1602 If RESULT_LIST is NULL, don't set *RESULT_LIST (but don't otherwise
1603 affect the operation).
1605 This routine does *not* modify the text pointed to by TEXT.
1607 If IGNORE_HELP_CLASSES is nonzero, ignore any command list elements which
1608 are actually help classes rather than commands (i.e. the function field of
1609 the struct cmd_list_element is NULL). */
1611 struct cmd_list_element
*
1612 lookup_cmd_1 (const char **text
, struct cmd_list_element
*clist
,
1613 struct cmd_list_element
**result_list
, int ignore_help_classes
)
1617 struct cmd_list_element
*found
, *c
;
1618 const char *line
= *text
;
1620 while (**text
== ' ' || **text
== '\t')
1623 /* Identify the name of the command. */
1624 len
= find_command_name_length (*text
);
1626 /* If nothing but whitespace, return 0. */
1630 /* *text and p now bracket the first command word to lookup (and
1631 it's length is len). We copy this into a local temporary. */
1634 command
= (char *) alloca (len
+ 1);
1635 memcpy (command
, *text
, len
);
1636 command
[len
] = '\0';
1641 found
= find_cmd (command
, len
, clist
, ignore_help_classes
, &nfound
);
1643 /* If nothing matches, we have a simple failure. */
1649 if (result_list
!= NULL
)
1650 /* Will be modified in calling routine
1651 if we know what the prefix command is. */
1653 return CMD_LIST_AMBIGUOUS
; /* Ambiguous. */
1656 /* We've matched something on this list. Move text pointer forward. */
1660 if (found
->cmd_pointer
)
1662 /* We drop the alias (abbreviation) in favor of the command it
1663 is pointing to. If the alias is deprecated, though, we need to
1664 warn the user about it before we drop it. Note that while we
1665 are warning about the alias, we may also warn about the command
1666 itself and we will adjust the appropriate DEPRECATED_WARN_USER
1669 if (found
->deprecated_warn_user
)
1670 deprecated_cmd_warning (line
);
1671 found
= found
->cmd_pointer
;
1673 /* If we found a prefix command, keep looking. */
1675 if (found
->prefixlist
)
1677 c
= lookup_cmd_1 (text
, *found
->prefixlist
, result_list
,
1678 ignore_help_classes
);
1681 /* Didn't find anything; this is as far as we got. */
1682 if (result_list
!= NULL
)
1683 *result_list
= clist
;
1686 else if (c
== CMD_LIST_AMBIGUOUS
)
1688 /* We've gotten this far properly, but the next step is
1689 ambiguous. We need to set the result list to the best
1690 we've found (if an inferior hasn't already set it). */
1691 if (result_list
!= NULL
)
1693 /* This used to say *result_list = *found->prefixlist.
1694 If that was correct, need to modify the documentation
1695 at the top of this function to clarify what is
1696 supposed to be going on. */
1697 *result_list
= found
;
1708 if (result_list
!= NULL
)
1709 *result_list
= clist
;
1714 /* All this hair to move the space to the front of cmdtype */
1717 undef_cmd_error (const char *cmdtype
, const char *q
)
1719 error (_("Undefined %scommand: \"%s\". Try \"help%s%.*s\"."),
1722 *cmdtype
? " " : "",
1723 (int) strlen (cmdtype
) - 1,
1727 /* Look up the contents of *LINE as a command in the command list LIST.
1728 LIST is a chain of struct cmd_list_element's.
1729 If it is found, return the struct cmd_list_element for that command
1730 and update *LINE to point after the command name, at the first argument.
1731 If not found, call error if ALLOW_UNKNOWN is zero
1732 otherwise (or if error returns) return zero.
1733 Call error if specified command is ambiguous,
1734 unless ALLOW_UNKNOWN is negative.
1735 CMDTYPE precedes the word "command" in the error message.
1737 If IGNORE_HELP_CLASSES is nonzero, ignore any command list
1738 elements which are actually help classes rather than commands (i.e.
1739 the function field of the struct cmd_list_element is 0). */
1741 struct cmd_list_element
*
1742 lookup_cmd (const char **line
, struct cmd_list_element
*list
,
1743 const char *cmdtype
,
1744 int allow_unknown
, int ignore_help_classes
)
1746 struct cmd_list_element
*last_list
= 0;
1747 struct cmd_list_element
*c
;
1749 /* Note: Do not remove trailing whitespace here because this
1750 would be wrong for complete_command. Jim Kingdon */
1753 error (_("Lack of needed %scommand"), cmdtype
);
1755 c
= lookup_cmd_1 (line
, list
, &last_list
, ignore_help_classes
);
1762 int len
= find_command_name_length (*line
);
1764 q
= (char *) alloca (len
+ 1);
1765 strncpy (q
, *line
, len
);
1767 undef_cmd_error (cmdtype
, q
);
1772 else if (c
== CMD_LIST_AMBIGUOUS
)
1774 /* Ambigous. Local values should be off prefixlist or called
1776 int local_allow_unknown
= (last_list
? last_list
->allow_unknown
:
1778 const char *local_cmdtype
= last_list
? last_list
->prefixname
: cmdtype
;
1779 struct cmd_list_element
*local_list
=
1780 (last_list
? *(last_list
->prefixlist
) : list
);
1782 if (local_allow_unknown
< 0)
1785 return last_list
; /* Found something. */
1787 return 0; /* Found nothing. */
1791 /* Report as error. */
1796 ((*line
)[amb_len
] && (*line
)[amb_len
] != ' '
1797 && (*line
)[amb_len
] != '\t');
1802 for (c
= local_list
; c
; c
= c
->next
)
1803 if (!strncmp (*line
, c
->name
, amb_len
))
1805 if (strlen (ambbuf
) + strlen (c
->name
) + 6
1806 < (int) sizeof ambbuf
)
1808 if (strlen (ambbuf
))
1809 strcat (ambbuf
, ", ");
1810 strcat (ambbuf
, c
->name
);
1814 strcat (ambbuf
, "..");
1818 error (_("Ambiguous %scommand \"%s\": %s."), local_cmdtype
,
1824 if (c
->type
== set_cmd
&& **line
!= '\0' && !isspace (**line
))
1825 error (_("Argument must be preceded by space."));
1827 /* We've got something. It may still not be what the caller
1828 wants (if this command *needs* a subcommand). */
1829 while (**line
== ' ' || **line
== '\t')
1832 if (c
->prefixlist
&& **line
&& !c
->allow_unknown
)
1833 undef_cmd_error (c
->prefixname
, *line
);
1835 /* Seems to be what he wants. Return it. */
1841 /* We are here presumably because an alias or command in TEXT is
1842 deprecated and a warning message should be generated. This
1843 function decodes TEXT and potentially generates a warning message
1846 Example for 'set endian big' which has a fictitious alias 'seb'.
1848 If alias wasn't used in TEXT, and the command is deprecated:
1849 "warning: 'set endian big' is deprecated."
1851 If alias was used, and only the alias is deprecated:
1852 "warning: 'seb' an alias for the command 'set endian big' is deprecated."
1854 If alias was used and command is deprecated (regardless of whether
1855 the alias itself is deprecated:
1857 "warning: 'set endian big' (seb) is deprecated."
1859 After the message has been sent, clear the appropriate flags in the
1860 command and/or the alias so the user is no longer bothered.
1864 deprecated_cmd_warning (const char *text
)
1866 struct cmd_list_element
*alias
= NULL
;
1867 struct cmd_list_element
*prefix_cmd
= NULL
;
1868 struct cmd_list_element
*cmd
= NULL
;
1870 if (!lookup_cmd_composition (text
, &alias
, &prefix_cmd
, &cmd
))
1871 /* Return if text doesn't evaluate to a command. */
1874 if (!((alias
? alias
->deprecated_warn_user
: 0)
1875 || cmd
->deprecated_warn_user
) )
1876 /* Return if nothing is deprecated. */
1879 printf_filtered ("Warning:");
1881 if (alias
&& !cmd
->cmd_deprecated
)
1882 printf_filtered (" '%s', an alias for the", alias
->name
);
1884 printf_filtered (" command '");
1887 printf_filtered ("%s", prefix_cmd
->prefixname
);
1889 printf_filtered ("%s", cmd
->name
);
1891 if (alias
&& cmd
->cmd_deprecated
)
1892 printf_filtered ("' (%s) is deprecated.\n", alias
->name
);
1894 printf_filtered ("' is deprecated.\n");
1897 /* If it is only the alias that is deprecated, we want to indicate
1898 the new alias, otherwise we'll indicate the new command. */
1900 if (alias
&& !cmd
->cmd_deprecated
)
1902 if (alias
->replacement
)
1903 printf_filtered ("Use '%s'.\n\n", alias
->replacement
);
1905 printf_filtered ("No alternative known.\n\n");
1909 if (cmd
->replacement
)
1910 printf_filtered ("Use '%s'.\n\n", cmd
->replacement
);
1912 printf_filtered ("No alternative known.\n\n");
1915 /* We've warned you, now we'll keep quiet. */
1917 alias
->deprecated_warn_user
= 0;
1919 cmd
->deprecated_warn_user
= 0;
1923 /* Look up the contents of TEXT as a command in the command list 'cmdlist'.
1924 Return 1 on success, 0 on failure.
1926 If TEXT refers to an alias, *ALIAS will point to that alias.
1928 If TEXT is a subcommand (i.e. one that is preceded by a prefix
1929 command) set *PREFIX_CMD.
1931 Set *CMD to point to the command TEXT indicates.
1933 If any of *ALIAS, *PREFIX_CMD, or *CMD cannot be determined or do not
1934 exist, they are NULL when we return.
1938 lookup_cmd_composition (const char *text
,
1939 struct cmd_list_element
**alias
,
1940 struct cmd_list_element
**prefix_cmd
,
1941 struct cmd_list_element
**cmd
)
1945 struct cmd_list_element
*cur_list
;
1946 struct cmd_list_element
*prev_cmd
;
1954 text
= skip_spaces (text
);
1958 /* Go through as many command lists as we need to,
1959 to find the command TEXT refers to. */
1963 /* Identify the name of the command. */
1964 len
= find_command_name_length (text
);
1966 /* If nothing but whitespace, return. */
1970 /* TEXT is the start of the first command word to lookup (and
1971 it's length is LEN). We copy this into a local temporary. */
1973 command
= (char *) alloca (len
+ 1);
1974 memcpy (command
, text
, len
);
1975 command
[len
] = '\0';
1980 *cmd
= find_cmd (command
, len
, cur_list
, 1, &nfound
);
1982 if (*cmd
== CMD_LIST_AMBIGUOUS
)
1984 return 0; /* ambiguous */
1988 return 0; /* nothing found */
1991 if ((*cmd
)->cmd_pointer
)
1993 /* cmd was actually an alias, we note that an alias was
1994 used (by assigning *ALIAS) and we set *CMD. */
1996 *cmd
= (*cmd
)->cmd_pointer
;
1998 *prefix_cmd
= prev_cmd
;
2002 text
= skip_spaces (text
);
2004 if ((*cmd
)->prefixlist
&& *text
!= '\0')
2005 cur_list
= *(*cmd
)->prefixlist
;
2011 /* Helper function for SYMBOL_COMPLETION_FUNCTION. */
2013 /* Return a vector of char pointers which point to the different
2014 possible completions in LIST of TEXT.
2016 WORD points in the same buffer as TEXT, and completions should be
2017 returned relative to this position. For example, suppose TEXT is
2018 "foo" and we want to complete to "foobar". If WORD is "oo", return
2019 "oobar"; if WORD is "baz/foo", return "baz/foobar". */
2022 complete_on_cmdlist (struct cmd_list_element
*list
,
2023 completion_tracker
&tracker
,
2024 const char *text
, const char *word
,
2025 int ignore_help_classes
)
2027 struct cmd_list_element
*ptr
;
2028 int textlen
= strlen (text
);
2030 int saw_deprecated_match
= 0;
2032 /* We do one or two passes. In the first pass, we skip deprecated
2033 commands. If we see no matching commands in the first pass, and
2034 if we did happen to see a matching deprecated command, we do
2035 another loop to collect those. */
2036 for (pass
= 0; pass
< 2; ++pass
)
2038 bool got_matches
= false;
2040 for (ptr
= list
; ptr
; ptr
= ptr
->next
)
2041 if (!strncmp (ptr
->name
, text
, textlen
)
2042 && !ptr
->abbrev_flag
2043 && (!ignore_help_classes
|| ptr
->func
2044 || ptr
->prefixlist
))
2048 if (ptr
->cmd_deprecated
)
2050 saw_deprecated_match
= 1;
2055 tracker
.add_completion
2056 (make_completion_match_str (ptr
->name
, text
, word
));
2063 /* If we saw no matching deprecated commands in the first pass,
2065 if (!saw_deprecated_match
)
2070 /* Helper function for SYMBOL_COMPLETION_FUNCTION. */
2072 /* Add the different possible completions in ENUMLIST of TEXT.
2074 WORD points in the same buffer as TEXT, and completions should be
2075 returned relative to this position. For example, suppose TEXT is "foo"
2076 and we want to complete to "foobar". If WORD is "oo", return
2077 "oobar"; if WORD is "baz/foo", return "baz/foobar". */
2080 complete_on_enum (completion_tracker
&tracker
,
2081 const char *const *enumlist
,
2082 const char *text
, const char *word
)
2084 int textlen
= strlen (text
);
2088 for (i
= 0; (name
= enumlist
[i
]) != NULL
; i
++)
2089 if (strncmp (name
, text
, textlen
) == 0)
2090 tracker
.add_completion (make_completion_match_str (name
, text
, word
));
2094 /* Check function pointer. */
2096 cmd_func_p (struct cmd_list_element
*cmd
)
2098 return (cmd
->func
!= NULL
);
2102 /* Call the command function. */
2104 cmd_func (struct cmd_list_element
*cmd
, const char *args
, int from_tty
)
2106 if (cmd_func_p (cmd
))
2108 gdb::optional
<scoped_restore_tmpl
<int>> restore_suppress
;
2110 if (cmd
->suppress_notification
!= NULL
)
2111 restore_suppress
.emplace (cmd
->suppress_notification
, 1);
2113 (*cmd
->func
) (cmd
, args
, from_tty
);
2116 error (_("Invalid command"));
2120 cli_user_command_p (struct cmd_list_element
*cmd
)
2122 return (cmd
->theclass
== class_user
2123 && (cmd
->func
== do_const_cfunc
|| cmd
->func
== do_sfunc
));