LLDB mainline
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CommandObjectMemoryRegion Class Reference
Inheritance diagram for CommandObjectMemoryRegion:
[legend]

Classes

class  OptionGroupMemoryRegion

Public Member Functions

 CommandObjectMemoryRegion (CommandInterpreter &interpreter)
 ~CommandObjectMemoryRegion () 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.
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

void DumpRegion (CommandReturnObject &result, Target &target, const MemoryRegionInfo &range_info, lldb::addr_t load_addr)
void DoExecute (Args &command, CommandReturnObject &result) override
std::optional< std::string > GetRepeatCommand (Args &current_command_args, uint32_t index) override
 Get the command that appropriate for a "repeat" of the current command.
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

lldb::addr_t m_prev_end_addr = LLDB_INVALID_ADDRESS
OptionGroupOptions m_option_group
OptionGroupMemoryRegion m_memory_region_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 1617 of file CommandObjectMemory.cpp.

Constructor & Destructor Documentation

◆ CommandObjectMemoryRegion()

CommandObjectMemoryRegion::CommandObjectMemoryRegion ( CommandInterpreter & interpreter)
inline

Definition at line 1653 of file CommandObjectMemory.cpp.

References lldb_private::CommandObjectParsed::CommandObjectParsed(), lldb_private::eArgRepeatPlain, lldb::eArgTypeAddressOrExpression, LLDB_OPT_SET_1, lldb_private::CommandObject::m_arguments, m_memory_region_options, and m_option_group.

◆ ~CommandObjectMemoryRegion()

CommandObjectMemoryRegion::~CommandObjectMemoryRegion ( )
overridedefault

Member Function Documentation

◆ DoExecute()

void CommandObjectMemoryRegion::DoExecute ( Args & command,
CommandReturnObject & result )
inlineoverrideprotectedvirtual

Implements lldb_private::CommandObjectParsed.

Definition at line 1723 of file CommandObjectMemory.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb_private::CommandReturnObject::AppendErrorWithFormat(), DumpRegion(), lldb::eReturnStatusSuccessFinishResult, error(), lldb_private::Args::GetArgumentCount(), lldb_private::MemoryRegionInfo::GetRange(), lldb_private::Range< B, S >::GetRangeEnd(), LLDB_INVALID_ADDRESS, lldb_private::CommandObject::m_cmd_name, lldb_private::CommandObject::m_cmd_syntax, lldb_private::CommandObject::m_exe_ctx, m_memory_region_options, m_prev_end_addr, lldb_private::CommandReturnObject::SetStatus(), and lldb_private::OptionArgParser::ToAddress().

◆ DumpRegion()

void CommandObjectMemoryRegion::DumpRegion ( CommandReturnObject & result,
Target & target,
const MemoryRegionInfo & range_info,
lldb::addr_t load_addr )
inlineprotected

Definition at line 1673 of file CommandObjectMemory.cpp.

References lldb_private::CommandReturnObject::AppendMessage(), lldb_private::CommandReturnObject::AppendMessageWithFormat(), lldb_private::CommandReturnObject::AppendMessageWithFormatv(), lldb_private::MemoryRegionInfo::eYes, lldb_private::MemoryRegionInfo::GetDirtyPageList(), lldb_private::MemoryRegionInfo::GetExecutable(), lldb_private::MemoryRegionInfo::GetMemoryTagged(), lldb_private::MemoryRegionInfo::GetName(), lldb_private::MemoryRegionInfo::GetRange(), lldb_private::Range< B, S >::GetRangeBase(), lldb_private::Range< B, S >::GetRangeEnd(), lldb_private::MemoryRegionInfo::GetReadable(), lldb_private::Address::GetSection(), lldb_private::MemoryRegionInfo::GetWritable(), lldb_private::MemoryRegionInfo::IsShadowStack(), and lldb_private::Target::ResolveLoadAddress().

Referenced by DoExecute().

◆ GetOptions()

Options * CommandObjectMemoryRegion::GetOptions ( )
inlineoverridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 1670 of file CommandObjectMemory.cpp.

References m_option_group.

◆ GetRepeatCommand()

std::optional< std::string > CommandObjectMemoryRegion::GetRepeatCommand ( Args & current_command_args,
uint32_t index )
inlineoverrideprotectedvirtual

Get the command that appropriate for a "repeat" of the current command.

Parameters
[in]current_command_argsThe command arguments.
[in]indexThis is for internal use - it is how the completion request is tracked in CommandObjectMultiword, and should otherwise be ignored.
Returns
std::nullopt if there is no special repeat command - it will use the current command line. Otherwise a std::string containing the command to be repeated. If the string is empty, the command won't be allow repeating.

Reimplemented from lldb_private::CommandObject.

Definition at line 1814 of file CommandObjectMemory.cpp.

References lldb_private::CommandObject::m_cmd_name.

Member Data Documentation

◆ m_memory_region_options

OptionGroupMemoryRegion CommandObjectMemoryRegion::m_memory_region_options
protected

Definition at line 1824 of file CommandObjectMemory.cpp.

Referenced by CommandObjectMemoryRegion(), and DoExecute().

◆ m_option_group

OptionGroupOptions CommandObjectMemoryRegion::m_option_group
protected

Definition at line 1823 of file CommandObjectMemory.cpp.

Referenced by CommandObjectMemoryRegion(), and GetOptions().

◆ m_prev_end_addr

lldb::addr_t CommandObjectMemoryRegion::m_prev_end_addr = LLDB_INVALID_ADDRESS
protected

Definition at line 1821 of file CommandObjectMemory.cpp.

Referenced by DoExecute().

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