#include <ValueObjectPrinter.h>

Public Member Functions
	ValueObjectPrinter (ValueObject &valobj, Stream *s)
	The ValueObjectPrinter is a one-shot printer for ValueObjects.
	ValueObjectPrinter (ValueObject &valobj, Stream *s, const DumpValueObjectOptions &options)
	~ValueObjectPrinter ()=default
llvm::Error	PrintValueObject ()

Protected Types
typedef std::set< uint64_t >	InstancePointersSet
typedef std::shared_ptr< InstancePointersSet >	InstancePointersSetSP

Protected Member Functions
	ValueObjectPrinter (ValueObject &valobj, Stream *s, const DumpValueObjectOptions &options, const DumpValueObjectOptions::PointerDepth &ptr_depth, uint32_t curr_depth, InstancePointersSetSP printed_instance_pointers)
	Only this class (and subclasses, if any) should ever be concerned with the depth mechanism.
void	Init (ValueObject &valobj, Stream *s, const DumpValueObjectOptions &options, const DumpValueObjectOptions::PointerDepth &ptr_depth, uint32_t curr_depth, InstancePointersSetSP printed_instance_pointers)
	Ee should actually be using delegating constructors here but some versions of GCC still have trouble with those.
ValueObject &	GetMostSpecializedValue ()
	Cache the ValueObject we are actually going to print.
void	SetupMostSpecializedValue ()
const char *	GetRootNameForDisplay ()
bool	ShouldPrintValueObject ()
bool	IsNil ()
bool	IsUninitialized ()
bool	IsPtr ()
bool	IsRef ()
bool	IsInstancePointer ()
bool	IsAggregate ()
bool	PrintLocationIfNeeded ()
void	PrintDecl ()
bool	CheckScopeIfNeeded ()
bool	ShouldPrintEmptyBrackets (bool value_printed, bool summary_printed)
TypeSummaryImpl *	GetSummaryFormatter (bool null_if_omitted=true)
void	GetValueSummaryError (std::string &value, std::string &summary, std::string &error)
bool	PrintValueAndSummaryIfNeeded (bool &value_printed, bool &summary_printed)
void	PrintObjectDescriptionIfNeeded (std::optional< std::string > object_desc)
bool	ShouldPrintChildren (DumpValueObjectOptions::PointerDepth &curr_ptr_depth)
bool	ShouldExpandEmptyAggregates ()
ValueObject &	GetValueObjectForChildrenGeneration ()
void	PrintChildrenPreamble (bool value_printed, bool summary_printed)
void	PrintChildrenPostamble (bool print_dotdotdot)
lldb::ValueObjectSP	GenerateChild (ValueObject &synth_valobj, size_t idx)
void	PrintChild (lldb::ValueObjectSP child_sp, const DumpValueObjectOptions::PointerDepth &curr_ptr_depth)
llvm::Expected< uint32_t >	GetMaxNumChildrenToPrint (bool &print_dotdotdot)
void	PrintChildren (bool value_printed, bool summary_printed, const DumpValueObjectOptions::PointerDepth &curr_ptr_depth)
llvm::Error	PrintChildrenIfNeeded (bool value_printed, bool summary_printed)
bool	PrintChildrenOneLiner (bool hide_names)
bool	HasReachedMaximumDepth ()

Protected Attributes
InstancePointersSetSP	m_printed_instance_pointers

Private Member Functions
bool	ShouldShowName () const
bool	ShouldPrintObjectDescription ()
	ValueObjectPrinter (const ValueObjectPrinter &)=delete
const ValueObjectPrinter &	operator= (const ValueObjectPrinter &)=delete

Private Attributes
ValueObject &	m_orig_valobj
ValueObject *	m_cached_valobj
	Cache the current "most specialized" value.
Stream *	m_stream
DumpValueObjectOptions	m_options
Flags	m_type_flags
CompilerType	m_compiler_type
DumpValueObjectOptions::PointerDepth	m_ptr_depth
uint32_t	m_curr_depth
LazyBool	m_should_print
LazyBool	m_is_nil
LazyBool	m_is_uninit
LazyBool	m_is_ptr
LazyBool	m_is_ref
LazyBool	m_is_aggregate
LazyBool	m_is_instance_ptr
std::pair< TypeSummaryImpl *, bool >	m_summary_formatter
std::string	m_value
std::string	m_summary
std::string	m_error
bool	m_val_summary_ok

Friends
struct	StringSummaryFormat

Detailed Description

Definition at line 22 of file ValueObjectPrinter.h.

Member Typedef Documentation

◆ InstancePointersSet

typedef std::set<uint64_t> lldb_private::ValueObjectPrinter::InstancePointersSet

protected

Definition at line 39 of file ValueObjectPrinter.h.

◆ InstancePointersSetSP

typedef std::shared_ptr<InstancePointersSet> lldb_private::ValueObjectPrinter::InstancePointersSetSP

protected

Definition at line 40 of file ValueObjectPrinter.h.

Constructor & Destructor Documentation

◆ ValueObjectPrinter() [1/4]

ValueObjectPrinter::ValueObjectPrinter	(	ValueObject &	valobj,
		Stream *	s )

The ValueObjectPrinter is a one-shot printer for ValueObjects.

It does not retain the ValueObject it is printing, that is the job of its caller. It also doesn't attempt to track changes in the ValueObject, e.g. changing synthetic child providers or changing dynamic versus static versus synthetic settings.

Definition at line 26 of file ValueObjectPrinter.cpp.

References Init(), m_options, and m_orig_valobj.

Referenced by operator=(), PrintChild(), and ValueObjectPrinter().

◆ ValueObjectPrinter() [2/4]

ValueObjectPrinter::ValueObjectPrinter	(	ValueObject &	valobj,
		Stream *	s,
		const DumpValueObjectOptions &	options )

Definition at line 32 of file ValueObjectPrinter.cpp.

References Init(), m_options, and m_orig_valobj.

◆ ~ValueObjectPrinter()

lldb_private::ValueObjectPrinter::~ValueObjectPrinter ( )

default

◆ ValueObjectPrinter() [3/4]

ValueObjectPrinter::ValueObjectPrinter	(	ValueObject &	valobj,
		Stream *	s,
		const DumpValueObjectOptions &	options,
		const DumpValueObjectOptions::PointerDepth &	ptr_depth,
		uint32_t	curr_depth,
		InstancePointersSetSP	printed_instance_pointers )

protected

Only this class (and subclasses, if any) should ever be concerned with the depth mechanism.

Definition at line 38 of file ValueObjectPrinter.cpp.

References Init(), and m_orig_valobj.

◆ ValueObjectPrinter() [4/4]

lldb_private::ValueObjectPrinter::ValueObjectPrinter ( const ValueObjectPrinter & )

privatedelete

References ValueObjectPrinter().

Member Function Documentation

◆ CheckScopeIfNeeded()

bool ValueObjectPrinter::CheckScopeIfNeeded ( )

protected

Definition at line 349 of file ValueObjectPrinter.cpp.

References GetMostSpecializedValue(), lldb_private::ValueObject::IsInScope(), and m_options.

Referenced by PrintValueAndSummaryIfNeeded().

◆ GenerateChild()

ValueObjectSP ValueObjectPrinter::GenerateChild	(	ValueObject &	synth_valobj,
		size_t	idx )

protected

Definition at line 693 of file ValueObjectPrinter.cpp.

References lldb_private::ValueObject::GetChildAtIndex(), lldb_private::ValueObject::GetSyntheticArrayMember(), m_options, and PhysicalIndexForLogicalIndex().

Referenced by PrintChildren().

◆ GetMaxNumChildrenToPrint()

llvm::Expected< uint32_t > ValueObjectPrinter::GetMaxNumChildrenToPrint ( bool & print_dotdotdot )

protected

Definition at line 629 of file ValueObjectPrinter.cpp.

References GetMostSpecializedValue(), lldb_private::ValueObject::GetNumChildren(), GetValueObjectForChildrenGeneration(), m_options, and UINT32_MAX.

Referenced by PrintChildren(), and PrintChildrenOneLiner().

◆ GetMostSpecializedValue()

ValueObject & ValueObjectPrinter::GetMostSpecializedValue ( )

protected

Cache the ValueObject we are actually going to print.

If this ValueObject has a Dynamic type, we return that, if either the original ValueObject or its Dynamic type has a Synthetic provider, return that. This will never return an empty ValueObject, since we use the ValueObject to carry errors. Note, this gets called when making the printer object, and uses the use dynamic and use synthetic settings of the ValueObject being printed, so changes made to these settings won't affect already made ValueObjectPrinters. SetupMostSpecializedValue();

Access the cached "most specialized value" - that is the one to use for printing the value object's value. However, be sure to use GetValueForChildGeneration when you are generating the children of this value.

Definition at line 135 of file ValueObjectPrinter.cpp.

References m_cached_valobj.

Referenced by CheckScopeIfNeeded(), GetMaxNumChildrenToPrint(), GetRootNameForDisplay(), GetSummaryFormatter(), GetValueObjectForChildrenGeneration(), GetValueSummaryError(), IsInstancePointer(), IsNil(), IsUninitialized(), PrintChildren(), PrintChildrenIfNeeded(), PrintChildrenPostamble(), PrintDecl(), PrintLocationIfNeeded(), PrintValueAndSummaryIfNeeded(), PrintValueObject(), and ShouldPrintChildren().

◆ GetRootNameForDisplay()

const char * ValueObjectPrinter::GetRootNameForDisplay ( )

protected

Definition at line 182 of file ValueObjectPrinter.cpp.

References lldb_private::ConstString::AsCString(), GetMostSpecializedValue(), lldb_private::ValueObject::GetName(), and m_options.

Referenced by PrintDecl().

◆ GetSummaryFormatter()

TypeSummaryImpl * ValueObjectPrinter::GetSummaryFormatter ( bool null_if_omitted = true )

protected

Definition at line 355 of file ValueObjectPrinter.cpp.

References GetMostSpecializedValue(), lldb_private::ValueObject::GetSummaryFormat(), m_options, and m_summary_formatter.

Referenced by GetValueSummaryError(), PrintValueAndSummaryIfNeeded(), ShouldExpandEmptyAggregates(), and ShouldPrintChildren().

◆ GetValueObjectForChildrenGeneration()

ValueObject & ValueObjectPrinter::GetValueObjectForChildrenGeneration ( )

protected

Definition at line 568 of file ValueObjectPrinter.cpp.

References GetMostSpecializedValue().

Referenced by GetMaxNumChildrenToPrint(), PrintChildren(), PrintChildrenOneLiner(), and ShouldPrintEmptyBrackets().

◆ GetValueSummaryError()

void ValueObjectPrinter::GetValueSummaryError	(	std::string &	value,
		std::string &	summary,
		std::string &	error )

protected

Definition at line 379 of file ValueObjectPrinter.cpp.

References lldb_private::Status::AsCString(), lldb::eFormatDefault, lldb::eLanguageTypeUnknown, error(), lldb_private::Language::FindPlugin(), lldb_private::ValueObject::GetError(), lldb_private::ValueObject::GetFormat(), GetMostSpecializedValue(), lldb_private::ValueObject::GetPreferredDisplayLanguage(), lldb_private::ValueObject::GetSummaryAsCString(), GetSummaryFormatter(), lldb_private::ValueObject::GetValueAsCString(), IsNil(), IsUninitialized(), m_options, and ShouldPrintValueObject().

Referenced by PrintValueAndSummaryIfNeeded().

◆ HasReachedMaximumDepth()

bool ValueObjectPrinter::HasReachedMaximumDepth ( )

protected

Definition at line 862 of file ValueObjectPrinter.cpp.

References m_curr_depth, and m_options.

Referenced by PrintChildrenIfNeeded(), and ShouldPrintChildren().

◆ Init()

void ValueObjectPrinter::Init	(	ValueObject &	valobj,
		Stream *	s,
		const DumpValueObjectOptions &	options,
		const DumpValueObjectOptions::PointerDepth &	ptr_depth,
		uint32_t	curr_depth,
		InstancePointersSetSP	printed_instance_pointers )