#include <CommandAlias.h>

Inheritance diagram for lldb_private::CommandAlias:

Collaboration diagram for lldb_private::CommandAlias:

[legend]

Public Types
typedef std::unique_ptr< CommandAlias >	UniquePointer

Public Types inherited from lldb_private::CommandObject
typedef llvm::StringRef()	ArgumentHelpCallbackFunction()

typedef std::vector< CommandArgumentData >	CommandArgumentEntry

typedef std::map< std::string, lldb::CommandObjectSP >	CommandMap

Public Member Functions
	CommandAlias (CommandInterpreter &interpreter, lldb::CommandObjectSP cmd_sp, llvm::StringRef options_args, llvm::StringRef name, llvm::StringRef help=llvm::StringRef(), llvm::StringRef syntax=llvm::StringRef(), uint32_t flags=0)

void	GetAliasExpansion (StreamString &help_string) const

bool	IsValid () const

	operator bool () const

bool	WantsRawCommandString () override

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

void	HandleArgumentCompletion (CompletionRequest &request, OptionElementVector &opt_element_vector) override
	The input array contains a parsed version of the line.

Options *	GetOptions () override

bool	IsAlias () override

bool	IsDashDashCommand () override

llvm::StringRef	GetHelp () override

llvm::StringRef	GetHelpLong () override

void	SetHelp (llvm::StringRef str) override

void	SetHelpLong (llvm::StringRef str) override

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

lldb::CommandObjectSP	GetUnderlyingCommand ()

OptionArgVectorSP	GetOptionArguments () const

const char *	GetOptionString ()

std::pair< lldb::CommandObjectSP, OptionArgVectorSP >	Desugar ()

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 ()

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)

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 input array contains a parsed version of the line.

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::CommandOverrideCallbackWithResult callback, void *baton)

bool	InvokeOverrideCallback (const char **argv, CommandReturnObject &result)

virtual bool	Execute (const char *args_string, CommandReturnObject &result)=0

Protected Member Functions
bool	IsNestedAlias ()

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.

void	Cleanup ()

Private Attributes
lldb::CommandObjectSP	m_underlying_command_sp

std::string	m_option_string

OptionArgVectorSP	m_option_args_sp

LazyBool	m_is_dashdash_alias

bool	m_did_set_help: 1

bool	m_did_set_help_long: 1

Additional Inherited Members
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 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 20 of file CommandAlias.h.

Member Typedef Documentation

◆ UniquePointer

typedef std::unique_ptr<CommandAlias> lldb_private::CommandAlias::UniquePointer

Definition at line 22 of file CommandAlias.h.

Constructor & Destructor Documentation

◆ CommandAlias()

CommandAlias::CommandAlias	(	CommandInterpreter &	interpreter,
		lldb::CommandObjectSP	cmd_sp,
		llvm::StringRef	options_args,
		llvm::StringRef	name,
		llvm::StringRef	help = `llvm::StringRef()`,
		llvm::StringRef	syntax = `llvm::StringRef()`,
		uint32_t	flags = `0`
	)

Definition at line 77 of file CommandAlias.cpp.

References GetAliasExpansion(), lldb_private::StreamString::GetData(), GetHelp(), lldb_private::StreamString::GetString(), GetUnderlyingCommand(), lldb_private::CommandObject::m_arguments, m_option_args_sp, m_underlying_command_sp, lldb_private::Stream::Printf(), ProcessAliasOptionsArgs(), and SetHelp().

Member Function Documentation

◆ Desugar()

std::pair< lldb::CommandObjectSP, OptionArgVectorSP > CommandAlias::Desugar ( )

Definition at line 205 of file CommandAlias.cpp.

References Desugar(), GetOptionArguments(), and GetUnderlyingCommand().

Referenced by Desugar().

◆ Execute()

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

overridevirtual

Implements lldb_private::CommandObject.

Definition at line 137 of file CommandAlias.cpp.

◆ GetAliasExpansion()

void CommandAlias::GetAliasExpansion ( StreamString & help_string ) const

Definition at line 142 of file CommandAlias.cpp.

References lldb_private::CommandInterpreter::g_argument, lldb_private::CommandInterpreter::g_need_argument, lldb_private::CommandInterpreter::g_no_argument, m_option_args_sp, m_underlying_command_sp, and lldb_private::Stream::Printf().

Referenced by CommandAlias(), and lldb_private::CommandObjectHelp::DoExecute().

◆ GetHelp()

llvm::StringRef CommandAlias::GetHelp ( )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 235 of file CommandAlias.cpp.

References IsValid(), lldb_private::CommandObject::m_cmd_help_short, m_did_set_help, and m_underlying_command_sp.

Referenced by CommandAlias().

◆ GetHelpLong()

llvm::StringRef CommandAlias::GetHelpLong ( )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 243 of file CommandAlias.cpp.

References IsValid(), lldb_private::CommandObject::m_cmd_help_long, m_did_set_help_long, and m_underlying_command_sp.

◆ GetOptionArguments()

OptionArgVectorSP lldb_private::CommandAlias::GetOptionArguments ( ) const

inline

Definition at line 64 of file CommandAlias.h.

References m_option_args_sp.

Referenced by lldb_private::CommandInterpreter::BuildAliasCommandArgs(), Desugar(), and IsDashDashCommand().

◆ GetOptions()

Options * CommandAlias::GetOptions ( )

overridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 131 of file CommandAlias.cpp.

References IsValid(), and m_underlying_command_sp.

◆ GetOptionString()

const char * lldb_private::CommandAlias::GetOptionString ( )

inline

Definition at line 65 of file CommandAlias.h.

References m_option_string.

◆ GetUnderlyingCommand()

lldb::CommandObjectSP lldb_private::CommandAlias::GetUnderlyingCommand ( )

inline

Definition at line 61 of file CommandAlias.h.

References m_underlying_command_sp.

Referenced by CommandAlias(), Desugar(), IsDashDashCommand(), and IsNestedAlias().

◆ HandleArgumentCompletion()

void CommandAlias::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 124 of file CommandAlias.cpp.

References IsValid(), and m_underlying_command_sp.

◆ HandleCompletion()

void CommandAlias::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 119 of file CommandAlias.cpp.

References IsValid(), and m_underlying_command_sp.