|
LLVM
4.0.0
|
This class implements an extremely fast bulk output stream that can only output to a stream. More...
#include <raw_ostream.h>
Public Types | |
| enum | Colors { BLACK = 0, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, SAVEDCOLOR } |
Public Member Functions | |
| 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_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 & | operator<< (const formatv_object_base &) |
| raw_ostream & | operator<< (const FormattedBytes &) |
| raw_ostream & | indent (unsigned NumSpaces) |
| indent - Insert 'NumSpaces' spaces. More... | |
| 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. More... | |
| virtual raw_ostream & | resetColor () |
| Resets the colors to terminal defaults. More... | |
| virtual raw_ostream & | reverseColor () |
| 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... | |
Protected Member Functions | |
| 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 char * | getBufferStart () const |
| Return the beginning of the current stream buffer, or 0 if the stream is unbuffered. More... | |
This class implements an extremely fast bulk output stream that can only output to a stream.
It does not support seeking, reopening, rewinding, line buffered disciplines etc. It is a simple buffer that outputs a chunk at a time.
Definition at line 44 of file raw_ostream.h.
| Enumerator | |
|---|---|
| BLACK | |
| RED | |
| GREEN | |
| YELLOW | |
| BLUE | |
| MAGENTA | |
| CYAN | |
| WHITE | |
| SAVEDCOLOR | |
Definition at line 74 of file raw_ostream.h.
Definition at line 86 of file raw_ostream.h.
|
delete |
|
virtual |
Definition at line 71 of file raw_ostream.cpp.
References assert().
|
inlinevirtual |
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 in llvm::raw_fd_ostream, and llvm::formatted_raw_ostream.
Definition at line 248 of file raw_ostream.h.
Referenced by llvm::formatted_raw_ostream::changeColor(), llvm::SMDiagnostic::print(), and llvm::dwarf::syntax::WithColor::WithColor().
|
inline |
Definition at line 140 of file raw_ostream.h.
Referenced by llvm::TarWriter::append(), llvm::object::ArchiveMemberHeader::ArchiveMemberHeader(), llvm::raw_fd_ostream::changeColor(), llvm::object::Archive::Child::Child(), llvm::raw_fd_ostream::close(), llvm::ImportedFunctionsInliningStatistics::dump(), llvm::DWARFContextInMemory::DWARFContextInMemory(), emitComments(), llvm::ARMAsmPrinter::EmitEndOfAsmFile(), llvm::X86AsmPrinter::EmitEndOfAsmFile(), llvm::AMDGPUAsmPrinter::EmitInstruction(), llvm::TargetLoweringObjectFileCOFF::emitLinkerFlagsForGlobal(), fail(), llvm::ScopedPrinter::flush(), llvm::MCJIT::generateCodeForModule(), llvm::object::ArchiveMemberHeader::getAccessMode(), getBlockName(), llvm::BFIDOTGraphTraitsBase< BlockFrequencyInfoT, BranchProbabilityInfoT >::getEdgeAttributes(), llvm::LockFileManager::getErrorMessage(), llvm::object::ArchiveMemberHeader::getGID(), llvm::object::ArchiveMemberHeader::getLastModified(), llvm::object::ArchiveMemberHeader::getName(), llvm::LazyCallGraph::SCC::getName(), llvm::LazyCallGraph::RefSCC::getName(), llvm::BFIDOTGraphTraitsBase< BlockFrequencyInfoT, BranchProbabilityInfoT >::getNodeAttributes(), getShuffleComment(), llvm::object::ArchiveMemberHeader::getSize(), llvm::object::ArchiveMemberHeader::getUID(), llvm::NVPTXAsmPrinter::getVirtualRegisterName(), llvm::isThumbFunc(), LLVMGetDiagInfoDescription(), LLVMGetSymbolAddress(), LLVMGetSymbolName(), LLVMMoveToContainingSection(), LLVMParseIRInContext(), LLVMPrintModuleToString(), LLVMPrintTypeToString(), LLVMPrintValueToString(), LLVMTargetMachineEmit(), LLVMTargetMachineEmitToFile(), llvm::DWARFDebugFrame::parse(), llvm::MIRPrinter::print(), llvm::DiagnosticInfoUnsupported::print(), PrintCurStackTrace(), llvm::opt::OptTable::PrintHelp(), llvm::AMDGPUInstPrinter::printInst(), llvm::PrintStatistics(), llvm::PrintStatisticsJSON(), llvm::RuntimeDyldELF::processRelocationRef(), reportError(), reportOpenError(), llvm::raw_fd_ostream::resetColor(), llvm::raw_fd_ostream::reverseColor(), llvm::raw_fd_ostream::seek(), SetBufferSize(), SetUnbuffered(), llvm::raw_sha1_ostream::sha1(), llvm::formatv_object_base::str(), llvm::raw_string_ostream::str(), llvm::sys::StrError(), llvm::circular_raw_ostream::~circular_raw_ostream(), llvm::formatted_raw_ostream::~formatted_raw_ostream(), llvm::raw_fd_ostream::~raw_fd_ostream(), llvm::raw_null_ostream::~raw_null_ostream(), llvm::raw_os_ostream::~raw_os_ostream(), and llvm::raw_string_ostream::~raw_string_ostream().
|
inline |
Definition at line 114 of file raw_ostream.h.
References preferred_buffer_size().
|
inlineprotected |
Return the beginning of the current stream buffer, or 0 if the stream is unbuffered.
Definition at line 312 of file raw_ostream.h.
Referenced by llvm::formatted_raw_ostream::PadToColumn().
|
inline |
Definition at line 132 of file raw_ostream.h.
Referenced by llvm::formatted_raw_ostream::PadToColumn(), and tell().
|
inlinevirtual |
This function determines if this stream is displayed and supports colors.
Reimplemented in llvm::raw_fd_ostream.
Definition at line 270 of file raw_ostream.h.
References is_displayed().
Referenced by llvm::SMDiagnostic::print(), llvm::dwarf::syntax::WithColor::WithColor(), and llvm::dwarf::syntax::WithColor::~WithColor().
| raw_ostream & raw_ostream::indent | ( | unsigned | NumSpaces | ) |
indent - Insert 'NumSpaces' spaces.
Definition at line 435 of file raw_ostream.cpp.
References llvm::array_lengthof(), fuzzer::min(), and write().
Referenced by llvm::pdb::IPDBSourceFile::dump(), llvm::DWARFDebugLoc::dump(), llvm::DWARFDebugLocDWO::dump(), llvm::DWARFDie::dump(), llvm::LexicalScope::dump(), llvm::RGPassManager::dumpPassStructure(), llvm::LPPassManager::dumpPassStructure(), llvm::Pass::dumpPassStructure(), llvm::FPPassManager::dumpPassStructure(), llvm::StringMatcher::Emit(), emitBasicBlockLoopComments(), llvm::FmtAlign::format(), llvm::detail::PadAdapter< T >::format(), operator<<(), llvm::formatted_raw_ostream::PadToColumn(), llvm::MIPrinter::print(), llvm::sampleprof::FunctionSamples::print(), llvm::MemoryDepChecker::Dependence::print(), llvm::SCEVEqualPredicate::print(), llvm::LoopBase< N, M >::print(), llvm::SCEVWrapPredicate::print(), llvm::RegionBase< RegionTr >::print(), llvm::RuntimePointerChecking::print(), llvm::LoopAccessInfo::print(), llvm::LoopAccessLegacyAnalysis::print(), llvm::PredicatedScalarEvolution::print(), llvm::RuntimePointerChecking::printChecks(), PrintChildLoopComment(), llvm::PrintDomTree(), llvm::cl::generic_parser_base::printGenericOptionDiff(), PrintHelpOptionList(), printHelpStr(), llvm::cl::generic_parser_base::printOptionInfo(), llvm::cl::basic_parser_impl::printOptionName(), PrintParentLoopComment(), llvm::DOTGraphTraits< RegionInfo * >::printRegionCluster(), printrWithDepthHelper(), printWithSpacePadding(), and llvm::LoopAccessInfoPrinterPass::run().
|
inlinevirtual |
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 in llvm::raw_fd_ostream, and llvm::formatted_raw_ostream.
Definition at line 267 of file raw_ostream.h.
Referenced by llvm::CheckBitcodeOutputToConsole(), has_colors(), and llvm::formatted_raw_ostream::is_displayed().
|
inline |
Definition at line 145 of file raw_ostream.h.
Referenced by operator<<().
|
inline |
Definition at line 152 of file raw_ostream.h.
|
inline |
Definition at line 159 of file raw_ostream.h.
|
inline |
Definition at line 166 of file raw_ostream.h.
References llvm::StringRef::data(), llvm::StringRef::size(), and write().
|
inline |
Definition at line 181 of file raw_ostream.h.
References operator<<().
|
inline |
Definition at line 188 of file raw_ostream.h.
References write().
|
inline |
Definition at line 193 of file raw_ostream.h.
References write().
| raw_ostream & raw_ostream::operator<< | ( | unsigned long | N | ) |
Definition at line 117 of file raw_ostream.cpp.
References llvm::Integer, and llvm::write_integer().
| raw_ostream & raw_ostream::operator<< | ( | long | N | ) |
Definition at line 122 of file raw_ostream.cpp.
References llvm::Integer, and llvm::write_integer().
| raw_ostream & raw_ostream::operator<< | ( | unsigned long long | N | ) |
Definition at line 127 of file raw_ostream.cpp.
References llvm::Integer, and llvm::write_integer().
| raw_ostream & raw_ostream::operator<< | ( | long long | N | ) |
Definition at line 132 of file raw_ostream.cpp.
References llvm::Integer, and llvm::write_integer().
| raw_ostream & raw_ostream::operator<< | ( | const void * | P | ) |
Definition at line 182 of file raw_ostream.cpp.
References llvm::PrefixLower, and llvm::write_hex().
|
inline |
Definition at line 203 of file raw_ostream.h.
References N.
|
inline |
Definition at line 207 of file raw_ostream.h.
References N.
| raw_ostream & raw_ostream::operator<< | ( | double | N | ) |
Definition at line 187 of file raw_ostream.cpp.
References llvm::Exponent, and llvm::write_double().
| raw_ostream & raw_ostream::operator<< | ( | const format_object_base & | Fmt | ) |
Definition at line 282 of file raw_ostream.cpp.
References assert(), llvm::SmallVectorTemplateCommon< T >::data(), llvm::format_object_base::print(), llvm::SmallVectorImpl< T >::resize(), and write().
| raw_ostream & raw_ostream::operator<< | ( | const FormattedString & | FS | ) |
Definition at line 328 of file raw_ostream.cpp.
References indent(), operator<<(), and llvm::StringRef::size().
| raw_ostream & raw_ostream::operator<< | ( | const FormattedNumber & | FN | ) |
Definition at line 339 of file raw_ostream.cpp.
References indent(), llvm::Integer, llvm::Lower, llvm::PrefixLower, llvm::PrefixUpper, llvm::SmallVectorTemplateCommon< T >::size(), llvm::Upper, llvm::write_hex(), and llvm::write_integer().
| raw_ostream & raw_ostream::operator<< | ( | const formatv_object_base & | Obj | ) |
Definition at line 322 of file raw_ostream.cpp.
References llvm::formatv_object_base::format().
| raw_ostream & raw_ostream::operator<< | ( | const FormattedBytes & | FB | ) |
Definition at line 362 of file raw_ostream.cpp.
References llvm::alignTo(), assert(), llvm::ArrayRef< T >::empty(), llvm::Optional< T >::getValue(), llvm::Optional< T >::hasValue(), I, indent(), llvm::Log2_64_Ceil(), llvm::Lower, Offset, llvm::ArrayRef< T >::size(), llvm::Upper, and llvm::write_hex().
|
delete |
|
protectedvirtual |
Return an efficient buffer size for the underlying output mechanism.
Definition at line 84 of file raw_ostream.cpp.
Referenced by GetBufferSize(), and SetBuffered().
|
inlinevirtual |
Resets the colors to terminal defaults.
Call this when you are done outputting colored text, or before program exit.
Reimplemented in llvm::raw_fd_ostream, and llvm::formatted_raw_ostream.
Definition at line 259 of file raw_ostream.h.
Referenced by llvm::SMDiagnostic::print(), llvm::formatted_raw_ostream::resetColor(), and llvm::dwarf::syntax::WithColor::~WithColor().
|
inlinevirtual |
Reverses the foreground and background colors.
Reimplemented in llvm::raw_fd_ostream, and llvm::formatted_raw_ostream.
Definition at line 262 of file raw_ostream.h.
Referenced by llvm::formatted_raw_ostream::reverseColor().
|
inlineprotected |
Use the provided buffer as the raw_ostream buffer.
This is intended for use only by subclasses which can arrange for the output to go directly into the desired output buffer, instead of being copied on each flush.
Definition at line 303 of file raw_ostream.h.
| void raw_ostream::SetBuffered | ( | ) |
Set the stream to be buffered, with an automatically determined buffer size.
Definition at line 89 of file raw_ostream.cpp.
References preferred_buffer_size(), SetBufferSize(), and SetUnbuffered().
Referenced by write().
|
inline |
Set the stream to be buffered, using the specified buffer size.
Definition at line 109 of file raw_ostream.h.
References flush().
Referenced by SetBuffered().
|
inline |
Set the stream to be unbuffered.
When unbuffered, the stream will flush after every write. This routine will also flush the buffer immediately when the stream is being set to unbuffered.
Definition at line 127 of file raw_ostream.h.
References flush().
Referenced by llvm::raw_svector_ostream::raw_svector_ostream(), and SetBuffered().
|
inline |
tell - Return the current offset with the file.
Definition at line 98 of file raw_ostream.h.
References GetNumBytesInBuffer().
Referenced by llvm::TarWriter::append(), llvm::OnDiskChainedHashTableGenerator< Info >::Emit(), llvm::MCAssembler::Finish(), llvm::MCObjectWriter::getInitialOffset(), pad(), printBSDMemberHeader(), printLine(), printWithSpacePadding(), llvm::raw_pwrite_stream::pwrite(), llvm::codeview::TypeRecordBuilder::size(), llvm::ProfOStream::tell(), llvm::writeArchive(), llvm::MachObjectWriter::writeDysymtabLoadCommand(), writeFragment(), llvm::MachObjectWriter::writeHeader(), llvm::MachObjectWriter::writeLinkeditLoadCommand(), llvm::MachObjectWriter::writeLinkerOptionsLoadCommand(), llvm::MachObjectWriter::writeObject(), llvm::MachObjectWriter::writeSection(), llvm::MCAssembler::writeSectionData(), llvm::MachObjectWriter::writeSegmentLoadCommand(), writeStringTable(), writeSymbolTable(), and llvm::MachObjectWriter::writeSymtabLoadCommand().
| raw_ostream & raw_ostream::write | ( | unsigned char | C | ) |
Definition at line 199 of file raw_ostream.cpp.
References C, LLVM_UNLIKELY, and SetBuffered().
Referenced by llvm::raw_fd_ostream::changeColor(), llvm::InstrProfRecordWriterTrait::EmitData(), EmitGCCInlineAsmStr(), llvm::InstrProfRecordWriterTrait::EmitKey(), EmitMSInlineAsmStr(), llvm::circular_raw_ostream::flushBufferWithBanner(), indent(), operator<<(), printBSDMemberHeader(), llvm::raw_fd_ostream::resetColor(), llvm::raw_fd_ostream::reverseColor(), llvm::support::endian::Writer< llvm::support::endianness::little >::write(), write(), llvm::write_hex(), write_unsigned_impl(), llvm::yaml::BinaryRef::writeAsBinary(), llvm::yaml::BinaryRef::writeAsHex(), llvm::WriteBitcodeToFile(), llvm::WriteIndexToFile(), writeSymbolTable(), and writeWithCommas().
| raw_ostream & raw_ostream::write | ( | const char * | Ptr, |
| size_t | Size | ||
| ) |
Definition at line 219 of file raw_ostream.cpp.
References assert(), LLVM_UNLIKELY, SetBuffered(), and write().
| raw_ostream & raw_ostream::write_escaped | ( | StringRef | Str, |
| bool | UseHexEscapes = false |
||
| ) |
Output Str, turning '\', '', '
', '"', and anything that doesn't satisfy std::isprint into an escape sequence.
Definition at line 142 of file raw_ostream.cpp.
Referenced by llvm::object::ArchiveMemberHeader::ArchiveMemberHeader(), llvm::object::Archive::Child::Child(), llvm::DWARFFormValue::dump(), llvm::StringToOffsetTable::EmitCharArray(), llvm::StringToOffsetTable::EmitString(), llvm::object::ArchiveMemberHeader::getAccessMode(), llvm::object::ArchiveMemberHeader::getGID(), llvm::object::ArchiveMemberHeader::getLastModified(), llvm::object::ArchiveMemberHeader::getName(), llvm::object::ArchiveMemberHeader::getSize(), llvm::object::ArchiveMemberHeader::getUID(), llvm::MCExternalSymbolizer::tryAddingPcLoadReferenceComment(), and llvm::AArch64ExternalSymbolizer::tryAddingSymbolicOperand().
| raw_ostream & raw_ostream::write_hex | ( | unsigned long long | N | ) |
Output N in hexadecimal, without any prefix or padding.
Definition at line 137 of file raw_ostream.cpp.
References llvm::Lower, and llvm::write_hex().
Referenced by dumpDataAux(), llvm::DIEInteger::print(), llvm::AArch64InstPrinter::printAlignedLabel(), printHex32(), llvm::AArch64InstPrinter::printLogicalImm32(), llvm::AArch64InstPrinter::printLogicalImm64(), llvm::ARMInstPrinter::printNEONModImmOperand(), llvm::ARMInstPrinter::printOperand(), and llvm::HexagonShuffler::shuffle().
1.8.6