CommandObjectProcessAttach Class Reference

Inheritance diagram for CommandObjectProcessAttach:

Public Member Functions
	CommandObjectProcessAttach (CommandInterpreter &interpreter)
	~CommandObjectProcessAttach () override=default
Options *	GetOptions () override
Public Member Functions inherited from CommandObjectProcessLaunchOrAttach
	CommandObjectProcessLaunchOrAttach (CommandInterpreter &interpreter, const char *name, const char *help, const char *syntax, uint32_t flags, const char *new_process_action)
	~CommandObjectProcessLaunchOrAttach () override=default
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 CommandObjectProcessLaunchOrAttach
bool	StopProcessIfNecessary (Process *process, StateType &state, CommandReturnObject &result)
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
CommandOptionsProcessAttach	m_options
OptionGroupPythonClassWithDict	m_class_options
OptionGroupOptions	m_all_options
Protected Attributes inherited from CommandObjectProcessLaunchOrAttach
std::string	m_new_process_action
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 286 of file CommandObjectProcess.cpp.

Constructor & Destructor Documentation

CommandObjectProcessAttach()

CommandObjectProcessAttach::CommandObjectProcessAttach ( CommandInterpreter &  interpreter )

inline

Definition at line 288 of file CommandObjectProcess.cpp.

References lldb_private::OptionGroupOptions::Append(), lldb_private::OptionGroupOptions::Finalize(), LLDB_OPT_SET_1, LLDB_OPT_SET_2, LLDB_OPT_SET_ALL, m_all_options, m_class_options, and m_options.

~CommandObjectProcessAttach()

CommandObjectProcessAttach::~CommandObjectProcessAttach ( )

overridedefault

Member Function Documentation

DoExecute()

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

inlineoverrideprotectedvirtual

Implements lldb_private::CommandObjectParsed.

Definition at line 304 of file CommandObjectProcess.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb_private::CommandReturnObject::AppendErrorWithFormat(), lldb_private::CommandReturnObject::AppendMessage(), lldb_private::CommandReturnObject::AppendMessageWithFormat(), lldb_private::CommandReturnObject::AppendWarningWithFormat(), lldb_private::Target::Attach(), lldb_private::CommandOptionsProcessAttach::attach_info, lldb_private::TargetList::CreateTarget(), lldb_private::eLazyBoolNo, lldb_private::eLoadDependentsNo, lldb::eReturnStatusSuccessFinishNoResult, error(), lldb::eStateInvalid, lldb_private::Target::GetArchitecture(), lldb_private::ProcessAttachInfo::GetContinueOnceAttached(), lldb_private::CommandObject::GetDebugger(), lldb_private::Target::GetExecutableModule(), lldb_private::OptionGroupPythonClassWithDict::GetName(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::Target::GetProcessSP(), lldb_private::Debugger::GetSelectedTarget(), lldb_private::StreamString::GetString(), lldb_private::OptionGroupPythonClassWithDict::GetStructuredData(), lldb_private::Debugger::GetTargetList(), lldb_private::ArchSpec::GetTriple(), lldb_private::CommandInterpreter::HandleCommand(), lldb_private::ArchSpec::IsExactMatch(), lldb_private::ArchSpec::IsValid(), m_class_options, lldb_private::CommandObject::m_exe_ctx, lldb_private::CommandObject::m_interpreter, m_options, lldb_private::CommandReturnObject::SetDidChangeProcessState(), lldb_private::ProcessAttachInfo::SetProcessPluginName(), lldb_private::ProcessInfo::SetScriptedMetadata(), lldb_private::CommandReturnObject::SetStatus(), CommandObjectProcessLaunchOrAttach::StopProcessIfNecessary(), and lldb_private::CommandReturnObject::Succeeded().

GetOptions()

Options * CommandObjectProcessAttach::GetOptions ( )

inlineoverridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 301 of file CommandObjectProcess.cpp.

References m_all_options.

Member Data Documentation

m_all_options

OptionGroupOptions CommandObjectProcessAttach::m_all_options

protected

Definition at line 415 of file CommandObjectProcess.cpp.

Referenced by CommandObjectProcessAttach(), and GetOptions().

m_class_options

OptionGroupPythonClassWithDict CommandObjectProcessAttach::m_class_options

protected

Definition at line 414 of file CommandObjectProcess.cpp.

Referenced by CommandObjectProcessAttach(), and DoExecute().

m_options

CommandOptionsProcessAttach CommandObjectProcessAttach::m_options

protected

Definition at line 413 of file CommandObjectProcess.cpp.

Referenced by CommandObjectProcessAttach(), and DoExecute().

---

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

• CommandObjectProcess.cpp