Fix a bunch of -Wdocumentation warnings.

[oota-llvm.git] / include / llvm / Support / FormattedStream.h

diff --git a/include/llvm/Support/FormattedStream.h b/include/llvm/Support/FormattedStream.h
index 11a0e18db4ce68ef1aac3e88696cd62d485ce095..58a18851687ca2b7732f43af1d68b0ef0b4af11f 100644 (file)
--- a/include/llvm/Support/FormattedStream.h
+++ b/include/llvm/Support/FormattedStream.h
@@ -1,4 +1,4 @@
-//===-- llvm/CodeGen/FormattedStream.h - Formatted streams ------*- C++ -*-===//
+//===-- llvm/Support/FormattedStream.h - Formatted streams ------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
@@ -26,17 +26,12 @@ namespace llvm
   public:
     /// DELETE_STREAM - Tell the destructor to delete the held stream.
     ///
-    const static bool DELETE_STREAM = true;
+    static const bool DELETE_STREAM = true;
 
     /// PRESERVE_STREAM - Tell the destructor to not delete the held
     /// stream.
     ///
-    const static bool PRESERVE_STREAM = false;
-
-    /// MAX_COLUMN_PAD - This is the maximum column padding we ever
-    /// expect to see.
-    ///
-    const static unsigned MAX_COLUMN_PAD = 100;
+    static const bool PRESERVE_STREAM = false;
 
   private:
     /// TheStream - The real stream we output to. We set it to be
@@ -58,26 +53,22 @@ namespace llvm
     /// Scanned - This points to one past the last character in the
     /// buffer we've scanned.
     ///
-    iterator Scanned;
+    const char *Scanned;
 
-    virtual void write_impl(const char *Ptr, size_t Size) {
-      ComputeColumn();
-      TheStream->write(Ptr, Size);
-      Scanned = begin();
-    }
+    virtual void write_impl(const char *Ptr, size_t Size);
 
     /// current_pos - Return the current position within the stream,
     /// not counting the bytes currently in the buffer.
-    virtual uint64_t current_pos() { 
+    virtual uint64_t current_pos() const { 
       // This has the same effect as calling TheStream.current_pos(),
       // but that interface is private.
       return TheStream->tell() - TheStream->GetNumBytesInBuffer();
     }
 
-    /// ComputeColumn - Examine the current output and figure out
-    /// which column we end up in after output.
+    /// ComputeColumn - Examine the given output buffer and figure out which
+    /// column we end up in after output.
     ///
-    void ComputeColumn();
+    void ComputeColumn(const char *Ptr, size_t size);
 
   public:
     /// formatted_raw_ostream - Open the specified file for
@@ -96,18 +87,16 @@ namespace llvm
     }
     explicit formatted_raw_ostream()
       : raw_ostream(), TheStream(0), DeleteStream(false), ColumnScanned(0) {
-      Scanned = begin();
+      Scanned = 0;
     }
 
     ~formatted_raw_ostream() {
       flush();
-      if (DeleteStream)
-        delete TheStream;
+      releaseStream();
     }
-    
+
     void setStream(raw_ostream &Stream, bool Delete = false) {
-      if (DeleteStream)
-        delete TheStream;
+      releaseStream();
 
       TheStream = &Stream;
       DeleteStream = Delete;
@@ -118,18 +107,33 @@ namespace llvm
       // had been using, and tell TheStream not to do its own buffering.
       if (size_t BufferSize = TheStream->GetBufferSize())
         SetBufferSize(BufferSize);
+      else
+        SetUnbuffered();
       TheStream->SetUnbuffered();
 
-      Scanned = begin();
+      Scanned = 0;
     }
 
-    /// PadToColumn - Align the output to some column number.
+    /// 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.
-    /// \param MinPad - The minimum space to give after the most
-    /// recent I/O, even if the current column + minpad > newcol.
-    ///
-    void PadToColumn(unsigned NewCol, unsigned MinPad = 0);
+    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
@@ -140,6 +144,10 @@ formatted_raw_ostream &fouts();
 /// standard error.  Use it like: ferrs() << "foo" << "bar";
 formatted_raw_ostream &ferrs();
 
+/// fdbgs() - This returns a reference to a formatted_raw_ostream for
+/// debug output.  Use it like: fdbgs() << "foo" << "bar";
+formatted_raw_ostream &fdbgs();
+
 } // end llvm namespace