LLDB mainline
lldb_private::ScriptedSummaryFormat Struct Reference

#include <TypeSummary.h>

Inheritance diagram for lldb_private::ScriptedSummaryFormat:
[legend]

Public Types

typedef std::shared_ptr< ScriptedSummaryFormatSharedPointer
Public Types inherited from lldb_private::TypeSummaryImpl
enum class  Kind {
  eSummaryString , eScript , eBytecode , eCallback ,
  eInternal , eScriptedClass
}
typedef std::shared_ptr< TypeSummaryImplSharedPointer

Public Member Functions

 ScriptedSummaryFormat (const TypeSummaryImpl::Flags &flags, const char *class_name, uint32_t ptr_match_depth=1)
 ~ScriptedSummaryFormat () override=default
const char * GetClassName () const
void SetClassName (const char *class_name)
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)
uint32_t GetPtrMatchDepth ()
void SetPtrMatchDepth (uint32_t value)
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_class_name
lldb::ScriptedStringSummaryInterfaceSP m_interface_sp

Private Member Functions

 ScriptedSummaryFormat (const ScriptedSummaryFormat &)=delete
const ScriptedSummaryFormatoperator= (const ScriptedSummaryFormat &)=delete

Additional Inherited Members

Protected Member Functions inherited from lldb_private::TypeSummaryImpl
 TypeSummaryImpl (Kind kind, const TypeSummaryImpl::Flags &flags, uint32_t ptr_match_depth=1)
Protected Attributes inherited from lldb_private::TypeSummaryImpl
uint32_t m_my_revision = 0
Flags m_flags

Detailed Description

Definition at line 440 of file TypeSummary.h.

Member Typedef Documentation

◆ SharedPointer

Definition at line 470 of file TypeSummary.h.

Constructor & Destructor Documentation

◆ ScriptedSummaryFormat() [1/2]

ScriptedSummaryFormat::ScriptedSummaryFormat ( const TypeSummaryImpl::Flags & flags,
const char * class_name,
uint32_t ptr_match_depth = 1 )

◆ ~ScriptedSummaryFormat()

lldb_private::ScriptedSummaryFormat::~ScriptedSummaryFormat ( )
overridedefault

◆ ScriptedSummaryFormat() [2/2]

lldb_private::ScriptedSummaryFormat::ScriptedSummaryFormat ( const ScriptedSummaryFormat & )
privatedelete

Member Function Documentation

◆ classof()

bool lldb_private::ScriptedSummaryFormat::classof ( const TypeSummaryImpl * S)
inlinestatic

◆ FormatObject()

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

◆ GetClassName()

const char * lldb_private::ScriptedSummaryFormat::GetClassName ( ) const
inline

Definition at line 449 of file TypeSummary.h.

References m_class_name.

Referenced by lldb::SBTypeSummary::IsEqualTo().

◆ GetDescription()

◆ GetName()

std::string ScriptedSummaryFormat::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 318 of file TypeSummary.cpp.

References m_class_name.

◆ operator=()

const ScriptedSummaryFormat & lldb_private::ScriptedSummaryFormat::operator= ( const ScriptedSummaryFormat & )
privatedelete

◆ SetClassName()

void lldb_private::ScriptedSummaryFormat::SetClassName ( const char * class_name)
inline

Definition at line 451 of file TypeSummary.h.

References m_class_name, and m_interface_sp.

Member Data Documentation

◆ m_class_name

std::string lldb_private::ScriptedSummaryFormat::m_class_name

◆ m_interface_sp

lldb::ScriptedStringSummaryInterfaceSP lldb_private::ScriptedSummaryFormat::m_interface_sp

Definition at line 442 of file TypeSummary.h.

Referenced by FormatObject(), ScriptedSummaryFormat(), and SetClassName().


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