#include <TypeSummary.h>

Inheritance diagram for lldb_private::ScriptSummaryFormat:

Public Types
typedef std::shared_ptr< ScriptSummaryFormat >	SharedPointer

Public Types inherited from lldb_private::TypeSummaryImpl
enum class	Kind { eSummaryString , eScript , eBytecode , eCallback , eInternal }

typedef std::shared_ptr< TypeSummaryImpl >	SharedPointer

Public Member Functions
	ScriptSummaryFormat (const TypeSummaryImpl::Flags &flags, const char function_name, const char python_script=nullptr)

	~ScriptSummaryFormat () override=default

const char *	GetFunctionName () const

const char *	GetPythonScript () const

void	SetFunctionName (const char *function_name)

void	SetPythonScript (const char *script)

bool	FormatObject (ValueObject *valobj, std::string &dest, const TypeSummaryOptions &options) override

std::string	GetDescription () override

std::string	GetName () override
	Get the name of the Type Summary Provider, either a C++ class, a summary string, or a script function name.

Public Member Functions inherited from lldb_private::TypeSummaryImpl
virtual	~TypeSummaryImpl ()=default

Kind	GetKind () const

bool	Cascades () const

bool	SkipsPointers () const

bool	SkipsReferences () const

bool	NonCacheable () const

virtual bool	DoesPrintChildren (ValueObject *valobj) const

virtual bool	DoesPrintEmptyAggregates () const

virtual bool	DoesPrintValue (ValueObject *valobj) const

bool	IsOneLiner () const

virtual bool	HideNames (ValueObject *valobj) const

void	SetCascades (bool value)

void	SetSkipsPointers (bool value)

void	SetSkipsReferences (bool value)

virtual void	SetDoesPrintChildren (bool value)

virtual void	SetDoesPrintValue (bool value)

void	SetIsOneLiner (bool value)

virtual void	SetHideNames (bool value)

virtual void	SetNonCacheable (bool value)

uint32_t	GetOptions ()

void	SetOptions (uint32_t value)

virtual bool	FormatObject (ValueObject *valobj, std::string &dest, const TypeSummaryOptions &options)=0

virtual std::string	GetDescription ()=0

virtual std::string	GetName ()=0
	Get the name of the Type Summary Provider, either a C++ class, a summary string, or a script function name.

virtual std::string	GetSummaryKindName ()
	Get the name of the kind of Summary Provider, either c++, summary string, script or python.

uint32_t &	GetRevision ()

Static Public Member Functions
static bool	classof (const TypeSummaryImpl *S)

Public Attributes
std::string	m_function_name

std::string	m_python_script

std::string	m_script_formatter_name

StructuredData::ObjectSP	m_script_function_sp

Private Member Functions
	ScriptSummaryFormat (const ScriptSummaryFormat &)=delete

const ScriptSummaryFormat &	operator= (const ScriptSummaryFormat &)=delete

Additional Inherited Members
Protected Member Functions inherited from lldb_private::TypeSummaryImpl
	TypeSummaryImpl (Kind kind, const TypeSummaryImpl::Flags &flags)

Protected Attributes inherited from lldb_private::TypeSummaryImpl
uint32_t	m_my_revision = 0

Flags	m_flags

Detailed Description

Definition at line 368 of file TypeSummary.h.

Member Typedef Documentation

◆ SharedPointer

typedef std::shared_ptr<ScriptSummaryFormat> lldb_private::ScriptSummaryFormat::SharedPointer

Definition at line 410 of file TypeSummary.h.

Constructor & Destructor Documentation

◆ ScriptSummaryFormat() [1/2]

ScriptSummaryFormat::ScriptSummaryFormat	(	const TypeSummaryImpl::Flags &	flags,
		const char *	function_name,
		const char *	python_script = `nullptr`
	)

Definition at line 165 of file TypeSummary.cpp.

References m_function_name, m_python_script, and m_script_formatter_name.

◆ ~ScriptSummaryFormat()

lldb_private::ScriptSummaryFormat::~ScriptSummaryFormat ( )

overridedefault

◆ ScriptSummaryFormat() [2/2]

lldb_private::ScriptSummaryFormat::ScriptSummaryFormat ( const ScriptSummaryFormat & )

privatedelete

Member Function Documentation

◆ classof()

static bool lldb_private::ScriptSummaryFormat::classof ( const TypeSummaryImpl * S )

inlinestatic

Definition at line 406 of file TypeSummary.h.

References lldb_private::TypeSummaryImpl::eScript, and lldb_private::TypeSummaryImpl::GetKind().

◆ FormatObject()

bool ScriptSummaryFormat::FormatObject	(	ValueObject *	valobj,
		std::string &	dest,
		const TypeSummaryOptions &	options
	)

overridevirtual

Implements lldb_private::TypeSummaryImpl.

Definition at line 186 of file TypeSummary.cpp.

References lldb_private::ScriptInterpreter::GetScriptedSummary(), lldb_private::ValueObject::GetSP(), lldb_private::ValueObject::GetTargetSP(), m_function_name, and m_script_function_sp.

◆ GetDescription()

std::string ScriptSummaryFormat::GetDescription ( )

overridevirtual

Implements lldb_private::TypeSummaryImpl.

Definition at line 211 of file TypeSummary.cpp.

References lldb_private::TypeSummaryImpl::Cascades(), lldb_private::TypeSummaryImpl::DoesPrintChildren(), lldb_private::TypeSummaryImpl::DoesPrintValue(), lldb_private::StreamString::GetString(), lldb_private::TypeSummaryImpl::HideNames(), lldb_private::TypeSummaryImpl::IsOneLiner(), m_function_name, m_python_script, lldb_private::Stream::Printf(), lldb_private::Stream::PutCString(), lldb_private::TypeSummaryImpl::SkipsPointers(), and lldb_private::TypeSummaryImpl::SkipsReferences().

◆ GetFunctionName()

const char * lldb_private::ScriptSummaryFormat::GetFunctionName ( ) const

inline

Definition at line 380 of file TypeSummary.h.

References m_function_name.

◆ GetName()

std::string ScriptSummaryFormat::GetName ( )

overridevirtual

Get the name of the Type Summary Provider, either a C++ class, a summary string, or a script function name.

Implements lldb_private::TypeSummaryImpl.

Definition at line 232 of file TypeSummary.cpp.

References m_script_formatter_name.

◆ GetPythonScript()

const char * lldb_private::ScriptSummaryFormat::GetPythonScript ( ) const

inline

Definition at line 382 of file TypeSummary.h.

References m_python_script.

◆ operator=()

const ScriptSummaryFormat & lldb_private::ScriptSummaryFormat::operator= ( const ScriptSummaryFormat & )

privatedelete

◆ SetFunctionName()

void lldb_private::ScriptSummaryFormat::SetFunctionName ( const char * function_name )

inline

Definition at line 384 of file TypeSummary.h.

References m_function_name, and m_python_script.

◆ SetPythonScript()

void lldb_private::ScriptSummaryFormat::SetPythonScript ( const char * script )

inline

Definition at line 392 of file TypeSummary.h.

References m_python_script.

Member Data Documentation

◆ m_function_name

std::string lldb_private::ScriptSummaryFormat::m_function_name

Definition at line 369 of file TypeSummary.h.

Referenced by FormatObject(), GetDescription(), GetFunctionName(), ScriptSummaryFormat(), and SetFunctionName().

◆ m_python_script

std::string lldb_private::ScriptSummaryFormat::m_python_script

Definition at line 370 of file TypeSummary.h.

Referenced by GetDescription(), GetPythonScript(), ScriptSummaryFormat(), SetFunctionName(), and SetPythonScript().

◆ m_script_formatter_name

std::string lldb_private::ScriptSummaryFormat::m_script_formatter_name

Definition at line 371 of file TypeSummary.h.

Referenced by GetName(), and ScriptSummaryFormat().

◆ m_script_function_sp

StructuredData::ObjectSP lldb_private::ScriptSummaryFormat::m_script_function_sp

Definition at line 372 of file TypeSummary.h.

Referenced by FormatObject().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SharedPointer

Constructor & Destructor Documentation

◆ ScriptSummaryFormat() [1/2]

◆ ~ScriptSummaryFormat()

◆ ScriptSummaryFormat() [2/2]

Member Function Documentation

◆ classof()

◆ FormatObject()

◆ GetDescription()

◆ GetFunctionName()

◆ GetName()

◆ GetPythonScript()

◆ operator=()

◆ SetFunctionName()

◆ SetPythonScript()

Member Data Documentation

◆ m_function_name

◆ m_python_script

◆ m_script_formatter_name

◆ m_script_function_sp