Inheritance diagram for CommandObjectFrameVariable:

[legend]

Public Member Functions
	CommandObjectFrameVariable (CommandInterpreter &interpreter)
	~CommandObjectFrameVariable () override=default
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	WantsCompletion ()
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)
void	SetOriginalCommandString (std::string s)
	Set the command input as it appeared in the terminal.

Protected Member Functions
llvm::StringRef	GetScopeString (VariableSP var_sp)
bool	ScopeRequested (lldb::ValueType scope)
	Returns true if scope matches any of the options in m_option_variable.
std::optional< llvm::ArrayRef< VariableSP > >	findUniqueRegexMatches (RegularExpression &regex, VariableList &matches, const VariableList &all_variables)
	Finds all the variables in all_variables whose name matches regex, inserting them into matches.
void	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 &	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
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
std::string	m_original_command
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

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, std::less<> >	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 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)

Detailed Description

Definition at line 395 of file CommandObjectFrame.cpp.

Constructor & Destructor Documentation

◆ CommandObjectFrameVariable()

CommandObjectFrameVariable::CommandObjectFrameVariable ( CommandInterpreter & interpreter )

inline

Definition at line 397 of file CommandObjectFrame.cpp.

References lldb_private::CommandObject::AddSimpleArgumentList(), lldb_private::CommandObjectParsed::CommandObjectParsed(), lldb_private::eArgRepeatStar, lldb::eArgTypeVarName, lldb::eFormatDefault, m_option_format, m_option_variable, and lldb_private::CommandObject::SetHelpLong().

◆ ~CommandObjectFrameVariable()

CommandObjectFrameVariable::~CommandObjectFrameVariable ( )

overridedefault

References LLDB_OPT_SET_1, LLDB_OPT_SET_ALL, m_option_group, and m_option_variable.

Member Function Documentation

◆ DoExecute()

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

inlineoverrideprotectedvirtual

Implements lldb_private::CommandObjectParsed.

Definition at line 497 of file CommandObjectFrame.cpp.

◆ findUniqueRegexMatches()

std::optional< llvm::ArrayRef< VariableSP > > CommandObjectFrameVariable::findUniqueRegexMatches	(	RegularExpression &	regex,
		VariableList &	matches,
		const VariableList &	all_variables )

inlineprotected

Finds all the variables in all_variables whose name matches regex, inserting them into matches.

Variables already contained in matches are not inserted again. Nullopt is returned in case of no matches. A sub-range of matches with all newly inserted variables is returned. This may be empty if all matches were already contained in matches.

Definition at line 479 of file CommandObjectFrame.cpp.