Inheritance diagram for CommandObjectRegisterRead:

[legend]

Classes
class	CommandOptions

Public Member Functions
	CommandObjectRegisterRead (CommandInterpreter &interpreter)

	~CommandObjectRegisterRead () override=default

void	HandleArgumentCompletion (CompletionRequest &request, OptionElementVector &opt_element_vector) override
	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.

Options *	GetOptions () override

bool	DumpRegister (const ExecutionContext &exe_ctx, Stream &strm, RegisterContext &reg_ctx, const RegisterInfo &reg_info, bool print_flags)

bool	DumpRegisterSet (const ExecutionContext &exe_ctx, Stream &strm, RegisterContext *reg_ctx, size_t set_idx, bool primitive_only=false)

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

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
OptionGroupOptions	m_option_group

OptionGroupFormat	m_format_options

CommandOptions	m_command_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 39 of file CommandObjectRegister.cpp.

Constructor & Destructor Documentation

◆ CommandObjectRegisterRead()

CommandObjectRegisterRead::CommandObjectRegisterRead ( CommandInterpreter & interpreter )

inline

Definition at line 41 of file CommandObjectRegister.cpp.

◆ ~CommandObjectRegisterRead()

CommandObjectRegisterRead::~CommandObjectRegisterRead ( )

overridedefault

Member Function Documentation

◆ DoExecute()

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

inlineoverrideprotectedvirtual

Implements lldb_private::CommandObjectParsed.

Definition at line 150 of file CommandObjectRegister.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb_private::CommandReturnObject::AppendErrorWithFormat(), lldb_private::CommandReturnObject::AppendErrorWithFormatv(), CommandObjectRegisterRead::CommandOptions::dump_all_sets, DumpRegister(), DumpRegisterSet(), lldb_private::Args::GetArgumentCount(), lldb_private::OptionValueBoolean::GetCurrentValue(), lldb_private::OptionGroupFormat::GetFormatValue(), lldb_private::CommandReturnObject::GetOutputStream(), lldb_private::ExecutionContext::GetRegisterContext(), lldb_private::RegisterContext::GetRegisterInfoByName(), lldb_private::RegisterContext::GetRegisterSetCount(), lldb_private::OptionValueArray::GetSize(), lldb_private::OptionValue::GetValueAs(), m_command_options, lldb_private::CommandObject::m_exe_ctx, m_format_options, lldb_private::OptionValue::OptionWasSet(), lldb_private::Stream::Printf(), CommandObjectRegisterRead::CommandOptions::set_indexes, and UINT32_MAX.

◆ DumpRegister()

bool CommandObjectRegisterRead::DumpRegister	(	const ExecutionContext &	exe_ctx,
		Stream &	strm,
		RegisterContext &	reg_ctx,
		const RegisterInfo &	reg_info,
		bool	print_flags
	)

inline

Definition at line 76 of file CommandObjectRegister.cpp.

References CommandObjectRegisterRead::CommandOptions::alternate_name, lldb_private::RegisterInfo::byte_size, lldb_private::Address::Dump(), lldb_private::DumpRegisterValue(), lldb_private::Address::DumpStyleResolvedDescription, lldb::eEncodingSint, lldb::eEncodingUint, lldb_private::RegisterInfo::encoding, lldb_private::Stream::EOL(), lldb_private::Process::GetAddressByteSize(), lldb_private::RegisterValue::GetAsUInt64(), lldb_private::ExecutionContext::GetBestExecutionContextScope(), lldb_private::OptionGroupFormat::GetFormat(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::Target::GetSectionLoadList(), lldb_private::ExecutionContext::GetTargetRef(), lldb_private::ExecutionContext::GetTargetSP(), lldb_private::Stream::Indent(), LLDB_INVALID_ADDRESS, m_command_options, m_format_options, lldb_private::Stream::PutCString(), lldb_private::RegisterContext::ReadRegister(), and lldb_private::SectionLoadList::ResolveLoadAddress().

Referenced by DoExecute(), and DumpRegisterSet().

◆ DumpRegisterSet()

bool CommandObjectRegisterRead::DumpRegisterSet	(	const ExecutionContext &	exe_ctx,
		Stream &	strm,
		RegisterContext *	reg_ctx,
		size_t	set_idx,
		bool	primitive_only = `false`
	)

inline

Definition at line 111 of file CommandObjectRegister.cpp.

References DumpRegister(), lldb_private::Stream::EOL(), lldb_private::RegisterContext::GetRegisterInfoAtIndex(), lldb_private::RegisterContext::GetRegisterSet(), lldb_private::Stream::Indent(), lldb_private::Stream::IndentLess(), lldb_private::Stream::IndentMore(), lldb_private::RegisterSet::name, lldb_private::RegisterSet::num_registers, lldb_private::Stream::Printf(), lldb_private::RegisterSet::registers, and lldb_private::RegisterInfo::value_regs.

Referenced by DoExecute().

◆ GetOptions()

Options * CommandObjectRegisterRead::GetOptions ( )

inlineoverridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 74 of file CommandObjectRegister.cpp.

References m_option_group.

◆ HandleArgumentCompletion()

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

inlineoverridevirtual

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.

Override this if you have a more complex argument setup. FIXME: we should be able to extend this to more complex argument definitions provided we have completers for all the argument types.

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 67 of file CommandObjectRegister.cpp.

References lldb_private::CommandObject::HandleArgumentCompletion(), lldb_private::ExecutionContext::HasProcessScope(), and lldb_private::CommandObject::m_exe_ctx.

Member Data Documentation

◆ m_command_options

CommandOptions CommandObjectRegisterRead::m_command_options

protected

Definition at line 285 of file CommandObjectRegister.cpp.

Referenced by DoExecute(), and DumpRegister().

◆ m_format_options

OptionGroupFormat CommandObjectRegisterRead::m_format_options

protected

Definition at line 284 of file CommandObjectRegister.cpp.

Referenced by DoExecute(), and DumpRegister().

◆ m_option_group

OptionGroupOptions CommandObjectRegisterRead::m_option_group

protected

Definition at line 283 of file CommandObjectRegister.cpp.

Referenced by GetOptions().

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

CommandObjectRegister.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CommandObjectRegisterRead()

◆ ~CommandObjectRegisterRead()

Member Function Documentation

◆ DoExecute()

◆ DumpRegister()

◆ DumpRegisterSet()

◆ GetOptions()

◆ HandleArgumentCompletion()

Member Data Documentation

◆ m_command_options

◆ m_format_options

◆ m_option_group