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
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
StructuredData::ObjectSP m_wrapper_sp
ScriptInterpreterm_interpreter

Additional Inherited Members

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 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 196 of file TypeSynthetic.cpp.

References m_interpreter, m_wrapper_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 203 of file TypeSynthetic.cpp.

References m_interpreter, and m_wrapper_sp.

◆ GetChildAtIndex()

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

Implements lldb_private::SyntheticChildrenFrontEnd.

Definition at line 184 of file TypeSynthetic.cpp.

References m_interpreter, and m_wrapper_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 226 of file TypeSynthetic.cpp.

References lldb_private::ConstString::AsCString(), lldb_private::ConstString::GetCString(), m_interpreter, and m_wrapper_sp.

◆ GetSyntheticTypeName()

ConstString ScriptedSyntheticChildren::FrontEnd::GetSyntheticTypeName ( )
overridevirtual

Reimplemented from lldb_private::SyntheticChildrenFrontEnd.

Definition at line 241 of file TypeSynthetic.cpp.

References m_interpreter, and m_wrapper_sp.

◆ GetSyntheticValue()

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

Reimplemented from lldb_private::SyntheticChildrenFrontEnd.

Definition at line 234 of file TypeSynthetic.cpp.

References m_interpreter, and m_wrapper_sp.

◆ IsValid()

bool ScriptedSyntheticChildren::FrontEnd::IsValid ( )

Definition at line 191 of file TypeSynthetic.cpp.

References m_interpreter, and m_wrapper_sp.

◆ MightHaveChildren()

bool ScriptedSyntheticChildren::FrontEnd::MightHaveChildren ( )
overridevirtual

Reimplemented from lldb_private::SyntheticChildrenFrontEnd.

Definition at line 218 of file TypeSynthetic.cpp.

References m_interpreter, and m_wrapper_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 209 of file TypeSynthetic.cpp.

References lldb::eRefetch, lldb::eReuse, m_interpreter, and m_wrapper_sp.

Member Data Documentation

◆ m_interpreter

ScriptInterpreter* lldb_private::ScriptedSyntheticChildren::FrontEnd::m_interpreter
private

◆ m_python_class

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

Definition at line 477 of file TypeSynthetic.h.

Referenced by FrontEnd().

◆ m_wrapper_sp


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