#include <SBValue.h>

Collaboration diagram for lldb::SBValue:

Public Member Functions
	SBValue ()

	SBValue (const lldb::SBValue &rhs)

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

	~SBValue ()

	operator bool () const

bool	IsValid ()

void	Clear ()

SBError	GetError ()

lldb::user_id_t	GetID ()

const char *	GetName ()

const char *	GetTypeName ()

const char *	GetDisplayTypeName ()

size_t	GetByteSize ()

bool	IsInScope ()

lldb::Format	GetFormat ()

void	SetFormat (lldb::Format format)

const char *	GetValue ()

int64_t	GetValueAsSigned (lldb::SBError &error, int64_t fail_value=0)

uint64_t	GetValueAsUnsigned (lldb::SBError &error, uint64_t fail_value=0)

int64_t	GetValueAsSigned (int64_t fail_value=0)

uint64_t	GetValueAsUnsigned (uint64_t fail_value=0)

ValueType	GetValueType ()

bool	GetValueDidChange ()

const char *	GetSummary ()

const char *	GetSummary (lldb::SBStream &stream, lldb::SBTypeSummaryOptions &options)

const char *	GetObjectDescription ()

lldb::SBValue	GetDynamicValue (lldb::DynamicValueType use_dynamic)

lldb::SBValue	GetStaticValue ()

lldb::SBValue	GetNonSyntheticValue ()

lldb::DynamicValueType	GetPreferDynamicValue ()

void	SetPreferDynamicValue (lldb::DynamicValueType use_dynamic)

bool	GetPreferSyntheticValue ()

void	SetPreferSyntheticValue (bool use_synthetic)

bool	IsDynamic ()

bool	IsSynthetic ()

bool	IsSyntheticChildrenGenerated ()

void	SetSyntheticChildrenGenerated (bool)

const char *	GetLocation ()

bool	SetValueFromCString (const char *value_str)

bool	SetValueFromCString (const char *value_str, lldb::SBError &error)

lldb::SBTypeFormat	GetTypeFormat ()

lldb::SBTypeSummary	GetTypeSummary ()

lldb::SBTypeFilter	GetTypeFilter ()

lldb::SBTypeSynthetic	GetTypeSynthetic ()

lldb::SBValue	GetChildAtIndex (uint32_t idx)

lldb::SBValue	CreateChildAtOffset (const char *name, uint32_t offset, lldb::SBType type)

lldb::SBValue	Cast (lldb::SBType type)

lldb::SBValue	CreateValueFromExpression (const char name, const char expression)

lldb::SBValue	CreateValueFromExpression (const char name, const char expression, SBExpressionOptions &options)

lldb::SBValue	CreateValueFromAddress (const char *name, lldb::addr_t address, lldb::SBType type)

lldb::SBValue	CreateValueFromData (const char *name, lldb::SBData data, lldb::SBType type)

lldb::SBValue	GetChildAtIndex (uint32_t idx, lldb::DynamicValueType use_dynamic, bool can_create_synthetic)
	Get a child value by index from a value.

uint32_t	GetIndexOfChildWithName (const char *name)

lldb::SBValue	GetChildMemberWithName (const char *name)

lldb::SBValue	GetChildMemberWithName (const char *name, lldb::DynamicValueType use_dynamic)

lldb::SBValue	GetValueForExpressionPath (const char *expr_path)

lldb::SBValue	AddressOf ()

lldb::addr_t	GetLoadAddress ()

lldb::SBAddress	GetAddress ()

lldb::SBData	GetPointeeData (uint32_t item_idx=0, uint32_t item_count=1)
	Get an SBData wrapping what this SBValue points to.

lldb::SBData	GetData ()
	Get an SBData wrapping the contents of this SBValue.

bool	SetData (lldb::SBData &data, lldb::SBError &error)

lldb::SBValue	Clone (const char *new_name)
	Creates a copy of the SBValue with a new name and setting the current SBValue as its parent.

lldb::SBDeclaration	GetDeclaration ()

bool	MightHaveChildren ()
	Find out if a SBValue might have children.

bool	IsRuntimeSupportValue ()

uint32_t	GetNumChildren ()

uint32_t	GetNumChildren (uint32_t max)

void *	GetOpaqueType ()

lldb::SBTarget	GetTarget ()

lldb::SBProcess	GetProcess ()

lldb::SBThread	GetThread ()

lldb::SBFrame	GetFrame ()

lldb::SBValue	Dereference ()

bool	TypeIsPointerType ()

lldb::SBType	GetType ()

lldb::SBValue	Persist ()

bool	GetDescription (lldb::SBStream &description)

bool	GetExpressionPath (lldb::SBStream &description)

bool	GetExpressionPath (lldb::SBStream &description, bool qualify_cxx_base_classes)

lldb::SBValue	EvaluateExpression (const char *expr) const

lldb::SBValue	EvaluateExpression (const char *expr, const SBExpressionOptions &options) const

lldb::SBValue	EvaluateExpression (const char expr, const SBExpressionOptions &options, const char name) const

	SBValue (const lldb::ValueObjectSP &value_sp)

lldb::SBWatchpoint	Watch (bool resolve_location, bool read, bool write, SBError &error)
	Watch this value if it resides in memory.

lldb::SBWatchpoint	Watch (bool resolve_location, bool read, bool write)

lldb::SBWatchpoint	WatchPointee (bool resolve_location, bool read, bool write, SBError &error)
	Watch this value that this value points to in memory.

lldb::ValueObjectSP	GetSP () const
	Same as the protected version of GetSP that takes a locker, except that we make the locker locally in the function.

Protected Member Functions
lldb::ValueObjectSP	GetSP (ValueLocker &value_locker) const
	Get the appropriate ValueObjectSP from this SBValue, consulting the use_dynamic and use_synthetic options passed in to SetSP when the SBValue's contents were set.

void	SetSP (const lldb::ValueObjectSP &sp)

void	SetSP (const lldb::ValueObjectSP &sp, bool use_synthetic)

void	SetSP (const lldb::ValueObjectSP &sp, lldb::DynamicValueType use_dynamic)

void	SetSP (const lldb::ValueObjectSP &sp, lldb::DynamicValueType use_dynamic, bool use_synthetic)

void	SetSP (const lldb::ValueObjectSP &sp, lldb::DynamicValueType use_dynamic, bool use_synthetic, const char *name)

Private Types
typedef std::shared_ptr< ValueImpl >	ValueImplSP

Private Member Functions
void	SetSP (ValueImplSP impl_sp)

Private Attributes
ValueImplSP	m_opaque_sp

Friends
class	SBBlock

class	SBFrame

class	SBTarget

class	SBThread

class	SBValueList

Detailed Description

Definition at line 21 of file SBValue.h.

Member Typedef Documentation

◆ ValueImplSP

typedef std::shared_ptr<ValueImpl> lldb::SBValue::ValueImplSP

private

Definition at line 431 of file SBValue.h.

Constructor & Destructor Documentation

◆ SBValue() [1/3]

SBValue::SBValue ( )

Definition at line 216 of file SBValue.cpp.

References LLDB_INSTRUMENT_VA.

Referenced by EvaluateExpression().

◆ SBValue() [2/3]

SBValue::SBValue ( const lldb::SBValue & rhs )

Definition at line 224 of file SBValue.cpp.

References LLDB_INSTRUMENT_VA, m_opaque_sp, and SetSP().

◆ ~SBValue()

SBValue::~SBValue ( )

default

◆ SBValue() [3/3]

SBValue::SBValue ( const lldb::ValueObjectSP & value_sp )

Definition at line 218 of file SBValue.cpp.

References LLDB_INSTRUMENT_VA, and SetSP().

Member Function Documentation

◆ AddressOf()

lldb::SBValue SBValue::AddressOf ( )

Definition at line 1246 of file SBValue.cpp.

References error(), GetPreferDynamicValue(), GetPreferSyntheticValue(), GetSP(), LLDB_INSTRUMENT_VA, and SetSP().

◆ Cast()

lldb::SBValue SBValue::Cast ( lldb::SBType type )

Definition at line 574 of file SBValue.cpp.

References GetPreferDynamicValue(), GetPreferSyntheticValue(), lldb::SBType::GetSP(), GetSP(), LLDB_INSTRUMENT_VA, and SetSP().

◆ Clear()

void SBValue::Clear ( )

Definition at line 255 of file SBValue.cpp.

References LLDB_INSTRUMENT_VA, and m_opaque_sp.

◆ Clone()

lldb::SBValue SBValue::Clone ( const char * new_name )

Creates a copy of the SBValue with a new name and setting the current SBValue as its parent.

It should be used when we want to change the name of a SBValue without modifying the actual SBValue itself (e.g. sythetic child provider).

Definition at line 1390 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ CreateChildAtOffset()

lldb::SBValue SBValue::CreateChildAtOffset	(	const char *	name,
		uint32_t	offset,
		lldb::SBType	type
	)

Definition at line 555 of file SBValue.cpp.

References GetPreferDynamicValue(), GetPreferSyntheticValue(), lldb::SBType::GetSP(), GetSP(), lldb::SBType::IsValid(), LLDB_INSTRUMENT_VA, and SetSP().

◆ CreateValueFromAddress()

lldb::SBValue SBValue::CreateValueFromAddress	(	const char *	name,
		lldb::addr_t	address,
		lldb::SBType	type
	)

Definition at line 616 of file SBValue.cpp.

References lldb_private::ValueObject::CreateValueObjectFromAddress(), lldb::SBType::GetSP(), GetSP(), LLDB_INSTRUMENT_VA, and SetSP().

◆ CreateValueFromData()

lldb::SBValue SBValue::CreateValueFromData	(	const char *	name,
		lldb::SBData	data,
		lldb::SBType	type
	)

Definition at line 636 of file SBValue.cpp.

References lldb_private::ValueObject::CreateValueObjectFromData(), lldb_private::eAddressTypeLoad, lldb::SBType::GetSP(), GetSP(), LLDB_INSTRUMENT_VA, and SetSP().

◆ CreateValueFromExpression() [1/2]

lldb::SBValue SBValue::CreateValueFromExpression	(	const char *	name,
		const char *	expression
	)

Definition at line 587 of file SBValue.cpp.

References CreateValueFromExpression(), LLDB_INSTRUMENT_VA, lldb::SBExpressionOptions::ref(), and lldb_private::EvaluateExpressionOptions::SetKeepInMemory().

Referenced by CreateValueFromExpression().

◆ CreateValueFromExpression() [2/2]

lldb::SBValue SBValue::CreateValueFromExpression	(	const char *	name,
		const char *	expression,
		SBExpressionOptions &	options
	)

Definition at line 596 of file SBValue.cpp.

References lldb_private::ValueObject::CreateValueObjectFromExpression(), GetSP(), LLDB_INSTRUMENT_VA, lldb::SBExpressionOptions::ref(), and SetSP().

◆ Dereference()

SBValue SBValue::Dereference ( )

Definition at line 966 of file SBValue.cpp.

References Dereference(), error(), GetSP(), and LLDB_INSTRUMENT_VA.

Referenced by Dereference(), and WatchPointee().

◆ EvaluateExpression() [1/3]

lldb::SBValue SBValue::EvaluateExpression ( const char * expr ) const

Definition at line 1143 of file SBValue.cpp.

References EvaluateExpression(), GetSP(), LLDB_INSTRUMENT_VA, SBValue(), lldb::SBExpressionOptions::SetFetchDynamicValue(), lldb::SBExpressionOptions::SetIgnoreBreakpoints(), and lldb::SBExpressionOptions::SetUnwindOnError().

Referenced by EvaluateExpression().

◆ EvaluateExpression() [2/3]

lldb::SBValue SBValue::EvaluateExpression	(	const char *	expr,
		const SBExpressionOptions &	options
	)		const

Definition at line 1164 of file SBValue.cpp.

References EvaluateExpression(), and LLDB_INSTRUMENT_VA.

◆ EvaluateExpression() [3/3]

lldb::SBValue SBValue::EvaluateExpression	(	const char *	expr,
		const SBExpressionOptions &	options,
		const char *	name
	)		const

Definition at line 1171 of file SBValue.cpp.

References lldb::SBExpressionOptions::GetFetchDynamicValue(), lldb_private::ExecutionContext::GetFramePtr(), GetSP(), LLDB_INSTRUMENT_VA, lldb::SBExpressionOptions::ref(), SBValue(), and SetSP().

◆ GetAddress()

lldb::SBAddress SBValue::GetAddress ( )

Definition at line 1291 of file SBValue.cpp.

References lldb_private::eAddressTypeFile, lldb_private::eAddressTypeLoad, GetSP(), LLDB_INSTRUMENT_VA, LLDB_INVALID_ADDRESS, and lldb_private::Address::SetLoadAddress().

◆ GetByteSize()

size_t SBValue::GetByteSize ( )

Definition at line 325 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

Referenced by Watch().

◆ GetChildAtIndex() [1/2]

SBValue SBValue::GetChildAtIndex ( uint32_t idx )

Definition at line 655 of file SBValue.cpp.

References lldb::eNoDynamicValues, GetChildAtIndex(), LLDB_INSTRUMENT_VA, and m_opaque_sp.

Referenced by GetChildAtIndex().

◆ GetChildAtIndex() [2/2]

SBValue SBValue::GetChildAtIndex	(	uint32_t	idx,
		lldb::DynamicValueType	use_dynamic,
		bool	can_create_synthetic
	)

Get a child value by index from a value.

Structs, unions, classes, arrays and pointers have child values that can be access by index.

Structs and unions access child members using a zero based index for each child member. For

Classes reserve the first indexes for base classes that have members (empty base classes are omitted), and all members of the current class will then follow the base classes.

Pointers differ depending on what they point to. If the pointer points to a simple type, the child at index zero is the only child value available, unless synthetic_allowed is true, in which case the pointer will be used as an array and can create 'synthetic' child values using positive or negative indexes. If the pointer points to an aggregate type (an array, class, union, struct), then the pointee is transparently skipped and any children are going to be the indexes of the child values within the aggregate type. For example if we have a 'Point' type and we have a SBValue that contains a pointer to a 'Point' type, then the child at index zero will be the 'x' member, and the child at index 1 will be the 'y' member (the child at index zero won't be a 'Point' instance).

If you actually need an SBValue that represents the type pointed to by a SBValue for which GetType().IsPointeeType() returns true, regardless of the pointee type, you can do that with SBValue::Dereference.

Arrays have a preset number of children that can be accessed by index and will returns invalid child values for indexes that are out of bounds unless the synthetic_allowed is true. In this case the array can create 'synthetic' child values for indexes that aren't in the array bounds using positive or negative indexes.

Parameters

[in]	idx	The index of the child value to get
[in]	use_dynamic	An enumeration that specifies whether to get dynamic values, and also if the target can be run to figure out the dynamic type of the child value.
[in]	can_create_synthetic	If true, then allow child values to be created by index for pointers and arrays for indexes that normally wouldn't be allowed.

Returns: A new SBValue object that represents the child member value.

Definition at line 670 of file SBValue.cpp.

References GetPreferSyntheticValue(), GetSP(), LLDB_INSTRUMENT_VA, and SetSP().

◆ GetChildMemberWithName() [1/2]

SBValue SBValue::GetChildMemberWithName ( const char * name )

Definition at line 705 of file SBValue.cpp.

References lldb::eNoDynamicValues, GetChildMemberWithName(), LLDB_INSTRUMENT_VA, and m_opaque_sp.

Referenced by GetChildMemberWithName().

◆ GetChildMemberWithName() [2/2]

SBValue SBValue::GetChildMemberWithName	(	const char *	name,
		lldb::DynamicValueType	use_dynamic
	)

Definition at line 719 of file SBValue.cpp.

References GetPreferSyntheticValue(), GetSP(), LLDB_INSTRUMENT_VA, and SetSP().

◆ GetData()

lldb::SBData SBValue::GetData ( )

Get an SBData wrapping the contents of this SBValue.

This method will read the contents of this object in memory and copy them into an SBData for future use.

Returns: An SBData with the contents of this SBValue, on success. An empty SBData otherwise.

Definition at line 1339 of file SBValue.cpp.

References error(), GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetDeclaration()

lldb::SBDeclaration SBValue::GetDeclaration ( )

Definition at line 1402 of file SBValue.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and lldb::SBDeclaration::SetDeclaration().

◆ GetDescription()

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

Definition at line 1212 of file SBValue.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, lldb_private::Stream::PutCString(), and lldb::SBStream::ref().

◆ GetDisplayTypeName()

const char * SBValue::GetDisplayTypeName ( )

Definition at line 312 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetDynamicValue()

lldb::SBValue SBValue::GetDynamicValue ( lldb::DynamicValueType use_dynamic )

Definition at line 738 of file SBValue.cpp.

References IsValid(), LLDB_INSTRUMENT_VA, m_opaque_sp, and SetSP().

◆ GetError()

SBError SBValue::GetError ( )

Definition at line 261 of file SBValue.cpp.

References lldb_private::Status::AsCString(), ValueLocker::GetError(), GetSP(), LLDB_INSTRUMENT_VA, lldb::SBError::SetError(), and lldb::SBError::SetErrorStringWithFormat().

◆ GetExpressionPath() [1/2]

bool SBValue::GetExpressionPath ( lldb::SBStream & description )

Definition at line 1118 of file SBValue.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and lldb::SBStream::ref().

◆ GetExpressionPath() [2/2]

bool SBValue::GetExpressionPath	(	lldb::SBStream &	description,
		bool	qualify_cxx_base_classes
	)

Definition at line 1130 of file SBValue.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and lldb::SBStream::ref().

◆ GetFormat()

lldb::Format SBValue::GetFormat ( )

Definition at line 1227 of file SBValue.cpp.

References lldb::eFormatDefault, GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetFrame()

lldb::SBFrame SBValue::GetFrame ( )

Definition at line 1036 of file SBValue.cpp.

References LLDB_INSTRUMENT_VA, m_opaque_sp, and lldb::SBFrame::SetFrameSP().

◆ GetID()

user_id_t SBValue::GetID ( )

Definition at line 277 of file SBValue.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and LLDB_INVALID_UID.

◆ GetIndexOfChildWithName()

uint32_t SBValue::GetIndexOfChildWithName ( const char * name )

Definition at line 693 of file SBValue.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and UINT32_MAX.

◆ GetLoadAddress()

lldb::addr_t SBValue::GetLoadAddress ( )

Definition at line 1261 of file SBValue.cpp.

References lldb_private::eAddressTypeFile, lldb_private::eAddressTypeHost, lldb_private::eAddressTypeInvalid, lldb_private::Address::GetLoadAddress(), GetSP(), LLDB_INSTRUMENT_VA, and LLDB_INVALID_ADDRESS.

Referenced by Watch().

◆ GetLocation()

const char * SBValue::GetLocation ( )

Definition at line 448 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetName()

const char * SBValue::GetName ( )

Definition at line 287 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetNonSyntheticValue()

lldb::SBValue SBValue::GetNonSyntheticValue ( )

Definition at line 763 of file SBValue.cpp.

References IsValid(), LLDB_INSTRUMENT_VA, m_opaque_sp, and SetSP().

◆ GetNumChildren() [1/2]

uint32_t SBValue::GetNumChildren ( )

Definition at line 947 of file SBValue.cpp.

References GetNumChildren(), LLDB_INSTRUMENT_VA, and UINT32_MAX.

Referenced by GetNumChildren().

◆ GetNumChildren() [2/2]

uint32_t SBValue::GetNumChildren ( uint32_t max )

Definition at line 953 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetObjectDescription()

const char * SBValue::GetObjectDescription ( )

Definition at line 378 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetOpaqueType()

void * SBValue::GetOpaqueType ( )

Definition at line 987 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetPointeeData()

lldb::SBData SBValue::GetPointeeData	(	uint32_t	item_idx = `0`,
		uint32_t	item_count = `1`
	)

Get an SBData wrapping what this SBValue points to.

This method will dereference the current SBValue, if its data type is a T* or T[], and extract item_count elements of type T from it, copying their contents in an SBData.

Parameters

[in]	item_idx	The index of the first item to retrieve. For an array this is equivalent to array[item_idx], for a pointer to *(pointer + item_idx). In either case, the measurement unit for item_idx is the sizeof(T) rather than the byte
[in]	item_count	How many items should be copied into the output. By default only one item is copied, but more can be asked for.

Returns: An SBData with the contents of the copied items, on success. An empty SBData otherwise.

Definition at line 1320 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetPreferDynamicValue()

lldb::DynamicValueType SBValue::GetPreferDynamicValue ( )

Definition at line 775 of file SBValue.cpp.

References lldb::eNoDynamicValues, IsValid(), LLDB_INSTRUMENT_VA, and m_opaque_sp.

Referenced by AddressOf(), Cast(), CreateChildAtOffset(), and GetValueForExpressionPath().

◆ GetPreferSyntheticValue()

bool SBValue::GetPreferSyntheticValue ( )

Definition at line 790 of file SBValue.cpp.

References IsValid(), LLDB_INSTRUMENT_VA, and m_opaque_sp.

Referenced by AddressOf(), Cast(), CreateChildAtOffset(), GetChildAtIndex(), GetChildMemberWithName(), and GetValueForExpressionPath().

◆ GetProcess()

lldb::SBProcess SBValue::GetProcess ( )

Definition at line 1010 of file SBValue.cpp.

References LLDB_INSTRUMENT_VA, m_opaque_sp, and lldb::SBProcess::SetSP().

◆ GetSP() [1/2]

lldb::ValueObjectSP SBValue::GetSP ( ) const

Same as the protected version of GetSP that takes a locker, except that we make the locker locally in the function.

Since the Target API mutex is recursive, and the StopLocker is a read lock, you can call this function even if you are already holding the two above-mentioned locks.

Returns: A ValueObjectSP of the best kind (static, dynamic or synthetic) we can cons up, in accordance with the SBValue's settings.

Definition at line 1057 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

Referenced by AddressOf(), Cast(), Clone(), CreateChildAtOffset(), CreateValueFromAddress(), CreateValueFromData(), CreateValueFromExpression(), Dereference(), lldb::SBTypeSummary::DoesPrintValue(), EvaluateExpression(), GetAddress(), GetByteSize(), GetChildAtIndex(), GetChildMemberWithName(), GetData(), GetDeclaration(), GetDescription(), GetDisplayTypeName(), GetError(), GetExpressionPath(), GetFormat(), GetID(), GetIndexOfChildWithName(), GetLoadAddress(), GetLocation(), GetName(), GetNumChildren(), GetObjectDescription(), GetOpaqueType(), GetPointeeData(), GetSP(), GetSummary(), GetType(), GetTypeFilter(), GetTypeFormat(), GetTypeName(), GetTypeSummary(), GetTypeSynthetic(), GetValue(), GetValueAsSigned(), GetValueAsUnsigned(), GetValueDidChange(), GetValueForExpressionPath(), GetValueType(), IsDynamic(), IsInScope(), IsRuntimeSupportValue(), IsSynthetic(), IsSyntheticChildrenGenerated(), MightHaveChildren(), Persist(), lldb::SBThread::ReturnFromFrame(), SetData(), SetFormat(), SetSyntheticChildrenGenerated(), SetValueFromCString(), and Watch().

◆ GetSP() [2/2]

lldb::ValueObjectSP SBValue::GetSP ( ValueLocker & value_locker ) const

protected

Get the appropriate ValueObjectSP from this SBValue, consulting the use_dynamic and use_synthetic options passed in to SetSP when the SBValue's contents were set.

Since this often requires examining memory, and maybe even running code, it needs to acquire the Target API and Process StopLock. Those are held in an opaque class ValueLocker which is currently local to SBValue.cpp. So you don't have to get these yourself just default construct a ValueLocker, and pass it into this. If we need to make a ValueLocker and use it in some other .cpp file, we'll have to move it to ValueObject.h/cpp or somewhere else convenient. We haven't needed to so far.

Parameters

[in] value_locker An object that will hold the Target API, and Process RunLocks, and auto-destroy them when it goes out of scope. Currently this is only useful in SBValue.cpp.

Returns: A ValueObjectSP of the best kind (static, dynamic or synthetic) we can cons up, in accordance with the SBValue's settings.

Definition at line 1049 of file SBValue.cpp.

References ValueLocker::GetError(), ValueLocker::GetLockedSP(), m_opaque_sp, and lldb_private::Status::SetErrorString().

◆ GetStaticValue()

lldb::SBValue SBValue::GetStaticValue ( )

Definition at line 750 of file SBValue.cpp.

References lldb::eNoDynamicValues, IsValid(), LLDB_INSTRUMENT_VA, m_opaque_sp, and SetSP().

◆ GetSummary() [1/2]

const char * SBValue::GetSummary ( )

Definition at line 420 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

Referenced by lldb::SBFrame::EvaluateExpression(), and lldb::SBTarget::EvaluateExpression().

◆ GetSummary() [2/2]

const char * SBValue::GetSummary	(	lldb::SBStream &	stream,
		lldb::SBTypeSummaryOptions &	options
	)

Definition at line 433 of file SBValue.cpp.

References lldb::SBStream::GetData(), GetSP(), LLDB_INSTRUMENT_VA, lldb::SBStream::Printf(), and lldb::SBTypeSummaryOptions::ref().

◆ GetTarget()

lldb::SBTarget SBValue::GetTarget ( )

Definition at line 997 of file SBValue.cpp.

References LLDB_INSTRUMENT_VA, m_opaque_sp, and lldb::SBTarget::SetSP().

Referenced by Watch().

◆ GetThread()

lldb::SBThread SBValue::GetThread ( )

Definition at line 1023 of file SBValue.cpp.

References LLDB_INSTRUMENT_VA, m_opaque_sp, and lldb::SBThread::SetThread().

◆ GetType()

SBType SBValue::GetType ( )

Definition at line 391 of file SBValue.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and lldb::SBType::SetSP().

Referenced by TypeIsPointerType(), and WatchPointee().

◆ GetTypeFilter()

lldb::SBTypeFilter SBValue::GetTypeFilter ( )

Definition at line 515 of file SBValue.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and lldb::SBTypeFilter::SetSP().

◆ GetTypeFormat()

lldb::SBTypeFormat SBValue::GetTypeFormat ( )

Definition at line 483 of file SBValue.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and lldb::SBTypeFormat::SetSP().

◆ GetTypeName()

const char * SBValue::GetTypeName ( )

Definition at line 299 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetTypeSummary()

lldb::SBTypeSummary SBValue::GetTypeSummary ( )

Definition at line 499 of file SBValue.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and lldb::SBTypeSummary::SetSP().

◆ GetTypeSynthetic()

lldb::SBTypeSynthetic SBValue::GetTypeSynthetic ( )

Definition at line 535 of file SBValue.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and lldb::SBTypeSynthetic::SetSP().

◆ GetValue()

const char * SBValue::GetValue ( )

Definition at line 353 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

Referenced by lldb::SBFrame::EvaluateExpression(), and lldb::SBTarget::EvaluateExpression().

◆ GetValueAsSigned() [1/2]

int64_t SBValue::GetValueAsSigned ( int64_t fail_value = 0 )

Definition at line 901 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetValueAsSigned() [2/2]

int64_t SBValue::GetValueAsSigned	(	lldb::SBError &	error,
		int64_t	fail_value = `0`
	)

Definition at line 861 of file SBValue.cpp.

References lldb_private::Status::AsCString(), error(), ValueLocker::GetError(), GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetValueAsUnsigned() [1/2]

uint64_t SBValue::GetValueAsUnsigned	(	lldb::SBError &	error,
		uint64_t	fail_value = `0`
	)

Definition at line 881 of file SBValue.cpp.

References lldb_private::Status::AsCString(), error(), ValueLocker::GetError(), GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetValueAsUnsigned() [2/2]

uint64_t SBValue::GetValueAsUnsigned ( uint64_t fail_value = 0 )

Definition at line 912 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetValueDidChange()

bool SBValue::GetValueDidChange ( )

Definition at line 406 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ GetValueForExpressionPath()

lldb::SBValue SBValue::GetValueForExpressionPath ( const char * expr_path )

Definition at line 844 of file SBValue.cpp.

References GetPreferDynamicValue(), GetPreferSyntheticValue(), GetSP(), LLDB_INSTRUMENT_VA, and SetSP().

◆ GetValueType()

ValueType SBValue::GetValueType ( )

Definition at line 366 of file SBValue.cpp.

References lldb::eValueTypeInvalid, GetSP(), and LLDB_INSTRUMENT_VA.

◆ IsDynamic()

bool SBValue::IsDynamic ( )

Definition at line 805 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ IsInScope()

bool SBValue::IsInScope ( )

Definition at line 339 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

Referenced by Watch(), and WatchPointee().

◆ IsRuntimeSupportValue()

bool SBValue::IsRuntimeSupportValue ( )

Definition at line 935 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ IsSynthetic()

bool SBValue::IsSynthetic ( )

Definition at line 815 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ IsSyntheticChildrenGenerated()

bool SBValue::IsSyntheticChildrenGenerated ( )

Definition at line 825 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ IsValid()

bool SBValue::IsValid ( )

Definition at line 241 of file SBValue.cpp.

References LLDB_INSTRUMENT_VA.

Referenced by GetDynamicValue(), GetNonSyntheticValue(), GetPreferDynamicValue(), GetPreferSyntheticValue(), GetStaticValue(), SetPreferDynamicValue(), and SetPreferSyntheticValue().

◆ MightHaveChildren()

bool SBValue::MightHaveChildren ( )

Find out if a SBValue might have children.

This call is much more efficient than GetNumChildren() as it doesn't need to complete the underlying type. This is designed to be used in a UI environment in order to detect if the disclosure triangle should be displayed or not.

This function returns true for class, union, structure, pointers, references, arrays and more. Again, it does so without doing any expensive type completion.

Returns: Returns true if the SBValue might have children, or false otherwise.

Definition at line 923 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ operator bool()

SBValue::operator bool ( ) const

explicit

Definition at line 245 of file SBValue.cpp.

References LLDB_INSTRUMENT_VA.

◆ operator=()

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

Definition at line 230 of file SBValue.cpp.

References LLDB_INSTRUMENT_VA, m_opaque_sp, and SetSP().

◆ Persist()

lldb::SBValue SBValue::Persist ( )

Definition at line 1497 of file SBValue.cpp.

References GetSP(), LLDB_INSTRUMENT_VA, and SetSP().

◆ SetData()

bool SBValue::SetData	(	lldb::SBData &	data,
		lldb::SBError &	error
	)

Definition at line 1356 of file SBValue.cpp.

References lldb_private::Status::AsCString(), error(), lldb::SBData::get(), ValueLocker::GetError(), GetSP(), LLDB_INSTRUMENT_VA, and lldb_private::Status::Success().

◆ SetFormat()

void SBValue::SetFormat ( lldb::Format format )

Definition at line 1237 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ SetPreferDynamicValue()

void SBValue::SetPreferDynamicValue ( lldb::DynamicValueType use_dynamic )

Definition at line 783 of file SBValue.cpp.

References IsValid(), LLDB_INSTRUMENT_VA, and m_opaque_sp.

◆ SetPreferSyntheticValue()

void SBValue::SetPreferSyntheticValue ( bool use_synthetic )

Definition at line 798 of file SBValue.cpp.

References IsValid(), LLDB_INSTRUMENT_VA, and m_opaque_sp.

◆ SetSP() [1/6]

void SBValue::SetSP ( const lldb::ValueObjectSP & sp )

protected

Definition at line 1066 of file SBValue.cpp.

References lldb::eNoDynamicValues, m_opaque_sp, and sp.

Referenced by AddressOf(), Cast(), CreateChildAtOffset(), CreateValueFromAddress(), lldb::SBTarget::CreateValueFromAddress(), lldb::SBTarget::CreateValueFromData(), CreateValueFromData(), lldb::SBTarget::CreateValueFromExpression(), CreateValueFromExpression(), lldb::SBFrame::EvaluateExpression(), lldb::SBTarget::EvaluateExpression(), EvaluateExpression(), lldb::SBFrame::FindRegister(), lldb::SBFrame::FindValue(), lldb::SBFrame::FindVariable(), GetChildAtIndex(), GetChildMemberWithName(), GetDynamicValue(), GetNonSyntheticValue(), GetStaticValue(), GetValueForExpressionPath(), lldb::SBFrame::GetValueForVariablePath(), lldb::SBFrame::GetVariables(), lldb::SBBlock::GetVariables(), operator=(), Persist(), SBValue(), and SetSP().

◆ SetSP() [2/6]

void SBValue::SetSP	(	const lldb::ValueObjectSP &	sp,
		bool	use_synthetic
	)

protected

Definition at line 1094 of file SBValue.cpp.

References lldb::eNoDynamicValues, SetSP(), and sp.

◆ SetSP() [3/6]

void SBValue::SetSP	(	const lldb::ValueObjectSP &	sp,
		lldb::DynamicValueType	use_dynamic
	)

protected

Definition at line 1080 of file SBValue.cpp.

References SetSP(), and sp.

◆ SetSP() [4/6]

void SBValue::SetSP	(	const lldb::ValueObjectSP &	sp,
		lldb::DynamicValueType	use_dynamic,
		bool	use_synthetic
	)

protected

Definition at line 1106 of file SBValue.cpp.

References m_opaque_sp, and sp.

◆ SetSP() [5/6]

void SBValue::SetSP	(	const lldb::ValueObjectSP &	sp,
		lldb::DynamicValueType	use_dynamic,
		bool	use_synthetic,
		const char *	name
	)

protected

Definition at line 1111 of file SBValue.cpp.

References m_opaque_sp, and sp.

◆ SetSP() [6/6]

void SBValue::SetSP ( ValueImplSP impl_sp )

private

Definition at line 1064 of file SBValue.cpp.

References m_opaque_sp.

◆ SetSyntheticChildrenGenerated()

void SBValue::SetSyntheticChildrenGenerated ( bool is )

Definition at line 835 of file SBValue.cpp.

References GetSP(), and LLDB_INSTRUMENT_VA.

◆ SetValueFromCString() [1/2]

bool SBValue::SetValueFromCString ( const char * value_str )

Definition at line 461 of file SBValue.cpp.

References LLDB_INSTRUMENT_VA, and SetValueFromCString().

Referenced by SetValueFromCString().

◆ SetValueFromCString() [2/2]

bool SBValue::SetValueFromCString	(	const char *	value_str,
		lldb::SBError &	error
	)

Definition at line 468 of file SBValue.cpp.

References lldb_private::Status::AsCString(), error(), ValueLocker::GetError(), GetSP(), and LLDB_INSTRUMENT_VA.

◆ TypeIsPointerType()

bool SBValue::TypeIsPointerType ( )

Definition at line 981 of file SBValue.cpp.

References GetType(), lldb::SBType::IsPointerType(), and LLDB_INSTRUMENT_VA.

◆ Watch() [1/2]

lldb::SBWatchpoint SBValue::Watch	(	bool	resolve_location,
		bool	read,
		bool	write
	)

Definition at line 1479 of file SBValue.cpp.

References error(), LLDB_INSTRUMENT_VA, and Watch().

◆ Watch() [2/2]

lldb::SBWatchpoint SBValue::Watch	(	bool	resolve_location,
		bool	read,
		bool	write,
		SBError &	error
	)

Watch this value if it resides in memory.

Sets a watchpoint on the value.

Parameters

[in]	resolve_location	Resolve the location of this value once and watch its address. This value must currently be set to true as watching all locations of a variable or a variable path is not yet supported, though we plan to support it in the future.
[in]	read	Stop when this value is accessed.
[in]	write	Stop when this value is modified
[out]	error	An error object. Contains the reason if there is some failure.

Returns: An SBWatchpoint object. This object might not be valid upon return due to a value not being contained in memory, too large, or watchpoint resources are not available or all in use.

Definition at line 1416 of file SBValue.cpp.

References lldb_private::Status::AsCString(), lldb_private::Declaration::DumpStopContext(), error(), GetByteSize(), ValueLocker::GetError(), lldb_private::Declaration::GetFile(), GetLoadAddress(), GetSP(), lldb_private::StreamString::GetString(), GetTarget(), IsInScope(), LLDB_INSTRUMENT_VA, LLDB_INVALID_ADDRESS, LLDB_WATCH_TYPE_READ, LLDB_WATCH_TYPE_WRITE, and lldb::SBWatchpoint::SetSP().

Referenced by Watch(), and WatchPointee().

◆ WatchPointee()

lldb::SBWatchpoint SBValue::WatchPointee	(	bool	resolve_location,
		bool	read,
		bool	write,
		SBError &	error
	)

Watch this value that this value points to in memory.

Sets a watchpoint on the value.

Parameters

[in]	resolve_location	Resolve the location of this value once and watch its address. This value must currently be set to true as watching all locations of a variable or a variable path is not yet supported, though we plan to support it in the future.
[in]	read	Stop when this value is accessed.
[in]	write	Stop when this value is modified
[out]	error	An error object. Contains the reason if there is some failure.

Returns: An SBWatchpoint object. This object might not be valid upon return due to a value not being contained in memory, too large, or watchpoint resources are not available or all in use.

Definition at line 1487 of file SBValue.cpp.

References Dereference(), error(), GetType(), IsInScope(), LLDB_INSTRUMENT_VA, and Watch().

Friends And Related Function Documentation

◆ SBBlock

friend class SBBlock

friend

Definition at line 385 of file SBValue.h.

◆ SBFrame

friend class SBFrame

friend

Definition at line 386 of file SBValue.h.

◆ SBTarget

friend class SBTarget

friend

Definition at line 387 of file SBValue.h.

◆ SBThread

friend class SBThread

friend

Definition at line 388 of file SBValue.h.

◆ SBValueList

friend class SBValueList

friend

Definition at line 389 of file SBValue.h.

Member Data Documentation

◆ m_opaque_sp

ValueImplSP lldb::SBValue::m_opaque_sp

private

Definition at line 432 of file SBValue.h.

Referenced by Clear(), GetChildAtIndex(), GetChildMemberWithName(), GetDynamicValue(), GetFrame(), GetNonSyntheticValue(), GetPreferDynamicValue(), GetPreferSyntheticValue(), GetProcess(), GetSP(), GetStaticValue(), GetTarget(), GetThread(), operator=(), SBValue(), SetPreferDynamicValue(), SetPreferSyntheticValue(), and SetSP().

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ValueImplSP

Constructor & Destructor Documentation

◆ SBValue() [1/3]

◆ SBValue() [2/3]

◆ ~SBValue()

◆ SBValue() [3/3]

Member Function Documentation

◆ AddressOf()

◆ Cast()

◆ Clear()

◆ Clone()

◆ CreateChildAtOffset()

◆ CreateValueFromAddress()

◆ CreateValueFromData()

◆ CreateValueFromExpression() [1/2]

◆ CreateValueFromExpression() [2/2]

◆ Dereference()

◆ EvaluateExpression() [1/3]

◆ EvaluateExpression() [2/3]

◆ EvaluateExpression() [3/3]

◆ GetAddress()

◆ GetByteSize()

◆ GetChildAtIndex() [1/2]

◆ GetChildAtIndex() [2/2]

◆ GetChildMemberWithName() [1/2]

◆ GetChildMemberWithName() [2/2]

◆ GetData()

◆ GetDeclaration()

◆ GetDescription()

◆ GetDisplayTypeName()

◆ GetDynamicValue()

◆ GetError()

◆ GetExpressionPath() [1/2]

◆ GetExpressionPath() [2/2]

◆ GetFormat()

◆ GetFrame()

◆ GetID()

◆ GetIndexOfChildWithName()

◆ GetLoadAddress()

◆ GetLocation()

◆ GetName()

◆ GetNonSyntheticValue()

◆ GetNumChildren() [1/2]

◆ GetNumChildren() [2/2]

◆ GetObjectDescription()

◆ GetOpaqueType()

◆ GetPointeeData()

◆ GetPreferDynamicValue()

◆ GetPreferSyntheticValue()

◆ GetProcess()

◆ GetSP() [1/2]

◆ GetSP() [2/2]

◆ GetStaticValue()

◆ GetSummary() [1/2]

◆ GetSummary() [2/2]

◆ GetTarget()

◆ GetThread()

◆ GetType()

◆ GetTypeFilter()

◆ GetTypeFormat()

◆ GetTypeName()

◆ GetTypeSummary()

◆ GetTypeSynthetic()

◆ GetValue()

◆ GetValueAsSigned() [1/2]

◆ GetValueAsSigned() [2/2]

◆ GetValueAsUnsigned() [1/2]

◆ GetValueAsUnsigned() [2/2]

◆ GetValueDidChange()

◆ GetValueForExpressionPath()

◆ GetValueType()

◆ IsDynamic()