]> Creatis software - gdcm.git/blobdiff - src/gdcmDebug.h
Fix comments (due to removal of difference between ValEntry and BinEntry)
[gdcm.git] / src / gdcmDebug.h
index c597d65e75d1b67dd0f6416df014ff3786f4d23b..9cb71d6fd5119bf56d3f4f39236bcdfc388eb0e3 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDebug.h,v $
   Language:  C++
-  Date:      $Date: 2005/07/20 14:49:42 $
-  Version:   $Revision: 1.37 $
+  Date:      $Date: 2005/10/27 09:12:20 $
+  Version:   $Revision: 1.46 $
                                                                                 
   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,7 @@
 
 #include "gdcmCommon.h"
 
+#include <iostream>
 #include <sstream>
 #include <fstream>
 #include <assert.h>
@@ -40,7 +41,7 @@ namespace gdcm
  *             proper input and proper output. 
  *             (should not happen, not user controlled)
  * 
- * A debugging message is only show if the flag is on (DebugFlag)
+ * 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();
  */
@@ -55,18 +56,18 @@ public:
    static void SetDebugFlag (bool flag);
    static bool GetDebugFlag ();
    /// \brief Sets the Debug Flag to true
-   static void DebugOn  () { SetDebugFlag(true);  };
+   static void DebugOn  () { SetDebugFlag(true);  }
    /// \brief Sets the Debug Flag to false
-   static void DebugOff () { SetDebugFlag(false); };
+   static void DebugOff () { SetDebugFlag(false); }
 
    /// \brief This is a global flag that controls if debug are redirected
    ///        to a file or not
    static void SetDebugToFile (bool flag);
    static bool GetDebugToFile ();
    /// \brief Next debug messages will be sent in the debug file
-   static void DebugToFileOn  () { SetDebugToFile(true);  };
+   static void DebugToFileOn  () { SetDebugToFile(true);  }
    /// \brief Next debug messages will be sent in the standard output
-   static void DebugToFileOff () { SetDebugToFile(false); };
+   static void DebugToFileOff () { SetDebugToFile(false); }
 
    static void SetDebugFilename (std::string const &filename);
 
@@ -98,7 +99,7 @@ public:
 #endif //GDCM_COMPILER_HAS_FUNCTION
 
 /**
- * \brief   Debug
+ * \brief   Debug : To be used to help bug tracking developer
  * @param msg message part
  */
 #ifdef NDEBUG
@@ -110,9 +111,11 @@ public:
    {                                                        \
    std::ostringstream osmacro;                              \
    osmacro << "Debug: In " __FILE__ ", line " << __LINE__   \
-           << ", function " << GDCM_FUNCTION << '\n'        \
-           << "Last system error was: " << strerror(errno)  \
-           << '\n' << msg << "\n\n";                        \
+           << ", function " << GDCM_FUNCTION << '\n';       \
+   if( errno )                                              \
+     osmacro  << "Last system error was: " <<               \
+       strerror(errno) << '\n';                             \
+   osmacro << msg << "\n\n";                                \
    if( Debug::GetDebugToFile() )                            \
       Debug::GetDebugFile() << osmacro.str() << std::endl;  \
    else                                                     \
@@ -122,7 +125,7 @@ public:
 #endif //NDEBUG
 
 /**
- * \brief   Warning
+ * \brief   Warning : To be used to warn the user when some oddity occurs
  * @param msg message part
  */
 #ifdef NDEBUG
@@ -145,7 +148,8 @@ public:
 #endif //NDEBUG
 
 /**
- * \brief   Error 
+ * \brief   Error : To be used when unecoverabale error occurs
+ *          at a 'deep' level. (don't use it if file is not ACR/DICOM!)
  * @param msg second message part 
  */
 #ifdef NDEBUG
@@ -165,7 +169,9 @@ public:
 #endif //NDEBUG
 
 /**
- * \brief   Assert 
+ * \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 arg argument to test
  *        An easy solution to pass also a message is to do:
  *        gdcmAssertMacro( "my message" && 2 < 3 )
@@ -204,14 +210,20 @@ public:
 #if defined(GDCM_LEGACY_REMOVE)
   // Remove legacy methods completely.
 # define GDCM_LEGACY(method)
-#elif defined(GDCM_LEGACY_SILENT)
+#elif defined(GDCM_LEGACY_SILENT) || defined(SWIG)
   // Provide legacy methods with no warnings.
 # define GDCM_LEGACY(method) method
 #else
   // Setup compile-time warnings for uses of deprecated methods if
   // possible on this compiler.
 # if defined(__GNUC__) && !defined(__INTEL_COMPILER) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
+#if defined(__APPLE__) && (__GNUC__ == 3) && (__GNUC_MINOR__ == 3)
+// Seems like there is a bug in APPLE gcc for deprecated attribute and ctor
+// This is fixed in g++ 4.0 (Tiger)
+#  define GDCM_LEGACY(method) method
+#else
 #  define GDCM_LEGACY(method) method __attribute__((deprecated))
+#endif
 # elif defined(_MSC_VER) && _MSC_VER >= 1300
 #  define GDCM_LEGACY(method) __declspec(deprecated) method
 # else