1 /* Header file for command creation.
3 Copyright (C) 1986-2021 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/>. */
18 #if !defined (COMMAND_H)
21 #include "gdbsupport/gdb_vecs.h"
22 #include "gdbsupport/scoped_restore.h"
24 struct completion_tracker
;
26 /* This file defines the public interface for any code wanting to
29 /* Command classes are top-level categories into which commands are
30 broken down for "help" purposes.
32 The class_alias is used for the user-defined aliases, defined
33 using the "alias" command.
35 Aliases pre-defined by GDB (e.g. the alias "bt" of the "backtrace" command)
36 are not using the class_alias.
37 Different pre-defined aliases of the same command do not necessarily
38 have the same classes. For example, class_stack is used for the
39 "backtrace" and its "bt" alias", while "info stack" (also an alias
40 of "backtrace" uses class_info. */
44 /* Classes of commands followed by a comment giving the name
45 to use in "help <classname>".
46 Note that help accepts unambiguous abbreviated class names. */
48 /* Special classes to help_list */
49 class_deprecated
= -3,
50 all_classes
= -2, /* help without <classname> */
51 all_commands
= -1, /* all */
53 /* Classes of commands */
55 class_run
= 0, /* running */
56 class_vars
, /* data */
57 class_stack
, /* stack */
58 class_files
, /* files */
59 class_support
, /* support */
60 class_info
, /* status */
61 class_breakpoint
, /* breakpoints */
62 class_trace
, /* tracepoints */
63 class_alias
, /* aliases */
65 class_obscure
, /* obscure */
66 class_maintenance
, /* internals */
67 class_tui
, /* text-user-interface */
68 class_user
, /* user-defined */
70 /* Used for "show" commands that have no corresponding "set" command. */
74 /* Types of "set" or "show" command. */
75 typedef enum var_types
77 /* "on" or "off". *VAR is a bool which is true for on,
81 /* "on" / "true" / "enable" or "off" / "false" / "disable" or
82 "auto. *VAR is an ``enum auto_boolean''. NOTE: In general a
83 custom show command will need to be implemented - one that for
84 "auto" prints both the "auto" and the current auto-selected
88 /* Unsigned Integer. *VAR is an unsigned int. The user can type
89 0 to mean "unlimited", which is stored in *VAR as UINT_MAX. */
92 /* Like var_uinteger but signed. *VAR is an int. The user can
93 type 0 to mean "unlimited", which is stored in *VAR as
94 INT_MAX. The only remaining use of it is the Python API.
95 Don't use it elsewhere. */
98 /* String which the user enters with escapes (e.g. the user types
99 \n and it is a real newline in the stored string).
100 *VAR is a std::string, "" if the string is empty. */
102 /* String which stores what the user types verbatim.
103 *VAR is std::string, "" if the string is empty. */
105 /* String which stores a filename. (*VAR) is a std::string,
106 "" if the string was empty. */
107 var_optional_filename
,
108 /* String which stores a filename. (*VAR) is a std::string. */
110 /* ZeroableInteger. *VAR is an int. Like var_integer except
111 that zero really means zero. */
113 /* ZeroableUnsignedInteger. *VAR is an unsigned int. Zero really
116 /* ZeroableUnsignedInteger with unlimited value. *VAR is an int,
117 but its range is [0, INT_MAX]. -1 stands for unlimited and
118 other negative numbers are not allowed. */
119 var_zuinteger_unlimited
,
120 /* Enumerated type. Can only have one of the specified values.
121 *VAR is a char pointer to the name of the element that we
127 /* Return true if a setting of type VAR_TYPE is backed with type T.
129 This function is left without definition intentionally. This template is
130 specialized for all valid types that are used to back var_types. Therefore
131 if one tries to instantiate this un-specialized template it means the T
132 parameter is not a type used to back a var_type and it is most likely a
133 programming error. */
135 bool var_type_uses (var_types var_type
) = delete;
137 /* Return true if a setting of type T is backed by a bool variable. */
139 inline bool var_type_uses
<bool> (var_types t
)
141 return t
== var_boolean
;
144 /* Return true if a setting of type T is backed by a auto_boolean variable.
147 inline bool var_type_uses
<enum auto_boolean
> (var_types t
)
149 return t
== var_auto_boolean
;
152 /* Return true if a setting of type T is backed by an unsigned int variable.
155 inline bool var_type_uses
<unsigned int> (var_types t
)
157 return (t
== var_uinteger
|| t
== var_zinteger
|| t
== var_zuinteger
);
160 /* Return true if a setting of type T is backed by an int variable. */
162 inline bool var_type_uses
<int> (var_types t
)
164 return (t
== var_integer
|| t
== var_zinteger
165 || t
== var_zuinteger_unlimited
);
168 /* Return true if a setting of type T is backed by a std::string variable. */
170 inline bool var_type_uses
<std::string
> (var_types t
)
172 return (t
== var_string
|| t
== var_string_noescape
173 || t
== var_optional_filename
|| t
== var_filename
);
176 /* Return true if a setting of type T is backed by a const char * variable.
179 inline bool var_type_uses
<const char *> (var_types t
)
181 return t
== var_enum
;
184 /* Function signature for a callback used to get a value from a setting. */
187 using setting_getter_ftype
= const T
&(*) ();
189 /* Function signature for a callback used to set a value to a setting. */
192 using setting_setter_ftype
= void (*) (const T
&);
194 /* Generic/type-erased function pointer. */
196 using erased_func
= void (*) ();
198 /* Interface for getting and setting a setting's value.
200 The underlying data can be of any VAR_TYPES type. */
203 /* Create a setting backed by a variable of type T.
205 Type T must match the var type VAR_TYPE (see VAR_TYPE_USES). */
207 setting (var_types var_type
, T
*var
)
208 : m_var_type (var_type
), m_var (var
)
210 gdb_assert (var
!= nullptr);
211 gdb_assert (var_type_uses
<T
> (var_type
));
214 /* A setting can also be constructed with a pre-validated
215 type-erased variable. Use the following function to
216 validate & type-erase said variable/function pointers. */
226 static erased_args
erase_args (var_types var_type
,
228 setting_setter_ftype
<T
> set_setting_func
,
229 setting_getter_ftype
<T
> get_setting_func
)
231 gdb_assert (var_type_uses
<T
> (var_type
));
232 /* The getter and the setter must be both provided or both omitted. */
234 ((set_setting_func
== nullptr) == (get_setting_func
== nullptr));
236 /* The caller must provide a pointer to a variable or get/set functions, but
238 gdb_assert ((set_setting_func
== nullptr) != (var
== nullptr));
242 reinterpret_cast<erased_func
> (set_setting_func
),
243 reinterpret_cast<erased_func
> (get_setting_func
)
247 /* Create a setting backed by pre-validated type-erased args.
248 ERASED_VAR's fields' real types must match the var type VAR_TYPE
249 (see VAR_TYPE_USES). */
250 setting (var_types var_type
, const erased_args
&args
)
251 : m_var_type (var_type
),
253 m_getter (args
.getter
),
254 m_setter (args
.setter
)
258 /* Create a setting backed by setter and getter functions.
260 Type T must match the var type VAR_TYPE (see VAR_TYPE_USES). */
262 setting (var_types var_type
,
263 setting_setter_ftype
<T
> setter
,
264 setting_getter_ftype
<T
> getter
)
265 : m_var_type (var_type
)
267 gdb_assert (var_type_uses
<T
> (var_type
));
269 /* Getters and setters are cast to and from the arbitrary `void (*) ()`
270 function pointer type. Make sure that the two types are really of the
272 gdb_static_assert (sizeof (m_getter
) == sizeof (getter
));
273 gdb_static_assert (sizeof (m_setter
) == sizeof (setter
));
275 m_getter
= reinterpret_cast<erased_func
> (getter
);
276 m_setter
= reinterpret_cast<erased_func
> (setter
);
279 /* Access the type of the current setting. */
280 var_types
type () const
281 { return m_var_type
; }
283 /* Return the current value.
285 The template parameter T is the type of the variable used to store the
288 const T
&get () const
290 gdb_assert (var_type_uses
<T
> (m_var_type
));
292 if (m_var
== nullptr)
294 gdb_assert (m_getter
!= nullptr);
295 auto getter
= reinterpret_cast<setting_getter_ftype
<T
>> (m_getter
);
299 return *static_cast<const T
*> (m_var
);
302 /* Sets the value of the setting to V. Returns true if the setting was
303 effectively changed, false if the update failed and the setting is left
306 If we have a user-provided setter, use it to set the setting. Otherwise
307 copy the value V to the internally referenced buffer.
309 The template parameter T indicates the type of the variable used to store
312 The var_type of the setting must match T. */
314 bool set (const T
&v
)
316 /* Check that the current instance is of one of the supported types for
317 this instantiation. */
318 gdb_assert (var_type_uses
<T
> (m_var_type
));
320 const T old_value
= this->get
<T
> ();
322 if (m_var
== nullptr)
324 gdb_assert (m_setter
!= nullptr);
325 auto setter
= reinterpret_cast<setting_setter_ftype
<T
>> (m_setter
);
329 *static_cast<T
*> (m_var
) = v
;
331 return old_value
!= this->get
<T
> ();
335 /* The type of the variable M_VAR is pointing to, or that M_GETTER / M_SETTER
337 var_types m_var_type
;
339 /* Pointer to the enclosed variable
341 Either M_VAR is non-nullptr, or both M_GETTER and M_SETTER are
343 void *m_var
= nullptr;
345 /* Pointer to a user provided getter. */
346 erased_func m_getter
= nullptr;
348 /* Pointer to a user provided setter. */
349 erased_func m_setter
= nullptr;
352 /* This structure records one command'd definition. */
353 struct cmd_list_element
;
355 /* The "simple" signature of command callbacks, which doesn't include a
356 cmd_list_element parameter. */
358 typedef void cmd_simple_func_ftype (const char *args
, int from_tty
);
360 /* This structure specifies notifications to be suppressed by a cli
361 command interpreter. */
363 struct cli_suppress_notification
365 /* Inferior, thread, frame selected notification suppressed? */
366 int user_selected_context
;
369 extern struct cli_suppress_notification cli_suppress_notification
;
371 /* Forward-declarations of the entry-points of cli/cli-decode.c. */
373 /* API to the manipulation of command lists. */
375 /* Return TRUE if NAME is a valid user-defined command name.
376 This is a stricter subset of all gdb commands,
377 see find_command_name_length. */
379 extern bool valid_user_defined_cmd_name_p (const char *name
);
381 /* Return TRUE if C is a valid command character. */
383 extern bool valid_cmd_char_p (int c
);
385 /* Const-correct variant of the above. */
387 extern struct cmd_list_element
*add_cmd (const char *, enum command_class
,
388 cmd_simple_func_ftype
*fun
,
390 struct cmd_list_element
**);
392 /* Like add_cmd, but no command function is specified. */
394 extern struct cmd_list_element
*add_cmd (const char *, enum command_class
,
396 struct cmd_list_element
**);
398 extern struct cmd_list_element
*add_cmd_suppress_notification
399 (const char *name
, enum command_class theclass
,
400 cmd_simple_func_ftype
*fun
, const char *doc
,
401 struct cmd_list_element
**list
,
402 int *suppress_notification
);
404 extern struct cmd_list_element
*add_alias_cmd (const char *,
406 enum command_class
, int,
407 struct cmd_list_element
**);
410 extern struct cmd_list_element
*add_prefix_cmd (const char *, enum command_class
,
411 cmd_simple_func_ftype
*fun
,
413 struct cmd_list_element
**,
415 struct cmd_list_element
**);
417 /* Like add_prefix_cmd, but sets the callback to a function that
418 simply calls help_list. */
420 extern struct cmd_list_element
*add_basic_prefix_cmd
421 (const char *, enum command_class
, const char *, struct cmd_list_element
**,
422 int, struct cmd_list_element
**);
424 /* Like add_prefix_cmd, but useful for "show" prefixes. This sets the
425 callback to a function that simply calls cmd_show_list. */
427 extern struct cmd_list_element
*add_show_prefix_cmd
428 (const char *, enum command_class
, const char *, struct cmd_list_element
**,
429 int, struct cmd_list_element
**);
431 extern struct cmd_list_element
*add_prefix_cmd_suppress_notification
432 (const char *name
, enum command_class theclass
,
433 cmd_simple_func_ftype
*fun
,
434 const char *doc
, struct cmd_list_element
**subcommands
,
436 struct cmd_list_element
**list
,
437 int *suppress_notification
);
439 extern struct cmd_list_element
*add_abbrev_prefix_cmd (const char *,
441 cmd_simple_func_ftype
*fun
,
443 struct cmd_list_element
445 struct cmd_list_element
448 typedef void cmd_func_ftype (const char *args
, int from_tty
,
449 cmd_list_element
*c
);
451 /* A completion routine. Add possible completions to tracker.
453 TEXT is the text beyond what was matched for the command itself
454 (leading whitespace is skipped). It stops where we are supposed to
455 stop completing (rl_point) and is '\0' terminated. WORD points in
456 the same buffer as TEXT, and completions should be returned
457 relative to this position. For example, suppose TEXT is "foo" and
458 we want to complete to "foobar". If WORD is "oo", return "oobar";
459 if WORD is "baz/foo", return "baz/foobar". */
460 typedef void completer_ftype (struct cmd_list_element
*,
461 completion_tracker
&tracker
,
462 const char *text
, const char *word
);
464 /* Same, but for set_cmd_completer_handle_brkchars. */
465 typedef void completer_handle_brkchars_ftype (struct cmd_list_element
*,
466 completion_tracker
&tracker
,
467 const char *text
, const char *word
);
469 extern void set_cmd_completer (struct cmd_list_element
*, completer_ftype
*);
471 /* Set the completer_handle_brkchars callback. */
473 extern void set_cmd_completer_handle_brkchars (struct cmd_list_element
*,
474 completer_handle_brkchars_ftype
*);
476 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
477 around in cmd objects to test the value of the commands sfunc(). */
478 extern int cmd_simple_func_eq (struct cmd_list_element
*cmd
,
479 cmd_simple_func_ftype
*cfun
);
481 /* Execute CMD's pre/post hook. Throw an error if the command fails.
482 If already executing this pre/post hook, or there is no pre/post
483 hook, the call is silently ignored. */
484 extern void execute_cmd_pre_hook (struct cmd_list_element
*cmd
);
485 extern void execute_cmd_post_hook (struct cmd_list_element
*cmd
);
487 /* Flag for an ambiguous cmd_list result. */
488 #define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1)
490 extern struct cmd_list_element
*lookup_cmd (const char **,
491 struct cmd_list_element
*,
496 /* This routine takes a line of TEXT and a CLIST in which to start the
497 lookup. When it returns it will have incremented the text pointer past
498 the section of text it matched, set *RESULT_LIST to point to the list in
499 which the last word was matched, and will return a pointer to the cmd
500 list element which the text matches. It will return NULL if no match at
501 all was possible. It will return -1 (cast appropriately, ick) if ambigous
502 matches are possible; in this case *RESULT_LIST will be set to point to
503 the list in which there are ambiguous choices (and *TEXT will be set to
504 the ambiguous text string).
506 if DEFAULT_ARGS is not null, *DEFAULT_ARGS is set to the found command
507 default args (possibly empty).
509 If the located command was an abbreviation, this routine returns the base
510 command of the abbreviation. Note that *DEFAULT_ARGS will contain the
511 default args defined for the alias.
513 It does no error reporting whatsoever; control will always return
514 to the superior routine.
516 In the case of an ambiguous return (-1), *RESULT_LIST will be set to point
517 at the prefix_command (ie. the best match) *or* (special case) will be NULL
518 if no prefix command was ever found. For example, in the case of "info a",
519 "info" matches without ambiguity, but "a" could be "args" or "address", so
520 *RESULT_LIST is set to the cmd_list_element for "info". So in this case
521 RESULT_LIST should not be interpreted as a pointer to the beginning of a
522 list; it simply points to a specific command. In the case of an ambiguous
523 return *TEXT is advanced past the last non-ambiguous prefix (e.g.
524 "info t" can be "info types" or "info target"; upon return *TEXT has been
525 advanced past "info ").
527 If RESULT_LIST is NULL, don't set *RESULT_LIST (but don't otherwise
528 affect the operation).
530 This routine does *not* modify the text pointed to by TEXT.
532 If IGNORE_HELP_CLASSES is nonzero, ignore any command list elements which
533 are actually help classes rather than commands (i.e. the function field of
534 the struct cmd_list_element is NULL).
536 When LOOKUP_FOR_COMPLETION_P is true the completion is being requested
537 for the completion engine, no warnings should be printed. */
539 extern struct cmd_list_element
*lookup_cmd_1
540 (const char **text
, struct cmd_list_element
*clist
,
541 struct cmd_list_element
**result_list
, std::string
*default_args
,
542 int ignore_help_classes
, bool lookup_for_completion_p
= false);
544 /* Look up the command called NAME in the command list LIST.
546 Unlike LOOKUP_CMD, partial matches are ignored and only exact matches
547 on NAME are considered.
549 LIST is a chain of struct cmd_list_element's.
551 If IGNORE_HELP_CLASSES is true (the default), ignore any command list
552 elements which are actually help classes rather than commands (i.e.
553 the function field of the struct cmd_list_element is null).
555 If found, return the struct cmd_list_element for that command,
556 otherwise return NULLPTR. */
558 extern struct cmd_list_element
*lookup_cmd_exact
560 struct cmd_list_element
*list
,
561 bool ignore_help_classes
= true);
563 extern struct cmd_list_element
*deprecate_cmd (struct cmd_list_element
*,
566 extern void deprecated_cmd_warning (const char *, struct cmd_list_element
*);
568 extern int lookup_cmd_composition (const char *text
,
569 struct cmd_list_element
**alias
,
570 struct cmd_list_element
**prefix_cmd
,
571 struct cmd_list_element
**cmd
);
573 extern struct cmd_list_element
*add_com (const char *, enum command_class
,
574 cmd_simple_func_ftype
*fun
,
577 extern cmd_list_element
*add_com_alias (const char *name
,
578 cmd_list_element
*target
,
579 command_class theclass
,
582 extern struct cmd_list_element
*add_com_suppress_notification
583 (const char *name
, enum command_class theclass
,
584 cmd_simple_func_ftype
*fun
, const char *doc
,
585 int *supress_notification
);
587 extern struct cmd_list_element
*add_info (const char *,
588 cmd_simple_func_ftype
*fun
,
591 extern cmd_list_element
*add_info_alias (const char *name
,
592 cmd_list_element
*target
,
595 extern void complete_on_cmdlist (struct cmd_list_element
*,
596 completion_tracker
&tracker
,
597 const char *, const char *, int);
599 extern void complete_on_enum (completion_tracker
&tracker
,
600 const char *const *enumlist
,
601 const char *, const char *);
603 /* Functions that implement commands about CLI commands. */
605 extern void help_list (struct cmd_list_element
*, const char *,
606 enum command_class
, struct ui_file
*);
608 /* Method for show a set/show variable's VALUE on FILE. If this
609 method isn't supplied deprecated_show_value_hack() is called (which
611 typedef void (show_value_ftype
) (struct ui_file
*file
,
613 struct cmd_list_element
*cmd
,
615 /* NOTE: i18n: This function is not i18n friendly. Callers should
616 instead print the value out directly. */
617 extern show_value_ftype deprecated_show_value_hack
;
619 /* Return value type for the add_setshow_* functions. */
621 struct set_show_commands
623 cmd_list_element
*set
, *show
;
626 extern set_show_commands add_setshow_enum_cmd
627 (const char *name
, command_class theclass
, const char *const *enumlist
,
628 const char **var
, const char *set_doc
, const char *show_doc
,
629 const char *help_doc
, cmd_func_ftype
*set_func
,
630 show_value_ftype
*show_func
, cmd_list_element
**set_list
,
631 cmd_list_element
**show_list
);
633 extern set_show_commands add_setshow_enum_cmd
634 (const char *name
, command_class theclass
, const char *const *enumlist
,
635 const char *set_doc
, const char *show_doc
,
636 const char *help_doc
, setting_setter_ftype
<const char *> set_func
,
637 setting_getter_ftype
<const char *> get_func
, show_value_ftype
*show_func
,
638 cmd_list_element
**set_list
, cmd_list_element
**show_list
);
640 extern set_show_commands add_setshow_auto_boolean_cmd
641 (const char *name
, command_class theclass
, auto_boolean
*var
,
642 const char *set_doc
, const char *show_doc
, const char *help_doc
,
643 cmd_func_ftype
*set_func
, show_value_ftype
*show_func
,
644 cmd_list_element
**set_list
, cmd_list_element
**show_list
);
646 extern set_show_commands add_setshow_auto_boolean_cmd
647 (const char *name
, command_class theclass
, const char *set_doc
,
648 const char *show_doc
, const char *help_doc
,
649 setting_setter_ftype
<enum auto_boolean
> set_func
,
650 setting_getter_ftype
<enum auto_boolean
> get_func
,
651 show_value_ftype
*show_func
, cmd_list_element
**set_list
,
652 cmd_list_element
**show_list
);
654 extern set_show_commands add_setshow_boolean_cmd
655 (const char *name
, command_class theclass
, bool *var
, const char *set_doc
,
656 const char *show_doc
, const char *help_doc
, cmd_func_ftype
*set_func
,
657 show_value_ftype
*show_func
, cmd_list_element
**set_list
,
658 cmd_list_element
**show_list
);
660 extern set_show_commands add_setshow_boolean_cmd
661 (const char *name
, command_class theclass
, const char *set_doc
,
662 const char *show_doc
, const char *help_doc
,
663 setting_setter_ftype
<bool> set_func
,
664 setting_getter_ftype
<bool> get_func
, show_value_ftype
*show_func
,
665 cmd_list_element
**set_list
, cmd_list_element
**show_list
);
667 extern set_show_commands add_setshow_filename_cmd
668 (const char *name
, command_class theclass
, std::string
*var
, const char *set_doc
,
669 const char *show_doc
, const char *help_doc
, cmd_func_ftype
*set_func
,
670 show_value_ftype
*show_func
, cmd_list_element
**set_list
,
671 cmd_list_element
**show_list
);
673 extern set_show_commands add_setshow_filename_cmd
674 (const char *name
, command_class theclass
, const char *set_doc
,
675 const char *show_doc
, const char *help_doc
,
676 setting_setter_ftype
<std::string
> set_func
,
677 setting_getter_ftype
<std::string
> get_func
, show_value_ftype
*show_func
,
678 cmd_list_element
**set_list
, cmd_list_element
**show_list
);
680 extern set_show_commands add_setshow_string_cmd
681 (const char *name
, command_class theclass
, std::string
*var
, const char *set_doc
,
682 const char *show_doc
, const char *help_doc
, cmd_func_ftype
*set_func
,
683 show_value_ftype
*show_func
, cmd_list_element
**set_list
,
684 cmd_list_element
**show_list
);
686 extern set_show_commands add_setshow_string_cmd
687 (const char *name
, command_class theclass
, const char *set_doc
,
688 const char *show_doc
, const char *help_doc
,
689 setting_setter_ftype
<std::string
> set_func
,
690 setting_getter_ftype
<std::string
> get_func
,
691 show_value_ftype
*show_func
, cmd_list_element
**set_list
,
692 cmd_list_element
**show_list
);
694 extern set_show_commands add_setshow_string_noescape_cmd
695 (const char *name
, command_class theclass
, std::string
*var
, const char *set_doc
,
696 const char *show_doc
, const char *help_doc
, cmd_func_ftype
*set_func
,
697 show_value_ftype
*show_func
, cmd_list_element
**set_list
,
698 cmd_list_element
**show_list
);
700 extern set_show_commands add_setshow_string_noescape_cmd
701 (const char *name
, command_class theclass
, const char *set_doc
,
702 const char *show_doc
, const char *help_doc
,
703 setting_setter_ftype
<std::string
> set_func
,
704 setting_getter_ftype
<std::string
> get_func
, show_value_ftype
*show_func
,
705 cmd_list_element
**set_list
, cmd_list_element
**show_list
);
707 extern set_show_commands add_setshow_optional_filename_cmd
708 (const char *name
, command_class theclass
, std::string
*var
, const char *set_doc
,
709 const char *show_doc
, const char *help_doc
, cmd_func_ftype
*set_func
,
710 show_value_ftype
*show_func
, cmd_list_element
**set_list
,
711 cmd_list_element
**show_list
);
713 extern set_show_commands add_setshow_optional_filename_cmd
714 (const char *name
, command_class theclass
, const char *set_doc
,
715 const char *show_doc
, const char *help_doc
,
716 setting_setter_ftype
<std::string
> set_func
,
717 setting_getter_ftype
<std::string
> get_func
,
718 show_value_ftype
*show_func
, cmd_list_element
**set_list
,
719 cmd_list_element
**show_list
);
721 extern set_show_commands add_setshow_integer_cmd
722 (const char *name
, command_class theclass
, int *var
, const char *set_doc
,
723 const char *show_doc
, const char *help_doc
, cmd_func_ftype
*set_func
,
724 show_value_ftype
*show_func
, cmd_list_element
**set_list
,
725 cmd_list_element
**show_list
);
727 extern set_show_commands add_setshow_integer_cmd
728 (const char *name
, command_class theclass
, const char *set_doc
,
729 const char *show_doc
, const char *help_doc
,
730 setting_setter_ftype
<int> set_func
,
731 setting_getter_ftype
<int> get_func
, show_value_ftype
*show_func
,
732 cmd_list_element
**set_list
, cmd_list_element
**show_list
);
734 extern set_show_commands add_setshow_uinteger_cmd
735 (const char *name
, command_class theclass
, unsigned int *var
,
736 const char *set_doc
, const char *show_doc
, const char *help_doc
,
737 cmd_func_ftype
*set_func
, show_value_ftype
*show_func
,
738 cmd_list_element
**set_list
, cmd_list_element
**show_list
);
740 extern set_show_commands add_setshow_uinteger_cmd
741 (const char *name
, command_class theclass
, const char *set_doc
,
742 const char *show_doc
, const char *help_doc
,
743 setting_setter_ftype
<unsigned int> set_func
,
744 setting_getter_ftype
<unsigned int> get_func
, show_value_ftype
*show_func
,
745 cmd_list_element
**set_list
, cmd_list_element
**show_list
);
747 extern set_show_commands add_setshow_zinteger_cmd
748 (const char *name
, command_class theclass
, int *var
, const char *set_doc
,
749 const char *show_doc
, const char *help_doc
, cmd_func_ftype
*set_func
,
750 show_value_ftype
*show_func
, cmd_list_element
**set_list
,
751 cmd_list_element
**show_list
);
753 extern set_show_commands add_setshow_zinteger_cmd
754 (const char *name
, command_class theclass
, const char *set_doc
,
755 const char *show_doc
, const char *help_doc
,
756 setting_setter_ftype
<int> set_func
,
757 setting_getter_ftype
<int> get_func
, show_value_ftype
*show_func
,
758 cmd_list_element
**set_list
, cmd_list_element
**show_list
);
760 extern set_show_commands add_setshow_zuinteger_cmd
761 (const char *name
, command_class theclass
, unsigned int *var
,
762 const char *set_doc
, const char *show_doc
, const char *help_doc
,
763 cmd_func_ftype
*set_func
, show_value_ftype
*show_func
,
764 cmd_list_element
**set_list
, cmd_list_element
**show_list
);
766 extern set_show_commands add_setshow_zuinteger_cmd
767 (const char *name
, command_class theclass
, const char *set_doc
,
768 const char *show_doc
, const char *help_doc
,
769 setting_setter_ftype
<unsigned int> set_func
,
770 setting_getter_ftype
<unsigned int> get_func
, show_value_ftype
*show_func
,
771 cmd_list_element
**set_list
, cmd_list_element
**show_list
);
773 extern set_show_commands add_setshow_zuinteger_unlimited_cmd
774 (const char *name
, command_class theclass
, int *var
, const char *set_doc
,
775 const char *show_doc
, const char *help_doc
, cmd_func_ftype
*set_func
,
776 show_value_ftype
*show_func
, cmd_list_element
**set_list
,
777 cmd_list_element
**show_list
);
779 extern set_show_commands add_setshow_zuinteger_unlimited_cmd
780 (const char *name
, command_class theclass
, const char *set_doc
,
781 const char *show_doc
, const char *help_doc
,
782 setting_setter_ftype
<int> set_func
, setting_getter_ftype
<int> get_func
,
783 show_value_ftype
*show_func
, cmd_list_element
**set_list
,
784 cmd_list_element
**show_list
);
786 /* Do a "show" command for each thing on a command list. */
788 extern void cmd_show_list (struct cmd_list_element
*, int);
790 /* Used everywhere whenever at least one parameter is required and
791 none is specified. */
793 extern void error_no_arg (const char *) ATTRIBUTE_NORETURN
;
796 /* Command line saving and repetition.
797 Each input line executed is saved to possibly be repeated either
798 when the user types an empty line, or be repeated by a command
799 that wants to repeat the previously executed command. The below
800 functions control command repetition. */
802 /* Commands call dont_repeat if they do not want to be repeated by null
803 lines or by repeat_previous (). */
805 extern void dont_repeat ();
807 /* Commands call repeat_previous if they want to repeat the previous
808 command. Such commands that repeat the previous command must
809 indicate to not repeat themselves, to avoid recursive repeat.
810 repeat_previous marks the current command as not repeating, and
811 ensures get_saved_command_line returns the previous command, so
812 that the currently executing command can repeat it. If there's no
813 previous command, throws an error. Otherwise, returns the result
814 of get_saved_command_line, which now points at the command to
817 extern const char *repeat_previous ();
819 /* Prevent dont_repeat from working, and return a cleanup that
820 restores the previous state. */
822 extern scoped_restore_tmpl
<int> prevent_dont_repeat (void);
824 /* Set the arguments that will be passed if the current command is
825 repeated. Note that the passed-in string must be a constant. */
827 extern void set_repeat_arguments (const char *args
);
829 /* Returns the saved command line to repeat.
830 When a command is being executed, this is the currently executing
831 command line, unless the currently executing command has called
832 repeat_previous (): in this case, get_saved_command_line returns
833 the previously saved command line. */
835 extern char *get_saved_command_line ();
837 /* Takes a copy of CMD, for possible repetition. */
839 extern void save_command_line (const char *cmd
);
841 /* Used to mark commands that don't do anything. If we just leave the
842 function field NULL, the command is interpreted as a help topic, or
843 as a class of commands. */
845 extern void not_just_help_class_command (const char *, int);
847 /* Call the command function. */
848 extern void cmd_func (struct cmd_list_element
*cmd
,
849 const char *args
, int from_tty
);
851 #endif /* !defined (COMMAND_H) */