LLDB mainline
lldb_private::SyntheticValueProviderFrontEnd Class Referenceabstract

#include <TypeSynthetic.h>

Inheritance diagram for lldb_private::SyntheticValueProviderFrontEnd:
[legend]

Public Member Functions

 SyntheticValueProviderFrontEnd (ValueObject &backend)
 ~SyntheticValueProviderFrontEnd () override=default
llvm::Expected< uint32_t > CalculateNumChildren () override
lldb::ValueObjectSP GetChildAtIndex (uint32_t idx) override
llvm::Expected< size_t > GetIndexOfChildWithName (ConstString name) override
 Determine the index of a named child.
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
lldb::ValueObjectSP GetSyntheticValue () override=0
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 ConstString GetSyntheticTypeName ()

Private Member Functions

 SyntheticValueProviderFrontEnd (const SyntheticValueProviderFrontEnd &)=delete
const SyntheticValueProviderFrontEndoperator= (const SyntheticValueProviderFrontEnd &)=delete

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 111 of file TypeSynthetic.h.

Constructor & Destructor Documentation

◆ SyntheticValueProviderFrontEnd() [1/2]

lldb_private::SyntheticValueProviderFrontEnd::SyntheticValueProviderFrontEnd ( ValueObject & backend)
inline

◆ ~SyntheticValueProviderFrontEnd()

lldb_private::SyntheticValueProviderFrontEnd::~SyntheticValueProviderFrontEnd ( )
overridedefault

◆ SyntheticValueProviderFrontEnd() [2/2]

lldb_private::SyntheticValueProviderFrontEnd::SyntheticValueProviderFrontEnd ( const SyntheticValueProviderFrontEnd & )
privatedelete

Member Function Documentation

◆ CalculateNumChildren()

llvm::Expected< uint32_t > lldb_private::SyntheticValueProviderFrontEnd::CalculateNumChildren ( )
inlineoverridevirtual

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 118 of file TypeSynthetic.h.

◆ GetChildAtIndex()

lldb::ValueObjectSP lldb_private::SyntheticValueProviderFrontEnd::GetChildAtIndex ( uint32_t idx)
inlineoverridevirtual

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 120 of file TypeSynthetic.h.

◆ GetIndexOfChildWithName()

llvm::Expected< size_t > lldb_private::SyntheticValueProviderFrontEnd::GetIndexOfChildWithName ( ConstString name)
inlineoverridevirtual

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 122 of file TypeSynthetic.h.

References lldb_private::ConstString::AsCString().

◆ GetSyntheticValue()

lldb::ValueObjectSP lldb_private::SyntheticValueProviderFrontEnd::GetSyntheticValue ( )
overridepure virtual

◆ MightHaveChildren()

bool lldb_private::SyntheticValueProviderFrontEnd::MightHaveChildren ( )
inlineoverridevirtual

Reimplemented from lldb_private::SyntheticChildrenFrontEnd.

Definition at line 131 of file TypeSynthetic.h.

◆ operator=()

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

◆ Update()

lldb::ChildCacheState lldb_private::SyntheticValueProviderFrontEnd::Update ( )
inlineoverridevirtual

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 127 of file TypeSynthetic.h.

References lldb::eRefetch.


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