LLDB mainline
lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd Class Reference
Inheritance diagram for lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd:
[legend]

Public Member Functions

 LibcxxStdVectorSyntheticFrontEnd (lldb::ValueObjectSP valobj_sp)
 ~LibcxxStdVectorSyntheticFrontEnd () override
llvm::Expected< uint32_t > CalculateNumChildren () override
lldb::ValueObjectSP GetChildAtIndex (uint32_t idx) override
lldb::ChildCacheState Update () override
 This function is assumed to always succeed and if it fails, the front-end should know to deal with it in the correct way (most probably, by refusing to return any children).
llvm::Expected< size_t > GetIndexOfChildWithName (ConstString name) override
 Determine the index of a named child.
Public Member Functions inherited from lldb_private::SyntheticChildrenFrontEnd
 SyntheticChildrenFrontEnd (ValueObject &backend)
virtual ~SyntheticChildrenFrontEnd ()=default
virtual llvm::Expected< uint32_t > CalculateNumChildren (uint32_t max)
uint32_t CalculateNumChildrenIgnoringErrors (uint32_t max=UINT32_MAX)
virtual bool MightHaveChildren ()
virtual lldb::ValueObjectSP GetSyntheticValue ()
virtual ConstString GetSyntheticTypeName ()

Private Types

enum class  VectorLayout : bool { Pointer , Size }

Private Member Functions

lldb::ChildCacheState UpdateVectorWithLayoutSubobject (ValueObject *layout)

Private Attributes

ValueObjectm_start = nullptr
ValueObjectm_finish = nullptr
VectorLayout m_layout
CompilerType m_element_type
uint32_t m_element_size = 0

Additional Inherited Members

Public Types inherited from lldb_private::SyntheticChildrenFrontEnd
typedef std::shared_ptr< SyntheticChildrenFrontEndSharedPointer
typedef std::unique_ptr< SyntheticChildrenFrontEndUniquePointer
Protected Member Functions inherited from lldb_private::SyntheticChildrenFrontEnd
lldb::ValueObjectSP CreateChildValueObjectFromExpression (llvm::StringRef name, llvm::StringRef expression, const ExecutionContext &exe_ctx)
lldb::ValueObjectSP CreateChildValueObjectFromAddress (llvm::StringRef name, uint64_t address, const ExecutionContext &exe_ctx, CompilerType type, bool do_deref=true)
lldb::ValueObjectSP CreateChildValueObjectFromData (llvm::StringRef name, const DataExtractor &data, const ExecutionContext &exe_ctx, CompilerType type)
Protected Attributes inherited from lldb_private::SyntheticChildrenFrontEnd
ValueObjectm_backend

Detailed Description

Definition at line 26 of file LibCxxVector.cpp.

Member Enumeration Documentation

◆ VectorLayout

Enumerator
Pointer 
Size 

Definition at line 49 of file LibCxxVector.cpp.

Constructor & Destructor Documentation

◆ LibcxxStdVectorSyntheticFrontEnd()

lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::LibcxxStdVectorSyntheticFrontEnd ( lldb::ValueObjectSP valobj_sp)

◆ ~LibcxxStdVectorSyntheticFrontEnd()

lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::~LibcxxStdVectorSyntheticFrontEnd ( )
override

Definition at line 85 of file LibCxxVector.cpp.

Member Function Documentation

◆ CalculateNumChildren()

llvm::Expected< uint32_t > lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::CalculateNumChildren ( )
overridevirtual

◆ GetChildAtIndex()

◆ GetIndexOfChildWithName()

llvm::Expected< size_t > lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::GetIndexOfChildWithName ( ConstString name)
overridevirtual

Determine the index of a named child.

Subscript names ("[N]") are, by default, handled automatically. For data types which need custom subscripting behavior - for example a sparse array, disable automatic subscripting with TypeOptions::eTypeOptionCustomSubscripting.

Reimplemented from lldb_private::SyntheticChildrenFrontEnd.

Definition at line 201 of file LibCxxVector.cpp.

References lldb_private::formatters::ExtractIndexFromString(), lldb_private::ConstString::GetCString(), m_finish, and m_start.

◆ Update()

lldb::ChildCacheState lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::Update ( )
overridevirtual

This function is assumed to always succeed and if it fails, the front-end should know to deal with it in the correct way (most probably, by refusing to return any children).

The return value of Update should actually be interpreted as "ValueObjectSynthetic cache is good/bad". If this function returns lldb::ChildCacheState::eReuse, ValueObjectSynthetic is allowed to use the children it fetched previously and cached. Otherwise, ValueObjectSynthetic must throw away its cache, and query again for children.

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 158 of file LibCxxVector.cpp.

References lldb_private::DataFormatters, lldb::eRefetch, lldb_private::ValueObject::GetChildMemberWithName(), lldb_private::GetLog(), LLDB_LOG_ERRORV, lldb_private::SyntheticChildrenFrontEnd::m_backend, m_element_size, m_element_type, m_finish, m_layout, m_start, Pointer, and Size.

Referenced by LibcxxStdVectorSyntheticFrontEnd().

◆ UpdateVectorWithLayoutSubobject()

lldb::ChildCacheState lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::UpdateVectorWithLayoutSubobject ( ValueObject * layout)
private

Member Data Documentation

◆ m_element_size

uint32_t lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::m_element_size = 0
private

Definition at line 52 of file LibCxxVector.cpp.

Referenced by CalculateNumChildren(), GetChildAtIndex(), and Update().

◆ m_element_type

CompilerType lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::m_element_type
private

Definition at line 51 of file LibCxxVector.cpp.

Referenced by GetChildAtIndex(), LibcxxStdVectorSyntheticFrontEnd(), and Update().

◆ m_finish

ValueObject* lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::m_finish = nullptr
private

◆ m_layout

VectorLayout lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::m_layout
private

Definition at line 50 of file LibCxxVector.cpp.

Referenced by CalculateNumChildren(), and Update().

◆ m_start

ValueObject* lldb_private::formatters::LibcxxStdVectorSyntheticFrontEnd::m_start = nullptr
private

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