CommandObjectTargetModulesList Class Reference

Inheritance diagram for CommandObjectTargetModulesList:

Classes
class	CommandOptions

Public Member Functions
	CommandObjectTargetModulesList (CommandInterpreter &interpreter)
	~CommandObjectTargetModulesList () 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	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

Protected Member Functions
void	DoExecute (Args &command, CommandReturnObject &result) override
void	PrintModule (Target &target, Module *module, int indent, Stream &strm)
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
CommandOptions	m_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

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
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 3112 of file CommandObjectTarget.cpp.

Constructor & Destructor Documentation

CommandObjectTargetModulesList()

CommandObjectTargetModulesList::CommandObjectTargetModulesList ( CommandInterpreter &  interpreter )

inline

Definition at line 3155 of file CommandObjectTarget.cpp.

References lldb_private::CommandObject::AddSimpleArgumentList(), lldb_private::eArgRepeatStar, and lldb::eArgTypeModule.

~CommandObjectTargetModulesList()

CommandObjectTargetModulesList::~CommandObjectTargetModulesList ( )

overridedefault

Member Function Documentation

DoExecute()

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

inlineoverrideprotectedvirtual

Implements lldb_private::CommandObjectParsed.

Definition at line 3167 of file CommandObjectTarget.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb_private::CommandReturnObject::AppendErrorWithFormat(), lldb::eReturnStatusSuccessFinishResult, FindModulesByName(), lldb_private::ArchSpec::GetAddressByteSize(), lldb_private::Module::GetAllocatedModuleAtIndex(), lldb_private::Module::GetAllocationModuleCollectionMutex(), lldb_private::Target::GetArchitecture(), lldb_private::Args::GetArgumentCount(), lldb_private::CommandReturnObject::GetErrorStream(), lldb_private::Target::GetImages(), lldb_private::Address::GetModule(), lldb_private::ModuleList::GetModuleAtIndexUnlocked(), lldb_private::ModuleList::GetMutex(), lldb_private::Module::GetNumberAllocatedModules(), lldb_private::CommandReturnObject::GetOutputStream(), lldb_private::ModuleList::GetSize(), lldb_private::CommandObject::GetTarget(), LLDB_INVALID_ADDRESS, CommandObjectTargetModulesList::CommandOptions::m_module_addr, m_options, CommandObjectTargetModulesList::CommandOptions::m_use_global_module_list, lldb_private::Stream::Printf(), PrintModule(), lldb_private::Stream::SetAddressByteSize(), lldb_private::Address::SetLoadAddress(), and lldb_private::CommandReturnObject::SetStatus().

GetOptions()

Options * CommandObjectTargetModulesList::GetOptions ( )

inlineoverridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 3164 of file CommandObjectTarget.cpp.

References m_options.

PrintModule()

void CommandObjectTargetModulesList::PrintModule ( Target &  target, Module *  module, int  indent, Stream &  strm  )

inlineprotected

Definition at line 3277 of file CommandObjectTarget.cpp.

References lldb_private::Address::Dump(), DumpBasename(), DumpDirectory(), DumpFullpath(), DumpModuleArchitecture(), DumpModuleUUID(), lldb_private::Address::DumpStyleFileAddress, lldb_private::Address::DumpStyleModuleWithFileAddress, lldb_private::Stream::EOL(), lldb_private::Stream::Format(), lldb_private::ArchSpec::GetAddressByteSize(), lldb_private::Target::GetArchitecture(), lldb_private::ObjectFile::GetBaseAddress(), lldb_private::ConstString::GetCString(), lldb_private::Address::GetFileAddress(), lldb_private::Module::GetFileSpec(), lldb_private::Address::GetLoadAddress(), lldb_private::Module::GetModificationTime(), lldb_private::Module::GetObjectFile(), lldb_private::Module::GetObjectName(), lldb_private::Target::GetSectionLoadList(), lldb_private::Module::GetSymbolFile(), lldb_private::SectionLoadList::IsEmpty(), lldb_private::Address::IsValid(), LLDB_INVALID_ADDRESS, CommandObjectTargetModulesList::CommandOptions::m_format_array, m_options, lldb_private::ModuleList::ModuleIsInCache(), lldb_private::Stream::Printf(), lldb_private::Stream::PutChar(), and lldb_private::Stream::PutCString().

Referenced by DoExecute().

Member Data Documentation

m_options

CommandOptions CommandObjectTargetModulesList::m_options

protected

Definition at line 3425 of file CommandObjectTarget.cpp.

Referenced by DoExecute(), GetOptions(), and PrintModule().

---

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

• CommandObjectTarget.cpp