|
LLVM
3.7.0
|
A raw_ostream that writes to a file descriptor. More...
#include <raw_ostream.h>
Public Member Functions | |
| raw_fd_ostream (StringRef Filename, std::error_code &EC, sys::fs::OpenFlags Flags) | |
| Open the specified file for writing. More... | |
| 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... | |
| void | SetUseAtomicWrites (bool Value) |
| Set the stream to attempt to use atomic writes for individual output routines where possible. 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 forground 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... | |
| 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) | |
| 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 llvm::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_escaped (StringRef Str, bool UseHexEscapes=false) |
Output Str, turning '\', '', '', '"', and anything that doesn't satisfy std::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 & | indent (unsigned NumSpaces) |
| indent - Insert 'NumSpaces' spaces. More... | |
Additional Inherited Members | |
Public Types inherited from llvm::raw_ostream | |
| enum | Colors { BLACK =0, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, SAVEDCOLOR } |
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... | |
A raw_ostream that writes to a file descriptor.
Definition at line 345 of file raw_ostream.h.
| 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 512 of file raw_ostream.cpp.
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 518 of file raw_ostream.cpp.
References llvm::sys::fs::regular_file, llvm::sys::fs::status(), and llvm::sys::fs::file_status::type().
|
override |
Definition at line 542 of file raw_ostream.cpp.
References llvm::raw_ostream::flush(), has_error(), llvm::report_fatal_error(), and llvm::sys::Process::SafelyCloseFileDescriptor().
|
overridevirtual |
Changes the foreground color of text that will be output from this point forward.
| 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 |
Reimplemented from llvm::raw_ostream.
Definition at line 661 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().
|
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."
Definition at line 443 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 616 of file raw_ostream.cpp.
References llvm::raw_ostream::flush(), and llvm::sys::Process::SafelyCloseFileDescriptor().
Referenced by LLVMPrintModuleToFile(), llvm::LockFileManager::LockFileManager(), llvm::writeArchive(), and llvm::LTOCodeGenerator::writeMergedModules().
|
overridevirtual |
This function determines if this stream is displayed and supports colors.
Reimplemented from llvm::raw_ostream.
Definition at line 707 of file raw_ostream.cpp.
References llvm::sys::Process::FileDescriptorHasColors().
|
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 430 of file raw_ostream.h.
Referenced by LLVMPrintModuleToFile(), llvm::LockFileManager::LockFileManager(), llvm::LTOCodeGenerator::writeMergedModules(), and ~raw_fd_ostream().
|
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 703 of file raw_ostream.cpp.
References llvm::sys::Process::FileDescriptorIsDisplayed().
|
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 677 of file raw_ostream.cpp.
References llvm::sys::Process::ColorNeedsFlush(), llvm::raw_ostream::flush(), llvm::sys::Process::ResetColor(), and llvm::raw_ostream::write().
|
overridevirtual |
Reverses the forground and background colors.
Reimplemented from llvm::raw_ostream.
Definition at line 690 of file raw_ostream.cpp.
References llvm::sys::Process::ColorNeedsFlush(), llvm::raw_ostream::flush(), llvm::sys::Process::OutputReverse(), and llvm::raw_ostream::write().
| 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 625 of file raw_ostream.cpp.
References llvm::raw_ostream::flush().
Referenced by printWithSpacePadding(), llvm::InstrProfWriter::write(), llvm::writeArchive(), writeStringTable(), and writeSymbolTable().
|
inline |
Set the stream to attempt to use atomic writes for individual output routines where possible.
Note that because raw_ostream's are typically buffered, this flag is only sensible when used on unbuffered streams which will flush their output immediately.
Definition at line 412 of file raw_ostream.h.
|
inline |
Definition at line 400 of file raw_ostream.h.
1.8.6