Normalize SourceMgr messages.
[oota-llvm.git] / include / llvm / Support / raw_ostream.h
index aa6a8b9f9fea20355710cbbc32814a075faa0d40..8242f04e23ce4670fa2e3d8005b3c8c284adeff5 100644 (file)
@@ -31,14 +31,33 @@ namespace llvm {
 /// a chunk at a time.
 class raw_ostream {
 private:
-  /// \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. }
-
+  /// 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;
@@ -48,13 +67,16 @@ public:
     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();
@@ -63,16 +85,19 @@ public:
     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 {
@@ -92,8 +117,6 @@ public:
     if (OutBufCur >= OutBufEnd)
       return write(C);
     *OutBufCur++ = C;
-    if (Unbuffered)
-      flush_nonempty();
     return *this;
   }
 
@@ -101,8 +124,6 @@ public:
     if (OutBufCur >= OutBufEnd)
       return write(C);
     *OutBufCur++ = C;
-    if (Unbuffered)
-      flush_nonempty();
     return *this;
   }
 
@@ -110,17 +131,27 @@ public:
     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);
@@ -129,15 +160,18 @@ public:
   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);
@@ -146,6 +180,20 @@ public:
   // 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
   //===--------------------------------------------------------------------===//
@@ -161,6 +209,10 @@ private:
   // 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
   //===--------------------------------------------------------------------===//
@@ -184,6 +236,11 @@ class raw_fd_ostream : public raw_ostream {
 
   /// 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,
@@ -213,6 +270,10 @@ public:
   /// 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.
@@ -253,9 +314,17 @@ class raw_os_ostream : public raw_ostream {
 
   /// 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();
+
+  /// 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
@@ -265,10 +334,17 @@ class raw_string_ostream : public raw_ostream {
 
   /// 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() {
@@ -284,9 +360,16 @@ class raw_svector_ostream : public raw_ostream {
 
   /// 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();
+
+  /// tell - Return the current offset with the stream.
+  uint64_t tell();
 };
 
 } // end llvm namespace