/* Header file for command creation.
- Copyright (C) 1986-2021 Free Software Foundation, Inc.
+ Copyright (C) 1986-2022 Free Software Foundation, Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Note that help accepts unambiguous abbreviated class names. */
/* Special classes to help_list */
- class_deprecated = -3,
all_classes = -2, /* help without <classname> */
all_commands = -1, /* all */
/* String which the user enters with escapes (e.g. the user types
\n and it is a real newline in the stored string).
- *VAR is a malloc'd string, or NULL if the string is empty. */
+ *VAR is a std::string, "" if the string is empty. */
var_string,
/* String which stores what the user types verbatim.
- *VAR is a malloc'd string, or NULL if the string is empty. */
+ *VAR is std::string, "" if the string is empty. */
var_string_noescape,
- /* String which stores a filename. (*VAR) is a malloc'd string,
- or "" if the string was empty. */
+ /* String which stores a filename. (*VAR) is a std::string,
+ "" if the string was empty. */
var_optional_filename,
- /* String which stores a filename. (*VAR) is a malloc'd
- string. */
+ /* String which stores a filename. (*VAR) is a std::string. */
var_filename,
/* ZeroableInteger. *VAR is an int. Like var_integer except
that zero really means zero. */
}
var_types;
+/* Return true if a setting of type VAR_TYPE is backed with type T.
+
+ This function is left without definition intentionally. This template is
+ specialized for all valid types that are used to back var_types. Therefore
+ if one tries to instantiate this un-specialized template it means the T
+ parameter is not a type used to back a var_type and it is most likely a
+ programming error. */
+template<typename T>
+bool var_type_uses (var_types var_type) = delete;
+
+/* Return true if a setting of type T is backed by a bool variable. */
+template<>
+inline bool var_type_uses<bool> (var_types t)
+{
+ return t == var_boolean;
+};
+
+/* Return true if a setting of type T is backed by a auto_boolean variable.
+*/
+template<>
+inline bool var_type_uses<enum auto_boolean> (var_types t)
+{
+ return t == var_auto_boolean;
+}
+
+/* Return true if a setting of type T is backed by an unsigned int variable.
+*/
+template<>
+inline bool var_type_uses<unsigned int> (var_types t)
+{
+ return (t == var_uinteger || t == var_zinteger || t == var_zuinteger);
+}
+
+/* Return true if a setting of type T is backed by an int variable. */
+template<>
+inline bool var_type_uses<int> (var_types t)
+{
+ return (t == var_integer || t == var_zinteger
+ || t == var_zuinteger_unlimited);
+}
+
+/* Return true if a setting of type T is backed by a std::string variable. */
+template<>
+inline bool var_type_uses<std::string> (var_types t)
+{
+ return (t == var_string || t == var_string_noescape
+ || t == var_optional_filename || t == var_filename);
+}
+
+/* Return true if a setting of type T is backed by a const char * variable.
+*/
+template<>
+inline bool var_type_uses<const char *> (var_types t)
+{
+ return t == var_enum;
+}
+
+template<bool is_scalar, typename T> struct setting_func_types_1;
+
+template<typename T>
+struct setting_func_types_1<true, T>
+{
+ using type = T;
+ using set = void (*) (type);
+ using get = type (*) ();
+};
+
+template<typename T>
+struct setting_func_types_1<false, T>
+{
+ using type = const T &;
+ using set = void (*) (type);
+ using get = type (*) ();
+};
+
+template<typename T>
+struct setting_func_types
+{
+ using type = typename setting_func_types_1<std::is_scalar<T>::value, T>::type;
+ using set = typename setting_func_types_1<std::is_scalar<T>::value, T>::set;
+ using get = typename setting_func_types_1<std::is_scalar<T>::value, T>::get;
+};
+
+/* Generic/type-erased function pointer. */
+
+using erased_func = void (*) ();
+
+/* Interface for getting and setting a setting's value.
+
+ The underlying data can be of any VAR_TYPES type. */
+struct setting
+{
+ /* Create a setting backed by a variable of type T.
+
+ Type T must match the var type VAR_TYPE (see VAR_TYPE_USES). */
+ template<typename T>
+ setting (var_types var_type, T *var)
+ : m_var_type (var_type), m_var (var)
+ {
+ gdb_assert (var != nullptr);
+ gdb_assert (var_type_uses<T> (var_type));
+ }
+
+ /* A setting can also be constructed with a pre-validated
+ type-erased variable. Use the following function to
+ validate & type-erase said variable/function pointers. */
+
+ struct erased_args
+ {
+ void *var;
+ erased_func setter;
+ erased_func getter;
+ };
+
+ template<typename T>
+ static erased_args erase_args (var_types var_type,
+ T *var,
+ typename setting_func_types<T>::set set_setting_func,
+ typename setting_func_types<T>::get get_setting_func)
+ {
+ gdb_assert (var_type_uses<T> (var_type));
+ /* The getter and the setter must be both provided or both omitted. */
+ gdb_assert
+ ((set_setting_func == nullptr) == (get_setting_func == nullptr));
+
+ /* The caller must provide a pointer to a variable or get/set functions, but
+ not both. */
+ gdb_assert ((set_setting_func == nullptr) != (var == nullptr));
+
+ return {
+ var,
+ reinterpret_cast<erased_func> (set_setting_func),
+ reinterpret_cast<erased_func> (get_setting_func)
+ };
+ }
+
+ /* Create a setting backed by pre-validated type-erased args.
+ ERASED_VAR's fields' real types must match the var type VAR_TYPE
+ (see VAR_TYPE_USES). */
+ setting (var_types var_type, const erased_args &args)
+ : m_var_type (var_type),
+ m_var (args.var),
+ m_getter (args.getter),
+ m_setter (args.setter)
+ {
+ }
+
+ /* Create a setting backed by setter and getter functions.
+
+ Type T must match the var type VAR_TYPE (see VAR_TYPE_USES). */
+ template<typename T>
+ setting (var_types var_type,
+ typename setting_func_types<T>::set setter,
+ typename setting_func_types<T>::get getter)
+ : m_var_type (var_type)
+ {
+ gdb_assert (var_type_uses<T> (var_type));
+
+ /* Getters and setters are cast to and from the arbitrary `void (*) ()`
+ function pointer type. Make sure that the two types are really of the
+ same size. */
+ gdb_static_assert (sizeof (m_getter) == sizeof (getter));
+ gdb_static_assert (sizeof (m_setter) == sizeof (setter));
+
+ m_getter = reinterpret_cast<erased_func> (getter);
+ m_setter = reinterpret_cast<erased_func> (setter);
+ }
+
+ /* Access the type of the current setting. */
+ var_types type () const
+ { return m_var_type; }
+
+ /* Return the current value.
+
+ The template parameter T is the type of the variable used to store the
+ setting. */
+ template<typename T>
+ typename setting_func_types<T>::type get () const
+ {
+ gdb_assert (var_type_uses<T> (m_var_type));
+
+ if (m_var == nullptr)
+ {
+ gdb_assert (m_getter != nullptr);
+ auto getter = reinterpret_cast<typename setting_func_types<T>::get> (m_getter);
+ return getter ();
+ }
+ else
+ return *static_cast<const T *> (m_var);
+ }
+
+ /* Sets the value of the setting to V. Returns true if the setting was
+ effectively changed, false if the update failed and the setting is left
+ unchanged.
+
+ If we have a user-provided setter, use it to set the setting. Otherwise
+ copy the value V to the internally referenced buffer.
+
+ The template parameter T indicates the type of the variable used to store
+ the setting.
+
+ The var_type of the setting must match T. */
+ template<typename T>
+ bool set (const T &v)
+ {
+ /* Check that the current instance is of one of the supported types for
+ this instantiation. */
+ gdb_assert (var_type_uses<T> (m_var_type));
+
+ const T old_value = this->get<T> ();
+
+ if (m_var == nullptr)
+ {
+ gdb_assert (m_setter != nullptr);
+ auto setter = reinterpret_cast<typename setting_func_types<T>::set> (m_setter);
+ setter (v);
+ }
+ else
+ *static_cast<T *> (m_var) = v;
+
+ return old_value != this->get<T> ();
+ }
+
+private:
+ /* The type of the variable M_VAR is pointing to, or that M_GETTER / M_SETTER
+ get or set. */
+ var_types m_var_type;
+
+ /* Pointer to the enclosed variable
+
+ Either M_VAR is non-nullptr, or both M_GETTER and M_SETTER are
+ non-nullptr. */
+ void *m_var = nullptr;
+
+ /* Pointer to a user provided getter. */
+ erased_func m_getter = nullptr;
+
+ /* Pointer to a user provided setter. */
+ erased_func m_setter = nullptr;
+};
+
/* This structure records one command'd definition. */
struct cmd_list_element;
-typedef void cmd_const_cfunc_ftype (const char *args, int from_tty);
+/* The "simple" signature of command callbacks, which doesn't include a
+ cmd_list_element parameter. */
+
+typedef void cmd_simple_func_ftype (const char *args, int from_tty);
/* This structure specifies notifications to be suppressed by a cli
command interpreter. */
struct cli_suppress_notification
{
/* Inferior, thread, frame selected notification suppressed? */
- int user_selected_context;
+ bool user_selected_context = false;
+
+ /* Normal stop event suppressed? */
+ bool normal_stop = false;
};
extern struct cli_suppress_notification cli_suppress_notification;
extern bool valid_cmd_char_p (int c);
+/* Return value type for the add_setshow_* functions. */
+
+struct set_show_commands
+{
+ cmd_list_element *set, *show;
+};
+
/* Const-correct variant of the above. */
extern struct cmd_list_element *add_cmd (const char *, enum command_class,
- cmd_const_cfunc_ftype *fun,
+ cmd_simple_func_ftype *fun,
const char *,
struct cmd_list_element **);
extern struct cmd_list_element *add_cmd_suppress_notification
(const char *name, enum command_class theclass,
- cmd_const_cfunc_ftype *fun, const char *doc,
+ cmd_simple_func_ftype *fun, const char *doc,
struct cmd_list_element **list,
- int *suppress_notification);
-
-extern struct cmd_list_element *add_alias_cmd (const char *, const char *,
- enum command_class, int,
- struct cmd_list_element **);
+ bool *suppress_notification);
extern struct cmd_list_element *add_alias_cmd (const char *,
cmd_list_element *,
extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class,
- cmd_const_cfunc_ftype *fun,
+ cmd_simple_func_ftype *fun,
const char *,
struct cmd_list_element **,
int,
(const char *, enum command_class, const char *, struct cmd_list_element **,
int, struct cmd_list_element **);
+/* Add matching set and show commands using add_basic_prefix_cmd and
+ add_show_prefix_cmd. */
+
+extern set_show_commands add_setshow_prefix_cmd
+ (const char *name, command_class theclass, const char *set_doc,
+ const char *show_doc,
+ cmd_list_element **set_subcommands_list,
+ cmd_list_element **show_subcommands_list,
+ cmd_list_element **set_list,
+ cmd_list_element **show_list);
+
extern struct cmd_list_element *add_prefix_cmd_suppress_notification
(const char *name, enum command_class theclass,
- cmd_const_cfunc_ftype *fun,
+ cmd_simple_func_ftype *fun,
const char *doc, struct cmd_list_element **subcommands,
int allow_unknown,
struct cmd_list_element **list,
- int *suppress_notification);
+ bool *suppress_notification);
extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *,
enum command_class,
- cmd_const_cfunc_ftype *fun,
+ cmd_simple_func_ftype *fun,
const char *,
struct cmd_list_element
**, int,
struct cmd_list_element
**);
-typedef void cmd_const_sfunc_ftype (const char *args, int from_tty,
- struct cmd_list_element *c);
-extern void set_cmd_sfunc (struct cmd_list_element *cmd,
- cmd_const_sfunc_ftype *sfunc);
+typedef void cmd_func_ftype (const char *args, int from_tty,
+ cmd_list_element *c);
/* A completion routine. Add possible completions to tracker.
/* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
around in cmd objects to test the value of the commands sfunc(). */
-extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
- cmd_const_cfunc_ftype *cfun);
-
-/* Each command object has a local context attached to it. */
-extern void set_cmd_context (struct cmd_list_element *cmd,
- void *context);
-extern void *get_cmd_context (struct cmd_list_element *cmd);
-
+extern int cmd_simple_func_eq (struct cmd_list_element *cmd,
+ cmd_simple_func_ftype *cfun);
/* Execute CMD's pre/post hook. Throw an error if the command fails.
If already executing this pre/post hook, or there is no pre/post
struct cmd_list_element **cmd);
extern struct cmd_list_element *add_com (const char *, enum command_class,
- cmd_const_cfunc_ftype *fun,
+ cmd_simple_func_ftype *fun,
const char *);
extern cmd_list_element *add_com_alias (const char *name,
extern struct cmd_list_element *add_com_suppress_notification
(const char *name, enum command_class theclass,
- cmd_const_cfunc_ftype *fun, const char *doc,
- int *supress_notification);
+ cmd_simple_func_ftype *fun, const char *doc,
+ bool *supress_notification);
extern struct cmd_list_element *add_info (const char *,
- cmd_const_cfunc_ftype *fun,
+ cmd_simple_func_ftype *fun,
const char *);
-extern struct cmd_list_element *add_info_alias (const char *, const char *,
- int);
+extern cmd_list_element *add_info_alias (const char *name,
+ cmd_list_element *target,
+ int abbrev_flag);
extern void complete_on_cmdlist (struct cmd_list_element *,
completion_tracker &tracker,
instead print the value out directly. */
extern show_value_ftype deprecated_show_value_hack;
-/* Return value type for the add_setshow_* functions. */
-
-struct set_show_commands
-{
- cmd_list_element *set, *show;
-};
-
extern set_show_commands add_setshow_enum_cmd
(const char *name, command_class theclass, const char *const *enumlist,
const char **var, const char *set_doc, const char *show_doc,
- const char *help_doc, cmd_const_sfunc_ftype *set_func,
+ const char *help_doc, cmd_func_ftype *set_func,
show_value_ftype *show_func, cmd_list_element **set_list,
- cmd_list_element **show_list, void *context = nullptr);
+ cmd_list_element **show_list);
+
+extern set_show_commands add_setshow_enum_cmd
+ (const char *name, command_class theclass, const char *const *enumlist,
+ const char *set_doc, const char *show_doc,
+ const char *help_doc, setting_func_types<const char *>::set set_func,
+ setting_func_types<const char *>::get get_func, show_value_ftype *show_func,
+ cmd_list_element **set_list, cmd_list_element **show_list);
extern set_show_commands add_setshow_auto_boolean_cmd
(const char *name, command_class theclass, auto_boolean *var,
const char *set_doc, const char *show_doc, const char *help_doc,
- cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func,
+ cmd_func_ftype *set_func, show_value_ftype *show_func,
cmd_list_element **set_list, cmd_list_element **show_list);
+extern set_show_commands add_setshow_auto_boolean_cmd
+ (const char *name, command_class theclass, const char *set_doc,
+ const char *show_doc, const char *help_doc,
+ setting_func_types<enum auto_boolean>::set set_func,
+ setting_func_types<enum auto_boolean>::get get_func,
+ show_value_ftype *show_func, cmd_list_element **set_list,
+ cmd_list_element **show_list);
+
extern set_show_commands add_setshow_boolean_cmd
(const char *name, command_class theclass, bool *var, const char *set_doc,
- const char *show_doc, const char *help_doc, cmd_const_sfunc_ftype *set_func,
+ const char *show_doc, const char *help_doc, cmd_func_ftype *set_func,
+ show_value_ftype *show_func, cmd_list_element **set_list,
+ cmd_list_element **show_list);
+
+extern set_show_commands add_setshow_boolean_cmd
+ (const char *name, command_class theclass, const char *set_doc,
+ const char *show_doc, const char *help_doc,
+ setting_func_types<bool>::set set_func,
+ setting_func_types<bool>::get get_func, show_value_ftype *show_func,
+ cmd_list_element **set_list, cmd_list_element **show_list);
+
+extern set_show_commands add_setshow_filename_cmd
+ (const char *name, command_class theclass, std::string *var, const char *set_doc,
+ const char *show_doc, const char *help_doc, cmd_func_ftype *set_func,
show_value_ftype *show_func, cmd_list_element **set_list,
cmd_list_element **show_list);
extern set_show_commands add_setshow_filename_cmd
- (const char *name, command_class theclass, char **var, const char *set_doc,
- const char *show_doc, const char *help_doc, cmd_const_sfunc_ftype *set_func,
+ (const char *name, command_class theclass, const char *set_doc,
+ const char *show_doc, const char *help_doc,
+ setting_func_types<std::string>::set set_func,
+ setting_func_types<std::string>::get get_func, show_value_ftype *show_func,
+ cmd_list_element **set_list, cmd_list_element **show_list);
+
+extern set_show_commands add_setshow_string_cmd
+ (const char *name, command_class theclass, std::string *var, const char *set_doc,
+ const char *show_doc, const char *help_doc, cmd_func_ftype *set_func,
show_value_ftype *show_func, cmd_list_element **set_list,
cmd_list_element **show_list);
extern set_show_commands add_setshow_string_cmd
- (const char *name, command_class theclass, char **var, const char *set_doc,
- const char *show_doc, const char *help_doc, cmd_const_sfunc_ftype *set_func,
+ (const char *name, command_class theclass, const char *set_doc,
+ const char *show_doc, const char *help_doc,
+ setting_func_types<std::string>::set set_func,
+ setting_func_types<std::string>::get get_func,
+ show_value_ftype *show_func, cmd_list_element **set_list,
+ cmd_list_element **show_list);
+
+extern set_show_commands add_setshow_string_noescape_cmd
+ (const char *name, command_class theclass, std::string *var, const char *set_doc,
+ const char *show_doc, const char *help_doc, cmd_func_ftype *set_func,
show_value_ftype *show_func, cmd_list_element **set_list,
cmd_list_element **show_list);
extern set_show_commands add_setshow_string_noescape_cmd
- (const char *name, command_class theclass, char **var, const char *set_doc,
- const char *show_doc, const char *help_doc, cmd_const_sfunc_ftype *set_func,
+ (const char *name, command_class theclass, const char *set_doc,
+ const char *show_doc, const char *help_doc,
+ setting_func_types<std::string>::set set_func,
+ setting_func_types<std::string>::get get_func, show_value_ftype *show_func,
+ cmd_list_element **set_list, cmd_list_element **show_list);
+
+extern set_show_commands add_setshow_optional_filename_cmd
+ (const char *name, command_class theclass, std::string *var, const char *set_doc,
+ const char *show_doc, const char *help_doc, cmd_func_ftype *set_func,
show_value_ftype *show_func, cmd_list_element **set_list,
cmd_list_element **show_list);
extern set_show_commands add_setshow_optional_filename_cmd
- (const char *name, command_class theclass, char **var, const char *set_doc,
- const char *show_doc, const char *help_doc, cmd_const_sfunc_ftype *set_func,
+ (const char *name, command_class theclass, const char *set_doc,
+ const char *show_doc, const char *help_doc,
+ setting_func_types<std::string>::set set_func,
+ setting_func_types<std::string>::get get_func,
show_value_ftype *show_func, cmd_list_element **set_list,
cmd_list_element **show_list);
extern set_show_commands add_setshow_integer_cmd
(const char *name, command_class theclass, int *var, const char *set_doc,
- const char *show_doc, const char *help_doc, cmd_const_sfunc_ftype *set_func,
+ const char *show_doc, const char *help_doc, cmd_func_ftype *set_func,
show_value_ftype *show_func, cmd_list_element **set_list,
cmd_list_element **show_list);
+extern set_show_commands add_setshow_integer_cmd
+ (const char *name, command_class theclass, const char *set_doc,
+ const char *show_doc, const char *help_doc,
+ setting_func_types<int>::set set_func,
+ setting_func_types<int>::get get_func, show_value_ftype *show_func,
+ cmd_list_element **set_list, cmd_list_element **show_list);
+
extern set_show_commands add_setshow_uinteger_cmd
(const char *name, command_class theclass, unsigned int *var,
const char *set_doc, const char *show_doc, const char *help_doc,
- cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func,
+ cmd_func_ftype *set_func, show_value_ftype *show_func,
+ cmd_list_element **set_list, cmd_list_element **show_list);
+
+extern set_show_commands add_setshow_uinteger_cmd
+ (const char *name, command_class theclass, const char *set_doc,
+ const char *show_doc, const char *help_doc,
+ setting_func_types<unsigned int>::set set_func,
+ setting_func_types<unsigned int>::get get_func, show_value_ftype *show_func,
cmd_list_element **set_list, cmd_list_element **show_list);
extern set_show_commands add_setshow_zinteger_cmd
(const char *name, command_class theclass, int *var, const char *set_doc,
- const char *show_doc, const char *help_doc, cmd_const_sfunc_ftype *set_func,
+ const char *show_doc, const char *help_doc, cmd_func_ftype *set_func,
show_value_ftype *show_func, cmd_list_element **set_list,
cmd_list_element **show_list);
+extern set_show_commands add_setshow_zinteger_cmd
+ (const char *name, command_class theclass, const char *set_doc,
+ const char *show_doc, const char *help_doc,
+ setting_func_types<int>::set set_func,
+ setting_func_types<int>::get get_func, show_value_ftype *show_func,
+ cmd_list_element **set_list, cmd_list_element **show_list);
+
extern set_show_commands add_setshow_zuinteger_cmd
(const char *name, command_class theclass, unsigned int *var,
const char *set_doc, const char *show_doc, const char *help_doc,
- cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func,
+ cmd_func_ftype *set_func, show_value_ftype *show_func,
+ cmd_list_element **set_list, cmd_list_element **show_list);
+
+extern set_show_commands add_setshow_zuinteger_cmd
+ (const char *name, command_class theclass, const char *set_doc,
+ const char *show_doc, const char *help_doc,
+ setting_func_types<unsigned int>::set set_func,
+ setting_func_types<unsigned int>::get get_func, show_value_ftype *show_func,
cmd_list_element **set_list, cmd_list_element **show_list);
extern set_show_commands add_setshow_zuinteger_unlimited_cmd
(const char *name, command_class theclass, int *var, const char *set_doc,
- const char *show_doc, const char *help_doc, cmd_const_sfunc_ftype *set_func,
+ const char *show_doc, const char *help_doc, cmd_func_ftype *set_func,
+ show_value_ftype *show_func, cmd_list_element **set_list,
+ cmd_list_element **show_list);
+
+extern set_show_commands add_setshow_zuinteger_unlimited_cmd
+ (const char *name, command_class theclass, const char *set_doc,
+ const char *show_doc, const char *help_doc,
+ setting_func_types<int>::set set_func, setting_func_types<int>::get get_func,
show_value_ftype *show_func, cmd_list_element **set_list,
cmd_list_element **show_list);
projects / binutils-gdb.git / blobdiff