Inheritance diagram for CommandObjectTargetVariable:

[legend]

Public Member Functions
	CommandObjectTargetVariable (CommandInterpreter &interpreter)

	~CommandObjectTargetVariable () override=default

void	DumpValueObject (Stream &s, VariableSP &var_sp, ValueObjectSP &valobj_sp, const char *root_name)

Options *	GetOptions () override

Public Member Functions inherited from lldb_private::CommandObjectParsed
	CommandObjectParsed (CommandInterpreter &interpreter, const char name, const char help=nullptr, const char *syntax=nullptr, uint32_t flags=0)

	~CommandObjectParsed () override=default

void	Execute (const char *args_string, CommandReturnObject &result) override

Public Member Functions inherited from lldb_private::CommandObject
	CommandObject (CommandInterpreter &interpreter, llvm::StringRef name, llvm::StringRef help="", llvm::StringRef syntax="", uint32_t flags=0)

virtual	~CommandObject ()=default

CommandInterpreter &	GetCommandInterpreter ()

Debugger &	GetDebugger ()

virtual llvm::StringRef	GetHelp ()

virtual llvm::StringRef	GetHelpLong ()

virtual llvm::StringRef	GetSyntax ()

llvm::StringRef	GetCommandName () const

virtual void	SetHelp (llvm::StringRef str)

virtual void	SetHelpLong (llvm::StringRef str)

void	SetSyntax (llvm::StringRef str)

virtual bool	IsRemovable () const

virtual bool	IsMultiwordObject ()

bool	IsUserCommand ()

void	SetIsUserCommand (bool is_user)

virtual CommandObjectMultiword *	GetAsMultiwordCommand ()

virtual bool	IsAlias ()

virtual bool	IsDashDashCommand ()

virtual lldb::CommandObjectSP	GetSubcommandSP (llvm::StringRef sub_cmd, StringList *matches=nullptr)

virtual lldb::CommandObjectSP	GetSubcommandSPExact (llvm::StringRef sub_cmd)

virtual CommandObject *	GetSubcommandObject (llvm::StringRef sub_cmd, StringList *matches=nullptr)

void	FormatLongHelpText (Stream &output_strm, llvm::StringRef long_help)

void	GenerateHelpText (CommandReturnObject &result)

virtual void	GenerateHelpText (Stream &result)

virtual bool	LoadSubCommand (llvm::StringRef cmd_name, const lldb::CommandObjectSP &command_obj)

virtual llvm::Error	LoadUserSubcommand (llvm::StringRef cmd_name, const lldb::CommandObjectSP &command_obj, bool can_replace)

virtual bool	WantsRawCommandString ()=0

virtual bool	WantsCompletion ()

virtual Options *	GetOptions ()

void	AddSimpleArgumentList (lldb::CommandArgumentType arg_type, ArgumentRepetitionType repetition_type=eArgRepeatPlain)

void	AddIDsArgumentData (IDType type)

int	GetNumArgumentEntries ()

CommandArgumentEntry *	GetArgumentEntryAtIndex (int idx)

void	GetFormattedCommandArguments (Stream &str, uint32_t opt_set_mask=LLDB_OPT_SET_ALL)

bool	ParseOptions (Args &args, CommandReturnObject &result)

void	SetCommandName (llvm::StringRef name)

virtual void	HandleCompletion (CompletionRequest &request)
	This default version handles calling option argument completions and then calls HandleArgumentCompletion if the cursor is on an argument, not an option.

virtual void	HandleArgumentCompletion (CompletionRequest &request, OptionElementVector &opt_element_vector)
	The default version handles argument definitions that have only one argument type, and use one of the argument types that have an entry in the CommonCompletions.

bool	HelpTextContainsWord (llvm::StringRef search_word, bool search_short_help=true, bool search_long_help=true, bool search_syntax=true, bool search_options=true)

Flags &	GetFlags ()
	The flags accessor.

const Flags &	GetFlags () const
	The flags const accessor.

virtual std::optional< std::string >	GetRepeatCommand (Args &current_command_args, uint32_t index)
	Get the command that appropriate for a "repeat" of the current command.

bool	HasOverrideCallback () const

void	SetOverrideCallback (lldb::CommandOverrideCallback callback, void *baton)

void	SetOverrideCallback (lldb_private::CommandOverrideCallbackWithResult callback, void *baton)

bool	InvokeOverrideCallback (const char **argv, CommandReturnObject &result)

virtual void	Execute (const char *args_string, CommandReturnObject &result)=0

Static Public Member Functions
static size_t	GetVariableCallback (void baton, const char name, VariableList &variable_list)

Static Public Member Functions inherited from lldb_private::CommandObject
static const char *	GetArgumentTypeAsCString (const lldb::CommandArgumentType arg_type)

static const char *	GetArgumentDescriptionAsCString (const lldb::CommandArgumentType arg_type)

static lldb::CommandArgumentType	LookupArgumentName (llvm::StringRef arg_name)

static const ArgumentTableEntry *	FindArgumentDataByType (lldb::CommandArgumentType arg_type)

static void	GetArgumentHelp (Stream &str, lldb::CommandArgumentType arg_type, CommandInterpreter &interpreter)

static const char *	GetArgumentName (lldb::CommandArgumentType arg_type)

static bool	IsPairType (ArgumentRepetitionType arg_repeat_type)

static std::optional< ArgumentRepetitionType >	ArgRepetitionFromString (llvm::StringRef string)

Protected Member Functions
void	DumpGlobalVariableList (const ExecutionContext &exe_ctx, const SymbolContext &sc, const VariableList &variable_list, Stream &s)

void	DoExecute (Args &args, CommandReturnObject &result) override

Protected Member Functions inherited from lldb_private::CommandObjectParsed
virtual void	DoExecute (Args &command, CommandReturnObject &result)=0

bool	WantsRawCommandString () override

Protected Member Functions inherited from lldb_private::CommandObject
bool	ParseOptionsAndNotify (Args &args, CommandReturnObject &result, OptionGroupOptions &group_options, ExecutionContext &exe_ctx)

virtual const char *	GetInvalidTargetDescription ()

virtual const char *	GetInvalidProcessDescription ()

virtual const char *	GetInvalidThreadDescription ()

virtual const char *	GetInvalidFrameDescription ()

virtual const char *	GetInvalidRegContextDescription ()

Target &	GetDummyTarget ()

Target &	GetTarget ()

Thread *	GetDefaultThread ()

bool	CheckRequirements (CommandReturnObject &result)
	Check the command to make sure anything required by this command is available.

void	Cleanup ()

Protected Attributes
OptionGroupOptions	m_option_group

OptionGroupVariable	m_option_variable

OptionGroupFormat	m_option_format

OptionGroupFileList	m_option_compile_units

OptionGroupFileList	m_option_shared_libraries

OptionGroupValueObjectDisplay	m_varobj_options

Protected Attributes inherited from lldb_private::CommandObject
CommandInterpreter &	m_interpreter

ExecutionContext	m_exe_ctx

std::unique_lock< std::recursive_mutex >	m_api_locker

std::string	m_cmd_name

std::string	m_cmd_help_short

std::string	m_cmd_help_long

std::string	m_cmd_syntax

Flags	m_flags

std::vector< CommandArgumentEntry >	m_arguments

lldb::CommandOverrideCallback	m_deprecated_command_override_callback

lldb_private::CommandOverrideCallbackWithResult	m_command_override_callback

void *	m_command_override_baton

bool	m_is_user_command = false

Static Private Attributes
static const uint32_t	SHORT_OPTION_FILE = 0x66696c65

static const uint32_t	SHORT_OPTION_SHLB = 0x73686c62

Additional Inherited Members
Public Types inherited from lldb_private::CommandObject
enum	IDType { eBreakpointArgs = 0 , eWatchpointArgs = 1 }

typedef llvm::StringRef()	ArgumentHelpCallbackFunction()

typedef std::vector< CommandArgumentData >	CommandArgumentEntry

typedef std::map< std::string, lldb::CommandObjectSP >	CommandMap

Detailed Description

Definition at line 696 of file CommandObjectTarget.cpp.

Constructor & Destructor Documentation

◆ CommandObjectTargetVariable()

CommandObjectTargetVariable::CommandObjectTargetVariable ( CommandInterpreter & interpreter )

inline

Definition at line 701 of file CommandObjectTarget.cpp.

References lldb_private::CommandObject::AddSimpleArgumentList(), lldb_private::OptionGroupOptions::Append(), lldb_private::eArgRepeatPlus, lldb::eArgTypeVarName, lldb_private::OptionGroupOptions::Finalize(), LLDB_OPT_SET_1, LLDB_OPT_SET_ALL, m_option_compile_units, m_option_format, m_option_group, m_option_shared_libraries, m_option_variable, m_varobj_options, lldb_private::OptionGroupFormat::OPTION_GROUP_FORMAT, and lldb_private::OptionGroupFormat::OPTION_GROUP_GDB_FMT.

◆ ~CommandObjectTargetVariable()

CommandObjectTargetVariable::~CommandObjectTargetVariable ( )

overridedefault

Member Function Documentation

◆ DoExecute()

void CommandObjectTargetVariable::DoExecute	(	Args &	args,
		CommandReturnObject &	result
	)

inlineoverrideprotectedvirtual

Implements lldb_private::CommandObjectParsed.

Definition at line 832 of file CommandObjectTarget.cpp.

◆ DumpGlobalVariableList()

void CommandObjectTargetVariable::DumpGlobalVariableList	(	const ExecutionContext &	exe_ctx,
		const SymbolContext &	sc,
		const VariableList &	variable_list,
		Stream &	s
	)

inlineprotected

Definition at line 804 of file CommandObjectTarget.cpp.

References lldb_private::SymbolContext::comp_unit, lldb_private::ValueObjectVariable::Create(), DumpValueObject(), lldb_private::VariableList::Empty(), lldb_private::Stream::Format(), lldb_private::ExecutionContext::GetBestExecutionContextScope(), lldb_private::CompileUnit::GetPrimaryFile(), lldb_private::SymbolContext::module_sp, and lldb_private::Stream::Printf().

Referenced by DoExecute().

◆ DumpValueObject()

void CommandObjectTargetVariable::DumpValueObject	(	Stream &	s,
		VariableSP &	var_sp,
		ValueObjectSP &	valobj_sp,
		const char *	root_name
	)

inline

◆ GetOptions()

Options * CommandObjectTargetVariable::GetOptions ( )

inlineoverridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 801 of file CommandObjectTarget.cpp.

References m_option_group.

◆ GetVariableCallback()

static size_t CommandObjectTargetVariable::GetVariableCallback	(	void *	baton,
		const char *	name,
		VariableList &	variable_list
	)

inlinestatic

Definition at line 791 of file CommandObjectTarget.cpp.

References lldb_private::ModuleList::FindGlobalVariables(), lldb_private::Target::GetImages(), lldb_private::VariableList::GetSize(), and UINT32_MAX.

Referenced by DoExecute().

Member Data Documentation

◆ m_option_compile_units

OptionGroupFileList CommandObjectTargetVariable::m_option_compile_units

protected

Definition at line 988 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetVariable(), and DoExecute().

◆ m_option_format

OptionGroupFormat CommandObjectTargetVariable::m_option_format

protected

Definition at line 987 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetVariable(), and DumpValueObject().

◆ m_option_group

OptionGroupOptions CommandObjectTargetVariable::m_option_group

protected

Definition at line 985 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetVariable(), and GetOptions().

◆ m_option_shared_libraries

OptionGroupFileList CommandObjectTargetVariable::m_option_shared_libraries

protected

Definition at line 989 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetVariable(), and DoExecute().

◆ m_option_variable

OptionGroupVariable CommandObjectTargetVariable::m_option_variable

protected

Definition at line 986 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetVariable(), DoExecute(), and DumpValueObject().

◆ m_varobj_options

OptionGroupValueObjectDisplay CommandObjectTargetVariable::m_varobj_options

protected

Definition at line 990 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetVariable(), and DumpValueObject().

◆ SHORT_OPTION_FILE

const uint32_t CommandObjectTargetVariable::SHORT_OPTION_FILE = 0x66696c65

staticprivate

Definition at line 697 of file CommandObjectTarget.cpp.

◆ SHORT_OPTION_SHLB

const uint32_t CommandObjectTargetVariable::SHORT_OPTION_SHLB = 0x73686c62

staticprivate

Definition at line 698 of file CommandObjectTarget.cpp.

The documentation for this class was generated from the following file:

CommandObjectTarget.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CommandObjectTargetVariable()

◆ ~CommandObjectTargetVariable()

Member Function Documentation

◆ DoExecute()

◆ DumpGlobalVariableList()

◆ DumpValueObject()

◆ GetOptions()

◆ GetVariableCallback()

Member Data Documentation

◆ m_option_compile_units

◆ m_option_format

◆ m_option_group

◆ m_option_shared_libraries

◆ m_option_variable

◆ m_varobj_options

◆ SHORT_OPTION_FILE

◆ SHORT_OPTION_SHLB