LLDB mainline
lldb_private::ScriptedSyntheticChildren::FrontEnd Class Reference

#include <TypeSynthetic.h>

Inheritance diagram for lldb_private::ScriptedSyntheticChildren::FrontEnd:
[legend]

Public Types

typedef std::shared_ptr< SyntheticChildrenFrontEndSharedPointer
Public Types inherited from lldb_private::SyntheticChildrenFrontEnd
typedef std::shared_ptr< SyntheticChildrenFrontEndSharedPointer
typedef std::unique_ptr< SyntheticChildrenFrontEndUniquePointer

Public Member Functions

 FrontEnd (std::string pclass, ValueObject &backend)
 ~FrontEnd () override
bool IsValid ()
llvm::Expected< uint32_t > CalculateNumChildren () override
llvm::Expected< uint32_t > CalculateNumChildren (uint32_t max) 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
llvm::Expected< size_t > GetIndexOfChildWithName (ConstString name) override
 Determine the index of a named child.
lldb::ValueObjectSP GetSyntheticValue () override
ConstString GetSyntheticTypeName () override
void * GetImplementation () override
Public Member Functions inherited from lldb_private::SyntheticChildrenFrontEnd
 SyntheticChildrenFrontEnd (ValueObject &backend)
virtual ~SyntheticChildrenFrontEnd ()=default
uint32_t CalculateNumChildrenIgnoringErrors (uint32_t max=UINT32_MAX)

Private Member Functions

 FrontEnd (const FrontEnd &)=delete
const FrontEndoperator= (const FrontEnd &)=delete

Private Attributes

std::string m_python_class
lldb::ScriptedSyntheticChildrenInterfaceSP m_interface_sp

Additional Inherited Members

Protected Member Functions inherited from lldb_private::SyntheticChildrenFrontEnd
lldb::ValueObjectSP CreateChildValueObjectFromExpression (llvm::StringRef name, llvm::StringRef expression, const ExecutionContext &exe_ctx)
lldb::ValueObjectSP CreateChildValueObjectFromAddress (llvm::StringRef name, uint64_t address, const ExecutionContext &exe_ctx, CompilerType type, bool do_deref=true)
lldb::ValueObjectSP CreateChildValueObjectFromData (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 450 of file TypeSynthetic.h.

Member Typedef Documentation

◆ SharedPointer

Constructor & Destructor Documentation

◆ FrontEnd() [1/2]

◆ ~FrontEnd()

ScriptedSyntheticChildren::FrontEnd::~FrontEnd ( )
overridedefault

◆ FrontEnd() [2/2]

lldb_private::ScriptedSyntheticChildren::FrontEnd::FrontEnd ( const FrontEnd & )
privatedelete

References FrontEnd().

Member Function Documentation

◆ CalculateNumChildren() [1/2]

llvm::Expected< uint32_t > ScriptedSyntheticChildren::FrontEnd::CalculateNumChildren ( )
overridevirtual

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 209 of file TypeSynthetic.cpp.

References m_interface_sp, and UINT32_MAX.

◆ CalculateNumChildren() [2/2]

llvm::Expected< uint32_t > ScriptedSyntheticChildren::FrontEnd::CalculateNumChildren ( uint32_t max)
overridevirtual

Reimplemented from lldb_private::SyntheticChildrenFrontEnd.

Definition at line 216 of file TypeSynthetic.cpp.

References m_interface_sp.

◆ GetChildAtIndex()

lldb::ValueObjectSP ScriptedSyntheticChildren::FrontEnd::GetChildAtIndex ( uint32_t idx)
overridevirtual

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 197 of file TypeSynthetic.cpp.

References m_interface_sp.

◆ GetImplementation()

void * ScriptedSyntheticChildren::FrontEnd::GetImplementation ( )
overridevirtual

Reimplemented from lldb_private::SyntheticChildrenFrontEnd.

Definition at line 257 of file TypeSynthetic.cpp.

References m_interface_sp.

◆ GetIndexOfChildWithName()

llvm::Expected< size_t > ScriptedSyntheticChildren::FrontEnd::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 237 of file TypeSynthetic.cpp.

References m_interface_sp.

◆ GetSyntheticTypeName()

ConstString ScriptedSyntheticChildren::FrontEnd::GetSyntheticTypeName ( )
overridevirtual

Reimplemented from lldb_private::SyntheticChildrenFrontEnd.

Definition at line 250 of file TypeSynthetic.cpp.

References m_interface_sp.

◆ GetSyntheticValue()

lldb::ValueObjectSP ScriptedSyntheticChildren::FrontEnd::GetSyntheticValue ( )
overridevirtual

Reimplemented from lldb_private::SyntheticChildrenFrontEnd.

Definition at line 243 of file TypeSynthetic.cpp.

References m_interface_sp.

◆ IsValid()

bool ScriptedSyntheticChildren::FrontEnd::IsValid ( )

Definition at line 204 of file TypeSynthetic.cpp.

References m_interface_sp.

◆ MightHaveChildren()

bool ScriptedSyntheticChildren::FrontEnd::MightHaveChildren ( )
overridevirtual

Reimplemented from lldb_private::SyntheticChildrenFrontEnd.

Definition at line 229 of file TypeSynthetic.cpp.

References m_interface_sp.

◆ operator=()

const FrontEnd & lldb_private::ScriptedSyntheticChildren::FrontEnd::operator= ( const FrontEnd & )
privatedelete

References FrontEnd().

◆ Update()

lldb::ChildCacheState ScriptedSyntheticChildren::FrontEnd::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 222 of file TypeSynthetic.cpp.

References lldb::eRefetch, and m_interface_sp.

Member Data Documentation

◆ m_interface_sp

◆ m_python_class

std::string lldb_private::ScriptedSyntheticChildren::FrontEnd::m_python_class
private

Definition at line 479 of file TypeSynthetic.h.

Referenced by FrontEnd().


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