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

Public Member Functions

 LibCxxMapIteratorSyntheticFrontEnd (lldb::ValueObjectSP valobj_sp)
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.
 ~LibCxxMapIteratorSyntheticFrontEnd () override=default
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 Attributes

ValueObjectSP m_pair_sp = nullptr

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 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, bool do_deref=true)
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 227 of file LibCxxMap.cpp.

Constructor & Destructor Documentation

◆ LibCxxMapIteratorSyntheticFrontEnd()

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

◆ ~LibCxxMapIteratorSyntheticFrontEnd()

lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::~LibCxxMapIteratorSyntheticFrontEnd ( )
overridedefault

Member Function Documentation

◆ CalculateNumChildren()

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

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 467 of file LibCxxMap.cpp.

◆ GetChildAtIndex()

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

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 473 of file LibCxxMap.cpp.

References m_pair_sp.

◆ GetIndexOfChildWithName()

llvm::Expected< size_t > lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::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 482 of file LibCxxMap.cpp.

References lldb_private::ConstString::AsCString(), and m_pair_sp.

◆ Update()

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

References lldb::eRefetch, lldb_private::SyntheticChildrenFrontEnd::m_backend, and m_pair_sp.

Referenced by LibCxxMapIteratorSyntheticFrontEnd().

Member Data Documentation

◆ m_pair_sp

ValueObjectSP lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEnd::m_pair_sp = nullptr
private

Definition at line 242 of file LibCxxMap.cpp.

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


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