#include <StringPrinter.h>

Inheritance diagram for lldb_private::formatters::StringPrinter::DumpToStreamOptions:

Public Member Functions
	DumpToStreamOptions ()=default
void	SetStream (Stream *s)
Stream *	GetStream () const
void	SetPrefixToken (const std::string &p)
void	SetPrefixToken (std::nullptr_t)
const char *	GetPrefixToken () const
void	SetSuffixToken (const std::string &p)
void	SetSuffixToken (std::nullptr_t)
const char *	GetSuffixToken () const
void	SetQuote (char q)
char	GetQuote () const
void	SetSourceSize (uint32_t s)
uint32_t	GetSourceSize () const
void	SetZeroTermination (ZeroTermination z)
ZeroTermination	GetZeroTermination () const
void	SetEscapeNonPrintables (bool e)
bool	GetEscapeNonPrintables () const
void	SetIgnoreMaxLength (bool e)
bool	GetIgnoreMaxLength () const
void	SetEscapeStyle (EscapeStyle style)
EscapeStyle	GetEscapeStyle () const

Private Attributes
Stream *	m_stream = nullptr
	The used output stream.
std::string	m_prefix_token
	String that should be printed before the heading quote character.
std::string	m_suffix_token
	String that should be printed after the trailing quote character.
char	m_quote = '"'
	The quote character that should surround the string.
uint32_t	m_source_size = 0
	The length of the memory region that should be dumped in bytes.
bool	m_escape_non_printables = true
	True iff non-printable characters should be escaped when dumping them to the stream.
bool	m_ignore_max_length = false
	True iff the max-string-summary-length setting of the target should be ignored.
EscapeStyle	m_escape_style = EscapeStyle::CXX
	The language-specific style for escaping special characters.
ZeroTermination	m_zero_termination = ZeroTermination::ZeroTerminate

Detailed Description

Definition at line 38 of file StringPrinter.h.

Constructor & Destructor Documentation

◆ DumpToStreamOptions()

lldb_private::formatters::StringPrinter::DumpToStreamOptions::DumpToStreamOptions ( )

default

Member Function Documentation

◆ GetEscapeNonPrintables()

bool lldb_private::formatters::StringPrinter::DumpToStreamOptions::GetEscapeNonPrintables ( ) const

inline

Definition at line 72 of file StringPrinter.h.

References m_escape_non_printables.

Referenced by DumpEncodedBufferToStream(), and lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions().

◆ GetEscapeStyle()

EscapeStyle lldb_private::formatters::StringPrinter::DumpToStreamOptions::GetEscapeStyle ( ) const

inline

Definition at line 80 of file StringPrinter.h.

References m_escape_style.

Referenced by DumpEncodedBufferToStream(), and lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions().

◆ GetIgnoreMaxLength()

bool lldb_private::formatters::StringPrinter::DumpToStreamOptions::GetIgnoreMaxLength ( ) const

inline

Definition at line 76 of file StringPrinter.h.

References m_ignore_max_length.

Referenced by lldb_private::formatters::ReadEncodedBufferAndDumpToStream().

◆ GetPrefixToken()

const char * lldb_private::formatters::StringPrinter::DumpToStreamOptions::GetPrefixToken ( ) const

inline

Definition at line 50 of file StringPrinter.h.

References m_prefix_token.

Referenced by DumpEncodedBufferToStream(), and lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions().

◆ GetQuote()

char lldb_private::formatters::StringPrinter::DumpToStreamOptions::GetQuote ( ) const

inline

Definition at line 60 of file StringPrinter.h.

References m_quote.

Referenced by DumpEncodedBufferToStream(), and lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions().

◆ GetSourceSize()

uint32_t lldb_private::formatters::StringPrinter::DumpToStreamOptions::GetSourceSize ( ) const

inline

Definition at line 64 of file StringPrinter.h.

References m_source_size.

Referenced by DumpEncodedBufferToStream(), and lldb_private::formatters::ReadEncodedBufferAndDumpToStream().

◆ GetStream()

Stream * lldb_private::formatters::StringPrinter::DumpToStreamOptions::GetStream ( ) const

inline

Definition at line 44 of file StringPrinter.h.

References m_stream.

Referenced by DumpEncodedBufferToStream(), lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions(), and lldb_private::formatters::ReadEncodedBufferAndDumpToStream().

◆ GetSuffixToken()

const char * lldb_private::formatters::StringPrinter::DumpToStreamOptions::GetSuffixToken ( ) const

inline

Definition at line 56 of file StringPrinter.h.

References m_suffix_token.

Referenced by DumpEncodedBufferToStream(), and lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions().

◆ GetZeroTermination()

ZeroTermination lldb_private::formatters::StringPrinter::DumpToStreamOptions::GetZeroTermination ( ) const

inline

Definition at line 68 of file StringPrinter.h.

References m_zero_termination.

Referenced by DumpEncodedBufferToStream(), lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions(), and lldb_private::formatters::ReadEncodedBufferAndDumpToStream().

◆ SetEscapeNonPrintables()

void lldb_private::formatters::StringPrinter::DumpToStreamOptions::SetEscapeNonPrintables ( bool e )

inline

Definition at line 70 of file StringPrinter.h.

References m_escape_non_printables.

Referenced by lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions(), lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions(), and lldb_private::formatters::StringPrinter::ReadStringAndDumpToStreamOptions::ReadStringAndDumpToStreamOptions().

◆ SetEscapeStyle()

void lldb_private::formatters::StringPrinter::DumpToStreamOptions::SetEscapeStyle ( EscapeStyle style )

inline

Definition at line 78 of file StringPrinter.h.

References m_escape_style.

Referenced by lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions().

◆ SetIgnoreMaxLength()

void lldb_private::formatters::StringPrinter::DumpToStreamOptions::SetIgnoreMaxLength ( bool e )

inline

Definition at line 74 of file StringPrinter.h.

References m_ignore_max_length.

Referenced by lldb_private::formatters::NSStringSummaryProvider().

◆ SetPrefixToken() [1/2]

void lldb_private::formatters::StringPrinter::DumpToStreamOptions::SetPrefixToken ( const std::string & p )

inline

Definition at line 46 of file StringPrinter.h.

References m_prefix_token.

Referenced by CharStringSummaryProvider(), CharSummaryProvider(), lldb_private::formatters::NSStringSummaryProvider(), lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions(), lldb_private::formatters::WCharStringSummaryProvider(), and lldb_private::formatters::WCharSummaryProvider().

◆ SetPrefixToken() [2/2]

void lldb_private::formatters::StringPrinter::DumpToStreamOptions::SetPrefixToken ( std::nullptr_t )

inline

Definition at line 48 of file StringPrinter.h.

References m_prefix_token.

◆ SetQuote()

void lldb_private::formatters::StringPrinter::DumpToStreamOptions::SetQuote ( char q )

inline

Definition at line 58 of file StringPrinter.h.

References m_quote.

Referenced by CharSummaryProvider(), lldb_private::formatters::NSStringSummaryProvider(), lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions(), and lldb_private::formatters::WCharSummaryProvider().

◆ SetSourceSize()

void lldb_private::formatters::StringPrinter::DumpToStreamOptions::SetSourceSize ( uint32_t s )

inline

Definition at line 62 of file StringPrinter.h.

References m_source_size.

Referenced by CharStringSummaryProvider(), CharSummaryProvider(), lldb_private::formatters::NSStringSummaryProvider(), lldb_private::formatters::ReadEncodedBufferAndDumpToStream(), lldb_private::formatters::WCharStringSummaryProvider(), and lldb_private::formatters::WCharSummaryProvider().

◆ SetStream()

void lldb_private::formatters::StringPrinter::DumpToStreamOptions::SetStream ( Stream * s )

inline

Definition at line 42 of file StringPrinter.h.

References m_stream.

Referenced by CharStringSummaryProvider(), CharSummaryProvider(), lldb_private::formatters::NSStringSummaryProvider(), lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions(), lldb_private::formatters::WCharStringSummaryProvider(), and lldb_private::formatters::WCharSummaryProvider().

◆ SetSuffixToken() [1/2]

void lldb_private::formatters::StringPrinter::DumpToStreamOptions::SetSuffixToken ( const std::string & p )

inline

Definition at line 52 of file StringPrinter.h.

References m_suffix_token.

Referenced by lldb_private::formatters::NSStringSummaryProvider(), and lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions().

◆ SetSuffixToken() [2/2]

void lldb_private::formatters::StringPrinter::DumpToStreamOptions::SetSuffixToken ( std::nullptr_t )

inline

Definition at line 54 of file StringPrinter.h.

References m_suffix_token.

◆ SetZeroTermination()

void lldb_private::formatters::StringPrinter::DumpToStreamOptions::SetZeroTermination ( ZeroTermination z )

inline

Definition at line 66 of file StringPrinter.h.

References m_zero_termination.

Referenced by CharStringSummaryProvider(), CharSummaryProvider(), lldb_private::formatters::NSStringSummaryProvider(), lldb_private::formatters::StringPrinter::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions(), lldb_private::formatters::ReadEncodedBufferAndDumpToStream(), lldb_private::formatters::WCharStringSummaryProvider(), and lldb_private::formatters::WCharSummaryProvider().

Member Data Documentation

◆ m_escape_non_printables

bool lldb_private::formatters::StringPrinter::DumpToStreamOptions::m_escape_non_printables = true

private

True iff non-printable characters should be escaped when dumping them to the stream.

Definition at line 95 of file StringPrinter.h.

Referenced by GetEscapeNonPrintables(), and SetEscapeNonPrintables().

◆ m_escape_style

EscapeStyle lldb_private::formatters::StringPrinter::DumpToStreamOptions::m_escape_style = EscapeStyle::CXX

private

The language-specific style for escaping special characters.

Definition at line 100 of file StringPrinter.h.

Referenced by GetEscapeStyle(), and SetEscapeStyle().

◆ m_ignore_max_length

bool lldb_private::formatters::StringPrinter::DumpToStreamOptions::m_ignore_max_length = false

private

True iff the max-string-summary-length setting of the target should be ignored.

Definition at line 98 of file StringPrinter.h.

Referenced by GetIgnoreMaxLength(), and SetIgnoreMaxLength().

◆ m_prefix_token

std::string lldb_private::formatters::StringPrinter::DumpToStreamOptions::m_prefix_token

private

String that should be printed before the heading quote character.

Definition at line 86 of file StringPrinter.h.

Referenced by GetPrefixToken(), SetPrefixToken(), and SetPrefixToken().

◆ m_quote

char lldb_private::formatters::StringPrinter::DumpToStreamOptions::m_quote = '"'

private

The quote character that should surround the string.

Definition at line 90 of file StringPrinter.h.

Referenced by GetQuote(), and SetQuote().

◆ m_source_size

uint32_t lldb_private::formatters::StringPrinter::DumpToStreamOptions::m_source_size = 0

private

The length of the memory region that should be dumped in bytes.

Definition at line 92 of file StringPrinter.h.

Referenced by GetSourceSize(), and SetSourceSize().

◆ m_stream

Stream* lldb_private::formatters::StringPrinter::DumpToStreamOptions::m_stream = nullptr

private

The used output stream.

Definition at line 84 of file StringPrinter.h.

Referenced by GetStream(), and SetStream().

◆ m_suffix_token

std::string lldb_private::formatters::StringPrinter::DumpToStreamOptions::m_suffix_token

private

String that should be printed after the trailing quote character.

Definition at line 88 of file StringPrinter.h.

Referenced by GetSuffixToken(), SetSuffixToken(), and SetSuffixToken().

◆ m_zero_termination

ZeroTermination lldb_private::formatters::StringPrinter::DumpToStreamOptions::m_zero_termination = ZeroTermination::ZeroTerminate

private

Definition at line 101 of file StringPrinter.h.

Referenced by GetZeroTermination(), and SetZeroTermination().

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

StringPrinter.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DumpToStreamOptions()

Member Function Documentation

◆ GetEscapeNonPrintables()

◆ GetEscapeStyle()

◆ GetIgnoreMaxLength()

◆ GetPrefixToken()

◆ GetQuote()

◆ GetSourceSize()

◆ GetStream()

◆ GetSuffixToken()

◆ GetZeroTermination()

◆ SetEscapeNonPrintables()

◆ SetEscapeStyle()

◆ SetIgnoreMaxLength()

◆ SetPrefixToken() [1/2]

◆ SetPrefixToken() [2/2]

◆ SetQuote()

◆ SetSourceSize()

◆ SetStream()

◆ SetSuffixToken() [1/2]

◆ SetSuffixToken() [2/2]

◆ SetZeroTermination()

Member Data Documentation

◆ m_escape_non_printables

◆ m_escape_style

◆ m_ignore_max_length

◆ m_prefix_token

◆ m_quote

◆ m_source_size

◆ m_stream

◆ m_suffix_token

◆ m_zero_termination