src/gdcmDebug.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDebug.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/10/18 12:58:27 $
   7   Version:   $Revision: 1.43 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCMDEBUG_H
  20 #define GDCMDEBUG_H
  21
  22 #include "gdcmCommon.h"
  23
  24 #include <iostream>
  25 #include <sstream>
  26 #include <fstream>
  27 #include <assert.h>
  28 #include <errno.h>
  29
  30 namespace gdcm
  31 {
  32 //-----------------------------------------------------------------------------
  33
  34 /**
  35  * \brief Debug is an object for debugging in program.
  36  * It has 2 debugging modes :
  37  *  - error : for bad library use, seriously wrong DICOM
  38  *  - debug : for information/debug messages
  39  *  - warning : for warning about DICOM quality (kosher)
  40  *  - assert : design by contract implementation. A function should have
  41  *             proper input and proper output.
  42  *             (should not happen, not user controlled)
  43  *
  44  * A debugging message is only shown if the flag is on (DebugFlag)
  45  * This is static var and can be set at beginning of code:
  46  *         gdcm::Debug::SetDebugOn();
  47  */
  48 class GDCM_EXPORT Debug
  49 {
  50 public:
  51    Debug();
  52    ~Debug();
  53
  54    /// \brief This is a global flag that controls whether any debug, warning
  55    ///        messages are displayed.
  56    static void SetDebugFlag (bool flag);
  57    static bool GetDebugFlag ();
  58    /// \brief Sets the Debug Flag to true
  59    static void DebugOn  () { SetDebugFlag(true);  }
  60    /// \brief Sets the Debug Flag to false
  61    static void DebugOff () { SetDebugFlag(false); }
  62
  63    /// \brief This is a global flag that controls if debug are redirected
  64    ///        to a file or not
  65    static void SetDebugToFile (bool flag);
  66    static bool GetDebugToFile ();
  67    /// \brief Next debug messages will be sent in the debug file
  68    static void DebugToFileOn  () { SetDebugToFile(true);  }
  69    /// \brief Next debug messages will be sent in the standard output
  70    static void DebugToFileOff () { SetDebugToFile(false); }
  71
  72    static void SetDebugFilename (std::string const &filename);
  73
  74    static std::ofstream &GetDebugFile ();
  75 };
  76
  77 } // end namespace gdcm
  78
  79 // Here we define function this is the only way to be able to pass
  80 // stuff with indirection like:
  81 // gdcmDebug( "my message:" << i << '\t' );
  82 // You cannot use function unless you use vnsprintf ...
  83
  84 // __FUNCTION is not always defined by preprocessor
  85 // In c++ we should use __PRETTY_FUNCTION__ instead...
  86 #ifdef GDCM_COMPILER_HAS_FUNCTION
  87 // Handle particular case for GNU C++ which also defines __PRETTY_FUNCTION__
  88 // which is a lot nice in C++
  89 #ifdef __BORLANDC__
  90 #  define __FUNCTION__ __FUNC__
  91 #endif
  92 #ifdef __GNUC__
  93 #  define GDCM_FUNCTION __PRETTY_FUNCTION__
  94 #else
  95 #  define GDCM_FUNCTION __FUNCTION__
  96 #endif //__GNUC__
  97 #else
  98 #  define GDCM_FUNCTION "<unknow>"
  99 #endif //GDCM_COMPILER_HAS_FUNCTION
 100
 101 /**
 102  * \brief   Debug
 103  * @param msg message part
 104  */
 105 #ifdef NDEBUG
 106 #define gdcmDebugMacro(msg) {}
 107 #else
 108 #define gdcmDebugMacro(msg)                                 \
 109 {                                                           \
 110    if( Debug::GetDebugFlag() )                              \
 111    {                                                        \
 112    std::ostringstream osmacro;                              \
 113    osmacro << "Debug: In " __FILE__ ", line " << __LINE__   \
 114            << ", function " << GDCM_FUNCTION << '\n'        \
 115            << "Last system error was: " << strerror(errno)  \
 116            << '\n' << msg << "\n\n";                        \
 117    if( Debug::GetDebugToFile() )                            \
 118       Debug::GetDebugFile() << osmacro.str() << std::endl;  \
 119    else                                                     \
 120       std::cerr << osmacro.str() << std::endl;              \
 121    }                                                        \
 122 }
 123 #endif //NDEBUG
 124
 125 /**
 126  * \brief   Warning
 127  * @param msg message part
 128  */
 129 #ifdef NDEBUG
 130 #define gdcmWarningMacro(msg) {}
 131 #else
 132 #define gdcmWarningMacro(msg)                               \
 133 {                                                           \
 134    if( Debug::GetDebugFlag() )                              \
 135    {                                                        \
 136    std::ostringstream osmacro;                              \
 137    osmacro << "Warning: In " __FILE__ ", line " << __LINE__ \
 138            << ", function " << GDCM_FUNCTION << "\n"        \
 139            << msg << "\n\n";                                \
 140    if( Debug::GetDebugToFile() )                            \
 141       Debug::GetDebugFile() << osmacro.str() << std::endl;  \
 142    else                                                     \
 143       std::cerr << osmacro.str() << std::endl;              \
 144    }                                                        \
 145 }
 146 #endif //NDEBUG
 147
 148 /**
 149  * \brief   Error
 150  * @param msg second message part
 151  */
 152 #ifdef NDEBUG
 153 #define gdcmErrorMacro(msg) {}
 154 #else
 155 #define gdcmErrorMacro(msg)                                 \
 156 {                                                           \
 157    std::ostringstream osmacro;                              \
 158    osmacro << "Error: In " __FILE__ ", line " << __LINE__   \
 159            << ", function " << GDCM_FUNCTION << '\n'        \
 160            << msg << "\n\n";                                \
 161    if( Debug::GetDebugToFile() )                            \
 162       Debug::GetDebugFile() << osmacro.str() << std::endl;  \
 163    else                                                     \
 164       std::cerr << osmacro.str() << std::endl;              \
 165 }
 166 #endif //NDEBUG
 167
 168 /**
 169  * \brief   Assert
 170  * @param arg argument to test
 171  *        An easy solution to pass also a message is to do:
 172  *        gdcmAssertMacro( "my message" && 2 < 3 )
 173  */
 174 #ifdef NDEBUG
 175 #define gdcmAssertMacro(arg) {}
 176 #else
 177 #define gdcmAssertMacro(arg)                                \
 178 {                                                           \
 179    if( !(arg) )                                             \
 180    {                                                        \
 181    std::ostringstream osmacro;                              \
 182    osmacro << "Assert: In " __FILE__ ", line " << __LINE__  \
 183            << ", function " << GDCM_FUNCTION                \
 184            << "\n\n";                                       \
 185    if( Debug::GetDebugToFile() )                            \
 186       Debug::GetDebugFile() << osmacro.str() << std::endl;  \
 187    else                                                     \
 188       std::cerr << osmacro.str() << std::endl;              \
 189    assert ( arg );                                          \
 190    }                                                        \
 191 }
 192 #endif //NDEBUG
 193
 194 //-----------------------------------------------------------------------------
 195 //
 196 // Define GDCM_LEGACY macro to mark legacy methods where they are
 197 // declared in their class.
 198 //
 199 // WARNING : Don't try to use it with 'inline' methods !
 200 //
 201 //Example usage:
 202 //
 203 //   // @deprecated Replaced by MyOtherMethod() as of gdcm 2.0.
 204 //   GDCM_LEGACY(void MyMethod());
 205 #if defined(GDCM_LEGACY_REMOVE)
 206   // Remove legacy methods completely.
 207 # define GDCM_LEGACY(method)
 208 #elif defined(GDCM_LEGACY_SILENT) || defined(SWIG)
 209   // Provide legacy methods with no warnings.
 210 # define GDCM_LEGACY(method) method
 211 #else
 212   // Setup compile-time warnings for uses of deprecated methods if
 213   // possible on this compiler.
 214 # if defined(__GNUC__) && !defined(__INTEL_COMPILER) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
 215 #if defined(__APPLE__) && (__GNUC__ == 3) && (__GNUC_MINOR__ == 3)
 216 // Seems like there is a bug in APPLE gcc for deprecated attribute and ctor
 217 // This is fixed in g++ 4.0 (Tiger)
 218 #  define GDCM_LEGACY(method) method
 219 #else
 220 #  define GDCM_LEGACY(method) method __attribute__((deprecated))
 221 #endif
 222 # elif defined(_MSC_VER) && _MSC_VER >= 1300
 223 #  define GDCM_LEGACY(method) __declspec(deprecated) method
 224 # else
 225 #  define GDCM_LEGACY(method) method
 226 # endif
 227 #endif
 228
 229 // Macros to create runtime deprecation warning messages in function
 230 // bodies.  Example usage:
 231 //
 232 //   void MyClass::MyOldMethod()
 233 //   {
 234 //     GDCM_LEGACY_BODY(MyClass::MyOldMethod, 2.0);
 235 //   }
 236 //
 237 //   void MyClass::MyMethod()
 238 //   {
 239 //     GDCM_LEGACY_REPLACED_BODY(MyClass::MyMethod, 5.0,
 240 //                               MyClass::MyOtherMethod);
 241 //   }
 242 #if defined(GDCM_LEGACY_REMOVE) || defined(GDCM_LEGACY_SILENT)
 243 # define GDCM_LEGACY_BODY(method, version)
 244 # define GDCM_LEGACY_REPLACED_BODY(method, version, replace)
 245 #else
 246 # define GDCM_LEGACY_BODY(method, version) \
 247   gdcmWarningMacro(#method " was deprecated for gdcm" #version " and will be removed in a future version.")
 248 # define GDCM_LEGACY_REPLACED_BODY(method, version, replace) \
 249   gdcmWarningMacro(#method " was deprecated for gdcm" #version " and will be removed in a future version.  Use " #replace " instead.")
 250 #endif
 251
 252 #endif