lldb_private::CommandObjectProxy Class Reference

#include <CommandObjectMultiword.h>

Inheritance diagram for lldb_private::CommandObjectProxy:

Collaboration diagram for lldb_private::CommandObjectProxy:

Public Member Functions
	CommandObjectProxy (CommandInterpreter &interpreter, const char *name, const char *help=nullptr, const char *syntax=nullptr, uint32_t flags=0)
	~CommandObjectProxy () override
virtual CommandObject *	GetProxyCommandObject ()=0
llvm::StringRef	GetSyntax () override
llvm::StringRef	GetHelp () override
llvm::StringRef	GetHelpLong () override
bool	IsRemovable () const override
bool	IsMultiwordObject () override
CommandObjectMultiword *	GetAsMultiwordCommand () override
void	GenerateHelpText (Stream &result) override
lldb::CommandObjectSP	GetSubcommandSP (llvm::StringRef sub_cmd, StringList *matches=nullptr) override
CommandObject *	GetSubcommandObject (llvm::StringRef sub_cmd, StringList *matches=nullptr) override
void	AproposAllSubCommands (llvm::StringRef prefix, llvm::StringRef search_word, StringList &commands_found, StringList &commands_help) override
bool	LoadSubCommand (llvm::StringRef cmd_name, const lldb::CommandObjectSP &command_obj) override
bool	WantsRawCommandString () override
bool	WantsCompletion () override
Options *	GetOptions () override
void	HandleCompletion (CompletionRequest &request) override
	This default version handles calling option argument completions and then calls HandleArgumentCompletion if the cursor is on an argument, not an option. More...
void	HandleArgumentCompletion (CompletionRequest &request, OptionElementVector &opt_element_vector) override
	The input array contains a parsed version of the line. More...
const char *	GetRepeatCommand (Args &current_command_args, uint32_t index) override
	Get the command that appropriate for a "repeat" of the current command. More...
virtual llvm::StringRef	GetUnsupportedError ()
bool	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 ()
llvm::StringRef	GetCommandName () const
virtual void	SetHelp (llvm::StringRef str)
virtual void	SetHelpLong (llvm::StringRef str)
void	SetSyntax (llvm::StringRef str)
bool	IsUserCommand ()
void	SetIsUserCommand (bool is_user)
virtual bool	IsAlias ()
virtual bool	IsDashDashCommand ()
virtual lldb::CommandObjectSP	GetSubcommandSPExact (llvm::StringRef sub_cmd)
void	FormatLongHelpText (Stream &output_strm, llvm::StringRef long_help)
void	GenerateHelpText (CommandReturnObject &result)
virtual llvm::Error	LoadUserSubcommand (llvm::StringRef cmd_name, const lldb::CommandObjectSP &command_obj, bool can_replace)
int	GetNumArgumentEntries ()
CommandArgumentEntry *	GetArgumentEntryAtIndex (int idx)
void	GetFormattedCommandArguments (Stream &str, uint32_t opt_set_mask=LLDB_OPT_SET_ALL)
bool	IsPairType (ArgumentRepetitionType arg_repeat_type)
bool	ParseOptions (Args &args, CommandReturnObject &result)
void	SetCommandName (llvm::StringRef name)
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. More...
const Flags &	GetFlags () const
	The flags const accessor. More...
bool	HasOverrideCallback () const
void	SetOverrideCallback (lldb::CommandOverrideCallback callback, void *baton)
void	SetOverrideCallback (lldb::CommandOverrideCallbackWithResult callback, void *baton)
bool	InvokeOverrideCallback (const char **argv, CommandReturnObject &result)

Friends
class	CommandInterpreter
class	CommandObjectSyntax

Additional Inherited Members
Public Types inherited from lldb_private::CommandObject
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 const ArgumentTableEntry *	GetArgumentTable ()
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 Public Attributes inherited from lldb_private::CommandObject
static ArgumentTableEntry	g_arguments_data [lldb::eArgTypeLastArg]
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 &	GetSelectedOrDummyTarget (bool prefer_dummy=false)
Target &	GetSelectedTarget ()
Target &	GetDummyTarget ()
Thread *	GetDefaultThread ()
bool	CheckRequirements (CommandReturnObject &result)
	Check the command to make sure anything required by this command is available. More...
void	Cleanup ()
Static Protected Member Functions inherited from lldb_private::CommandObject
static void	AddIDsArgumentData (CommandArgumentEntry &arg, lldb::CommandArgumentType ID, lldb::CommandArgumentType IDRange)
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::CommandOverrideCallbackWithResult	m_command_override_callback
void *	m_command_override_baton
bool	m_is_user_command = false

Detailed Description

Definition at line 81 of file CommandObjectMultiword.h.

Constructor & Destructor Documentation

CommandObjectProxy()

CommandObjectProxy::CommandObjectProxy	(	CommandInterpreter &	interpreter,
		const char *	name,
		const char *	help = nullptr,
		const char *	syntax = nullptr,
		uint32_t	flags = 0
	)

Definition at line 330 of file CommandObjectMultiword.cpp.

~CommandObjectProxy()

CommandObjectProxy::~CommandObjectProxy ( )

overridedefault

Member Function Documentation

AproposAllSubCommands()

void CommandObjectProxy::AproposAllSubCommands ( llvm::StringRef  prefix, llvm::StringRef  search_word, StringList &  commands_found, StringList &  commands_help  )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 412 of file CommandObjectMultiword.cpp.

References lldb_private::CommandObject::AproposAllSubCommands(), and GetProxyCommandObject().

Execute()

bool CommandObjectProxy::Execute ( const char *  args_string, CommandReturnObject &  result  )

overridevirtual

Implements lldb_private::CommandObject.

Definition at line 469 of file CommandObjectMultiword.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb_private::CommandObject::Execute(), GetProxyCommandObject(), and GetUnsupportedError().

GenerateHelpText()

void CommandObjectProxy::GenerateHelpText ( Stream &  result )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 387 of file CommandObjectMultiword.cpp.

References lldb_private::CommandObject::GenerateHelpText(), and GetProxyCommandObject().

GetAsMultiwordCommand()

CommandObjectMultiword * CommandObjectProxy::GetAsMultiwordCommand ( )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 380 of file CommandObjectMultiword.cpp.

References lldb_private::CommandObject::GetAsMultiwordCommand(), and GetProxyCommandObject().

GetHelp()

llvm::StringRef CommandObjectProxy::GetHelp ( )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 344 of file CommandObjectMultiword.cpp.

References lldb_private::CommandObject::GetHelp(), and GetProxyCommandObject().

GetHelpLong()

llvm::StringRef CommandObjectProxy::GetHelpLong ( )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 358 of file CommandObjectMultiword.cpp.

References lldb_private::CommandObject::GetHelpLong(), and GetProxyCommandObject().

GetOptions()

Options * CommandObjectProxy::GetOptions ( )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 337 of file CommandObjectMultiword.cpp.

References lldb_private::CommandObject::GetOptions(), and GetProxyCommandObject().

GetProxyCommandObject()

virtual CommandObject* lldb_private::CommandObjectProxy::GetProxyCommandObject ( )

pure virtual

Implemented in CommandObjectProcessPlugin, and lldb_private::CommandObjectTraceProxy.

Referenced by AproposAllSubCommands(), Execute(), GenerateHelpText(), GetAsMultiwordCommand(), GetHelp(), GetHelpLong(), GetOptions(), GetRepeatCommand(), GetSubcommandObject(), GetSubcommandSP(), GetSyntax(), HandleArgumentCompletion(), HandleCompletion(), IsMultiwordObject(), IsRemovable(), LoadSubCommand(), WantsCompletion(), and WantsRawCommandString().

GetRepeatCommand()

const char * CommandObjectProxy::GetRepeatCommand ( Args &  current_command_args, uint32_t  index  )

overridevirtual

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

Parameters

[in]

current_command_args

The command arguments.

Returns

nullptr if there is no special repeat command - it will use the current command line. Otherwise a pointer to the command to be repeated. If the returned string is the empty string, the command won't be repeated.

Reimplemented from lldb_private::CommandObject.

Definition at line 457 of file CommandObjectMultiword.cpp.

References GetProxyCommandObject(), and lldb_private::CommandObject::GetRepeatCommand().

GetSubcommandObject()

CommandObject * CommandObjectProxy::GetSubcommandObject ( llvm::StringRef  sub_cmd, StringList *  matches = nullptr  )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 404 of file CommandObjectMultiword.cpp.

References GetProxyCommandObject(), and lldb_private::CommandObject::GetSubcommandObject().

GetSubcommandSP()

lldb::CommandObjectSP CommandObjectProxy::GetSubcommandSP ( llvm::StringRef  sub_cmd, StringList *  matches = nullptr  )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 396 of file CommandObjectMultiword.cpp.

References GetProxyCommandObject(), and lldb_private::CommandObject::GetSubcommandSP().

GetSyntax()

llvm::StringRef CommandObjectProxy::GetSyntax ( )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 351 of file CommandObjectMultiword.cpp.

References GetProxyCommandObject(), and lldb_private::CommandObject::GetSyntax().

GetUnsupportedError()

llvm::StringRef CommandObjectProxy::GetUnsupportedError ( )

virtual

Returns

An error message to be displayed when the command is executed (i.e. Execute is called) and GetProxyCommandObject returned null.

Reimplemented in lldb_private::CommandObjectTraceProxy.

Definition at line 465 of file CommandObjectMultiword.cpp.

Referenced by Execute().

HandleArgumentCompletion()

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

overridevirtual

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 450 of file CommandObjectMultiword.cpp.

References GetProxyCommandObject(), and lldb_private::CommandObject::HandleArgumentCompletion().

HandleCompletion()

void CommandObjectProxy::HandleCompletion ( CompletionRequest &  request )

overridevirtual

This default version handles calling option argument completions and then calls HandleArgumentCompletion if the cursor is on an argument, not an option.

Don't override this method, override HandleArgumentCompletion instead unless you have special reasons.

Parameters

[in,out]

request

The completion request that needs to be answered.

Reimplemented from lldb_private::CommandObject.

Definition at line 444 of file CommandObjectMultiword.cpp.

References GetProxyCommandObject(), and lldb_private::CommandObject::HandleCompletion().

IsMultiwordObject()

bool CommandObjectProxy::IsMultiwordObject ( )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 373 of file CommandObjectMultiword.cpp.

References GetProxyCommandObject(), and lldb_private::CommandObject::IsMultiwordObject().

IsRemovable()

bool CommandObjectProxy::IsRemovable ( ) const

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 365 of file CommandObjectMultiword.cpp.

References GetProxyCommandObject(), and lldb_private::CommandObject::IsRemovable().

LoadSubCommand()

bool CommandObjectProxy::LoadSubCommand ( llvm::StringRef  cmd_name, const lldb::CommandObjectSP &  command_obj  )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 422 of file CommandObjectMultiword.cpp.

References GetProxyCommandObject(), and lldb_private::CommandObject::LoadSubCommand().

WantsCompletion()

bool CommandObjectProxy::WantsCompletion ( )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 437 of file CommandObjectMultiword.cpp.

References GetProxyCommandObject(), and lldb_private::CommandObject::WantsCompletion().

WantsRawCommandString()

bool CommandObjectProxy::WantsRawCommandString ( )

overridevirtual

Implements lldb_private::CommandObject.

Definition at line 430 of file CommandObjectMultiword.cpp.

References GetProxyCommandObject(), and lldb_private::CommandObject::WantsRawCommandString().

Friends And Related Function Documentation

CommandInterpreter

friend class CommandInterpreter

friend

Definition at line 145 of file CommandObjectMultiword.h.

CommandObjectSyntax

friend class CommandObjectSyntax

friend

Definition at line 146 of file CommandObjectMultiword.h.

---

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

• CommandObjectMultiword.h
• CommandObjectMultiword.cpp