#include <SBValue.h>

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 ()

const char *	GetTypeValidatorResult ()

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. More...

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. More...

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

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

lldb::SBDeclaration	GetDeclaration ()

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

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. More...

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. More...

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. More...

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. More...

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)

Friends
class	SBBlock

class	SBFrame

class	SBTarget

class	SBThread

class	SBValueList

Detailed Description

Definition at line 21 of file SBValue.h.

Constructor & Destructor Documentation

◆ SBValue() [1/3]

SBValue::SBValue ( )

Definition at line 218 of file SBValue.cpp.

References LLDB_RECORD_CONSTRUCTOR_NO_ARGS.

Referenced by EvaluateExpression().

◆ SBValue() [2/3]

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

Definition at line 226 of file SBValue.cpp.

References LLDB_RECORD_CONSTRUCTOR, and SetSP().

◆ ~SBValue()

SBValue::~SBValue ( )

Definition at line 242 of file SBValue.cpp.

◆ SBValue() [3/3]

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

Definition at line 220 of file SBValue.cpp.

References LLDB_RECORD_CONSTRUCTOR, and SetSP().

Member Function Documentation

◆ AddressOf()

lldb::SBValue SBValue::AddressOf ( )

Definition at line 1307 of file SBValue.cpp.

References GetPreferDynamicValue(), GetPreferSyntheticValue(), GetSP(), LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, and SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ Cast()

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

Definition at line 602 of file SBValue.cpp.

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

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ Clear()

void SBValue::Clear ( )

Definition at line 258 of file SBValue.cpp.

References LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ CreateChildAtOffset()

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

Definition at line 581 of file SBValue.cpp.

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

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ CreateValueFromAddress()

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

Definition at line 648 of file SBValue.cpp.

References lldb::SBType::GetSP(), GetSP(), LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, and SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ CreateValueFromData()

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

Definition at line 670 of file SBValue.cpp.

References lldb_private::eAddressTypeLoad, lldb::SBType::GetSP(), GetSP(), LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, and SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ CreateValueFromExpression() [1/2]

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

Definition at line 615 of file SBValue.cpp.

References LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, lldb::SBExpressionOptions::ref(), and lldb_private::EvaluateExpressionOptions::SetKeepInMemory().

Referenced by CreateValueFromExpression(), and lldb_private::repro::RegisterMethods< SBValue >().

◆ CreateValueFromExpression() [2/2]

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

Definition at line 626 of file SBValue.cpp.

References CreateValueFromExpression(), GetSP(), LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, lldb::SBExpressionOptions::ref(), and SetSP().

◆ Dereference()

SBValue SBValue::Dereference ( )

Definition at line 1017 of file SBValue.cpp.

References Dereference(), GetSP(), LLDB_RECORD_METHOD_NO_ARGS, and LLDB_RECORD_RESULT.

Referenced by Dereference(), lldb_private::repro::RegisterMethods< SBValue >(), and WatchPointee().

◆ EvaluateExpression() [1/3]

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

Definition at line 1196 of file SBValue.cpp.

References GetSP(), LLDB_RECORD_METHOD_CONST, LLDB_RECORD_RESULT, SBValue(), lldb::SBExpressionOptions::SetFetchDynamicValue(), lldb::SBExpressionOptions::SetIgnoreBreakpoints(), and lldb::SBExpressionOptions::SetUnwindOnError().

Referenced by EvaluateExpression(), and lldb_private::repro::RegisterMethods< SBValue >().

◆ EvaluateExpression() [2/3]

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

Definition at line 1218 of file SBValue.cpp.

References EvaluateExpression(), LLDB_RECORD_METHOD_CONST, and LLDB_RECORD_RESULT.

◆ EvaluateExpression() [3/3]

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

Definition at line 1227 of file SBValue.cpp.

References EvaluateExpression(), lldb::SBExpressionOptions::GetFetchDynamicValue(), GetSP(), LLDB_RECORD_METHOD_CONST, LLDB_RECORD_RESULT, lldb::SBExpressionOptions::ref(), SBValue(), and SetSP().

◆ GetAddress()

lldb::SBAddress SBValue::GetAddress ( )

Definition at line 1352 of file SBValue.cpp.

References lldb_private::eAddressTypeFile, lldb_private::eAddressTypeLoad, GetSP(), LLDB_INVALID_ADDRESS, LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, lldb::SBAddress, and lldb_private::Address::SetLoadAddress().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetByteSize()

size_t SBValue::GetByteSize ( )

Definition at line 328 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >(), and Watch().

◆ GetChildAtIndex() [1/2]

SBValue SBValue::GetChildAtIndex ( uint32_t idx )

Definition at line 691 of file SBValue.cpp.

References lldb::eNoDynamicValues, LLDB_RECORD_METHOD, and LLDB_RECORD_RESULT.

Referenced by GetChildAtIndex(), and lldb_private::repro::RegisterMethods< SBValue >().

◆ 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 707 of file SBValue.cpp.

References GetChildAtIndex(), GetPreferSyntheticValue(), GetSP(), LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, and SetSP().

◆ GetChildMemberWithName() [1/2]

SBValue SBValue::GetChildMemberWithName ( const char * name )

Definition at line 745 of file SBValue.cpp.

References lldb::eNoDynamicValues, LLDB_RECORD_METHOD, and LLDB_RECORD_RESULT.

Referenced by GetChildMemberWithName(), and lldb_private::repro::RegisterMethods< SBValue >().

◆ GetChildMemberWithName() [2/2]

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

Definition at line 760 of file SBValue.cpp.

References GetChildMemberWithName(), GetPreferSyntheticValue(), GetSP(), LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, 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 1401 of file SBValue.cpp.

References GetSP(), LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, and lldb_private::Status::Success().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetDeclaration()

lldb::SBDeclaration SBValue::GetDeclaration ( )

Definition at line 1453 of file SBValue.cpp.

References GetSP(), LLDB_RECORD_METHOD_NO_ARGS, and LLDB_RECORD_RESULT.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetDescription()

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

Definition at line 1272 of file SBValue.cpp.

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

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetDisplayTypeName()

const char * SBValue::GetDisplayTypeName ( )

Definition at line 315 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetDynamicValue()

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

Definition at line 781 of file SBValue.cpp.

References IsValid(), LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, and SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetError()

SBError SBValue::GetError ( )

Definition at line 264 of file SBValue.cpp.

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

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetExpressionPath() [1/2]

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

Definition at line 1169 of file SBValue.cpp.

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

Referenced by GetExpressionPath(), and lldb_private::repro::RegisterMethods< SBValue >().

◆ GetExpressionPath() [2/2]

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

Definition at line 1182 of file SBValue.cpp.

References GetExpressionPath(), GetSP(), LLDB_RECORD_METHOD, and lldb::SBStream::ref().

◆ GetFormat()

lldb::Format SBValue::GetFormat ( )

Definition at line 1288 of file SBValue.cpp.

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

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetFrame()

lldb::SBFrame SBValue::GetFrame ( )

Definition at line 1087 of file SBValue.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, and lldb::SBFrame::SetFrameSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetID()

user_id_t SBValue::GetID ( )

Definition at line 280 of file SBValue.cpp.

References GetSP(), LLDB_INVALID_UID, and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetIndexOfChildWithName()

uint32_t SBValue::GetIndexOfChildWithName ( const char * name )

Definition at line 732 of file SBValue.cpp.

References GetSP(), LLDB_RECORD_METHOD, and UINT32_MAX.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetLoadAddress()

lldb::addr_t SBValue::GetLoadAddress ( )

Definition at line 1322 of file SBValue.cpp.

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

Referenced by lldb_private::repro::RegisterMethods< SBValue >(), and Watch().

◆ GetLocation()

const char * SBValue::GetLocation ( )

Definition at line 472 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetName()

const char * SBValue::GetName ( )

Definition at line 290 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetNonSyntheticValue()

lldb::SBValue SBValue::GetNonSyntheticValue ( )

Definition at line 807 of file SBValue.cpp.

References IsValid(), LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, and SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetNumChildren() [1/2]

uint32_t SBValue::GetNumChildren ( )

Definition at line 998 of file SBValue.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and UINT32_MAX.

Referenced by GetNumChildren(), and lldb_private::repro::RegisterMethods< SBValue >().

◆ GetNumChildren() [2/2]

uint32_t SBValue::GetNumChildren ( uint32_t max )

Definition at line 1004 of file SBValue.cpp.

References GetNumChildren(), GetSP(), and LLDB_RECORD_METHOD.

◆ GetObjectDescription()

const char * SBValue::GetObjectDescription ( )

Definition at line 381 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetOpaqueType()

void * SBValue::GetOpaqueType ( )

Definition at line 1038 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ 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 1381 of file SBValue.cpp.

References GetSP(), LLDB_RECORD_METHOD, and LLDB_RECORD_RESULT.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetPreferDynamicValue()

lldb::DynamicValueType SBValue::GetPreferDynamicValue ( )

Definition at line 819 of file SBValue.cpp.

References lldb::eNoDynamicValues, IsValid(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by AddressOf(), Cast(), CreateChildAtOffset(), GetValueForExpressionPath(), and lldb_private::repro::RegisterMethods< SBValue >().

◆ GetPreferSyntheticValue()

bool SBValue::GetPreferSyntheticValue ( )

Definition at line 836 of file SBValue.cpp.

References IsValid(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by AddressOf(), Cast(), CreateChildAtOffset(), GetChildAtIndex(), GetChildMemberWithName(), GetValueForExpressionPath(), and lldb_private::repro::RegisterMethods< SBValue >().

◆ GetProcess()

lldb::SBProcess SBValue::GetProcess ( )

Definition at line 1061 of file SBValue.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, and lldb::SBProcess::SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ 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 1108 of file SBValue.cpp.

References LLDB_RECORD_METHOD_CONST_NO_ARGS, LLDB_RECORD_RESULT, and SetSP().

Referenced by AddressOf(), Cast(), 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(), GetSummary(), GetType(), GetTypeFilter(), GetTypeFormat(), GetTypeName(), GetTypeSummary(), GetTypeSynthetic(), GetTypeValidatorResult(), GetValue(), GetValueAsSigned(), GetValueAsUnsigned(), GetValueDidChange(), GetValueForExpressionPath(), GetValueType(), IsDynamic(), IsInScope(), IsRuntimeSupportValue(), IsSynthetic(), IsSyntheticChildrenGenerated(), MightHaveChildren(), Persist(), lldb_private::repro::RegisterMethods< SBValue >(), 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 1100 of file SBValue.cpp.

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

◆ GetStaticValue()

lldb::SBValue SBValue::GetStaticValue ( )

Definition at line 794 of file SBValue.cpp.

References lldb::eNoDynamicValues, IsValid(), LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, and SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetSummary() [1/2]

const char * SBValue::GetSummary ( )

Definition at line 442 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb::SBFrame::EvaluateExpression(), lldb::SBTarget::EvaluateExpression(), GetSummary(), and lldb_private::repro::RegisterMethods< SBValue >().

◆ GetSummary() [2/2]

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

Definition at line 455 of file SBValue.cpp.

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

◆ GetTarget()

lldb::SBTarget SBValue::GetTarget ( )

Definition at line 1048 of file SBValue.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, and lldb::SBTarget::SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >(), and Watch().

◆ GetThread()

lldb::SBThread SBValue::GetThread ( )

Definition at line 1074 of file SBValue.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and LLDB_RECORD_RESULT.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetType()

SBType SBValue::GetType ( )

Definition at line 413 of file SBValue.cpp.

References GetSP(), LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, and lldb::SBType::SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >(), TypeIsPointerType(), and WatchPointee().

◆ GetTypeFilter()

lldb::SBTypeFilter SBValue::GetTypeFilter ( )

Definition at line 541 of file SBValue.cpp.

References GetSP(), LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, lldb::SBTypeFilter::SetSP(), and lldb_private::static_pointer_cast().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetTypeFormat()

lldb::SBTypeFormat SBValue::GetTypeFormat ( )

Definition at line 509 of file SBValue.cpp.

References GetSP(), LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, and lldb::SBTypeFormat::SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetTypeName()

const char * SBValue::GetTypeName ( )

Definition at line 302 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetTypeSummary()

lldb::SBTypeSummary SBValue::GetTypeSummary ( )

Definition at line 525 of file SBValue.cpp.

References GetSP(), LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, and lldb::SBTypeSummary::SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetTypeSynthetic()

lldb::SBTypeSynthetic SBValue::GetTypeSynthetic ( )

Definition at line 561 of file SBValue.cpp.

References GetSP(), LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, lldb::SBTypeSynthetic::SetSP(), and lldb_private::static_pointer_cast().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetTypeValidatorResult()

const char * SBValue::GetTypeValidatorResult ( )

Definition at line 394 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetValue()

const char * SBValue::GetValue ( )

Definition at line 356 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb::SBFrame::EvaluateExpression(), lldb::SBTarget::EvaluateExpression(), and lldb_private::repro::RegisterMethods< SBValue >().

◆ GetValueAsSigned() [1/2]

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

Definition at line 909 of file SBValue.cpp.

References lldb_private::Status::AsCString(), lldb::SBError::Clear(), ValueLocker::GetError(), GetSP(), LLDB_RECORD_METHOD, lldb::SBError::SetErrorString(), and lldb::SBError::SetErrorStringWithFormat().

Referenced by GetValueAsSigned(), and lldb_private::repro::RegisterMethods< SBValue >().

◆ GetValueAsSigned() [2/2]

int64_t SBValue::GetValueAsSigned ( int64_t fail_value = 0 )

Definition at line 951 of file SBValue.cpp.

References GetSP(), GetValueAsSigned(), and LLDB_RECORD_METHOD.

◆ GetValueAsUnsigned() [1/2]

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

Definition at line 930 of file SBValue.cpp.

References lldb_private::Status::AsCString(), lldb::SBError::Clear(), ValueLocker::GetError(), GetSP(), LLDB_RECORD_METHOD, lldb::SBError::SetErrorString(), and lldb::SBError::SetErrorStringWithFormat().

Referenced by GetValueAsUnsigned(), and lldb_private::repro::RegisterMethods< SBValue >().

◆ GetValueAsUnsigned() [2/2]

uint64_t SBValue::GetValueAsUnsigned ( uint64_t fail_value = 0 )

Definition at line 962 of file SBValue.cpp.

References GetSP(), GetValueAsUnsigned(), and LLDB_RECORD_METHOD.

◆ GetValueDidChange()

bool SBValue::GetValueDidChange ( )

Definition at line 428 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetValueForExpressionPath()

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

Definition at line 891 of file SBValue.cpp.

References GetPreferDynamicValue(), GetPreferSyntheticValue(), GetSP(), LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, and SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ GetValueType()

ValueType SBValue::GetValueType ( )

Definition at line 369 of file SBValue.cpp.

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

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ IsDynamic()

bool SBValue::IsDynamic ( )

Definition at line 852 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ IsInScope()

bool SBValue::IsInScope ( )

Definition at line 342 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >(), Watch(), and WatchPointee().

◆ IsRuntimeSupportValue()

bool SBValue::IsRuntimeSupportValue ( )

Definition at line 986 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ IsSynthetic()

bool SBValue::IsSynthetic ( )

Definition at line 862 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ IsSyntheticChildrenGenerated()

bool SBValue::IsSyntheticChildrenGenerated ( )

Definition at line 872 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ IsValid()

bool SBValue::IsValid ( )

Definition at line 244 of file SBValue.cpp.

References LLDB_RECORD_METHOD_NO_ARGS.

Referenced by GetDynamicValue(), GetNonSyntheticValue(), GetPreferDynamicValue(), GetPreferSyntheticValue(), GetStaticValue(), lldb_private::repro::RegisterMethods< SBValue >(), 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 974 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD_NO_ARGS.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ operator bool()

SBValue::operator bool ( ) const

explicit

Definition at line 248 of file SBValue.cpp.

References LLDB_RECORD_METHOD_CONST_NO_ARGS.

◆ operator=()

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

Definition at line 232 of file SBValue.cpp.

References LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, and SetSP().

◆ Persist()

lldb::SBValue SBValue::Persist ( )

Definition at line 1553 of file SBValue.cpp.

References GetSP(), LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, and SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ SetData()

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

Definition at line 1418 of file SBValue.cpp.

References lldb_private::Status::AsCString(), lldb::SBData::get(), ValueLocker::GetError(), GetSP(), LLDB_RECORD_METHOD, lldb::SBError::SetErrorString(), lldb::SBError::SetErrorStringWithFormat(), and lldb_private::Status::Success().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ SetFormat()

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

Definition at line 1298 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ SetPreferDynamicValue()

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

Definition at line 828 of file SBValue.cpp.

References IsValid(), and LLDB_RECORD_METHOD.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ SetPreferSyntheticValue()

void SBValue::SetPreferSyntheticValue ( bool use_synthetic )

Definition at line 844 of file SBValue.cpp.

References IsValid(), and LLDB_RECORD_METHOD.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ SetSP() [1/5]

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

protected

◆ SetSP() [2/5]

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

protected

Definition at line 1145 of file SBValue.cpp.

References lldb::eNoDynamicValues, and SetSP().

◆ SetSP() [3/5]

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

protected

Definition at line 1131 of file SBValue.cpp.

References SetSP().

◆ SetSP() [4/5]

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

protected

Definition at line 1157 of file SBValue.cpp.

◆ SetSP() [5/5]

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

protected

Definition at line 1162 of file SBValue.cpp.

◆ SetSyntheticChildrenGenerated()

void SBValue::SetSyntheticChildrenGenerated ( bool is )

Definition at line 882 of file SBValue.cpp.

References GetSP(), and LLDB_RECORD_METHOD.

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ SetValueFromCString() [1/2]

bool SBValue::SetValueFromCString ( const char * value_str )

Definition at line 485 of file SBValue.cpp.

References LLDB_RECORD_METHOD.

Referenced by lldb_private::repro::RegisterMethods< SBValue >(), and SetValueFromCString().

◆ SetValueFromCString() [2/2]

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

Definition at line 493 of file SBValue.cpp.

References lldb_private::Status::AsCString(), ValueLocker::GetError(), GetSP(), LLDB_RECORD_METHOD, lldb::SBError::ref(), lldb::SBError::SetErrorStringWithFormat(), and SetValueFromCString().

◆ TypeIsPointerType()

bool SBValue::TypeIsPointerType ( )

Definition at line 1032 of file SBValue.cpp.

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

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

◆ Watch() [1/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 1467 of file SBValue.cpp.

References lldb_private::Status::AsCString(), lldb_private::Declaration::DumpStopContext(), GetByteSize(), ValueLocker::GetError(), lldb_private::Declaration::GetFile(), GetLoadAddress(), GetSP(), lldb_private::StreamString::GetString(), GetTarget(), IsInScope(), LLDB_INVALID_ADDRESS, LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, LLDB_WATCH_TYPE_READ, LLDB_WATCH_TYPE_WRITE, lldb::SBError::SetError(), lldb::SBError::SetErrorString(), lldb::SBError::SetErrorStringWithFormat(), and lldb::SBWatchpoint::SetSP().

Referenced by lldb_private::repro::RegisterMethods< SBValue >(), Watch(), and WatchPointee().

◆ Watch() [2/2]

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

Definition at line 1532 of file SBValue.cpp.

References LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, and Watch().

◆ 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 1541 of file SBValue.cpp.

References Dereference(), GetType(), IsInScope(), LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, and Watch().

Referenced by lldb_private::repro::RegisterMethods< SBValue >().

Friends And Related Function Documentation

◆ SBBlock

friend class SBBlock

friend

Definition at line 381 of file SBValue.h.

◆ SBFrame

friend class SBFrame

friend

Definition at line 382 of file SBValue.h.

◆ SBTarget

friend class SBTarget

friend

Definition at line 383 of file SBValue.h.

◆ SBThread

friend class SBThread

friend

Definition at line 384 of file SBValue.h.

◆ SBValueList

friend class SBValueList

friend

Definition at line 385 of file SBValue.h.

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

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SBValue() [1/3]

◆ SBValue() [2/3]

◆ ~SBValue()

◆ SBValue() [3/3]

Member Function Documentation

◆ AddressOf()

◆ Cast()

◆ Clear()

◆ 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()

◆ GetTypeValidatorResult()

◆ GetValue()

◆ GetValueAsSigned() [1/2]

◆ GetValueAsSigned() [2/2]

◆ GetValueAsUnsigned() [1/2]

◆ GetValueAsUnsigned() [2/2]

◆ GetValueDidChange()

◆ GetValueForExpressionPath()

◆ GetValueType()

◆ IsDynamic()

◆ IsInScope()

◆ IsRuntimeSupportValue()

◆ IsSynthetic()

◆ IsSyntheticChildrenGenerated()

◆ IsValid()