#include <SBSymbol.h>

Public Member Functions
	SBSymbol ()

	~SBSymbol ()

	SBSymbol (const lldb::SBSymbol &rhs)

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

	operator bool () const

bool	IsValid () const

const char *	GetName () const

const char *	GetDisplayName () const

const char *	GetMangledName () const

lldb::SBInstructionList	GetInstructions (lldb::SBTarget target)

lldb::SBInstructionList	GetInstructions (lldb::SBTarget target, const char *flavor_string)

SBAddress	GetStartAddress ()
	Get the start address of this symbol.

SBAddress	GetEndAddress ()
	Get the end address of this symbol.

uint64_t	GetValue ()
	Get the raw value of a symbol.

uint64_t	GetSize ()
	Get the size of the symbol.

uint32_t	GetPrologueByteSize ()

SymbolType	GetType ()

bool	operator== (const lldb::SBSymbol &rhs) const

bool	operator!= (const lldb::SBSymbol &rhs) const

bool	GetDescription (lldb::SBStream &description)

bool	IsExternal ()

bool	IsSynthetic ()

Protected Member Functions
lldb_private::Symbol *	get ()

void	reset (lldb_private::Symbol *)

Private Member Functions
	SBSymbol (lldb_private::Symbol *lldb_object_ptr)

void	SetSymbol (lldb_private::Symbol *lldb_object_ptr)

Private Attributes
lldb_private::Symbol *	m_opaque_ptr = nullptr

Friends
class	SBAddress

class	SBFrame

class	SBModule

class	SBSymbolContext

Detailed Description

Definition at line 19 of file SBSymbol.h.

Constructor & Destructor Documentation

◆ SBSymbol() [1/3]

SBSymbol::SBSymbol ( )

Definition at line 21 of file SBSymbol.cpp.

References LLDB_INSTRUMENT_VA.

◆ ~SBSymbol()

SBSymbol::~SBSymbol ( )

Definition at line 37 of file SBSymbol.cpp.

References m_opaque_ptr.

◆ SBSymbol() [2/3]

SBSymbol::SBSymbol ( const lldb::SBSymbol & rhs )

Definition at line 26 of file SBSymbol.cpp.

References LLDB_INSTRUMENT_VA.

◆ SBSymbol() [3/3]

SBSymbol::SBSymbol ( lldb_private::Symbol * lldb_object_ptr )

private

Definition at line 23 of file SBSymbol.cpp.

Member Function Documentation

◆ get()

lldb_private::Symbol * SBSymbol::get ( )

protected

Definition at line 138 of file SBSymbol.cpp.

References m_opaque_ptr.

Referenced by lldb::SBSymbolContext::SetSymbol().

◆ GetDescription()

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

Definition at line 94 of file SBSymbol.cpp.

References lldb::eDescriptionLevelFull, lldb_private::Symbol::GetDescription(), LLDB_INSTRUMENT_VA, m_opaque_ptr, lldb_private::Stream::PutCString(), and lldb::SBStream::ref().

◆ GetDisplayName()

const char * SBSymbol::GetDisplayName ( ) const

Definition at line 63 of file SBSymbol.cpp.

References lldb_private::ConstString::AsCString(), lldb_private::Mangled::GetDisplayDemangledName(), lldb_private::Symbol::GetMangled(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ GetEndAddress()

SBAddress SBSymbol::GetEndAddress ( )

Get the end address of this symbol.

Returns: If the symbol's value is not an address, an invalid SBAddress object will be returned. If the symbol's value is an address, a valid SBAddress object will be returned.

Definition at line 152 of file SBSymbol.cpp.

References lldb_private::Symbol::GetAddressRef(), lldb_private::Symbol::GetByteSize(), LLDB_INSTRUMENT_VA, m_opaque_ptr, lldb::SBAddress::SetAddress(), lldb_private::Address::Slide(), and lldb_private::Symbol::ValueIsAddress().

◆ GetInstructions() [1/2]

SBInstructionList SBSymbol::GetInstructions ( lldb::SBTarget target )

Definition at line 107 of file SBSymbol.cpp.

References GetInstructions(), and LLDB_INSTRUMENT_VA.

Referenced by GetInstructions().

◆ GetInstructions() [2/2]

SBInstructionList SBSymbol::GetInstructions	(	lldb::SBTarget	target,
		const char *	flavor_string
	)

Definition at line 113 of file SBSymbol.cpp.

References lldb_private::Disassembler::DisassembleRange(), lldb_private::Symbol::GetAddressRef(), lldb_private::Symbol::GetByteSize(), lldb_private::Address::GetModule(), lldb::SBTarget::GetSP(), LLDB_INSTRUMENT_VA, m_opaque_ptr, lldb::SBInstructionList::SetDisassembler(), and lldb_private::Symbol::ValueIsAddress().

◆ GetMangledName()

const char * SBSymbol::GetMangledName ( ) const

Definition at line 73 of file SBSymbol.cpp.

References lldb_private::ConstString::AsCString(), lldb_private::Symbol::GetMangled(), lldb_private::Mangled::GetMangledName(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ GetName()

const char * SBSymbol::GetName ( ) const

Definition at line 53 of file SBSymbol.cpp.

References lldb_private::ConstString::AsCString(), lldb_private::Symbol::GetName(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ GetPrologueByteSize()

uint32_t SBSymbol::GetPrologueByteSize ( )

Definition at line 180 of file SBSymbol.cpp.

References lldb_private::Symbol::GetPrologueByteSize(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ GetSize()

uint64_t SBSymbol::GetSize ( )

Get the size of the symbol.

This accessor allows direct access to the symbol's size from the symbol table regardless of what the value is (address or integer value).

Returns: Returns the size of a symbol from the symbol table.

Definition at line 173 of file SBSymbol.cpp.

References lldb_private::Symbol::GetByteSize(), lldb_private::Symbol::GetByteSizeIsValid(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ GetStartAddress()

SBAddress SBSymbol::GetStartAddress ( )

Get the start address of this symbol.

Returns: If the symbol's value is not an address, an invalid SBAddress object will be returned. If the symbol's value is an address, a valid SBAddress object will be returned.

Definition at line 142 of file SBSymbol.cpp.

References lldb_private::Symbol::GetAddressRef(), LLDB_INSTRUMENT_VA, m_opaque_ptr, lldb::SBAddress::SetAddress(), and lldb_private::Symbol::ValueIsAddress().

◆ GetType()

SymbolType SBSymbol::GetType ( )

Definition at line 188 of file SBSymbol.cpp.

References lldb::eSymbolTypeInvalid, lldb_private::Symbol::GetType(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ GetValue()

uint64_t SBSymbol::GetValue ( )

Get the raw value of a symbol.

This accessor allows direct access to the symbol's value from the symbol table regardless of what the value is. The value can be a file address or it can be an integer value that depends on what the symbol's type is. Some symbol values are not addresses, but absolute values or integer values that can be mean different things. The GetStartAddress() accessor will only return a valid SBAddress if the symbol's value is an address, so this accessor provides a way to access the symbol's value when the value is not an address.

Returns: Returns the raw integer value of a symbol from the symbol table.

Definition at line 166 of file SBSymbol.cpp.

References lldb_private::Symbol::GetRawValue(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ IsExternal()

bool SBSymbol::IsExternal ( )

Definition at line 196 of file SBSymbol.cpp.

References lldb_private::Symbol::IsExternal(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ IsSynthetic()

bool SBSymbol::IsSynthetic ( )

Definition at line 204 of file SBSymbol.cpp.

References lldb_private::Symbol::IsSynthetic(), LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ IsValid()

bool SBSymbol::IsValid ( ) const

Definition at line 43 of file SBSymbol.cpp.

References LLDB_INSTRUMENT_VA.

◆ operator bool()

SBSymbol::operator bool ( ) const

explicit

Definition at line 47 of file SBSymbol.cpp.

References LLDB_INSTRUMENT_VA.

◆ operator!=()

bool SBSymbol::operator!= ( const lldb::SBSymbol & rhs ) const

Definition at line 88 of file SBSymbol.cpp.

References LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ operator=()

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

Definition at line 30 of file SBSymbol.cpp.

References LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ operator==()

bool SBSymbol::operator== ( const lldb::SBSymbol & rhs ) const

Definition at line 82 of file SBSymbol.cpp.

References LLDB_INSTRUMENT_VA, and m_opaque_ptr.

◆ reset()

void SBSymbol::reset ( lldb_private::Symbol * symbol )

protected

Definition at line 140 of file SBSymbol.cpp.

References m_opaque_ptr.

Referenced by lldb::SBAddress::GetSymbol(), and lldb::SBFrame::GetSymbol().

◆ SetSymbol()

void SBSymbol::SetSymbol ( lldb_private::Symbol * lldb_object_ptr )

private

Definition at line 39 of file SBSymbol.cpp.

References m_opaque_ptr.

Referenced by lldb::SBModule::FindSymbol(), and lldb::SBModule::GetSymbolAtIndex().

Friends And Related Function Documentation

◆ SBAddress

friend class SBAddress

friend

Definition at line 108 of file SBSymbol.h.

◆ SBFrame

friend class SBFrame

friend

Definition at line 109 of file SBSymbol.h.

◆ SBModule

friend class SBModule

friend

Definition at line 110 of file SBSymbol.h.

◆ SBSymbolContext

friend class SBSymbolContext

friend

Definition at line 111 of file SBSymbol.h.

Member Data Documentation

◆ m_opaque_ptr

lldb_private::Symbol* lldb::SBSymbol::m_opaque_ptr = nullptr

private

Definition at line 117 of file SBSymbol.h.

Referenced by get(), GetDescription(), GetDisplayName(), GetEndAddress(), GetInstructions(), GetMangledName(), GetName(), GetPrologueByteSize(), GetSize(), GetStartAddress(), GetType(), GetValue(), IsExternal(), IsSynthetic(), operator!=(), operator=(), operator==(), reset(), SetSymbol(), and ~SBSymbol().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SBSymbol() [1/3]

◆ ~SBSymbol()

◆ SBSymbol() [2/3]

◆ SBSymbol() [3/3]

Member Function Documentation

◆ get()

◆ GetDescription()

◆ GetDisplayName()

◆ GetEndAddress()

◆ GetInstructions() [1/2]

◆ GetInstructions() [2/2]

◆ GetMangledName()

◆ GetName()

◆ GetPrologueByteSize()

◆ GetSize()

◆ GetStartAddress()

◆ GetType()

◆ GetValue()

◆ IsExternal()

◆ IsSynthetic()

◆ IsValid()

◆ operator bool()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ reset()

◆ SetSymbol()

Friends And Related Function Documentation

◆ SBAddress

◆ SBFrame

◆ SBModule

◆ SBSymbolContext

Member Data Documentation

◆ m_opaque_ptr