/// rewinding, line buffered disciplines etc. It is a simple buffer that outputs
/// a chunk at a time.
class raw_ostream {
-protected:
- /// \invariant { The buffer is uninitialized (OutBufStart,
- /// OutBufEnd, and OutBufCur are non-zero), or none of them are zero
- /// and there are at least 64 total bytes in the buffer. }
-
+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:
+ // 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;
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();
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(bool unbuffered) {
- Unbuffered = unbuffered;
- if (Unbuffered)
- flush();
+ void SetUnbuffered() {
+ flush();
+
+ delete [] OutBufStart;
+ OutBufStart = OutBufEnd = OutBufCur = 0;
+ Unbuffered = true;
+ }
+
+ unsigned GetNumBytesInBuffer() const {
+ return OutBufCur - OutBufStart;
}
//===--------------------------------------------------------------------===//
if (OutBufCur >= OutBufEnd)
return write(C);
*OutBufCur++ = C;
- if (Unbuffered)
- flush_nonempty();
return *this;
}
if (OutBufCur >= OutBufEnd)
return write(C);
*OutBufCur++ = C;
- if (Unbuffered)
- flush_nonempty();
return *this;
}
if (OutBufCur >= OutBufEnd)
return write(C);
*OutBufCur++ = C;
- if (Unbuffered)
- flush_nonempty();
return *this;
}
raw_ostream &operator<<(const char *Str) {
- return write(Str, strlen(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)
+ return write(Str, Size);
+
+ memcpy(OutBufCur, Str, Size);
+ OutBufCur += Size;
+ return *this;
}
raw_ostream &operator<<(const std::string& Str) {
- return write(Str.data(), Str.length());
+ write(Str.data(), Str.length());
+ return *this;
}
raw_ostream &operator<<(unsigned long N);
raw_ostream &operator<<(long long N);
raw_ostream &operator<<(const void *P);
raw_ostream &operator<<(unsigned int N) {
- return this->operator<<(static_cast<unsigned long>(N));
+ this->operator<<(static_cast<unsigned long>(N));
+ return *this;
}
raw_ostream &operator<<(int N) {
- return this->operator<<(static_cast<long>(N));
+ this->operator<<(static_cast<long>(N));
+ return *this;
}
raw_ostream &operator<<(double N) {
- return this->operator<<(ftostr(N));
+ this->operator<<(ftostr(N));
+ return *this;
}
raw_ostream &write(unsigned char C);
// 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
//===--------------------------------------------------------------------===//
private:
- /// flush_impl - The is the piece of the class that is implemented by
- /// subclasses. This only outputs the currently buffered data.
- ///
- /// raw_ostream guarantees to only call this routine when there is
- /// buffered data, i.e. OutBufStart != OutBufCur.
- virtual void flush_impl() = 0;
+ /// 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
//===--------------------------------------------------------------------===//
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,
~raw_fd_ostream();
- /// flush_impl - The is the piece of the class that is implemented by
- /// subclasses. This only outputs the currently buffered data.
- ///
- /// raw_ostream guarantees to only call this routine when there is
- /// buffered data, i.e. OutBufStart != OutBufCur.
- 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 + (OutBufCur - OutBufStart);
- }
+ 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.
/// 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) {}
~raw_os_ostream();
- /// flush_impl - The is the piece of the class that is implemented by
- /// subclasses. This only outputs the currently buffered data.
- ///
- /// raw_ostream guarantees to only call this routine when there is
- /// buffered data, i.e. OutBufStart != OutBufCur.
- virtual void flush_impl();
+ /// 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;
}
-
- /// flush_impl - The is the piece of the class that is implemented by
- /// subclasses. This only outputs the currently buffered data.
- ///
- /// raw_ostream guarantees to only call this routine when there is
- /// buffered data, i.e. OutBufStart != OutBufCur.
- virtual void flush_impl();
};
/// 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<char> &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<char> &O) : OS(O) {}
~raw_svector_ostream();
- /// flush_impl - The is the piece of the class that is implemented by
- /// subclasses. This only outputs the currently buffered data.
- ///
- /// raw_ostream guarantees to only call this routine when there is
- /// buffered data, i.e. OutBufStart != OutBufCur.
- virtual void flush_impl();
+ /// tell - Return the current offset with the stream.
+ uint64_t tell();
};
} // end llvm namespace
projects / oota-llvm.git / blobdiff