Try to explain better what SwapCode means

[gdcm.git] / src / gdcmDebug.h

diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h
index 1b193986ec33b2fd65ab31b53643a85ee474b24e..7ad5767d34a2a8887fa45835dafcef10e3a98657 100644 (file)
--- a/src/gdcmDebug.h
+++ b/src/gdcmDebug.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDebug.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/07 16:26:12 $
-  Version:   $Revision: 1.11 $
+  Date:      $Date: 2005/01/11 17:54:10 $
+  Version:   $Revision: 1.19 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -21,6 +21,9 @@
 
 #include "gdcmCommon.h"
 
+#include <sstream>
+#include <assert.h>
+
 namespace gdcm 
 {
 //-----------------------------------------------------------------------------
@@ -29,31 +32,115 @@ namespace gdcm
  * \ingroup Debug
  * \brief Debug is an object for debugging in program.
  * It has 2 debugging modes :
- *  - error : for bad library use
- *  - debug : for debugging messages
+ *  - error : for bad library use, seriously wrong DICOM
+ *  - debug : for information/debug messages
+ *  - warning : for warning about DICOM quality (kosher)
  * 
- * A debugging message has a level of priority and is 
- * Shown only when the debug level is higher than the 
- * message level.
+ * A debugging message is only show if the flag is on (DebugFlag)
+ * This is static var and can be set at begining of code:
+ *         gdcm::Debug::SetDebugOn();
  */
 class GDCM_EXPORT Debug
 {
 public:
-   Debug(int level = -1);
-
    /// This is a global flag that controls whether any debug, warning
    /// messages are displayed.
-   static void SetDebugLevel (int level);
-   static int  GetDebugLevel ();
-
-   static void Verbose(int level, const char *msg1, const char *msg2 = "") ;
-   static void Error  (bool test, const char *msg1, const char *msg2 = "");
-   static void Error  (const char *msg1, const char *msg2 = "", const char *msg3 = "");
-
-   static void Assert(int level, bool test, const char *msg1, const char *msg2);
-   static void Exit  (int a);
+   static int  GetDebugFlag ();
+   static void SetDebugFlag (int flag);
+   static void SetDebugOn  () { SetDebugFlag(1); };
+   static void SetDebugOff () { SetDebugFlag(0); };
 };
 
 } // end namespace gdcm
 
+// Here we define function this is the only way to be able to pass
+// stuff with indirection like:
+// gdcmDebug( "my message:" << i << '\t' ); 
+// You cannot use function unless you use vnsprintf ...
+
+// __FUNCTION is not always defined by preprocessor
+// In c++ we should use __PRETTY_FUNCTION__ instead...
+#ifdef GDCM_COMPILER_HAS_FUNCTION
+// Handle particular case for GNU C++ which also defines __PRETTY_FUNCTION__
+// which is a lot nice in C++
+#ifdef __BORLANDC__
+#  define __FUNCTION__ __FUNC__
+#endif
+#ifdef __GNUC__
+#  define GDCM_FUNCTION __PRETTY_FUNCTION__
+#else
+#  define GDCM_FUNCTION __FUNCTION__ 
+#endif //__GNUC__
+#else
+#  define GDCM_FUNCTION "<unknow>"
+#endif //GDCM_COMPILER_HAS_FUNCTION
+
+/**
+ * \brief   Debug
+ * @param msg message part
+ */
+#define gdcmDebugMacro(msg)                                \
+{                                                          \
+   if( gdcm::Debug::GetDebugFlag() )                       \
+   {                                                       \
+   std::ostringstream osmacro;                             \
+   osmacro << "Debug: In " __FILE__ ", line " << __LINE__  \
+           << ", function " << GDCM_FUNCTION << '\n'       \
+           << msg << "\n\n";                               \
+   std::cerr << osmacro.str() << std::endl;                \
+   }                                                       \
+}
+
+/**
+ * \brief   Verbose 
+ * @param msg message part
+ */
+#define gdcmVerboseMacro(msg)                               \
+{                                                           \
+   if( gdcm::Debug::GetDebugFlag() )                        \
+   {                                                        \
+   std::ostringstream osmacro;                              \
+   osmacro << "Verbose: In " __FILE__ ", line " << __LINE__ \
+           << ", function " << GDCM_FUNCTION << "\n"        \
+           << msg << "\n\n";                                \
+   std::cerr << osmacro.str() << std::endl;                 \
+   }                                                        \
+}
+
+/**
+ * \brief   Error 
+ * @param msg second message part 
+ */
+#define gdcmErrorMacro(msg)                               \
+{                                                         \
+   if( gdcm::Debug::GetDebugFlag() )                      \
+   {                                                      \
+   std::ostringstream osmacro;                            \
+   osmacro << "Error: In " __FILE__ ", line " << __LINE__ \
+           << ", function " << GDCM_FUNCTION << '\n'      \
+           << msg << "\n\n";                              \
+   std::cerr << osmacro.str() << std::endl;               \
+   exit(1);                                               \
+   }                                                      \
+}
+
+/**
+ * \brief   Assert 
+ * @param arg argument to test
+ *        An easy solution to pass also a message is to do:
+ *        gdcmAssertMacro( "my message" && 2 < 3 )
+ */
+#define gdcmAssertMacro(arg)                               \
+{                                                          \
+   if( !(arg) )                                              \
+   {                                                       \
+   std::ostringstream osmacro;                             \
+   osmacro << "Assert: In " __FILE__ ", line " << __LINE__ \
+           << ", function " << GDCM_FUNCTION               \
+           << "\n\n";                                      \
+   std::cerr << osmacro.str() << std::endl;                \
+   assert ( arg );                                         \
+   }                                                       \
+}
+
 #endif