LLDB mainline
Public Member Functions | Private Attributes | List of all members
lldb_private::formatters::VectorIteratorSyntheticFrontEnd Class Reference

#include <VectorIterator.h>

Inheritance diagram for lldb_private::formatters::VectorIteratorSyntheticFrontEnd:
Inheritance graph
[legend]

Public Member Functions

 VectorIteratorSyntheticFrontEnd (lldb::ValueObjectSP valobj_sp, llvm::ArrayRef< ConstString > item_names)
 
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).
 
bool MightHaveChildren () override
 
size_t GetIndexOfChildWithName (ConstString name) override
 
- Public Member Functions inherited from lldb_private::SyntheticChildrenFrontEnd
 SyntheticChildrenFrontEnd (ValueObject &backend)
 
virtual ~SyntheticChildrenFrontEnd ()=default
 
virtual llvm::Expected< uint32_t > CalculateNumChildren ()=0
 
virtual llvm::Expected< uint32_t > CalculateNumChildren (uint32_t max)
 
uint32_t CalculateNumChildrenIgnoringErrors (uint32_t max=UINT32_MAX)
 
virtual lldb::ValueObjectSP GetChildAtIndex (uint32_t idx)=0
 
virtual size_t GetIndexOfChildWithName (ConstString name)=0
 
virtual lldb::ChildCacheState Update ()=0
 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).
 
virtual bool MightHaveChildren ()=0
 
virtual lldb::ValueObjectSP GetSyntheticValue ()
 
virtual ConstString GetSyntheticTypeName ()
 

Private Attributes

ExecutionContextRef m_exe_ctx_ref
 
llvm::SmallVector< ConstString, 2 > m_item_names
 
lldb::ValueObjectSP m_item_sp
 

Additional Inherited Members

- Public Types inherited from lldb_private::SyntheticChildrenFrontEnd
typedef std::shared_ptr< SyntheticChildrenFrontEndSharedPointer
 
typedef std::unique_ptr< SyntheticChildrenFrontEndAutoPointer
 
- Protected Member Functions inherited from lldb_private::SyntheticChildrenFrontEnd
void SetValid (bool valid)
 
bool IsValid ()
 
lldb::ValueObjectSP CreateValueObjectFromExpression (llvm::StringRef name, llvm::StringRef expression, const ExecutionContext &exe_ctx)
 
lldb::ValueObjectSP CreateValueObjectFromAddress (llvm::StringRef name, uint64_t address, const ExecutionContext &exe_ctx, CompilerType type)
 
lldb::ValueObjectSP CreateValueObjectFromData (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 22 of file VectorIterator.h.

Constructor & Destructor Documentation

◆ VectorIteratorSyntheticFrontEnd()

lldb_private::formatters::VectorIteratorSyntheticFrontEnd::VectorIteratorSyntheticFrontEnd ( lldb::ValueObjectSP  valobj_sp,
llvm::ArrayRef< ConstString item_names 
)

Definition at line 188 of file LibStdcpp.cpp.

References Update().

Member Function Documentation

◆ CalculateNumChildren()

llvm::Expected< uint32_t > VectorIteratorSyntheticFrontEnd::CalculateNumChildren ( )
overridevirtual

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 224 of file LibStdcpp.cpp.

◆ GetChildAtIndex()

lldb::ValueObjectSP VectorIteratorSyntheticFrontEnd::GetChildAtIndex ( uint32_t  idx)
overridevirtual

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 229 of file LibStdcpp.cpp.

References m_item_sp.

◆ GetIndexOfChildWithName()

size_t VectorIteratorSyntheticFrontEnd::GetIndexOfChildWithName ( ConstString  name)
overridevirtual

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 237 of file LibStdcpp.cpp.

References UINT32_MAX.

◆ MightHaveChildren()

bool VectorIteratorSyntheticFrontEnd::MightHaveChildren ( )
overridevirtual

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 235 of file LibStdcpp.cpp.

◆ Update()

lldb::ChildCacheState VectorIteratorSyntheticFrontEnd::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 "ValueObjectSyntheticFilter cache is good/bad". If this function returns lldb::ChildCacheState::eReuse, ValueObjectSyntheticFilter is allowed to use the children it fetched previously and cached. Otherwise, ValueObjectSyntheticFilter must throw away its cache, and query again for children.

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 197 of file LibStdcpp.cpp.

References lldb_private::SyntheticChildrenFrontEnd::CreateValueObjectFromAddress(), lldb::eRefetch, lldb_private::Status::Fail(), lldb_private::formatters::GetChildMemberWithName(), lldb_private::ValueObject::GetSP(), lldb_private::SyntheticChildrenFrontEnd::m_backend, m_exe_ctx_ref, m_item_names, and m_item_sp.

Referenced by VectorIteratorSyntheticFrontEnd().

Member Data Documentation

◆ m_exe_ctx_ref

ExecutionContextRef lldb_private::formatters::VectorIteratorSyntheticFrontEnd::m_exe_ctx_ref
private

Definition at line 38 of file VectorIterator.h.

Referenced by Update().

◆ m_item_names

llvm::SmallVector<ConstString, 2> lldb_private::formatters::VectorIteratorSyntheticFrontEnd::m_item_names
private

Definition at line 39 of file VectorIterator.h.

Referenced by Update().

◆ m_item_sp

lldb::ValueObjectSP lldb_private::formatters::VectorIteratorSyntheticFrontEnd::m_item_sp
private

Definition at line 40 of file VectorIterator.h.

Referenced by GetChildAtIndex(), and Update().


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