X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FSupport%2Fraw_ostream.h;h=8242f04e23ce4670fa2e3d8005b3c8c284adeff5;hb=3fb7683bec8c8edb24e80c95f3b0668c6ecc0ae6;hp=16945200846e03779ba57893c7d7014852b1761a;hpb=071acf4279abb72e0accc6b76212ec8959c6b637;p=oota-llvm.git diff --git a/include/llvm/Support/raw_ostream.h b/include/llvm/Support/raw_ostream.h index 16945200846..8242f04e23c 100644 --- a/include/llvm/Support/raw_ostream.h +++ b/include/llvm/Support/raw_ostream.h @@ -1,4 +1,4 @@ -//===--- raw_ostream.h - Raw output stream --------------------------------===// +//===--- raw_ostream.h - Raw output stream ----------------------*- C++ -*-===// // // The LLVM Compiler Infrastructure // @@ -14,163 +14,268 @@ #ifndef LLVM_SUPPORT_RAW_OSTREAM_H #define LLVM_SUPPORT_RAW_OSTREAM_H +#include "llvm/ADT/StringExtras.h" #include #include #include #include namespace llvm { + class format_object_base; + template + class SmallVectorImpl; /// raw_ostream - 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. class raw_ostream { -protected: +private: + /// The buffer is handled in such a way that the buffer is + /// uninitialized, unbuffered, or out of space when OutBufCur >= + /// OutBufEnd. Thus a single comparison suffices to determine if we + /// need to take the slow path to write a single character. + /// + /// The buffer is in one of three states: + /// 1. Unbuffered (Unbuffered == true) + /// 1. Uninitialized (Unbuffered == false && OutBufStart == 0). + /// 2. Buffered (Unbuffered == false && OutBufStart != 0 && + /// OutBufEnd - OutBufStart >= 64). char *OutBufStart, *OutBufEnd, *OutBufCur; + bool Unbuffered; + public: - raw_ostream() { + // color order matches ANSI escape sequence, don't change + enum Colors { + BLACK=0, + RED, + GREEN, + YELLOW, + BLUE, + MAGENTA, + CYAN, + WHITE, + SAVEDCOLOR + }; + + explicit raw_ostream(bool unbuffered=false) : Unbuffered(unbuffered) { // Start out ready to flush. OutBufStart = OutBufEnd = OutBufCur = 0; } - virtual ~raw_ostream() {} - + + virtual ~raw_ostream() { + delete [] OutBufStart; + } + + /// tell - Return the current offset with the file. + uint64_t tell() { return current_pos() + GetNumBytesInBuffer(); } + //===--------------------------------------------------------------------===// // Configuration Interface //===--------------------------------------------------------------------===// - + /// SetBufferSize - Set the internal buffer size to the specified amount /// instead of the default. - void SetBufferSize(unsigned Size) { + void SetBufferSize(unsigned Size=4096) { assert(Size >= 64 && "Buffer size must be somewhat large for invariants to hold"); flush(); - + delete [] OutBufStart; OutBufStart = new char[Size]; OutBufEnd = OutBufStart+Size; OutBufCur = OutBufStart; + Unbuffered = false; } - + + /// SetUnbuffered - Set the streams buffering status. 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. + void SetUnbuffered() { + flush(); + + delete [] OutBufStart; + OutBufStart = OutBufEnd = OutBufCur = 0; + Unbuffered = true; + } + + unsigned GetNumBytesInBuffer() const { + return OutBufCur - OutBufStart; + } + //===--------------------------------------------------------------------===// // Data Output Interface //===--------------------------------------------------------------------===// - + void flush() { if (OutBufCur != OutBufStart) - flush_impl(); + flush_nonempty(); } - + raw_ostream &operator<<(char C) { if (OutBufCur >= OutBufEnd) - flush_impl(); + return write(C); *OutBufCur++ = C; return *this; } - - raw_ostream &operator<<(const char *Str) { - return write(Str, strlen(Str)); + + raw_ostream &operator<<(unsigned char C) { + if (OutBufCur >= OutBufEnd) + return write(C); + *OutBufCur++ = C; + return *this; } - - raw_ostream &operator<<(unsigned N) { - // Zero is a special case. - if (N == 0) - return *this << '0'; - - char NumberBuffer[20]; - char *EndPtr = NumberBuffer+sizeof(NumberBuffer); - char *CurPtr = EndPtr; - - while (N) { - *--CurPtr = '0' + char(N % 10); - N /= 10; - } - return write(CurPtr, EndPtr-CurPtr); + + raw_ostream &operator<<(signed char C) { + if (OutBufCur >= OutBufEnd) + return write(C); + *OutBufCur++ = C; + return *this; } - - - raw_ostream &write(const char *Ptr, unsigned Size) { + + raw_ostream &operator<<(const char *Str) { + // Inline fast path, particulary for constant strings where a + // sufficiently smart compiler will simplify strlen. + + unsigned Size = strlen(Str); + + // Make sure we can use the fast path. if (OutBufCur+Size > OutBufEnd) - flush_impl(); - - // Handle short strings specially, memcpy isn't very good at very short - // strings. - switch (Size) { - case 4: OutBufCur[3] = Ptr[3]; // FALL THROUGH - case 3: OutBufCur[2] = Ptr[2]; // FALL THROUGH - case 2: OutBufCur[1] = Ptr[1]; // FALL THROUGH - case 1: OutBufCur[0] = Ptr[0]; // FALL THROUGH - case 0: break; - default: - // Normally the string to emit is shorter than the buffer. - if (Size <= unsigned(OutBufEnd-OutBufStart)) { - memcpy(OutBufCur, Ptr, Size); - break; - } - - // If emitting a string larger than our buffer, emit in chunks. In this - // case we know that we just flushed the buffer. - while (Size) { - unsigned NumToEmit = OutBufEnd-OutBufStart; - if (Size < NumToEmit) NumToEmit = Size; - assert(OutBufCur == OutBufStart); - memcpy(OutBufStart, Ptr, NumToEmit); - Ptr += NumToEmit; - OutBufCur = OutBufStart + NumToEmit; - flush_impl(); - } - break; - } + return write(Str, Size); + + memcpy(OutBufCur, Str, Size); OutBufCur += Size; return *this; } - + + raw_ostream &operator<<(const std::string& Str) { + write(Str.data(), Str.length()); + return *this; + } + + 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) { + this->operator<<(static_cast(N)); + return *this; + } + + raw_ostream &operator<<(int N) { + this->operator<<(static_cast(N)); + return *this; + } + + raw_ostream &operator<<(double N) { + this->operator<<(ftostr(N)); + return *this; + } + + raw_ostream &write(unsigned char C); + raw_ostream &write(const char *Ptr, unsigned Size); + + // Formatted output, see the format() function in Support/Format.h. + raw_ostream &operator<<(const format_object_base &Fmt); + + /// Changes the foreground color of text that will be output from this point + /// forward. + /// @param colors ANSI color to use, the special SAVEDCOLOR can be used to + /// change only the bold attribute, and keep colors untouched + /// @param bold bold/brighter text, default false + /// @param bg if true change the background, default: change foreground + /// @returns itself so it can be used within << invocations + virtual raw_ostream &changeColor(enum Colors colors, bool bold=false, + bool bg=false) { return *this; } + + /// Resets the colors to terminal defaults. Call this when you are done + /// outputting colored text, or before program exit. + virtual raw_ostream &resetColor() { return *this; } + //===--------------------------------------------------------------------===// // Subclass Interface //===--------------------------------------------------------------------===// -protected: - - /// flush_impl - The is the piece of the class that is implemented by - /// subclasses. This outputs the currently buffered data and resets the - /// buffer to empty. - virtual void flush_impl() = 0; - - /// HandleFlush - A stream's implementation of flush should call this after - /// emitting the bytes to the data sink. - void HandleFlush() { - if (OutBufStart == 0) - SetBufferSize(4096); - OutBufCur = OutBufStart; - } private: + /// write_impl - The is the piece of the class that is implemented + /// by subclasses. This writes the \args Size bytes starting at + /// \arg Ptr to the underlying stream. + /// + /// \invariant { Size > 0 } + virtual void write_impl(const char *Ptr, unsigned Size) = 0; + // An out of line virtual method to provide a home for the class vtable. virtual void handle(); + + /// current_pos - Return the current position within the stream, not + /// counting the bytes currently in the buffer. + virtual uint64_t current_pos() = 0; + + //===--------------------------------------------------------------------===// + // Private Interface + //===--------------------------------------------------------------------===// +private: + /// flush_nonempty - Flush the current buffer, which is known to be + /// non-empty. This outputs the currently buffered data and resets + /// the buffer to empty. + void flush_nonempty(); }; - + +//===----------------------------------------------------------------------===// +// File Output Streams +//===----------------------------------------------------------------------===// + /// raw_fd_ostream - A raw_ostream that writes to a file descriptor. /// class raw_fd_ostream : public raw_ostream { int FD; bool ShouldClose; + uint64_t pos; + + /// write_impl - See raw_ostream::write_impl. + virtual void write_impl(const char *Ptr, unsigned Size); + + /// current_pos - Return the current position within the stream, not + /// counting the bytes currently in the buffer. + virtual uint64_t current_pos() { return pos; } + public: - /// raw_fd_ostream - Open the specified file for writing. If an error occurs, - /// information about the error is put into ErrorInfo, and the stream should - /// be immediately destroyed. - raw_fd_ostream(const char *Filename, std::string &ErrorInfo); - + /// raw_fd_ostream - Open the specified file for writing. If an + /// error occurs, information about the error is put into ErrorInfo, + /// and the stream should be immediately destroyed; the string will + /// be empty if no error occurred. + /// + /// \param Filename - The file to open. If this is "-" then the + /// stream will use stdout instead. + /// \param Binary - The file should be opened in binary mode on + /// platforms that support this distinction. + raw_fd_ostream(const char *Filename, bool Binary, std::string &ErrorInfo); + /// raw_fd_ostream ctor - FD is the file descriptor that this writes to. If - /// ShouldClose is true, this closes the file when - raw_fd_ostream(int fd, bool shouldClose) : FD(fd), ShouldClose(shouldClose) {} + /// ShouldClose is true, this closes the file when the stream is destroyed. + raw_fd_ostream(int fd, bool shouldClose, + bool unbuffered=false) : raw_ostream(unbuffered), FD(fd), + ShouldClose(shouldClose) {} ~raw_fd_ostream(); - - /// flush_impl - The is the piece of the class that is implemented by - /// subclasses. This outputs the currently buffered data and resets the - /// buffer to empty. - virtual void flush_impl(); + + /// close - Manually flush the stream and close the file. + void close(); + + /// tell - Return the current offset with the file. + uint64_t tell() { return pos + GetNumBytesInBuffer(); } + + /// seek - Flushes the stream and repositions the underlying file descriptor + /// positition to the offset specified from the beginning of the file. + uint64_t seek(uint64_t off); + + virtual raw_ostream &changeColor(enum Colors colors, bool bold=false, + bool bg=false); + virtual raw_ostream &resetColor(); }; - + /// raw_stdout_ostream - This is a stream that always prints to stdout. /// class raw_stdout_ostream : public raw_fd_ostream { @@ -188,7 +293,7 @@ class raw_stderr_ostream : public raw_fd_ostream { public: raw_stderr_ostream(); }; - + /// outs() - This returns a reference to a raw_ostream for standard output. /// Use it like: outs() << "foo" << "bar"; raw_ostream &outs(); @@ -196,21 +301,77 @@ raw_ostream &outs(); /// errs() - This returns a reference to a raw_ostream for standard error. /// Use it like: errs() << "foo" << "bar"; raw_ostream &errs(); - - + + +//===----------------------------------------------------------------------===// +// Output Stream Adaptors +//===----------------------------------------------------------------------===// + /// raw_os_ostream - A raw_ostream that writes to an std::ostream. This is a /// simple adaptor class. class raw_os_ostream : public raw_ostream { std::ostream &OS; + + /// write_impl - See raw_ostream::write_impl. + virtual void write_impl(const char *Ptr, unsigned Size); + + /// current_pos - Return the current position within the stream, not + /// counting the bytes currently in the buffer. + virtual uint64_t current_pos(); + public: raw_os_ostream(std::ostream &O) : OS(O) {} - - /// flush_impl - The is the piece of the class that is implemented by - /// subclasses. This outputs the currently buffered data and resets the - /// buffer to empty. - virtual void flush_impl(); + ~raw_os_ostream(); + + /// tell - Return the current offset with the stream. + uint64_t tell(); }; - + +/// raw_string_ostream - A raw_ostream that writes to an std::string. This is a +/// simple adaptor class. +class raw_string_ostream : public raw_ostream { + std::string &OS; + + /// write_impl - See raw_ostream::write_impl. + virtual void write_impl(const char *Ptr, unsigned Size); + + /// current_pos - Return the current position within the stream, not + /// counting the bytes currently in the buffer. + virtual uint64_t current_pos() { return OS.size(); } +public: + raw_string_ostream(std::string &O) : OS(O) {} + ~raw_string_ostream(); + + /// tell - Return the current offset with the stream. + uint64_t tell() { return OS.size() + GetNumBytesInBuffer(); } + + /// str - Flushes the stream contents to the target string and returns + /// the string's reference. + std::string& str() { + flush(); + return OS; + } +}; + +/// raw_svector_ostream - A raw_ostream that writes to an SmallVector or +/// SmallString. This is a simple adaptor class. +class raw_svector_ostream : public raw_ostream { + SmallVectorImpl &OS; + + /// write_impl - See raw_ostream::write_impl. + virtual void write_impl(const char *Ptr, unsigned Size); + + /// current_pos - Return the current position within the stream, not + /// counting the bytes currently in the buffer. + virtual uint64_t current_pos(); +public: + raw_svector_ostream(SmallVectorImpl &O) : OS(O) {} + ~raw_svector_ostream(); + + /// tell - Return the current offset with the stream. + uint64_t tell(); +}; + } // end llvm namespace #endif