LLDB mainline
Public Member Functions | Private Member Functions | List of all members
lldb_private::SyntheticValueProviderFrontEnd Class Referenceabstract

#include <TypeSynthetic.h>

Inheritance diagram for lldb_private::SyntheticValueProviderFrontEnd:
Inheritance graph
[legend]

Public Member Functions

 SyntheticValueProviderFrontEnd (ValueObject &backend)
 
 ~SyntheticValueProviderFrontEnd () override=default
 
llvm::Expected< uint32_t > CalculateNumChildren () override
 
lldb::ValueObjectSP GetChildAtIndex (uint32_t idx) override
 
size_t GetIndexOfChildWithName (ConstString name) 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
 
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 ()=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

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

Constructor & Destructor Documentation

◆ SyntheticValueProviderFrontEnd() [1/2]

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

Definition at line 111 of file TypeSynthetic.h.

◆ ~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 116 of file TypeSynthetic.h.

◆ GetChildAtIndex()

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

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 118 of file TypeSynthetic.h.

◆ GetIndexOfChildWithName()

size_t lldb_private::SyntheticValueProviderFrontEnd::GetIndexOfChildWithName ( ConstString  name)
inlineoverridevirtual

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 120 of file TypeSynthetic.h.

References UINT32_MAX.

◆ GetSyntheticValue()

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

◆ MightHaveChildren()

bool lldb_private::SyntheticValueProviderFrontEnd::MightHaveChildren ( )
inlineoverridevirtual

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 128 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 "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 124 of file TypeSynthetic.h.

References lldb::eRefetch.


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