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

#include "llvm/Support/raw_ostream.h"

Inheritance diagram for llvm::raw_fd_ostream:

Collaboration diagram for llvm::raw_fd_ostream:

Public Member Functions
	raw_fd_ostream (StringRef Filename, std::error_code &EC)
	Open the specified file for writing. More...

	raw_fd_ostream (StringRef Filename, std::error_code &EC, sys::fs::CreationDisposition Disp)

	raw_fd_ostream (StringRef Filename, std::error_code &EC, sys::fs::FileAccess Access)

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

	raw_fd_ostream (StringRef Filename, std::error_code &EC, sys::fs::CreationDisposition Disp, sys::fs::FileAccess Access, sys::fs::OpenFlags Flags)

	raw_fd_ostream (int fd, bool shouldClose, bool unbuffered=false)
	FD is the file descriptor that this writes to. More...

	~raw_fd_ostream () override

void	close ()
	Manually flush the stream and close the file. More...

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. More...

raw_ostream &	changeColor (enum Colors colors, bool bold=false, bool bg=false) override
	Changes the foreground color of text that will be output from this point forward. More...

raw_ostream &	resetColor () override
	Resets the colors to terminal defaults. More...

raw_ostream &	reverseColor () override
	Reverses the foreground and background colors. More...

bool	is_displayed () const override
	This function determines if this stream is connected to a "tty" or "console" window. More...

bool	has_colors () const override
	This function determines if this stream is displayed and supports colors. More...

std::error_code	error () const

bool	has_error () const
	Return the value of the flag in this raw_fd_ostream indicating whether an output error has been encountered. More...

void	clear_error ()
	Set the flag read by has_error() to false. More...

Public Member Functions inherited from llvm::raw_pwrite_stream
	raw_pwrite_stream (bool Unbuffered=false)

void	pwrite (const char *Ptr, size_t Size, uint64_t Offset)

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_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 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. More...

raw_ostream &	write_uuid (const uuid_t UUID)

raw_ostream &	write_escaped (StringRef Str, bool UseHexEscapes=false)
	Output `Str`, turning '\', '', ' ', '"', and anything that doesn't satisfy llvm::isPrint into an escape sequence. More...

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. More...

raw_ostream &	write_zeros (unsigned NumZeros)
	write_zeros - Insert 'NumZeros' nulls. 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...

const char *	getBufferStart () const
	Return the beginning of the current stream buffer, or 0 if the stream is unbuffered. More...

Detailed Description

A raw_ostream that writes to a file descriptor.

Definition at line 366 of file raw_ostream.h.

Constructor & Destructor Documentation

◆ raw_fd_ostream() [1/6]

raw_fd_ostream::raw_fd_ostream	(	StringRef	Filename,
		std::error_code &	EC
	)

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. This will not close the stdout descriptor.

Definition at line 529 of file raw_ostream.cpp.

◆ raw_fd_ostream() [2/6]

raw_fd_ostream::raw_fd_ostream	(	StringRef	Filename,
		std::error_code &	EC,
		sys::fs::CreationDisposition	Disp
	)

Definition at line 533 of file raw_ostream.cpp.

◆ raw_fd_ostream() [3/6]

raw_fd_ostream::raw_fd_ostream	(	StringRef	Filename,
		std::error_code &	EC,
		sys::fs::FileAccess	Access
	)

Definition at line 537 of file raw_ostream.cpp.

◆ raw_fd_ostream() [4/6]

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

Definition at line 542 of file raw_ostream.cpp.

◆ raw_fd_ostream() [5/6]

raw_fd_ostream::raw_fd_ostream	(	StringRef	Filename,
		std::error_code &	EC,
		sys::fs::CreationDisposition	Disp,
		sys::fs::FileAccess	Access,
		sys::fs::OpenFlags	Flags
	)

Definition at line 547 of file raw_ostream.cpp.

◆ raw_fd_ostream() [6/6]

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. If FD is for stdout or stderr, it will not be closed.

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

Definition at line 555 of file raw_ostream.cpp.

References llvm::sys::fs::regular_file, llvm::sys::fs::status(), and llvm::sys::fs::basic_file_status::type().

◆ ~raw_fd_ostream()

raw_fd_ostream::~raw_fd_ostream ( )

override

Definition at line 593 of file raw_ostream.cpp.

References assert(), llvm::Data, llvm::AMDGPU::SDWA::DWORD, error(), llvm::raw_ostream::flush(), has_error(), llvm::report_fatal_error(), llvm::RunningWindows8OrGreater(), llvm::sys::Process::SafelyCloseFileDescriptor(), Size, llvm::SmallVectorBase::size(), Success, and llvm::raw_ostream::write().

Member Function Documentation

◆ changeColor()

raw_ostream & raw_fd_ostream::changeColor	(	enum Colors	Color,
		bool	Bold = `false`,
		bool	BG = `false`
	)

overridevirtual

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 786 of file raw_ostream.cpp.

References llvm::sys::Process::ColorNeedsFlush(), llvm::raw_ostream::flush(), llvm::sys::Process::OutputBold(), llvm::sys::Process::OutputColor(), llvm::raw_ostream::SAVEDCOLOR, and llvm::raw_ostream::write().

◆ clear_error()

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 463 of file raw_ostream.h.

References llvm::errs(), llvm::nulls(), and llvm::outs().

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

◆ close()

void raw_fd_ostream::close ( )

Manually flush the stream and close the file.

Note that this does not call fsync.

Definition at line 725 of file raw_ostream.cpp.

References assert(), llvm::raw_ostream::flush(), and llvm::sys::Process::SafelyCloseFileDescriptor().

Referenced by LLVMPrintModuleToFile(), llvm::LockFileManager::LockFileManager(), shouldKeepInEntry(), and llvm::LTOCodeGenerator::writeMergedModules().

◆ error()

std::error_code llvm::raw_fd_ostream::error ( ) const

inline

Definition at line 446 of file raw_ostream.h.

Referenced by LLVMPrintModuleToFile(), llvm::LockFileManager::LockFileManager(), llvm::LTOCodeGenerator::writeMergedModules(), and ~raw_fd_ostream().

◆ has_colors()

bool raw_fd_ostream::has_colors ( ) const

overridevirtual

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

Reimplemented from llvm::raw_ostream.

Definition at line 832 of file raw_ostream.cpp.

References llvm::sys::Process::FileDescriptorHasColors().

◆ has_error()

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 452 of file raw_ostream.h.

Referenced by LLVMPrintModuleToFile(), llvm::LockFileManager::LockFileManager(), llvm::LTOCodeGenerator::writeMergedModules(), and ~raw_fd_ostream().

◆ is_displayed()

bool raw_fd_ostream::is_displayed ( ) const

overridevirtual

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 828 of file raw_ostream.cpp.

References llvm::sys::Process::FileDescriptorIsDisplayed().

◆ resetColor()

raw_ostream & raw_fd_ostream::resetColor ( )

overridevirtual

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 802 of file raw_ostream.cpp.

References llvm::sys::Process::ColorNeedsFlush(), llvm::raw_ostream::flush(), llvm::sys::Process::ResetColor(), and llvm::raw_ostream::write().

◆ reverseColor()

raw_ostream & raw_fd_ostream::reverseColor ( )

overridevirtual

Reverses the foreground and background colors.

Reimplemented from llvm::raw_ostream.

Definition at line 815 of file raw_ostream.cpp.

References llvm::sys::Process::ColorNeedsFlush(), llvm::raw_ostream::flush(), llvm::sys::Process::OutputReverse(), and llvm::raw_ostream::write().

◆ seek()

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 734 of file raw_ostream.cpp.

References assert(), llvm::raw_ostream::flush(), llvm::raw_ostream::preferred_buffer_size(), Size, llvm::raw_ostream::tell(), and llvm::raw_ostream::write().

Referenced by pad(), and llvm::ProfOStream::patch().

◆ supportsSeeking()

bool llvm::raw_fd_ostream::supportsSeeking ( )

inline

Definition at line 430 of file raw_ostream.h.

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

include/llvm/Support/raw_ostream.h
lib/Support/raw_ostream.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ raw_fd_ostream() [1/6]

◆ raw_fd_ostream() [2/6]

◆ raw_fd_ostream() [3/6]

◆ raw_fd_ostream() [4/6]

◆ raw_fd_ostream() [5/6]

◆ raw_fd_ostream() [6/6]

◆ ~raw_fd_ostream()

Member Function Documentation

◆ changeColor()

◆ clear_error()

◆ close()

◆ error()

◆ has_colors()

◆ has_error()

◆ is_displayed()

◆ resetColor()

◆ reverseColor()

◆ seek()

◆ supportsSeeking()