CommandObjectTargetCreate Class Reference

Inheritance diagram for CommandObjectTargetCreate:

Collaboration diagram for CommandObjectTargetCreate:

Public Member Functions
	CommandObjectTargetCreate (CommandInterpreter &interpreter)
	~CommandObjectTargetCreate () override=default
Options *	GetOptions () override
void	HandleArgumentCompletion (CompletionRequest &request, OptionElementVector &opt_element_vector) override
	The input array contains a parsed version of the line.
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
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 ()
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	DoExecute (Args &command, CommandReturnObject &result) override
Protected Member Functions inherited from lldb_private::CommandObjectParsed
virtual bool	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 &	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
OptionGroupOptions	m_option_group
OptionGroupArchitecture	m_arch_option
OptionGroupPlatform	m_platform_options
OptionGroupFile	m_core_file
OptionGroupFile	m_symbol_file
OptionGroupFile	m_remote_file
OptionGroupDependents	m_add_dependents

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 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 202 of file CommandObjectTarget.cpp.

Constructor & Destructor Documentation

CommandObjectTargetCreate()

CommandObjectTargetCreate::CommandObjectTargetCreate ( CommandInterpreter &  interpreter )

inline

Definition at line 204 of file CommandObjectTarget.cpp.

References lldb_private::OptionGroupOptions::Append(), lldb_private::CommandObject::CommandArgumentData::arg_repetition, lldb_private::CommandObject::CommandArgumentData::arg_type, lldb_private::eArgRepeatPlain, lldb::eArgTypeFilename, lldb_private::OptionGroupOptions::Finalize(), LLDB_OPT_SET_1, LLDB_OPT_SET_ALL, m_add_dependents, m_arch_option, lldb_private::CommandObject::m_arguments, m_core_file, m_option_group, m_platform_options, m_remote_file, and m_symbol_file.

~CommandObjectTargetCreate()

CommandObjectTargetCreate::~CommandObjectTargetCreate ( )

overridedefault

Member Function Documentation

DoExecute()

bool CommandObjectTargetCreate::DoExecute ( Args &  command, CommandReturnObject &  result  )

inlineoverrideprotectedvirtual

Implements lldb_private::CommandObjectParsed.

Definition at line 256 of file CommandObjectTarget.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb_private::CommandReturnObject::AppendErrorWithFormat(), lldb_private::CommandReturnObject::AppendErrorWithFormatv(), lldb_private::CommandReturnObject::AppendMessageWithFormat(), lldb_private::CommandReturnObject::AppendMessageWithFormatv(), lldb_private::Status::AsCString(), lldb_private::TargetList::CreateTarget(), lldb_private::File::eOpenOptionReadOnly, lldb::eReturnStatusSuccessFinishNoResult, error(), lldb_private::FileSystem::Exists(), lldb_private::Status::Fail(), lldb_private::OptionGroupArchitecture::GetArchitectureName(), lldb_private::Args::GetArgumentAtIndex(), lldb_private::Args::GetArgumentCount(), lldb_private::OptionValueFileSpec::GetCurrentValue(), lldb_private::CommandObject::GetDebugger(), lldb_private::FileSpec::GetDirectory(), lldb_private::OptionGroupFile::GetOptionValue(), lldb_private::FileSpec::GetPath(), lldb_private::Debugger::GetTargetList(), lldb_private::FileSystem::Instance(), LLDB_SCOPED_TIMERF, m_add_dependents, m_arch_option, lldb_private::CommandObject::m_cmd_name, m_core_file, OptionGroupDependents::m_load_dependent_files, m_platform_options, m_remote_file, m_symbol_file, lldb_private::FileSystem::Open(), lldb_private::FileSystem::Resolve(), lldb_private::FileSystem::ResolveExecutableLocation(), lldb_private::FileSpec::SetDirectory(), lldb_private::ProcessInfo::SetExecutableFile(), lldb_private::FileSpec::SetFile(), lldb_private::CommandReturnObject::SetStatus(), and lldb_private::CommandReturnObject::Succeeded().

GetOptions()

Options * CommandObjectTargetCreate::GetOptions ( )

inlineoverridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 245 of file CommandObjectTarget.cpp.

References m_option_group.

HandleArgumentCompletion()

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

inlineoverridevirtual

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 248 of file CommandObjectTarget.cpp.

References lldb_private::CommandCompletions::eDiskFileCompletion, lldb_private::CommandObject::GetCommandInterpreter(), and lldb_private::CommandCompletions::InvokeCommonCompletionCallbacks().

Member Data Documentation

m_add_dependents

OptionGroupDependents CommandObjectTargetCreate::m_add_dependents

private

Definition at line 460 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetCreate(), and DoExecute().

m_arch_option

OptionGroupArchitecture CommandObjectTargetCreate::m_arch_option

private

Definition at line 455 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetCreate(), and DoExecute().

m_core_file

OptionGroupFile CommandObjectTargetCreate::m_core_file

private

Definition at line 457 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetCreate(), and DoExecute().

m_option_group

OptionGroupOptions CommandObjectTargetCreate::m_option_group

private

Definition at line 454 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetCreate(), and GetOptions().

m_platform_options

OptionGroupPlatform CommandObjectTargetCreate::m_platform_options

private

Definition at line 456 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetCreate(), and DoExecute().

m_remote_file

OptionGroupFile CommandObjectTargetCreate::m_remote_file

private

Definition at line 459 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetCreate(), and DoExecute().

m_symbol_file

OptionGroupFile CommandObjectTargetCreate::m_symbol_file

private

Definition at line 458 of file CommandObjectTarget.cpp.

Referenced by CommandObjectTargetCreate(), and DoExecute().

---

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

• CommandObjectTarget.cpp