X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDebug.h;h=df9e02f831f4d412b1b43a710ae4c2454e46715a;hb=e7ed9c263ead790fecfa6bdac9d6e535fbe1b0cc;hp=edb114fd5f05420043d3401c7ee4f93e8aaae5fa;hpb=1ce6ae86daabc8b64c9309acce4ecf137ee79f07;p=gdcm.git diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h index edb114fd..df9e02f8 100644 --- a/src/gdcmDebug.h +++ b/src/gdcmDebug.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDebug.h,v $ Language: C++ - Date: $Date: 2005/01/31 12:19:33 $ - Version: $Revision: 1.26 $ + Date: $Date: 2005/11/05 13:21:32 $ + Version: $Revision: 1.47 $ 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 #include #include #include @@ -31,14 +32,16 @@ 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 * - debug : for information/debug messages * - warning : for warning about DICOM quality (kosher) + * - assert : design by contract implementation. A function should have + * 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(); */ @@ -48,26 +51,35 @@ public: Debug(); ~Debug(); - /// This is a global flag that controls whether any debug, warning - /// messages are displayed. - static bool GetDebugFlag (); + /// \brief This is a global flag that controls whether + /// both debug and 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); } + + /// \brief This is a global flag that controls whether + /// warning messages are displayed. + static void SetWarningFlag (bool flag); + static bool GetWarningFlag (); + /// \brief Sets the Warning Flag to true + static void WarningOn () { SetWarningFlag(true); } + /// \brief Sets the Warning Flag to false + static void WarningOff () { SetWarningFlag(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 (); }; @@ -96,11 +108,11 @@ public: #endif //GDCM_COMPILER_HAS_FUNCTION /** - * \brief Debug + * \brief Debug : To be used to help bug tracking developer * @param msg message part */ #ifdef NDEBUG -#define gdcmDebugMacro(msg) +#define gdcmDebugMacro(msg) {} #else #define gdcmDebugMacro(msg) \ { \ @@ -108,9 +120,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 \ @@ -120,20 +134,18 @@ public: #endif //NDEBUG /** - * \brief Verbose + * \brief Warning : To be used to warn the user when some oddity occurs * @param msg message part */ #ifdef NDEBUG -#define gdcmVerboseMacro(msg) \ -{ \ -} +#define gdcmWarningMacro(msg) {} #else -#define gdcmVerboseMacro(msg) \ +#define gdcmWarningMacro(msg) \ { \ - if( Debug::GetDebugFlag() ) \ + if( Debug::GetWarningFlag() ) \ { \ 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() ) \ @@ -145,11 +157,12 @@ 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 -#define gdcmErrorMacro(msg) +#define gdcmErrorMacro(msg) {} #else #define gdcmErrorMacro(msg) \ { \ @@ -165,13 +178,15 @@ 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 ) */ #ifdef NDEBUG -#define gdcmAssertMacro(arg) +#define gdcmAssertMacro(arg) {} #else #define gdcmAssertMacro(arg) \ { \ @@ -190,4 +205,62 @@ public: } #endif //NDEBUG +//----------------------------------------------------------------------------- +// +// Define GDCM_LEGACY macro to mark legacy methods where they are +// declared in their class. +// +// WARNING : Don't try to use it with 'inline' methods ! +// +//Example usage: +// +// // @deprecated Replaced by MyOtherMethod() as of gdcm 2.0. +// GDCM_LEGACY(void MyMethod()); +#if defined(GDCM_LEGACY_REMOVE) + // Remove legacy methods completely. +# define GDCM_LEGACY(method) +#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 +# define GDCM_LEGACY(method) method +# endif +#endif + +// Macros to create runtime deprecation warning messages in function +// bodies. Example usage: +// +// void MyClass::MyOldMethod() +// { +// GDCM_LEGACY_BODY(MyClass::MyOldMethod, 2.0); +// } +// +// void MyClass::MyMethod() +// { +// GDCM_LEGACY_REPLACED_BODY(MyClass::MyMethod, 5.0, +// MyClass::MyOtherMethod); +// } +#if defined(GDCM_LEGACY_REMOVE) || defined(GDCM_LEGACY_SILENT) +# define GDCM_LEGACY_BODY(method, version) +# define GDCM_LEGACY_REPLACED_BODY(method, version, replace) +#else +# define GDCM_LEGACY_BODY(method, version) \ + gdcmWarningMacro(#method " was deprecated for gdcm" #version " and will be removed in a future version.") +# define GDCM_LEGACY_REPLACED_BODY(method, version, replace) \ + gdcmWarningMacro(#method " was deprecated for gdcm" #version " and will be removed in a future version. Use " #replace " instead.") +#endif + #endif