Fix mistypings

[gdcm.git] / src / gdcmDebug.h

diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h
index 4f5462c3f03b245a405c55a91f80f726653920ee..908ae2d9dd66a3053d88abc81c481540c41aed3d 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: 2006/01/03 14:28:53 $
-  Version:   $Revision: 1.53 $
+  Date:      $Date: 2008/04/10 12:15:36 $
+  Version:   $Revision: 1.59 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -16,8 +16,8 @@
                                                                                 
 =========================================================================*/
 
-#ifndef GDCMDEBUG_H
-#define GDCMDEBUG_H
+#ifndef _GDCMDEBUG_H_
+#define _GDCMDEBUG_H_
 
 #include "gdcmCommon.h"
 #include "gdcmCommand.h"
@@ -26,9 +26,10 @@
 #include <sstream>
 #include <fstream>
 #include <assert.h>
+#include <string.h> // strerror
 #include <errno.h>
 
-namespace gdcm 
+namespace GDCM_NAME_SPACE
 {
 //-----------------------------------------------------------------------------
 class CommandManager;
@@ -48,7 +49,7 @@ class CommandManager;
  * 
  * A debugging message is only shown if the flag is on (DebugFlag)
  * This is static var and can be set at beginning of code:
- *         gdcm::Debug::SetDebugOn();
+ *         GDCM_NAME_SPACE::Debug::SetDebugOn();
  *
  * Warning  : Warns the user when some oddity occured, and we used an heuristics
  *            to bypass the trouble.
@@ -78,7 +79,7 @@ public:
    ///        (used to warn user when file contains some oddity)
    static void SetDebugFlag (bool flag);
    /// \brief   Gets the debug flag value
-   static bool GetDebugFlag () {return DebugFlag;}
+   static bool GetDebugFlag () {return DebugFlag; }
    /// \brief Sets the Debug Flag to true
    static void DebugOn  () { SetDebugFlag(true);  }
    /// \brief Sets the Debug Flag to false
@@ -88,7 +89,7 @@ public:
    ///        log messages are displayed.
    static void SetLogFlag (bool flag);
    /// \brief   Gets the Log flag value
-   static bool GetLogFlag () {return LogFlag;}
+   static bool GetLogFlag () {return LogFlag; }
    /// \brief Sets the Log Flag to true
    static void LogOn  () { SetLogFlag(true);  }
    /// \brief Sets the Log Flag to false
@@ -98,7 +99,7 @@ public:
    ///        warning messages are displayed.
    static void SetWarningFlag (bool flag);
    /// \brief   Gets the warning flag value
-   static bool GetWarningFlag () {return WarningFlag;}
+   static bool GetWarningFlag () {return WarningFlag; }
    /// \brief Sets the Warning Flag to true
    static void WarningOn  () { SetWarningFlag(true);  }
    /// \brief Sets the Warning Flag to false
@@ -159,7 +160,10 @@ private:
 
 /**
  * \brief   Debug : To be used to help bug tracking developer
- * @param msg message part
+ * @param type type 
+ * @param obj obj
+ * @param msg message part 
+ * @param adds adds
  */
 #define gdcmMessageBodyMacro(type, obj, msg, adds)             \
 {                                                              \
@@ -167,13 +171,14 @@ private:
    osmacro << "In " __FILE__ ", line " << __LINE__             \
            << ", function " << GDCM_FUNCTION << "\n"           \
            << adds << msg << "\n\n";                           \
-   gdcm::Debug::SendToOutput(type,osmacro.str(),obj);          \
+   GDCM_NAME_SPACE::Debug::SendToOutput(type,osmacro.str(),obj);\
 }
 
 // ------------------------------------------------------------------------
 
 /**
  * \brief Debug : To be used to help bug tracking developer
+ * @param obj current instance or NULL
  * @param msg message part
  */
 #ifdef NDEBUG
@@ -192,7 +197,7 @@ private:
          adds += strerror(errno);                              \
          adds += "\n";                                         \
       }                                                        \
-      gdcmMessageBodyMacro(gdcm::CMD_DEBUG,obj,msg,adds);      \
+      gdcmMessageBodyMacro(GDCM_NAME_SPACE::CMD_DEBUG,obj,msg,adds);\
    }                                                           \
 }
 #define gdcmDebugMacro(msg)                                    \
@@ -205,14 +210,15 @@ private:
 
 /**
  * \brief Log : we display messages when anything is not Dicom Kosher
+ * @param obj current instance or NULL
  * @param msg message part
  */
 // No NDEBUG test to always have a return of warnings !!!
 // -> Rien compris! JPRx
 #define gdcmLogBodyMacro(obj, msg)                         \
-{                                                              \
+{                                                          \
    if( Debug::GetLogFlag() )                               \
-      gdcmMessageBodyMacro(gdcm::CMD_LOG,obj,msg,"");      \
+      gdcmMessageBodyMacro(GDCM_NAME_SPACE::CMD_LOG,obj,msg,"");\
 }
 #define gdcmLogMacro(msg)                                  \
    gdcmLogBodyMacro(this,msg)
@@ -223,6 +229,7 @@ private:
 
 /**
  * \brief Warning : To be used to warn the user when some oddity occurs
+ * @param obj current instance or NULL
  * @param msg message part
  */
 // No NDEBUG test to always have a return of warnings !!!
@@ -230,7 +237,7 @@ private:
 #define gdcmWarningBodyMacro(obj, msg)                         \
 {                                                              \
    if( Debug::GetWarningFlag() )                               \
-      gdcmMessageBodyMacro(gdcm::CMD_WARNING,obj,msg,"");      \
+      gdcmMessageBodyMacro(GDCM_NAME_SPACE::CMD_WARNING,obj,msg,"");\
 }
 #define gdcmWarningMacro(msg)                                  \
    gdcmWarningBodyMacro(this,msg)
@@ -242,13 +249,14 @@ private:
 /**
  * \brief   Error : To be used when unecoverabale error occurs
  *          at a 'deep' level. (don't use it if file is not ACR/DICOM!)
+ * @param obj current instance or NULL 
  * @param msg second message part 
  */
 // No NDEBUG test to always have a return of errors !!!
 // -> Rien compris! JPRx
 #define gdcmErrorBodyMacro(obj, msg)                           \
 {                                                              \
-   gdcmMessageBodyMacro(gdcm::CMD_ERROR,obj,msg,"");           \
+   gdcmMessageBodyMacro(GDCM_NAME_SPACE::CMD_ERROR,obj,msg,"");\
 }
 #define gdcmErrorMacro(msg)                                    \
    gdcmErrorBodyMacro(this,msg)
@@ -261,6 +269,7 @@ private:
  * \brief Assert : To be used when an *absolutely* impossible error occurs
  *        No function should be allowed to stop the process instead of
  *        warning the caller!
+ * @param obj current instance or NULL
  * @param arg argument to test
  *        An easy solution to pass also a message is to do:
  *        gdcmAssertMacro( "my message" && 2 < 3 )
@@ -271,7 +280,7 @@ private:
 {                                                              \
    if( !(arg) )                                                \
    {                                                           \
-      gdcmMessageBodyMacro(gdcm::CMD_ASSERT,obj,"","");        \
+      gdcmMessageBodyMacro(GDCM_NAME_SPACE::CMD_ASSERT,obj,"","");\
       assert ( arg );                                          \
    }                                                           \
 }