lldb_private::Target::StopHookScripted Class Reference

#include <Target.h>

Inheritance diagram for lldb_private::Target::StopHookScripted:

Public Member Functions
	~StopHookScripted () override=default
StopHookResult	HandleStop (ExecutionContext &exc_ctx, lldb::StreamSP output) override
Status	SetScriptCallback (std::string class_name, StructuredData::ObjectSP extra_args_sp)
void	GetSubclassDescription (Stream &s, lldb::DescriptionLevel level) const override
Public Member Functions inherited from lldb_private::Target::StopHook
	StopHook (const StopHook &rhs)
virtual	~StopHook ()=default
lldb::TargetSP &	GetTarget ()
void	SetSpecifier (SymbolContextSpecifier *specifier)
SymbolContextSpecifier *	GetSpecifier ()
bool	ExecutionContextPasses (const ExecutionContext &exe_ctx)
void	SetThreadSpecifier (ThreadSpec *specifier)
ThreadSpec *	GetThreadSpecifier ()
bool	IsActive ()
void	SetIsActive (bool is_active)
void	SetAutoContinue (bool auto_continue)
bool	GetAutoContinue () const
void	SetRunAtInitialStop (bool at_initial_stop)
bool	GetRunAtInitialStop () const
void	SetSuppressOutput (bool suppress_output)
bool	GetSuppressOutput () const
void	GetDescription (Stream &s, lldb::DescriptionLevel level) const
Public Member Functions inherited from lldb_private::UserID
	UserID (lldb::user_id_t uid=LLDB_INVALID_UID)
	Construct with optional user ID.
	~UserID ()=default
	Destructor.
void	Clear ()
	Clears the object state.
lldb::user_id_t	GetID () const
	Get accessor for the user ID.
void	SetID (lldb::user_id_t uid)
	Set accessor for the user ID.

Private Member Functions
	StopHookScripted (lldb::TargetSP target_sp, lldb::user_id_t uid)
	Use CreateStopHook to make a new empty stop hook.

Private Attributes
std::string	m_class_name
StructuredDataImpl	m_extra_args
	This holds the dictionary of keys & values that can be used to parametrize any given callback's behavior.
lldb::ScriptedStopHookInterfaceSP	m_interface_sp

Friends
class	Target

Additional Inherited Members
Public Types inherited from lldb_private::Target::StopHook
enum class	StopHookKind : uint32_t { CommandBased = 0 , ScriptBased , CodeBased }
enum class	StopHookResult : uint32_t { KeepStopped = 0 , RequestContinue , NoPreference , AlreadyContinued }
Protected Member Functions inherited from lldb_private::Target::StopHook
	StopHook (lldb::TargetSP target_sp, lldb::user_id_t uid)
Protected Attributes inherited from lldb_private::Target::StopHook
lldb::TargetSP	m_target_sp
lldb::SymbolContextSpecifierSP	m_specifier_sp
std::unique_ptr< ThreadSpec >	m_thread_spec_up
bool	m_active = true
bool	m_auto_continue = false
bool	m_at_initial_stop = true
bool	m_suppress_output = false
Protected Attributes inherited from lldb_private::UserID
lldb::user_id_t	m_uid
	The user ID that uniquely identifies an object.

Detailed Description

Definition at line 1462 of file Target.h.

Constructor & Destructor Documentation

~StopHookScripted()

lldb_private::Target::StopHookScripted::~StopHookScripted ( )

overridedefault

StopHookScripted()

lldb_private::Target::StopHookScripted::StopHookScripted ( lldb::TargetSP target_sp, lldb::user_id_t uid )

inlineprivate

Use CreateStopHook to make a new empty stop hook.

Use SetScriptCallback to set the script to execute, and SetSpecifier to set the specifier shared pointer (can be null, that will match anything.)

Definition at line 1484 of file Target.h.

References lldb_private::Target::StopHook::StopHook().

Member Function Documentation

GetSubclassDescription()

void Target::StopHookScripted::GetSubclassDescription ( Stream & s, lldb::DescriptionLevel level ) const

overridevirtual

Implements lldb_private::Target::StopHook.

Definition at line 4116 of file Target.cpp.

References lldb::eDescriptionLevelBrief, lldb_private::StructuredData::Dictionary::ForEach(), lldb_private::Stream::Format(), lldb_private::StructuredData::Object::GetAsDictionary(), lldb_private::StructuredData::Dictionary::GetSize(), lldb_private::Stream::Indent(), lldb_private::StructuredData::Object::IsValid(), m_class_name, m_extra_args, lldb_private::Stream::MakeIndentScope(), lldb_private::Stream::Printf(), and lldb_private::Stream::PutCString().

HandleStop()

Target::StopHook::StopHookResult Target::StopHookScripted::HandleStop ( ExecutionContext & exc_ctx, lldb::StreamSP output )

overridevirtual

Implements lldb_private::Target::StopHook.

Definition at line 4097 of file Target.cpp.

References lldb_private::StreamString::GetData(), lldb_private::ExecutionContext::GetTargetPtr(), lldb_private::Target::StopHook::KeepStopped, m_interface_sp, and lldb_private::Target::StopHook::RequestContinue.

SetScriptCallback()

Status Target::StopHookScripted::SetScriptCallback	(	std::string	class_name,
		StructuredData::ObjectSP	extra_args_sp )

Definition at line 4057 of file Target.cpp.

References lldb_private::ScriptInterpreter::CreateScriptedStopHookInterface(), error(), lldb_private::Status::FromError(), lldb_private::Status::FromErrorString(), lldb_private::Status::FromErrorStringWithFormat(), lldb_private::Target::StopHook::GetTarget(), m_class_name, m_extra_args, and m_interface_sp.

Friends And Related Symbol Documentation

Target

friend class Target

friend

Definition at line 1486 of file Target.h.

References Target.

Referenced by Target.

Member Data Documentation

m_class_name

std::string lldb_private::Target::StopHookScripted::m_class_name

private

Definition at line 1475 of file Target.h.

Referenced by GetSubclassDescription(), and SetScriptCallback().

m_extra_args

StructuredDataImpl lldb_private::Target::StopHookScripted::m_extra_args

private

This holds the dictionary of keys & values that can be used to parametrize any given callback's behavior.

Definition at line 1478 of file Target.h.

Referenced by GetSubclassDescription(), and SetScriptCallback().

m_interface_sp

lldb::ScriptedStopHookInterfaceSP lldb_private::Target::StopHookScripted::m_interface_sp

private

Definition at line 1479 of file Target.h.

Referenced by HandleStop(), and SetScriptCallback().

---

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

• Target.h
• Target.cpp