Inheritance diagram for CommandObjectFrameVariable:

Collaboration diagram for CommandObjectFrameVariable:

[legend]

Public Member Functions
	CommandObjectFrameVariable (CommandInterpreter &interpreter)

	~CommandObjectFrameVariable () override=default

Options *	GetOptions () override

void	HandleArgumentCompletion (CompletionRequest &request, OptionElementVector &opt_element_vector) override
	The input array contains a parsed version of the line. More...

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

bool	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)

virtual void	AproposAllSubCommands (llvm::StringRef prefix, llvm::StringRef search_word, StringList &commands_found, StringList &commands_help)

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	WantsCompletion ()

int	GetNumArgumentEntries ()

CommandArgumentEntry *	GetArgumentEntryAtIndex (int idx)

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

bool	IsPairType (ArgumentRepetitionType arg_repeat_type)

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. More...

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. More...

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

virtual const char *	GetRepeatCommand (Args &current_command_args, uint32_t index)
	Get the command that appropriate for a "repeat" of the current command. More...

bool	HasOverrideCallback () const

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

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

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

Protected Member Functions
llvm::StringRef	GetScopeString (VariableSP var_sp)

bool	DoExecute (Args &command, CommandReturnObject &result) override

Protected Member Functions inherited from lldb_private::CommandObjectParsed
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 &	GetSelectedOrDummyTarget (bool prefer_dummy=false)

Target &	GetSelectedTarget ()

Target &	GetDummyTarget ()

Thread *	GetDefaultThread ()

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

void	Cleanup ()

Protected Attributes
OptionGroupOptions	m_option_group

OptionGroupVariable	m_option_variable

OptionGroupFormat	m_option_format

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::CommandOverrideCallbackWithResult	m_command_override_callback

void *	m_command_override_baton

bool	m_is_user_command = false

Additional Inherited Members
Public Types inherited from lldb_private::CommandObject
typedef llvm::StringRef()	ArgumentHelpCallbackFunction()

typedef std::vector< CommandArgumentData >	CommandArgumentEntry

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

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 const ArgumentTableEntry *	GetArgumentTable ()

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 Public Attributes inherited from lldb_private::CommandObject
static ArgumentTableEntry	g_arguments_data [lldb::eArgTypeLastArg]

Static Protected Member Functions inherited from lldb_private::CommandObject
static void	AddIDsArgumentData (CommandArgumentEntry &arg, lldb::CommandArgumentType ID, lldb::CommandArgumentType IDRange)

Detailed Description

Definition at line 390 of file CommandObjectFrame.cpp.

Constructor & Destructor Documentation

◆ CommandObjectFrameVariable()

CommandObjectFrameVariable::CommandObjectFrameVariable ( CommandInterpreter & interpreter )

inline

Definition at line 392 of file CommandObjectFrame.cpp.

References lldb_private::CommandObject::CommandArgumentData::arg_repetition, lldb_private::CommandObject::CommandArgumentData::arg_type, lldb_private::eArgRepeatStar, lldb::eArgTypeVarName, LLDB_OPT_SET_1, and LLDB_OPT_SET_ALL.

◆ ~CommandObjectFrameVariable()

CommandObjectFrameVariable::~CommandObjectFrameVariable ( )

overridedefault

Member Function Documentation

◆ DoExecute()

bool CommandObjectFrameVariable::DoExecute	(	Args &	command,
		CommandReturnObject &	result
	)

inlineoverrideprotectedvirtual

Implements lldb_private::CommandObjectParsed.

Definition at line 477 of file CommandObjectFrame.cpp.

References lldb_private::VariableList::AppendVariablesIfUnique(), lldb::eFormatDefault, lldb_private::eLanguageRuntimeDescriptionDisplayVerbosityFull, lldb_private::Args::empty(), lldb::eReturnStatusSuccessFinishResult, error(), lldb::eValueTypeVariableArgument, lldb::eValueTypeVariableGlobal, lldb::eValueTypeVariableLocal, lldb::eValueTypeVariableStatic, lldb_private::SymbolContext::function, lldb_private::RegularExpression::GetError(), lldb_private::CommandReturnObject::GetErrorStream(), lldb_private::TargetStats::GetFrameVariableStats(), lldb_private::CommandReturnObject::GetOutputStream(), lldb_private::StackFrame::GetRecognizedFrame(), lldb_private::VariableList::GetSize(), lldb_private::StackFrame::GetSymbolContext(), lldb_private::StackFrame::GetValueForVariableExpressionPath(), lldb_private::StackFrame::GetValueObjectForFrameVariable(), lldb_private::VariableList::GetVariableAtIndex(), lldb_private::StackFrame::GetVariableList(), lldb_private::Function::IsTopLevelFunction(), lldb_private::RegularExpression::IsValid(), lldb_private::StatsSuccessFail::NotifyFailure(), lldb_private::StatsSuccessFail::NotifySuccess(), lldb_private::Stream::Printf(), lldb_private::Stream::PutCString(), lldb_private::DumpValueObjectOptions::SetFormat(), lldb_private::DumpValueObjectOptions::SetRootValueObjectName(), lldb_private::CommandReturnObject::SetStatus(), lldb_private::DumpValueObjectOptions::SetVariableFormatDisplayLanguage(), string(), lldb_private::CommandReturnObject::Succeeded(), and lldb_private::toString().

◆ GetOptions()

Options* CommandObjectFrameVariable::GetOptions ( )

inlineoverridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 443 of file CommandObjectFrame.cpp.

◆ GetScopeString()

llvm::StringRef CommandObjectFrameVariable::GetScopeString ( VariableSP var_sp )

inlineprotected

Definition at line 455 of file CommandObjectFrame.cpp.

References lldb::eValueTypeVariableArgument, lldb::eValueTypeVariableGlobal, lldb::eValueTypeVariableLocal, lldb::eValueTypeVariableStatic, and lldb::eValueTypeVariableThreadLocal.

◆ HandleArgumentCompletion()

void CommandObjectFrameVariable::HandleArgumentCompletion	(	CompletionRequest &	request,
		OptionElementVector &	opt_element_vector
	)

inlineoverridevirtual

The input array contains a parsed version of the line.

We've constructed the map of options and their arguments as well if that is helpful for the completion.

Parameters

[in,out] request The completion request that needs to be answered.

Reimplemented from lldb_private::CommandObject.

Definition at line 446 of file CommandObjectFrame.cpp.

Member Data Documentation

◆ m_option_format

OptionGroupFormat CommandObjectFrameVariable::m_option_format

protected

Definition at line 721 of file CommandObjectFrame.cpp.

◆ m_option_group

OptionGroupOptions CommandObjectFrameVariable::m_option_group

protected

Definition at line 719 of file CommandObjectFrame.cpp.

◆ m_option_variable

OptionGroupVariable CommandObjectFrameVariable::m_option_variable

protected

Definition at line 720 of file CommandObjectFrame.cpp.

◆ m_varobj_options

OptionGroupValueObjectDisplay CommandObjectFrameVariable::m_varobj_options

protected

Definition at line 722 of file CommandObjectFrame.cpp.

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

CommandObjectFrame.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CommandObjectFrameVariable()

◆ ~CommandObjectFrameVariable()

Member Function Documentation

◆ DoExecute()

◆ GetOptions()

◆ GetScopeString()

◆ HandleArgumentCompletion()

Member Data Documentation

◆ m_option_format

◆ m_option_group

◆ m_option_variable

◆ m_varobj_options