unindent the file to follow coding standards, change class doc comment

to be correct.  No functionality or behavior change.



git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@178511 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Chris Lattner 2013-04-01 23:00:01 +00:00
parent 8d9594fe92
commit 080e3c523e

View File

@ -17,125 +17,125 @@
#include "llvm/Support/raw_ostream.h" #include "llvm/Support/raw_ostream.h"
namespace llvm namespace llvm {
{
/// formatted_raw_ostream - Formatted raw_fd_ostream to handle /// formatted_raw_ostream - A raw_ostream that wraps another one and keeps track
/// asm-specific constructs. /// of column position, allowing padding out to specific column boundaries.
///
class formatted_raw_ostream : public raw_ostream {
public:
/// DELETE_STREAM - Tell the destructor to delete the held stream.
/// ///
class formatted_raw_ostream : public raw_ostream { static const bool DELETE_STREAM = true;
public:
/// DELETE_STREAM - Tell the destructor to delete the held stream.
///
static const bool DELETE_STREAM = true;
/// PRESERVE_STREAM - Tell the destructor to not delete the held /// PRESERVE_STREAM - Tell the destructor to not delete the held
/// stream. /// stream.
/// ///
static const bool PRESERVE_STREAM = false; static const bool PRESERVE_STREAM = false;
private: private:
/// TheStream - The real stream we output to. We set it to be /// TheStream - The real stream we output to. We set it to be
/// unbuffered, since we're already doing our own buffering. /// unbuffered, since we're already doing our own buffering.
/// ///
raw_ostream *TheStream; raw_ostream *TheStream;
/// DeleteStream - Do we need to delete TheStream in the /// DeleteStream - Do we need to delete TheStream in the
/// destructor? /// destructor?
/// ///
bool DeleteStream; bool DeleteStream;
/// ColumnScanned - The current output column of the data that's /// ColumnScanned - The current output column of the data that's
/// been flushed and the portion of the buffer that's been /// been flushed and the portion of the buffer that's been
/// scanned. The column scheme is zero-based. /// scanned. The column scheme is zero-based.
/// ///
unsigned ColumnScanned; unsigned ColumnScanned;
/// Scanned - This points to one past the last character in the /// Scanned - This points to one past the last character in the
/// buffer we've scanned. /// buffer we've scanned.
/// ///
const char *Scanned; const char *Scanned;
virtual void write_impl(const char *Ptr, size_t Size) LLVM_OVERRIDE; virtual void write_impl(const char *Ptr, size_t Size) LLVM_OVERRIDE;
/// current_pos - Return the current position within the stream, /// current_pos - Return the current position within the stream,
/// not counting the bytes currently in the buffer. /// not counting the bytes currently in the buffer.
virtual uint64_t current_pos() const LLVM_OVERRIDE { virtual uint64_t current_pos() const LLVM_OVERRIDE {
// Our current position in the stream is all the contents which have been // Our current position in the stream is all the contents which have been
// written to the underlying stream (*not* the current position of the // written to the underlying stream (*not* the current position of the
// underlying stream). // underlying stream).
return TheStream->tell(); return TheStream->tell();
} }
/// ComputeColumn - Examine the given output buffer and figure out which /// ComputeColumn - Examine the given output buffer and figure out which
/// column we end up in after output. /// column we end up in after output.
/// ///
void ComputeColumn(const char *Ptr, size_t size); void ComputeColumn(const char *Ptr, size_t size);
public: public:
/// formatted_raw_ostream - Open the specified file for /// formatted_raw_ostream - Open the specified file for
/// writing. If an error occurs, information about the error is /// writing. If an error occurs, information about the error is
/// put into ErrorInfo, and the stream should be immediately /// put into ErrorInfo, and the stream should be immediately
/// destroyed; the string will be empty if no error occurred. /// destroyed; the string will be empty if no error occurred.
/// ///
/// As a side effect, the given Stream is set to be Unbuffered. /// As a side effect, the given Stream is set to be Unbuffered.
/// This is because formatted_raw_ostream does its own buffering, /// This is because formatted_raw_ostream does its own buffering,
/// so it doesn't want another layer of buffering to be happening /// so it doesn't want another layer of buffering to be happening
/// underneath it. /// underneath it.
/// ///
formatted_raw_ostream(raw_ostream &Stream, bool Delete = false) formatted_raw_ostream(raw_ostream &Stream, bool Delete = false)
: raw_ostream(), TheStream(0), DeleteStream(false), ColumnScanned(0) { : raw_ostream(), TheStream(0), DeleteStream(false), ColumnScanned(0) {
setStream(Stream, Delete); setStream(Stream, Delete);
} }
explicit formatted_raw_ostream() explicit formatted_raw_ostream()
: raw_ostream(), TheStream(0), DeleteStream(false), ColumnScanned(0) { : raw_ostream(), TheStream(0), DeleteStream(false), ColumnScanned(0) {
Scanned = 0; Scanned = 0;
} }
~formatted_raw_ostream() { ~formatted_raw_ostream() {
flush(); flush();
releaseStream(); releaseStream();
} }
void setStream(raw_ostream &Stream, bool Delete = false) { void setStream(raw_ostream &Stream, bool Delete = false) {
releaseStream(); releaseStream();
TheStream = &Stream; TheStream = &Stream;
DeleteStream = Delete; DeleteStream = Delete;
// This formatted_raw_ostream inherits from raw_ostream, so it'll do its // This formatted_raw_ostream inherits from raw_ostream, so it'll do its
// own buffering, and it doesn't need or want TheStream to do another // own buffering, and it doesn't need or want TheStream to do another
// layer of buffering underneath. Resize the buffer to what TheStream // layer of buffering underneath. Resize the buffer to what TheStream
// had been using, and tell TheStream not to do its own buffering. // had been using, and tell TheStream not to do its own buffering.
if (size_t BufferSize = TheStream->GetBufferSize()) if (size_t BufferSize = TheStream->GetBufferSize())
SetBufferSize(BufferSize); SetBufferSize(BufferSize);
else else
SetUnbuffered(); SetUnbuffered();
TheStream->SetUnbuffered();
Scanned = 0;
}
/// PadToColumn - Align the output to some column number. If the current
/// column is already equal to or more than NewCol, PadToColumn inserts one
/// space.
///
/// \param NewCol - The column to move to.
formatted_raw_ostream &PadToColumn(unsigned NewCol);
private:
void releaseStream() {
// Delete the stream if needed. Otherwise, transfer the buffer
// settings from this raw_ostream back to the underlying stream.
if (!TheStream)
return;
if (DeleteStream)
delete TheStream;
else if (size_t BufferSize = GetBufferSize())
TheStream->SetBufferSize(BufferSize);
else
TheStream->SetUnbuffered(); TheStream->SetUnbuffered();
}
Scanned = 0; };
}
/// PadToColumn - Align the output to some column number. If the current
/// column is already equal to or more than NewCol, PadToColumn inserts one
/// space.
///
/// \param NewCol - The column to move to.
formatted_raw_ostream &PadToColumn(unsigned NewCol);
private:
void releaseStream() {
// Delete the stream if needed. Otherwise, transfer the buffer
// settings from this raw_ostream back to the underlying stream.
if (!TheStream)
return;
if (DeleteStream)
delete TheStream;
else if (size_t BufferSize = GetBufferSize())
TheStream->SetBufferSize(BufferSize);
else
TheStream->SetUnbuffered();
}
};
/// fouts() - This returns a reference to a formatted_raw_ostream for /// fouts() - This returns a reference to a formatted_raw_ostream for
/// standard output. Use it like: fouts() << "foo" << "bar"; /// standard output. Use it like: fouts() << "foo" << "bar";