]> Creatis software - gdcm.git/blobdiff - src/gdcmDebug.h
*** empty log message ***
[gdcm.git] / src / gdcmDebug.h
index 35c61e71112d710503969b988aabc71403a0d6cf..35e159506d636b4b451cb2ea85c14e0bfbf9dcaa 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDebug.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/13 22:30:11 $
-  Version:   $Revision: 1.22 $
+  Date:      $Date: 2005/02/11 20:14:55 $
+  Version:   $Revision: 1.33 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -31,7 +31,6 @@ namespace gdcm
 //-----------------------------------------------------------------------------
 
 /**
- * \ingroup Debug
  * \brief Debug is an object for debugging in program.
  * It has 2 debugging modes :
  *  - error : for bad library use, seriously wrong DICOM
@@ -39,33 +38,36 @@ namespace gdcm
  *  - warning : for warning about DICOM quality (kosher)
  * 
  * A debugging message is only show if the flag is on (DebugFlag)
- * This is static var and can be set at begining of code:
+ * This is static var and can be set at beginning of code:
  *         gdcm::Debug::SetDebugOn();
  */
 class GDCM_EXPORT Debug
 {
 public:
-   /// This is a global flag that controls whether any debug, warning
-   /// messages are displayed.
-   static bool GetDebugFlag ();
+   Debug();
+   ~Debug();
+
+   /// \brief This is a global flag that controls whether any debug, warning
+   ///        messages are displayed.
    static void SetDebugFlag (bool flag);
-   static void SetDebugOn  () { SetDebugFlag(true); };
-   static void SetDebugOff () { SetDebugFlag(false); };
+   static bool GetDebugFlag ();
+   /// \brief Sets the Debug Flag to true
+   static void DebugOn  () { SetDebugFlag(true);  };
+   /// \brief Sets the Debug Flag to false
+   static void DebugOff () { SetDebugFlag(false); };
 
-   /// This is a global flag that controls if debug are redirected
-   /// to a file or not
-   static bool GetDebugToFile ();
+   /// \brief This is a global flag that controls if debug are redirected
+   ///        to a file or not
    static void SetDebugToFile (bool flag);
-   static void SetDebugToFileOn  () { SetDebugToFile(true); };
-   static void SetDebugToFileOff () { SetDebugToFile(false); };
+   static bool GetDebugToFile ();
+   /// \brief Next debug messages will be sent in the debug file
+   static void DebugToFileOn  () { SetDebugToFile(true);  };
+   /// \brief Next debug messages will be sent in the standard output
+   static void DebugToFileOff () { SetDebugToFile(false); };
 
-   /// Set the filename the debug stream should be redirect to
-   /// Settting a filename also set DebugToFile to true
-   static void SetDebugFilename (std::string const& filename);
+   static void SetDebugFilename (std::string const &filename);
 
-   /// Internal use only. Allow us to retrieve the static from anywhere
-   /// in gdcm code
-   static std::ofstream & GetDebugFile ();
+   static std::ofstream &GetDebugFile ();
 };
 
 } // end namespace gdcm
@@ -96,6 +98,9 @@ public:
  * \brief   Debug
  * @param msg message part
  */
+#ifdef NDEBUG
+#define gdcmDebugMacro(msg)
+#else
 #define gdcmDebugMacro(msg)                                 \
 {                                                           \
    if( Debug::GetDebugFlag() )                              \
@@ -111,17 +116,21 @@ public:
       std::cerr << osmacro.str() << std::endl;              \
    }                                                        \
 }
+#endif //NDEBUG
 
 /**
- * \brief   Verbose 
+ * \brief   Warning
  * @param msg message part
  */
-#define gdcmVerboseMacro(msg)                               \
+#ifdef NDEBUG
+#define gdcmWarningMacro(msg)
+#else
+#define gdcmWarningMacro(msg)                               \
 {                                                           \
    if( Debug::GetDebugFlag() )                              \
    {                                                        \
    std::ostringstream osmacro;                              \
-   osmacro << "Verbose: In " __FILE__ ", line " << __LINE__ \
+   osmacro << "Warning: In " __FILE__ ", line " << __LINE__ \
            << ", function " << GDCM_FUNCTION << "\n"        \
            << msg << "\n\n";                                \
    if( Debug::GetDebugToFile() )                            \
@@ -130,15 +139,17 @@ public:
       std::cerr << osmacro.str() << std::endl;              \
    }                                                        \
 }
+#endif //NDEBUG
 
 /**
  * \brief   Error 
  * @param msg second message part 
  */
+#ifdef NDEBUG
+#define gdcmErrorMacro(msg)
+#else
 #define gdcmErrorMacro(msg)                                 \
 {                                                           \
-   if( Debug::GetDebugFlag() )                              \
-   {                                                        \
    std::ostringstream osmacro;                              \
    osmacro << "Error: In " __FILE__ ", line " << __LINE__   \
            << ", function " << GDCM_FUNCTION << '\n'        \
@@ -147,9 +158,8 @@ public:
       Debug::GetDebugFile() << osmacro.str() << std::endl;  \
    else                                                     \
       std::cerr << osmacro.str() << std::endl;              \
-   exit(1);                                                 \
-   }                                                        \
 }
+#endif //NDEBUG
 
 /**
  * \brief   Assert 
@@ -157,6 +167,9 @@ public:
  *        An easy solution to pass also a message is to do:
  *        gdcmAssertMacro( "my message" && 2 < 3 )
  */
+#ifdef NDEBUG
+#define gdcmAssertMacro(arg)
+#else
 #define gdcmAssertMacro(arg)                                \
 {                                                           \
    if( !(arg) )                                             \
@@ -172,5 +185,6 @@ public:
    assert ( arg );                                          \
    }                                                        \
 }
+#endif //NDEBUG
 
 #endif