LLVM  6.0.0svn
Public Member Functions | Static Public Attributes | List of all members
llvm::circular_raw_ostream Class Reference

circular_raw_ostream - A raw_ostream which can save its data to a circular buffer, or can pass it through directly to an underlying stream if specified with a buffer of zero. More...

#include "llvm/Support/circular_raw_ostream.h"

Inheritance diagram for llvm::circular_raw_ostream:
Inheritance graph
[legend]
Collaboration diagram for llvm::circular_raw_ostream:
Collaboration graph
[legend]

Public Member Functions

 circular_raw_ostream (raw_ostream &Stream, const char *Header, size_t BuffSize=0, bool Owns=REFERENCE_ONLY)
 circular_raw_ostream - Construct an optionally circular-buffered stream, handing it an underlying stream to do the "real" output. More...
 
 ~circular_raw_ostream () override
 
void setStream (raw_ostream &Stream, bool Owns=REFERENCE_ONLY)
 setStream - Tell the circular_raw_ostream to output a different stream. More...
 
void flushBufferWithBanner ()
 flushBufferWithBanner - Force output of the buffer along with a small header. More...
 
- Public Member Functions inherited from llvm::raw_ostream
 raw_ostream (bool unbuffered=false)
 
 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. More...
 
void SetBuffered ()
 Set the stream to be buffered, with an automatically determined buffer size. More...
 
void SetBufferSize (size_t Size)
 Set the stream to be buffered, using the specified buffer size. More...
 
size_t GetBufferSize () const
 
void SetUnbuffered ()
 Set the stream to be unbuffered. More...
 
size_t GetNumBytesInBuffer () const
 
void flush ()
 
raw_ostreamoperator<< (char C)
 
raw_ostreamoperator<< (unsigned char C)
 
raw_ostreamoperator<< (signed char C)
 
raw_ostreamoperator<< (StringRef Str)
 
raw_ostreamoperator<< (const char *Str)
 
raw_ostreamoperator<< (const std::string &Str)
 
raw_ostreamoperator<< (const SmallVectorImpl< char > &Str)
 
raw_ostreamoperator<< (unsigned long N)
 
raw_ostreamoperator<< (long N)
 
raw_ostreamoperator<< (unsigned long long N)
 
raw_ostreamoperator<< (long long N)
 
raw_ostreamoperator<< (const void *P)
 
raw_ostreamoperator<< (unsigned int N)
 
raw_ostreamoperator<< (int N)
 
raw_ostreamoperator<< (double N)
 
raw_ostreamwrite_hex (unsigned long long N)
 Output N in hexadecimal, without any prefix or padding. More...
 
raw_ostreamwrite_uuid (const uuid_t UUID)
 
raw_ostreamwrite_escaped (StringRef Str, bool UseHexEscapes=false)
 Output Str, turning '\', '', '
', '"', and anything that doesn't satisfy std::isprint into an escape sequence. More...
 
raw_ostreamwrite (unsigned char C)
 
raw_ostreamwrite (const char *Ptr, size_t Size)
 
raw_ostreamoperator<< (const format_object_base &Fmt)
 
raw_ostreamoperator<< (const FormattedString &)
 
raw_ostreamoperator<< (const FormattedNumber &)
 
raw_ostreamoperator<< (const formatv_object_base &)
 
raw_ostreamoperator<< (const FormattedBytes &)
 
raw_ostreamindent (unsigned NumSpaces)
 indent - Insert 'NumSpaces' spaces. More...
 
virtual raw_ostreamchangeColor (enum Colors Color, bool Bold=false, bool BG=false)
 Changes the foreground color of text that will be output from this point forward. More...
 
virtual raw_ostreamresetColor ()
 Resets the colors to terminal defaults. More...
 
virtual raw_ostreamreverseColor ()
 Reverses the foreground and background colors. More...
 
virtual bool is_displayed () const
 This function determines if this stream is connected to a "tty" or "console" window. More...
 
virtual bool has_colors () const
 This function determines if this stream is displayed and supports colors. More...
 

Static Public Attributes

static const bool TAKE_OWNERSHIP = true
 TAKE_OWNERSHIP - Tell this stream that it owns the underlying stream and is responsible for cleanup, memory management issues, etc. More...
 
static const bool REFERENCE_ONLY = false
 REFERENCE_ONLY - Tell this stream it should not manage the held stream. More...
 

Additional Inherited Members

- Public Types inherited from llvm::raw_ostream
enum  Colors {
  BLACK = 0, RED, GREEN, YELLOW,
  BLUE, MAGENTA, CYAN, WHITE,
  SAVEDCOLOR
}
 
using uuid_t = uint8_t[16]
 Output a formatted UUID with dash separators. More...
 
- Protected Member Functions inherited from llvm::raw_ostream
void SetBuffer (char *BufferStart, size_t Size)
 Use the provided buffer as the raw_ostream buffer. More...
 
virtual size_t preferred_buffer_size () const
 Return an efficient buffer size for the underlying output mechanism. More...
 
const chargetBufferStart () const
 Return the beginning of the current stream buffer, or 0 if the stream is unbuffered. More...
 

Detailed Description

circular_raw_ostream - A raw_ostream which can save its data to a circular buffer, or can pass it through directly to an underlying stream if specified with a buffer of zero.

Definition at line 25 of file circular_raw_ostream.h.

Constructor & Destructor Documentation

◆ circular_raw_ostream()

llvm::circular_raw_ostream::circular_raw_ostream ( raw_ostream Stream,
const char Header,
size_t  BuffSize = 0,
bool  Owns = REFERENCE_ONLY 
)
inline

circular_raw_ostream - Construct an optionally circular-buffered stream, handing it an underlying stream to do the "real" output.

As a side effect, if BuffSize is nonzero, the given Stream is set to be Unbuffered. This is because circular_raw_ostream does its own buffering, so it doesn't want another layer of buffering to be happening underneath it.

"Owns" tells the circular_raw_ostream whether it is responsible for managing the held stream, doing memory management of it, etc.

Definition at line 108 of file circular_raw_ostream.h.

References setStream().

◆ ~circular_raw_ostream()

llvm::circular_raw_ostream::~circular_raw_ostream ( )
inlineoverride

Definition at line 119 of file circular_raw_ostream.h.

References llvm::raw_ostream::flush(), and flushBufferWithBanner().

Member Function Documentation

◆ flushBufferWithBanner()

void circular_raw_ostream::flushBufferWithBanner ( )

flushBufferWithBanner - Force output of the buffer along with a small header.

Definition at line 39 of file circular_raw_ostream.cpp.

References llvm::raw_ostream::write().

Referenced by debug_user_sig_handler(), setStream(), and ~circular_raw_ostream().

◆ setStream()

void llvm::circular_raw_ostream::setStream ( raw_ostream Stream,
bool  Owns = REFERENCE_ONLY 
)
inline

setStream - Tell the circular_raw_ostream to output a different stream.

"Owns" tells circular_raw_ostream whether it should take responsibility for managing the underlying stream.

Definition at line 131 of file circular_raw_ostream.h.

References flushBufferWithBanner().

Referenced by circular_raw_ostream().

Member Data Documentation

◆ REFERENCE_ONLY

const bool llvm::circular_raw_ostream::REFERENCE_ONLY = false
static

REFERENCE_ONLY - Tell this stream it should not manage the held stream.

Definition at line 36 of file circular_raw_ostream.h.

◆ TAKE_OWNERSHIP

const bool llvm::circular_raw_ostream::TAKE_OWNERSHIP = true
static

TAKE_OWNERSHIP - Tell this stream that it owns the underlying stream and is responsible for cleanup, memory management issues, etc.

Definition at line 31 of file circular_raw_ostream.h.


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