llvm::impl::RAIINewLineStream Class Reference

A raw_ostream that prints a newline on destruction, useful for LDBG() More...

#include "llvm/Support/DebugLog.h"

Inheritance diagram for llvm::impl::RAIINewLineStream:

Public Member Functions
	RAIINewLineStream (raw_ostream &Os)
	~RAIINewLineStream ()
void	write_impl (const char *Ptr, size_t Size) final
	The is the piece of the class that is implemented by subclasses.
uint64_t	current_pos () const final
	Return the current position within the stream, not counting the bytes currently in the buffer.
RAIINewLineStream &	asLvalue ()
Public Member Functions inherited from llvm::raw_ostream
	raw_ostream (bool unbuffered=false, OStreamKind K=OStreamKind::OK_OStream)
	raw_ostream (const raw_ostream &)=delete
void	operator= (const raw_ostream &)=delete
virtual	~raw_ostream ()
uint64_t	tell () const
	tell - Return the current offset with the file.
OStreamKind	get_kind () const
virtual void	reserveExtraSpace (uint64_t ExtraSize)
	If possible, pre-allocate ExtraSize bytes for stream data.
void	SetBuffered ()
	Set the stream to be buffered, with an automatically determined buffer size.
void	SetBufferSize (size_t Size)
	Set the stream to be buffered, using the specified buffer size.
size_t	GetBufferSize () const
void	SetUnbuffered ()
	Set the stream to be unbuffered.
size_t	GetNumBytesInBuffer () const
void	flush ()
raw_ostream &	operator<< (char C)
raw_ostream &	operator<< (unsigned char C)
raw_ostream &	operator<< (signed char C)
raw_ostream &	operator<< (StringRef Str)
raw_ostream &	operator<< (const char *Str)
raw_ostream &	operator<< (const std::string &Str)
raw_ostream &	operator<< (const std::string_view &Str)
raw_ostream &	operator<< (const SmallVectorImpl< char > &Str)
raw_ostream &	operator<< (unsigned long N)
raw_ostream &	operator<< (long N)
raw_ostream &	operator<< (unsigned long long N)
raw_ostream &	operator<< (long long N)
raw_ostream &	operator<< (const void *P)
raw_ostream &	operator<< (unsigned int N)
raw_ostream &	operator<< (int N)
raw_ostream &	operator<< (double N)
raw_ostream &	write_hex (unsigned long long N)
	Output N in hexadecimal, without any prefix or padding.
raw_ostream &	operator<< (Colors C)
raw_ostream &	write_uuid (const uuid_t UUID)
raw_ostream &	write_escaped (StringRef Str, bool UseHexEscapes=false)
	Output Str, turning '\', '\t', ' ', '"', and anything that doesn't satisfy llvm::isPrint into an escape sequence.
raw_ostream &	write (unsigned char C)
raw_ostream &	write (const char *Ptr, size_t Size)
raw_ostream &	operator<< (const format_object_base &Fmt)
raw_ostream &	operator<< (const FormattedString &)
raw_ostream &	operator<< (const FormattedNumber &)
raw_ostream &	operator<< (const formatv_object_base &)
raw_ostream &	operator<< (const FormattedBytes &)
raw_ostream &	indent (unsigned NumSpaces)
	indent - Insert 'NumSpaces' spaces.
raw_ostream &	write_zeros (unsigned NumZeros)
	write_zeros - Insert 'NumZeros' nulls.
virtual raw_ostream &	changeColor (enum Colors Color, bool Bold=false, bool BG=false)
	Changes the foreground color of text that will be output from this point forward.
virtual raw_ostream &	resetColor ()
	Resets the colors to terminal defaults.
virtual raw_ostream &	reverseColor ()
	Reverses the foreground and background colors.
virtual bool	is_displayed () const
	This function determines if this stream is connected to a "tty" or "console" window.
virtual bool	has_colors () const
	This function determines if this stream is displayed and supports colors.
virtual void	enable_colors (bool enable)
bool	colors_enabled () const

Additional Inherited Members
Public Types inherited from llvm::raw_ostream
enum class	OStreamKind { OK_OStream , OK_FDStream , OK_SVecStream }
enum class	Colors {   BLACK = 0 , RED , GREEN , YELLOW ,   BLUE , MAGENTA , CYAN , WHITE ,   BRIGHT_BLACK , BRIGHT_RED , BRIGHT_GREEN , BRIGHT_YELLOW ,   BRIGHT_BLUE , BRIGHT_MAGENTA , BRIGHT_CYAN , BRIGHT_WHITE ,   SAVEDCOLOR , RESET }
using	uuid_t = uint8_t[16]
	Output a formatted UUID with dash separators.
Static Public Attributes inherited from llvm::raw_ostream
static constexpr Colors	BLACK = Colors::BLACK
static constexpr Colors	RED = Colors::RED
static constexpr Colors	GREEN = Colors::GREEN
static constexpr Colors	YELLOW = Colors::YELLOW
static constexpr Colors	BLUE = Colors::BLUE
static constexpr Colors	MAGENTA = Colors::MAGENTA
static constexpr Colors	CYAN = Colors::CYAN
static constexpr Colors	WHITE = Colors::WHITE
static constexpr Colors	BRIGHT_BLACK = Colors::BRIGHT_BLACK
static constexpr Colors	BRIGHT_RED = Colors::BRIGHT_RED
static constexpr Colors	BRIGHT_GREEN = Colors::BRIGHT_GREEN
static constexpr Colors	BRIGHT_YELLOW = Colors::BRIGHT_YELLOW
static constexpr Colors	BRIGHT_BLUE = Colors::BRIGHT_BLUE
static constexpr Colors	BRIGHT_MAGENTA = Colors::BRIGHT_MAGENTA
static constexpr Colors	BRIGHT_CYAN = Colors::BRIGHT_CYAN
static constexpr Colors	BRIGHT_WHITE = Colors::BRIGHT_WHITE
static constexpr Colors	SAVEDCOLOR = Colors::SAVEDCOLOR
static constexpr Colors	RESET = Colors::RESET
Protected Member Functions inherited from llvm::raw_ostream
void	SetBuffer (char *BufferStart, size_t Size)
	Use the provided buffer as the raw_ostream buffer.
virtual size_t	preferred_buffer_size () const
	Return an efficient buffer size for the underlying output mechanism.
const char *	getBufferStart () const
	Return the beginning of the current stream buffer, or 0 if the stream is unbuffered.

Detailed Description

A raw_ostream that prints a newline on destruction, useful for LDBG()

Definition at line 305 of file DebugLog.h.

Constructor & Destructor Documentation

RAIINewLineStream()

llvm::impl::RAIINewLineStream::RAIINewLineStream ( raw_ostream & Os )

inline

Definition at line 309 of file DebugLog.h.

~RAIINewLineStream()

llvm::impl::RAIINewLineStream::~RAIINewLineStream ( )

inline

Definition at line 310 of file DebugLog.h.

Member Function Documentation

asLvalue()

RAIINewLineStream & llvm::impl::RAIINewLineStream::asLvalue ( )

inline

Definition at line 313 of file DebugLog.h.

current_pos()

uint64_t llvm::impl::RAIINewLineStream::current_pos ( ) const

inlinefinalvirtual

Return the current position within the stream, not counting the bytes currently in the buffer.

Implements llvm::raw_ostream.

Definition at line 312 of file DebugLog.h.

write_impl()

void llvm::impl::RAIINewLineStream::write_impl ( const char * Ptr, size_t Size )

inlinefinalvirtual

The is the piece of the class that is implemented by subclasses.

This writes the Size bytes starting at Ptr to the underlying stream.

This function is guaranteed to only be called at a point at which it is safe for the subclass to install a new buffer via SetBuffer.

Parameters

Ptr	The start of the data to be written. For buffered streams this is guaranteed to be the start of the buffer.
Size	The number of bytes to be written.

Invariant

{ Size > 0 }

Implements llvm::raw_ostream.

Definition at line 311 of file DebugLog.h.

---

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

• include/llvm/Support/DebugLog.h