Added "DOUT" macro. This is used as a replacement for the std::cerr

stream. It centralizes the use of std::cerr so that static c'tor/d'tors
aren't scattered around all over the place. The way to use it is like this:

       DOUT << "This is a status line: " << Var << "\n";

If "-debug" is specified, it will print. Otherwise, it'll not print. If
NDEBUG is defined, the DOUT does nothing.

llvm-svn: 31798

2 files changed, 42 insertions, 0 deletions

diff --git a/llvm/include/llvm/Support/Debug.h b/llvm/include/llvm/Support/Debug.h
index 472364ba2fa..f14da843d76 100644
--- a/llvm/include/llvm/Support/Debug.h
+++ b/llvm/include/llvm/Support/Debug.h
@@ -26,6 +26,8 @@
 #ifndef LLVM_SUPPORT_DEBUG_H
 #define LLVM_SUPPORT_DEBUG_H
 
+#include <ostream>              // Doesn't have static d'tors!!
+
 namespace llvm {
 
 // DebugFlag - This boolean is set to true if the '-debug' command line option
@@ -59,6 +61,34 @@ bool isCurrentDebugType(const char *Type);
   do { if (DebugFlag && isCurrentDebugType(DEBUG_TYPE)) { X; } } while (0)
 #endif
 
+// llvm_ostream - Acts like an ostream. However, it doesn't print things out if
+// an ostream isn't specified.
+// 
+class llvm_ostream {
+  std::ostream* Stream;
+public:
+  llvm_ostream() : Stream(0) {}
+  llvm_ostream(std::ostream& OStream) : Stream(&OStream) {}
+
+  template <typename Ty>
+  llvm_ostream& operator << (const Ty& Thing) {
+    if (Stream) *Stream << Thing;
+    return *this;
+  }
+};
+
+// getErrorOutputStream - Returns the error output stream (std::cerr). This
+// places the std::c* I/O streams into one .cpp file and relieves the whole
+// program from having to have hundreds of static c'tor/d'tors for them.
+// 
+llvm_ostream getErrorOutputStream(const char *DebugType);
+
+#ifdef NDEBUG
+#define DOUT llvm_ostream()
+#else
+#define DOUT getErrorOutputStream(DEBUG_TYPE)
+#endif
+
 } // End llvm namespace
 
 #endif
diff --git a/llvm/lib/Support/Debug.cpp b/llvm/lib/Support/Debug.cpp
index 394d9c11094..cbf12c7c0d7 100644
--- a/llvm/lib/Support/Debug.cpp
+++ b/llvm/lib/Support/Debug.cpp
@@ -25,6 +25,7 @@
 
 #include "llvm/Support/Debug.h"
 #include "llvm/Support/CommandLine.h"
+#include <iostream>
 using namespace llvm;
 
 bool llvm::DebugFlag;  // DebugFlag - Exported boolean set by the -debug option
@@ -63,3 +64,14 @@ bool llvm::isCurrentDebugType(const char *DebugType) {
   return false;
 #endif
 }
+
+// getErrorOutputStream - Returns the error output stream (std::cerr). This
+// places the std::c* I/O streams into one .cpp file and relieves the whole
+// program from having to have hundreds of static c'tor/d'tors for them.
+// 
+llvm_ostream llvm::getErrorOutputStream(const char *DebugType) {
+  if (DebugFlag && isCurrentDebugType(DebugType))
+    return llvm_ostream(std::cerr);
+  else
+    return llvm_ostream();
+}