LLDB mainline
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Private Attributes | List of all members
CommandObjectTargetVariable Class Reference
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 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.

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, CommandReturnObject &result)
void DoExecute (Args &args, 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
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
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

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

Detailed Description

Definition at line 695 of file CommandObjectTarget.cpp.

Constructor & Destructor Documentation

◆ CommandObjectTargetVariable()

CommandObjectTargetVariable::CommandObjectTargetVariable ( CommandInterpreter & interpreter)
inline

Definition at line 700 of file CommandObjectTarget.cpp.

References lldb_private::CommandObject::AddSimpleArgumentList(), lldb_private::CommandObjectParsed::CommandObjectParsed(), lldb_private::eArgRepeatPlus, lldb::eArgTypeFilename, lldb::eArgTypeVarName, lldb::eFormatDefault, 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, lldb_private::OptionGroupFormat::OPTION_GROUP_GDB_FMT, SHORT_OPTION_FILE, and SHORT_OPTION_SHLB.

◆ ~CommandObjectTargetVariable()

CommandObjectTargetVariable::~CommandObjectTargetVariable ( )
overridedefault

Member Function Documentation

◆ DoExecute()

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

Implements lldb_private::CommandObjectParsed.

Definition at line 835 of file CommandObjectTarget.cpp.

References lldb_private::SymbolContextList::Append(), lldb_private::CommandReturnObject::AppendError(), lldb_private::CommandReturnObject::AppendErrorWithFormat(), lldb_private::CommandReturnObject::AppendErrorWithFormatv(), lldb_private::SymbolContext::comp_unit, lldb_private::ValueObjectVariable::Create(), DumpGlobalVariableList(), DumpValueObject(), error(), lldb_private::ModuleList::FindCompileUnits(), lldb_private::ModuleList::FindFirstModule(), lldb_private::ModuleList::FindGlobalVariables(), lldb_private::Args::GetArgumentCount(), lldb_private::CommandReturnObject::GetErrorStream(), lldb_private::FileSpecList::GetFileSpecAtIndex(), lldb_private::StackFrame::GetFrameIndex(), lldb_private::Target::GetImages(), lldb_private::CommandReturnObject::GetOutputStream(), lldb_private::FileSpec::GetPath(), lldb_private::CompileUnit::GetPrimaryFile(), lldb_private::FileSpecList::GetSize(), lldb_private::VariableList::GetSize(), lldb_private::StackFrame::GetSymbolContext(), lldb_private::ValueObjectList::GetValueObjectAtIndex(), lldb_private::Variable::GetValuesForVariableExpressionPath(), lldb_private::VariableList::GetVariableAtIndex(), GetVariableCallback(), lldb_private::CompileUnit::GetVariableList(), lldb_private::RegularExpression::IsValid(), lldb_private::CommandObject::m_cmd_name, lldb_private::CommandObject::m_exe_ctx, lldb_private::CommandObject::m_interpreter, m_option_compile_units, m_option_shared_libraries, m_option_variable, lldb_private::SymbolContext::module_sp, lldb_private::Stream::Printf(), and UINT32_MAX.

◆ DumpGlobalVariableList()

void CommandObjectTargetVariable::DumpGlobalVariableList ( const ExecutionContext & exe_ctx,
const SymbolContext & sc,
const VariableList & variable_list,
CommandReturnObject & result )
inlineprotected

Definition at line 803 of file CommandObjectTarget.cpp.

References lldb_private::ValueObjectList::Append(), lldb_private::SymbolContext::comp_unit, lldb_private::ValueObjectVariable::Create(), DumpValueObject(), lldb_private::VariableList::Empty(), lldb_private::Stream::Format(), lldb_private::ExecutionContext::GetBestExecutionContextScope(), lldb_private::CommandReturnObject::GetOutputStream(), lldb_private::CompileUnit::GetPrimaryFile(), lldb_private::CommandReturnObject::GetValueObjectList(), 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

Definition at line 735 of file CommandObjectTarget.cpp.

References lldb::eFormatDefault, error(), lldb::eValueTypeVariableArgument, lldb::eValueTypeVariableGlobal, lldb::eValueTypeVariableLocal, lldb::eValueTypeVariableStatic, lldb::eValueTypeVariableThreadLocal, m_option_format, m_option_variable, m_varobj_options, lldb_private::Stream::PutCString(), lldb_private::DumpValueObjectOptions::SetFormat(), lldb_private::DumpValueObjectOptions::SetRootValueObjectName(), and lldb_private::toString().

Referenced by DoExecute(), and DumpGlobalVariableList().

◆ GetOptions()

Options * CommandObjectTargetVariable::GetOptions ( )
inlineoverridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 800 of file CommandObjectTarget.cpp.

References m_option_group.

◆ GetVariableCallback()

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

Definition at line 790 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 992 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetVariable(), and DoExecute().

◆ m_option_format

OptionGroupFormat CommandObjectTargetVariable::m_option_format
protected

Definition at line 991 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetVariable(), and DumpValueObject().

◆ m_option_group

OptionGroupOptions CommandObjectTargetVariable::m_option_group
protected

Definition at line 989 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetVariable(), and GetOptions().

◆ m_option_shared_libraries

OptionGroupFileList CommandObjectTargetVariable::m_option_shared_libraries
protected

Definition at line 993 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetVariable(), and DoExecute().

◆ m_option_variable

OptionGroupVariable CommandObjectTargetVariable::m_option_variable
protected

Definition at line 990 of file CommandObjectTarget.cpp.

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

◆ m_varobj_options

OptionGroupValueObjectDisplay CommandObjectTargetVariable::m_varobj_options
protected

Definition at line 994 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetVariable(), and DumpValueObject().

◆ SHORT_OPTION_FILE

const uint32_t CommandObjectTargetVariable::SHORT_OPTION_FILE = 0x66696c65
staticprivate

Definition at line 696 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetVariable().

◆ SHORT_OPTION_SHLB

const uint32_t CommandObjectTargetVariable::SHORT_OPTION_SHLB = 0x73686c62
staticprivate

Definition at line 697 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetVariable().

The documentation for this class was generated from the following file:
Generated on for LLDB by doxygen 1.14.0