src/gdcmDebug.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDebug.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/10/27 09:12:20 $
   7   Version:   $Revision: 1.46 $
   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 : To be used to help bug tracking developer
 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    if( errno )                                              \
 116      osmacro  << "Last system error was: " <<               \
 117        strerror(errno) << '\n';                             \
 118    osmacro << msg << "\n\n";                                \
 119    if( Debug::GetDebugToFile() )                            \
 120       Debug::GetDebugFile() << osmacro.str() << std::endl;  \
 121    else                                                     \
 122       std::cerr << osmacro.str() << std::endl;              \
 123    }                                                        \
 124 }
 125 #endif //NDEBUG
 126
 127 /**
 128  * \brief   Warning : To be used to warn the user when some oddity occurs
 129  * @param msg message part
 130  */
 131 #ifdef NDEBUG
 132 #define gdcmWarningMacro(msg) {}
 133 #else
 134 #define gdcmWarningMacro(msg)                               \
 135 {                                                           \
 136    if( Debug::GetDebugFlag() )                              \
 137    {                                                        \
 138    std::ostringstream osmacro;                              \
 139    osmacro << "Warning: In " __FILE__ ", line " << __LINE__ \
 140            << ", function " << GDCM_FUNCTION << "\n"        \
 141            << msg << "\n\n";                                \
 142    if( Debug::GetDebugToFile() )                            \
 143       Debug::GetDebugFile() << osmacro.str() << std::endl;  \
 144    else                                                     \
 145       std::cerr << osmacro.str() << std::endl;              \
 146    }                                                        \
 147 }
 148 #endif //NDEBUG
 149
 150 /**
 151  * \brief   Error : To be used when unecoverabale error occurs
 152  *          at a 'deep' level. (don't use it if file is not ACR/DICOM!)
 153  * @param msg second message part
 154  */
 155 #ifdef NDEBUG
 156 #define gdcmErrorMacro(msg) {}
 157 #else
 158 #define gdcmErrorMacro(msg)                                 \
 159 {                                                           \
 160    std::ostringstream osmacro;                              \
 161    osmacro << "Error: In " __FILE__ ", line " << __LINE__   \
 162            << ", function " << GDCM_FUNCTION << '\n'        \
 163            << msg << "\n\n";                                \
 164    if( Debug::GetDebugToFile() )                            \
 165       Debug::GetDebugFile() << osmacro.str() << std::endl;  \
 166    else                                                     \
 167       std::cerr << osmacro.str() << std::endl;              \
 168 }
 169 #endif //NDEBUG
 170
 171 /**
 172  * \brief   Assert : To be used when an *absolutely* impossible error occurs
 173  *          No function should be allowed to stop the process instead of
 174  *          warning the caller!
 175  * @param arg argument to test
 176  *        An easy solution to pass also a message is to do:
 177  *        gdcmAssertMacro( "my message" && 2 < 3 )
 178  */
 179 #ifdef NDEBUG
 180 #define gdcmAssertMacro(arg) {}
 181 #else
 182 #define gdcmAssertMacro(arg)                                \
 183 {                                                           \
 184    if( !(arg) )                                             \
 185    {                                                        \
 186    std::ostringstream osmacro;                              \
 187    osmacro << "Assert: In " __FILE__ ", line " << __LINE__  \
 188            << ", function " << GDCM_FUNCTION                \
 189            << "\n\n";                                       \
 190    if( Debug::GetDebugToFile() )                            \
 191       Debug::GetDebugFile() << osmacro.str() << std::endl;  \
 192    else                                                     \
 193       std::cerr << osmacro.str() << std::endl;              \
 194    assert ( arg );                                          \
 195    }                                                        \
 196 }
 197 #endif //NDEBUG
 198
 199 //-----------------------------------------------------------------------------
 200 //
 201 // Define GDCM_LEGACY macro to mark legacy methods where they are
 202 // declared in their class.
 203 //
 204 // WARNING : Don't try to use it with 'inline' methods !
 205 //
 206 //Example usage:
 207 //
 208 //   // @deprecated Replaced by MyOtherMethod() as of gdcm 2.0.
 209 //   GDCM_LEGACY(void MyMethod());
 210 #if defined(GDCM_LEGACY_REMOVE)
 211   // Remove legacy methods completely.
 212 # define GDCM_LEGACY(method)
 213 #elif defined(GDCM_LEGACY_SILENT) || defined(SWIG)
 214   // Provide legacy methods with no warnings.
 215 # define GDCM_LEGACY(method) method
 216 #else
 217   // Setup compile-time warnings for uses of deprecated methods if
 218   // possible on this compiler.
 219 # if defined(__GNUC__) && !defined(__INTEL_COMPILER) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
 220 #if defined(__APPLE__) && (__GNUC__ == 3) && (__GNUC_MINOR__ == 3)
 221 // Seems like there is a bug in APPLE gcc for deprecated attribute and ctor
 222 // This is fixed in g++ 4.0 (Tiger)
 223 #  define GDCM_LEGACY(method) method
 224 #else
 225 #  define GDCM_LEGACY(method) method __attribute__((deprecated))
 226 #endif
 227 # elif defined(_MSC_VER) && _MSC_VER >= 1300
 228 #  define GDCM_LEGACY(method) __declspec(deprecated) method
 229 # else
 230 #  define GDCM_LEGACY(method) method
 231 # endif
 232 #endif
 233
 234 // Macros to create runtime deprecation warning messages in function
 235 // bodies.  Example usage:
 236 //
 237 //   void MyClass::MyOldMethod()
 238 //   {
 239 //     GDCM_LEGACY_BODY(MyClass::MyOldMethod, 2.0);
 240 //   }
 241 //
 242 //   void MyClass::MyMethod()
 243 //   {
 244 //     GDCM_LEGACY_REPLACED_BODY(MyClass::MyMethod, 5.0,
 245 //                               MyClass::MyOtherMethod);
 246 //   }
 247 #if defined(GDCM_LEGACY_REMOVE) || defined(GDCM_LEGACY_SILENT)
 248 # define GDCM_LEGACY_BODY(method, version)
 249 # define GDCM_LEGACY_REPLACED_BODY(method, version, replace)
 250 #else
 251 # define GDCM_LEGACY_BODY(method, version) \
 252   gdcmWarningMacro(#method " was deprecated for gdcm" #version " and will be removed in a future version.")
 253 # define GDCM_LEGACY_REPLACED_BODY(method, version, replace) \
 254   gdcmWarningMacro(#method " was deprecated for gdcm" #version " and will be removed in a future version.  Use " #replace " instead.")
 255 #endif
 256
 257 #endif