LLVM  mainline
llvm::raw_fd_ostream Class Reference

A raw_ostream that writes to a file descriptor. More...

#include <raw_ostream.h>

Inheritance diagram for llvm::raw_fd_ostream:
[legend]
Collaboration diagram for llvm::raw_fd_ostream:
[legend]

List of all members.

Public Member Functions

raw_fd_ostream (StringRef Filename, std::error_code &EC, sys::fs::OpenFlags Flags)
Open the specified file for writing.
raw_fd_ostream (int fd, bool shouldClose, bool unbuffered=false)
FD is the file descriptor that this writes to.
~raw_fd_ostream () override
void close ()
Manually flush the stream and close the file.
bool supportsSeeking ()
uint64_t seek (uint64_t off)
Flushes the stream and repositions the underlying file descriptor position to the offset specified from the beginning of the file.
raw_ostreamchangeColor (enum Colors colors, bool bold=false, bool bg=false) override
Changes the foreground color of text that will be output from this point forward.
raw_ostreamresetColor () override
Resets the colors to terminal defaults.
raw_ostreamreverseColor () override
Reverses the foreground and background colors.
bool is_displayed () const override
This function determines if this stream is connected to a "tty" or "console" window.
bool has_colors () const override
This function determines if this stream is displayed and supports colors.
bool has_error () const
Return the value of the flag in this raw_fd_ostream indicating whether an output error has been encountered.
void clear_error ()
Set the flag read by has_error() to false.

Detailed Description

A raw_ostream that writes to a file descriptor.

Definition at line 344 of file raw_ostream.h.

Constructor & Destructor Documentation

 raw_fd_ostream::raw_fd_ostream ( StringRef Filename, std::error_code & EC, sys::fs::OpenFlags Flags )

Open the specified file for writing.

If an error occurs, information about the error is put into EC, and the stream should be immediately destroyed; Flags allows optional flags to control how the file will be opened.

As a special case, if Filename is "-", then the stream will use STDOUT_FILENO instead of opening a file. Note that it will still consider itself to own the file descriptor. In particular, it will close the file descriptor when it is done (this is necessary to detect output errors).

Definition at line 516 of file raw_ostream.cpp.

 raw_fd_ostream::raw_fd_ostream ( int fd, bool shouldClose, bool unbuffered = false )

FD is the file descriptor that this writes to.

If ShouldClose is true, this closes the file when the stream is destroyed.

Definition at line 522 of file raw_ostream.cpp.

 raw_fd_ostream::~raw_fd_ostream ( )  [override]

Definition at line 546 of file raw_ostream.cpp.

Member Function Documentation

 raw_ostream & raw_fd_ostream::changeColor ( enum Colors Color, bool Bold = false, bool BG = false )  [override, virtual]

Changes the foreground color of text that will be output from this point forward.

Parameters:
 Color ANSI color to use, the special SAVEDCOLOR can be used to change only the bold attribute, and keep colors untouched Bold bold/brighter text, default false BG if true change the background, default: change foreground
Returns:
itself so it can be used within << invocations

Reimplemented from llvm::raw_ostream.

Definition at line 664 of file raw_ostream.cpp.

 void llvm::raw_fd_ostream::clear_error ( )  [inline]

Set the flag read by has_error() to false.

If the error flag is set at the time when this raw_ostream's destructor is called, report_fatal_error is called to report the error. Use clear_error() after handling the error to avoid this behavior.

"Errors should never pass silently. Unless explicitly silenced."

• from The Zen of Python, by Tim Peters

Definition at line 428 of file raw_ostream.h.

Referenced by llvm::LTOCodeGenerator::writeMergedModules().

 void raw_fd_ostream::close ( )

Manually flush the stream and close the file.

Note that this does not call fsync.

Definition at line 619 of file raw_ostream.cpp.

 bool raw_fd_ostream::has_colors ( ) const [override, virtual]

This function determines if this stream is displayed and supports colors.

Reimplemented from llvm::raw_ostream.

Definition at line 710 of file raw_ostream.cpp.

 bool llvm::raw_fd_ostream::has_error ( ) const [inline]

Return the value of the flag in this raw_fd_ostream indicating whether an output error has been encountered.

This doesn't implicitly flush any pending output. Also, it doesn't guarantee to detect all errors unless the stream has been closed.

Definition at line 415 of file raw_ostream.h.

 bool raw_fd_ostream::is_displayed ( ) const [override, virtual]

This function determines if this stream is connected to a "tty" or "console" window.

That is, the output would be displayed to the user rather than being put on a pipe or stored in a file.

Reimplemented from llvm::raw_ostream.

Definition at line 706 of file raw_ostream.cpp.

 raw_ostream & raw_fd_ostream::resetColor ( )  [override, virtual]

Resets the colors to terminal defaults.

Call this when you are done outputting colored text, or before program exit.

Reimplemented from llvm::raw_ostream.

Definition at line 680 of file raw_ostream.cpp.

 raw_ostream & raw_fd_ostream::reverseColor ( )  [override, virtual]

Reverses the foreground and background colors.

Reimplemented from llvm::raw_ostream.

Definition at line 693 of file raw_ostream.cpp.

 uint64_t raw_fd_ostream::seek ( uint64_t off )

Flushes the stream and repositions the underlying file descriptor position to the offset specified from the beginning of the file.

Definition at line 628 of file raw_ostream.cpp.

References llvm::raw_ostream::flush().

 bool llvm::raw_fd_ostream::supportsSeeking ( )  [inline]

Definition at line 395 of file raw_ostream.h.

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