LLDB mainline
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
lldb::SBBlock Class Reference

#include <SBBlock.h>

Public Member Functions

 SBBlock ()
 
 SBBlock (const lldb::SBBlock &rhs)
 
 ~SBBlock ()
 
const lldb::SBBlock & operator= (const lldb::SBBlock &rhs)
 
bool IsInlined () const
 
 operator bool () const
 
bool IsValid () const
 
const char * GetInlinedName () const
 
lldb::SBFileSpec GetInlinedCallSiteFile () const
 
uint32_t GetInlinedCallSiteLine () const
 
uint32_t GetInlinedCallSiteColumn () const
 
lldb::SBBlock GetParent ()
 
lldb::SBBlock GetSibling ()
 
lldb::SBBlock GetFirstChild ()
 
uint32_t GetNumRanges ()
 
lldb::SBAddress GetRangeStartAddress (uint32_t idx)
 
lldb::SBAddress GetRangeEndAddress (uint32_t idx)
 
uint32_t GetRangeIndexForBlockAddress (lldb::SBAddress block_addr)
 
lldb::SBValueList GetVariables (lldb::SBFrame &frame, bool arguments, bool locals, bool statics, lldb::DynamicValueType use_dynamic)
 
lldb::SBValueList GetVariables (lldb::SBTarget &target, bool arguments, bool locals, bool statics)
 
lldb::SBBlock GetContainingInlinedBlock ()
 Get the inlined block that contains this block.
 
bool GetDescription (lldb::SBStream &description)
 

Private Member Functions

lldb_private::Block * GetPtr ()
 
void SetPtr (lldb_private::Block *lldb_object_ptr)
 
 SBBlock (lldb_private::Block *lldb_object_ptr)
 
void AppendVariables (bool can_create, bool get_parent_variables, lldb_private::VariableList *var_list)
 

Private Attributes

lldb_private::Block * m_opaque_ptr = nullptr
 

Friends

class SBAddress
 
class SBFrame
 
class SBFunction
 
class SBSymbolContext
 

Detailed Description

Definition at line 19 of file SBBlock.h.

Constructor & Destructor Documentation

◆ SBBlock() [1/3]

SBBlock::SBBlock ( )

Definition at line 28 of file SBBlock.cpp.

References LLDB_INSTRUMENT_VA.

◆ SBBlock() [2/3]

SBBlock::SBBlock ( const lldb::SBBlock &  rhs)

Definition at line 33 of file SBBlock.cpp.

References LLDB_INSTRUMENT_VA.

◆ ~SBBlock()

SBBlock::~SBBlock ( )

Definition at line 44 of file SBBlock.cpp.

References m_opaque_ptr.

◆ SBBlock() [3/3]

SBBlock::SBBlock ( lldb_private::Block *  lldb_object_ptr)
private

Definition at line 30 of file SBBlock.cpp.

Member Function Documentation

◆ AppendVariables()

void SBBlock::AppendVariables ( bool  can_create,
bool  get_parent_variables,
lldb_private::VariableList *  var_list 
)
private

Definition at line 114 of file SBBlock.cpp.

References lldb_private::Block::AppendVariables(), IsValid(), and m_opaque_ptr.

◆ GetContainingInlinedBlock()

lldb::SBBlock SBBlock::GetContainingInlinedBlock ( )

Get the inlined block that contains this block.

Returns
If this block is inlined, it will return this block, else parent blocks will be searched to see if any contain this block and are themselves inlined. An invalid SBBlock will be returned if this block nor any parent blocks are inlined function blocks.

Definition at line 132 of file SBBlock.cpp.

References lldb_private::Block::GetContainingInlinedBlock(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ GetDescription()

bool SBBlock::GetDescription ( lldb::SBStream &  description)

Definition at line 163 of file SBBlock.cpp.

References lldb_private::Block::CalculateSymbolContext(), lldb_private::Block::DumpAddressRanges(), lldb_private::SymbolContext::function, lldb_private::Function::GetAddressRange(), lldb_private::AddressRange::GetBaseAddress(), lldb_private::Address::GetFileAddress(), lldb_private::UserID::GetID(), GetInlinedName(), IsInlined(), LLDB_INSTRUMENT_VA, m_opaque_ptr, lldb_private::Stream::Printf(), lldb_private::Stream::PutCString(), and lldb::SBStream::ref().

◆ GetFirstChild()

SBBlock SBBlock::GetFirstChild ( )

Definition at line 150 of file SBBlock.cpp.

References lldb_private::Block::GetFirstChild(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ GetInlinedCallSiteColumn()

uint32_t SBBlock::GetInlinedCallSiteColumn ( ) const

Definition at line 102 of file SBBlock.cpp.

References lldb_private::InlineFunctionInfo::GetCallSite(), lldb_private::Declaration::GetColumn(), lldb_private::Block::GetInlinedFunctionInfo(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ GetInlinedCallSiteFile()

SBFileSpec SBBlock::GetInlinedCallSiteFile ( ) const

Definition at line 77 of file SBBlock.cpp.

References lldb_private::InlineFunctionInfo::GetCallSite(), lldb_private::Declaration::GetFile(), lldb_private::Block::GetInlinedFunctionInfo(), LLDB_INSTRUMENT_VA, m_opaque_ptr, and lldb::SBFileSpec::SetFileSpec().

◆ GetInlinedCallSiteLine()

uint32_t SBBlock::GetInlinedCallSiteLine ( ) const

Definition at line 90 of file SBBlock.cpp.

References lldb_private::InlineFunctionInfo::GetCallSite(), lldb_private::Block::GetInlinedFunctionInfo(), lldb_private::Declaration::GetLine(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ GetInlinedName()

const char * SBBlock::GetInlinedName ( ) const

Definition at line 64 of file SBBlock.cpp.

References lldb_private::ConstString::AsCString(), lldb_private::Block::GetInlinedFunctionInfo(), lldb_private::InlineFunctionInfo::GetName(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

Referenced by GetDescription().

◆ GetNumRanges()

uint32_t SBBlock::GetNumRanges ( )

Definition at line 187 of file SBBlock.cpp.

References lldb_private::Block::GetNumRanges(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ GetParent()

SBBlock SBBlock::GetParent ( )

Definition at line 123 of file SBBlock.cpp.

References lldb_private::Block::GetParent(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ GetPtr()

lldb_private::Block * SBBlock::GetPtr ( )
private

Definition at line 159 of file SBBlock.cpp.

References m_opaque_ptr.

Referenced by GetVariables(), and lldb::SBSymbolContext::SetBlock().

◆ GetRangeEndAddress()

lldb::SBAddress SBBlock::GetRangeEndAddress ( uint32_t  idx)

Definition at line 208 of file SBBlock.cpp.

References lldb_private::AddressRange::GetBaseAddress(), lldb_private::AddressRange::GetByteSize(), lldb_private::Block::GetRangeAtIndex(), LLDB_INSTRUMENT_VA, m_opaque_ptr, lldb::SBAddress::ref(), and lldb_private::Address::Slide().

◆ GetRangeIndexForBlockAddress()

uint32_t SBBlock::GetRangeIndexForBlockAddress ( lldb::SBAddress  block_addr)

Definition at line 222 of file SBBlock.cpp.

References lldb_private::Block::GetRangeIndexContainingAddress(), lldb::SBAddress::IsValid(), LLDB_INSTRUMENT_VA, m_opaque_ptr, lldb::SBAddress::ref(), and UINT32_MAX.

◆ GetRangeStartAddress()

lldb::SBAddress SBBlock::GetRangeStartAddress ( uint32_t  idx)

Definition at line 195 of file SBBlock.cpp.

References lldb_private::AddressRange::GetBaseAddress(), lldb_private::Block::GetRangeAtIndex(), LLDB_INSTRUMENT_VA, m_opaque_ptr, and lldb::SBAddress::ref().

◆ GetSibling()

SBBlock SBBlock::GetSibling ( )

Definition at line 141 of file SBBlock.cpp.

References lldb_private::Block::GetSibling(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ GetVariables() [1/2]

lldb::SBValueList SBBlock::GetVariables ( lldb::SBFrame &  frame,
bool  arguments,
bool  locals,
bool  statics,
lldb::DynamicValueType  use_dynamic 
)

Definition at line 232 of file SBBlock.cpp.

References lldb::SBValueList::Append(), lldb::eNoDynamicValues, lldb::eValueTypeVariableArgument, lldb::eValueTypeVariableGlobal, lldb::eValueTypeVariableLocal, lldb::eValueTypeVariableStatic, lldb::eValueTypeVariableThreadLocal, lldb_private::Block::GetBlockVariableList(), lldb::SBFrame::GetFrameSP(), GetPtr(), LLDB_INSTRUMENT_VA, and lldb::SBValue::SetSP().

◆ GetVariables() [2/2]

lldb::SBValueList SBBlock::GetVariables ( lldb::SBTarget &  target,
bool  arguments,
bool  locals,
bool  statics 
)

Definition at line 286 of file SBBlock.cpp.

References lldb::SBValueList::Append(), lldb_private::ValueObjectVariable::Create(), lldb::eValueTypeVariableArgument, lldb::eValueTypeVariableGlobal, lldb::eValueTypeVariableLocal, lldb::eValueTypeVariableStatic, lldb::eValueTypeVariableThreadLocal, lldb_private::Block::GetBlockVariableList(), GetPtr(), lldb::SBTarget::GetSP(), and LLDB_INSTRUMENT_VA.

◆ IsInlined()

bool SBBlock::IsInlined ( ) const

Definition at line 56 of file SBBlock.cpp.

References lldb_private::Block::GetInlinedFunctionInfo(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

Referenced by GetDescription().

◆ IsValid()

bool SBBlock::IsValid ( ) const

Definition at line 46 of file SBBlock.cpp.

References LLDB_INSTRUMENT_VA.

Referenced by AppendVariables().

◆ operator bool()

SBBlock::operator bool ( ) const
explicit

Definition at line 50 of file SBBlock.cpp.

References LLDB_INSTRUMENT_VA.

◆ operator=()

const SBBlock & SBBlock::operator= ( const lldb::SBBlock &  rhs)

Definition at line 37 of file SBBlock.cpp.

References LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ SetPtr()

void SBBlock::SetPtr ( lldb_private::Block *  lldb_object_ptr)
private

Definition at line 161 of file SBBlock.cpp.

References m_opaque_ptr.

Referenced by lldb::SBAddress::GetBlock(), lldb::SBFunction::GetBlock(), lldb::SBFrame::GetBlock(), and lldb::SBFrame::GetFrameBlock().

Friends And Related Function Documentation

◆ SBAddress

friend class SBAddress
friend

Definition at line 76 of file SBBlock.h.

◆ SBFrame

friend class SBFrame
friend

Definition at line 77 of file SBBlock.h.

◆ SBFunction

friend class SBFunction
friend

Definition at line 78 of file SBBlock.h.

◆ SBSymbolContext

friend class SBSymbolContext
friend

Definition at line 79 of file SBBlock.h.

Member Data Documentation

◆ m_opaque_ptr

lldb_private::Block* lldb::SBBlock::m_opaque_ptr = nullptr
private

Definition at line 90 of file SBBlock.h.

Referenced by AppendVariables(), GetContainingInlinedBlock(), GetDescription(), GetFirstChild(), GetInlinedCallSiteColumn(), GetInlinedCallSiteFile(), GetInlinedCallSiteLine(), GetInlinedName(), GetNumRanges(), GetParent(), GetPtr(), GetRangeEndAddress(), GetRangeIndexForBlockAddress(), GetRangeStartAddress(), GetSibling(), IsInlined(), operator=(), SetPtr(), and ~SBBlock().

The documentation for this class was generated from the following files:
Generated on Sun Apr 28 2024 07:40:10 for LLDB by doxygen 1.9.6