LLDB mainline
Public Member Functions | Private Member Functions | Private Attributes | List of all members
lldb_private::formatters::LibcxxStdMapSyntheticFrontEnd Class Reference
Inheritance diagram for lldb_private::formatters::LibcxxStdMapSyntheticFrontEnd:
Inheritance graph
[legend]

Public Member Functions

 LibcxxStdMapSyntheticFrontEnd (lldb::ValueObjectSP valobj_sp)
 
 ~LibcxxStdMapSyntheticFrontEnd () override=default
 
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 Member Functions

ValueObjectSP GetKeyValuePair (size_t idx, size_t max_depth)
 Returns the ValueObject for the __tree_node type that holds the key/value pair of the node at index idx.
 

Private Attributes

ValueObjectm_tree = nullptr
 
ValueObjectm_root_node = nullptr
 
CompilerType m_node_ptr_type
 
size_t m_count = UINT32_MAX
 
std::map< size_t, MapIteratorm_iterators
 

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 188 of file LibCxxMap.cpp.

Constructor & Destructor Documentation

◆ LibcxxStdMapSyntheticFrontEnd()

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

Definition at line 250 of file LibCxxMap.cpp.

References Update().

◆ ~LibcxxStdMapSyntheticFrontEnd()

lldb_private::formatters::LibcxxStdMapSyntheticFrontEnd::~LibcxxStdMapSyntheticFrontEnd ( )
overridedefault

Member Function Documentation

◆ CalculateNumChildren()

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

◆ GetChildAtIndex()

lldb::ValueObjectSP lldb_private::formatters::LibcxxStdMapSyntheticFrontEnd::GetChildAtIndex ( uint32_t  idx)
overridevirtual

◆ GetIndexOfChildWithName()

size_t lldb_private::formatters::LibcxxStdMapSyntheticFrontEnd::GetIndexOfChildWithName ( ConstString  name)
overridevirtual

◆ GetKeyValuePair()

ValueObjectSP lldb_private::formatters::LibcxxStdMapSyntheticFrontEnd::GetKeyValuePair ( size_t  idx,
size_t  max_depth 
)
private

Returns the ValueObject for the __tree_node type that holds the key/value pair of the node at index idx.

Parameters
[in]idxThe child index that we're looking to get the key/value pair for.
[in]max_depthThe maximum search depth after which we stop trying to find the key/value pair for.
Returns
On success, returns the ValueObjectSP corresponding to the __tree_node's __value_ member (which holds the key/value pair the formatter wants to display). On failure, will return nullptr.

Definition at line 279 of file LibCxxMap.cpp.

References MapIterator::advance().

◆ MightHaveChildren()

bool lldb_private::formatters::LibcxxStdMapSyntheticFrontEnd::MightHaveChildren ( )
overridevirtual

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 381 of file LibCxxMap.cpp.

◆ Update()

lldb::ChildCacheState lldb_private::formatters::LibcxxStdMapSyntheticFrontEnd::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 367 of file LibCxxMap.cpp.

References lldb::eRefetch, and UINT32_MAX.

Referenced by LibcxxStdMapSyntheticFrontEnd().

Member Data Documentation

◆ m_count

size_t lldb_private::formatters::LibcxxStdMapSyntheticFrontEnd::m_count = UINT32_MAX
private

Definition at line 224 of file LibCxxMap.cpp.

◆ m_iterators

std::map<size_t, MapIterator> lldb_private::formatters::LibcxxStdMapSyntheticFrontEnd::m_iterators
private

Definition at line 225 of file LibCxxMap.cpp.

◆ m_node_ptr_type

CompilerType lldb_private::formatters::LibcxxStdMapSyntheticFrontEnd::m_node_ptr_type
private

Definition at line 223 of file LibCxxMap.cpp.

◆ m_root_node

ValueObject* lldb_private::formatters::LibcxxStdMapSyntheticFrontEnd::m_root_node = nullptr
private

Definition at line 222 of file LibCxxMap.cpp.

◆ m_tree

ValueObject* lldb_private::formatters::LibcxxStdMapSyntheticFrontEnd::m_tree = nullptr
private

Definition at line 221 of file LibCxxMap.cpp.


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