GDB (xrefs)
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Private Attributes | List of all members
cmd_list_element Struct Reference

#include "cli-decode.h"

Public Types

using aliases_list_node_type = intrusive_list_node<cmd_list_element>
 
using aliases_list_member_node_type
 
using aliases_list_type = intrusive_list<cmd_list_element, aliases_list_member_node_type>
 

Public Member Functions

 cmd_list_element (const char *name_, enum command_class theclass_, const char *doc_)
 
 ~cmd_list_element ()
 
 DISABLE_COPY_AND_ASSIGN (cmd_list_element)
 
std::string prefixname () const
 
std::vector< std::string > command_components () const
 
bool is_alias () const
 
bool is_prefix () const
 
bool is_command_class_help () const
 
void set_context (void *context)
 
void * context () const
 

Public Attributes

struct cmd_list_elementnext = nullptr
 
const char * name
 
enum command_class theclass
 
unsigned int cmd_deprecated: 1
 
unsigned int deprecated_warn_user: 1
 
unsigned int malloced_replacement: 1
 
unsigned int doc_allocated: 1
 
unsigned int name_allocated: 1
 
unsigned int hook_in: 1
 
unsigned int allow_unknown: 1
 
unsigned int abbrev_flag: 1
 
__extension__ enum cmd_types type: 2
 
cmd_func_ftypefunc
 
union { 
 
   cmd_simple_func_ftype *   simple_func 
 
function 
 
const char * doc
 
show_value_ftypeshow_value_func = nullptr
 
const char * replacement = nullptr
 
struct cmd_list_elementhook_pre = nullptr
 
struct cmd_list_elementhook_post = nullptr
 
std::string default_args
 
struct cmd_list_element ** subcommands = nullptr
 
struct cmd_list_elementprefix = nullptr
 
completer_ftypecompleter = symbol_completer
 
completer_handle_brkchars_ftypecompleter_handle_brkchars = nullptr
 
void(* destroyer )(struct cmd_list_element *self, void *context) = nullptr
 
gdb::optional< settingvar
 
const char *const * enums = nullptr
 
counted_command_line user_commands
 
struct cmd_list_elementhookee_pre = nullptr
 
struct cmd_list_elementhookee_post = nullptr
 
struct cmd_list_elementalias_target = nullptr
 
aliases_list_node_type aliases_list_node
 
aliases_list_type aliases
 
bool * suppress_notification = nullptr
 

Private Attributes

void * m_context = nullptr
 

Detailed Description

Definition at line 45 of file cli-decode.h.

Member Typedef Documentation

◆ aliases_list_member_node_type

Initial value:
intrusive_member_node<cmd_list_element,
cmd_list_element(const char *name_, enum command_class theclass_, const char *doc_)
Definition cli-decode.h:47
aliases_list_node_type aliases_list_node
Definition cli-decode.h:259

Definition at line 262 of file cli-decode.h.

◆ aliases_list_node_type

Definition at line 258 of file cli-decode.h.

◆ aliases_list_type

Definition at line 264 of file cli-decode.h.

Constructor & Destructor Documentation

◆ cmd_list_element()

cmd_list_element::cmd_list_element ( const char * name_,
enum command_class theclass_,
const char * doc_ )
inline

Definition at line 47 of file cli-decode.h.

References function.

◆ ~cmd_list_element()

cmd_list_element::~cmd_list_element ( )
inline

Definition at line 65 of file cli-decode.h.

References doc, doc_allocated, name, name_allocated, and xfree().

Member Function Documentation

◆ command_components()

std::vector< std::string > cmd_list_element::command_components ( ) const

Definition at line 151 of file cli-decode.c.

References command_components(), name, and prefix.

Referenced by command_components(), full_cmd_name_without_first_prefix(), and setting_cmd().

◆ context()

void * cmd_list_element::context ( ) const
inline

◆ DISABLE_COPY_AND_ASSIGN()

cmd_list_element::DISABLE_COPY_AND_ASSIGN ( cmd_list_element )

◆ is_alias()

bool cmd_list_element::is_alias ( ) const
inline

◆ is_command_class_help()

bool cmd_list_element::is_command_class_help ( ) const
inline

Definition at line 100 of file cli-decode.h.

References func.

Referenced by cmd_func(), complete_on_cmdlist(), execute_command(), find_cmd(), help_all(), help_cmd(), and help_cmd_list().

◆ is_prefix()

bool cmd_list_element::is_prefix ( ) const
inline

◆ prefixname()

std::string cmd_list_element::prefixname ( ) const

◆ set_context()

void cmd_list_element::set_context ( void * context)
inline

Member Data Documentation

◆ abbrev_flag

unsigned int cmd_list_element::abbrev_flag

◆ alias_target

struct cmd_list_element* cmd_list_element::alias_target = nullptr

◆ aliases

aliases_list_type cmd_list_element::aliases

◆ aliases_list_node

aliases_list_node_type cmd_list_element::aliases_list_node

Definition at line 259 of file cli-decode.h.

◆ allow_unknown

unsigned int cmd_list_element::allow_unknown

◆ cmd_deprecated

unsigned int cmd_list_element::cmd_deprecated

◆ completer

completer_ftype* cmd_list_element::completer = symbol_completer

◆ completer_handle_brkchars

completer_handle_brkchars_ftype* cmd_list_element::completer_handle_brkchars = nullptr

◆ default_args

std::string cmd_list_element::default_args

◆ deprecated_warn_user

unsigned int cmd_list_element::deprecated_warn_user

◆ destroyer

void(* cmd_list_element::destroyer) (struct cmd_list_element *self, void *context) = nullptr

◆ doc

const char* cmd_list_element::doc

◆ doc_allocated

unsigned int cmd_list_element::doc_allocated

◆ enums

const char* const* cmd_list_element::enums = nullptr

◆ func

cmd_func_ftype* cmd_list_element::func

◆ [union]

union { ... } cmd_list_element::function

◆ hook_in

unsigned int cmd_list_element::hook_in

◆ hook_post

struct cmd_list_element* cmd_list_element::hook_post = nullptr

◆ hook_pre

struct cmd_list_element* cmd_list_element::hook_pre = nullptr

◆ hookee_post

struct cmd_list_element* cmd_list_element::hookee_post = nullptr

Definition at line 251 of file cli-decode.h.

Referenced by delete_cmd(), do_add_cmd(), and do_define_command().

◆ hookee_pre

struct cmd_list_element* cmd_list_element::hookee_pre = nullptr

Definition at line 247 of file cli-decode.h.

Referenced by delete_cmd(), do_add_cmd(), and do_define_command().

◆ m_context

void* cmd_list_element::m_context = nullptr
private

Definition at line 275 of file cli-decode.h.

Referenced by context(), and set_context().

◆ malloced_replacement

unsigned int cmd_list_element::malloced_replacement

Definition at line 141 of file cli-decode.h.

Referenced by maintenance_do_deprecate().

◆ name

const char* cmd_list_element::name

◆ name_allocated

unsigned int cmd_list_element::name_allocated

◆ next

struct cmd_list_element* cmd_list_element::next = nullptr

◆ prefix

struct cmd_list_element* cmd_list_element::prefix = nullptr

◆ replacement

const char* cmd_list_element::replacement = nullptr

Definition at line 200 of file cli-decode.h.

Referenced by deprecate_cmd(), deprecated_cmd_warning(), and maintenance_do_deprecate().

◆ show_value_func

show_value_ftype* cmd_list_element::show_value_func = nullptr

Definition at line 197 of file cli-decode.h.

Referenced by add_setshow_cmd_full_erased(), and do_show_command().

◆ simple_func

cmd_simple_func_ftype* cmd_list_element::simple_func

Definition at line 185 of file cli-decode.h.

Referenced by add_cmd(), cmd_simple_func_eq(), do_simple_func(), and set_cmd_simple_func().

◆ subcommands

struct cmd_list_element** cmd_list_element::subcommands = nullptr

◆ suppress_notification

bool* cmd_list_element::suppress_notification = nullptr

◆ theclass

enum command_class cmd_list_element::theclass

Definition at line 119 of file cli-decode.h.

Referenced by add_abbrev_prefix_cmd(), add_alias_cmd(), add_basic_prefix_cmd(), add_cmd(), add_cmd(), add_cmd_suppress_notification(), add_com(), add_com_alias(), add_com_suppress_notification(), add_prefix_cmd(), add_prefix_cmd_suppress_notification(), add_set_or_show_cmd(), add_setshow_auto_boolean_cmd(), add_setshow_auto_boolean_cmd(), add_setshow_boolean_cmd(), add_setshow_boolean_cmd(), add_setshow_cmd_full(), add_setshow_cmd_full(), add_setshow_cmd_full_erased(), add_setshow_enum_cmd(), add_setshow_enum_cmd(), add_setshow_filename_cmd(), add_setshow_filename_cmd(), add_setshow_integer_cmd(), add_setshow_integer_cmd(), add_setshow_integer_cmd(), add_setshow_integer_cmd(), add_setshow_optional_filename_cmd(), add_setshow_optional_filename_cmd(), add_setshow_pinteger_cmd(), add_setshow_pinteger_cmd(), add_setshow_prefix_cmd(), add_setshow_string_cmd(), add_setshow_string_cmd(), add_setshow_string_noescape_cmd(), add_setshow_string_noescape_cmd(), add_setshow_uinteger_cmd(), add_setshow_uinteger_cmd(), add_setshow_uinteger_cmd(), add_setshow_uinteger_cmd(), add_setshow_zinteger_cmd(), add_setshow_zinteger_cmd(), add_setshow_zuinteger_cmd(), add_setshow_zuinteger_cmd(), add_setshow_zuinteger_unlimited_cmd(), add_setshow_zuinteger_unlimited_cmd(), add_show_prefix_cmd(), cli_user_command_p(), cmd_show_list(), define_prefix_command(), do_add_cmd(), do_define_command(), do_document_command(), execute_command(), help_all(), help_cmd(), help_cmd_list(), help_list(), notify_command_param_changed_p(), and show_user_1().

◆ type

__extension__ enum cmd_types cmd_list_element::type

◆ user_commands

counted_command_line cmd_list_element::user_commands

◆ var

gdb::optional<setting> cmd_list_element::var

The documentation for this struct was generated from the following files: