X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDebug.h;h=85eda8b3cae08ec08fdc3d24982d99946ff3af16;hb=066996143ee597cc94ffc6d27751301931afad30;hp=60a4bd489b5455b2101de324ccf8a606f97636d6;hpb=95e43356511d138225d8f718f632b3e7a8fcc106;p=gdcm.git diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h index 60a4bd48..85eda8b3 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/02/05 01:37:08 $ - Version: $Revision: 1.30 $ + Date: $Date: 2005/07/19 14:43:48 $ + Version: $Revision: 1.36 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -36,6 +36,9 @@ namespace gdcm * - 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) * This is static var and can be set at beginning of code: @@ -47,8 +50,8 @@ public: Debug(); ~Debug(); - /// This is a global flag that controls whether any debug, warning - /// messages are displayed. + /// \brief This is a global flag that controls whether any debug, warning + /// messages are displayed. static void SetDebugFlag (bool flag); static bool GetDebugFlag (); /// \brief Sets the Debug Flag to true @@ -56,8 +59,8 @@ public: /// \brief Sets the Debug Flag to false static void DebugOff () { SetDebugFlag(false); }; - /// This is a global flag that controls if debug are redirected - /// to a file or not + /// \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 @@ -99,7 +102,7 @@ public: * @param msg message part */ #ifdef NDEBUG -#define gdcmDebugMacro(msg) +#define gdcmDebugMacro(msg) {} #else #define gdcmDebugMacro(msg) \ { \ @@ -119,20 +122,18 @@ public: #endif //NDEBUG /** - * \brief Verbose + * \brief Warning * @param msg message part */ #ifdef NDEBUG -#define gdcmWarningMacro(msg) \ -{ \ -} +#define gdcmWarningMacro(msg) {} #else #define gdcmWarningMacro(msg) \ { \ if( Debug::GetDebugFlag() ) \ { \ 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() ) \ @@ -148,7 +149,7 @@ public: * @param msg second message part */ #ifdef NDEBUG -#define gdcmErrorMacro(msg) +#define gdcmErrorMacro(msg) {} #else #define gdcmErrorMacro(msg) \ { \ @@ -170,7 +171,7 @@ public: * gdcmAssertMacro( "my message" && 2 < 3 ) */ #ifdef NDEBUG -#define gdcmAssertMacro(arg) +#define gdcmAssertMacro(arg) {} #else #define gdcmAssertMacro(arg) \ { \ @@ -189,4 +190,52 @@ public: } #endif //NDEBUG +//----------------------------------------------------------------------------- +// +// Define GDCM_LEGACY macro to mark legacy methods where they are +// declared in their class. 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) + // 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)) +# define GDCM_LEGACY(method) method __attribute__((deprecated)) +# 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