#include <CommandObjectMultiword.h>

Inherits lldb_private::CommandObject.

Public Member Functions
	CommandObjectMultiword (CommandInterpreter &interpreter, const char name, const char help=nullptr, const char *syntax=nullptr, uint32_t flags=0)

	~CommandObjectMultiword () override

bool	IsMultiwordObject () override

CommandObjectMultiword *	GetAsMultiwordCommand () override

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

llvm::Error	LoadUserSubcommand (llvm::StringRef cmd_name, const lldb::CommandObjectSP &command_obj, bool can_replace) override

llvm::Error	RemoveUserSubcommand (llvm::StringRef cmd_name, bool multiword_okay)

void	GenerateHelpText (Stream &output_stream) override

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

lldb::CommandObjectSP	GetSubcommandSPExact (llvm::StringRef sub_cmd) override

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

bool	WantsRawCommandString () 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.

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.

void	Execute (const char *args_string, CommandReturnObject &result) override

bool	IsRemovable () const override

void	SetRemovable (bool removable)

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
CommandObject::CommandMap &	GetSubcommandDictionary ()

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
CommandObject::CommandMap	m_subcommand_dict

bool	m_can_be_removed

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

Friends
class	CommandInterpreter

class	CommandObjectSyntax

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 20 of file CommandObjectMultiword.h.

Constructor & Destructor Documentation

◆ CommandObjectMultiword()

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

Definition at line 20 of file CommandObjectMultiword.cpp.

◆ ~CommandObjectMultiword()

CommandObjectMultiword::~CommandObjectMultiword ( )

overridedefault

Member Function Documentation

◆ Execute()

void CommandObjectMultiword::Execute	(	const char *	args_string,
		CommandReturnObject &	result
	)

overridevirtual

Implements lldb_private::CommandObject.

Definition at line 162 of file CommandObjectMultiword.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb_private::CommandReturnObject::AppendErrorWithFormat(), lldb_private::CommandReturnObject::AppendRawError(), lldb_private::CommandObject::Execute(), lldb_private::CommandObject::GenerateHelpText(), lldb_private::Args::GetArgumentCount(), lldb_private::CommandObject::GetCommandName(), lldb_private::StringList::GetSize(), GetSubcommandObject(), m_subcommand_dict, and lldb_private::Args::Shift().

◆ GenerateHelpText()

void CommandObjectMultiword::GenerateHelpText ( Stream & output_stream )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 219 of file CommandObjectMultiword.cpp.

References lldb_private::FindLongestCommandWord(), lldb_private::CommandObject::GenerateHelpText(), lldb_private::CommandObject::m_interpreter, m_subcommand_dict, lldb_private::CommandInterpreter::OutputFormattedHelpText(), and lldb_private::Stream::PutCString().

◆ GetAsMultiwordCommand()

CommandObjectMultiword * lldb_private::CommandObjectMultiword::GetAsMultiwordCommand ( )

inlineoverridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 34 of file CommandObjectMultiword.h.

Referenced by lldb_private::CommandInterpreter::VerifyUserMultiwordCmdPath().

◆ GetRepeatCommand()

std::optional< std::string > CommandObjectMultiword::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.
[in]	index	This 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 289 of file CommandObjectMultiword.cpp.

References lldb_private::Args::GetArgumentCount(), lldb_private::CommandObject::GetRepeatCommand(), and GetSubcommandObject().

◆ GetSubcommandDictionary()

CommandObject::CommandMap & lldb_private::CommandObjectMultiword::GetSubcommandDictionary ( )

inlineprotected

Definition at line 69 of file CommandObjectMultiword.h.

References m_subcommand_dict.

◆ GetSubcommandObject()

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

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 76 of file CommandObjectMultiword.cpp.

References GetSubcommandSP().

Referenced by lldb_private::CommandCompletions::CompleteModifiableCmdPathArgs(), Execute(), GetRepeatCommand(), and HandleCompletion().

◆ GetSubcommandSP()

CommandObjectSP CommandObjectMultiword::GetSubcommandSP	(	llvm::StringRef	sub_cmd,
		StringList *	matches = `nullptr`
	)

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 42 of file CommandObjectMultiword.cpp.

References lldb_private::AddNamesMatchingPartialString(), lldb_private::StringList::AppendString(), lldb_private::StringList::GetStringAtIndex(), GetSubcommandSPExact(), and m_subcommand_dict.

Referenced by GetSubcommandObject().

◆ GetSubcommandSPExact()

CommandObjectSP CommandObjectMultiword::GetSubcommandSPExact ( llvm::StringRef sub_cmd )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 31 of file CommandObjectMultiword.cpp.

References m_subcommand_dict.

Referenced by GetSubcommandSP(), and lldb_private::CommandInterpreter::VerifyUserMultiwordCmdPath().

◆ HandleCompletion()

void CommandObjectMultiword::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 250 of file CommandObjectMultiword.cpp.

References lldb_private::CompletionRequest::AddCompletions(), lldb_private::AddNamesMatchingPartialString(), lldb_private::CompletionRequest::AppendEmptyArgument(), lldb_private::StringList::DeleteStringAtIndex(), lldb_private::Args::GetArgumentCount(), lldb_private::CompletionRequest::GetCursorIndex(), lldb_private::CompletionRequest::GetParsedLine(), lldb_private::StringList::GetSize(), lldb_private::StringList::GetStringAtIndex(), GetSubcommandObject(), lldb_private::CommandObject::HandleCompletion(), m_subcommand_dict, lldb_private::Args::Shift(), and lldb_private::CompletionRequest::ShiftArguments().