X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDebug.h;h=85eda8b3cae08ec08fdc3d24982d99946ff3af16;hb=066996143ee597cc94ffc6d27751301931afad30;hp=35c61e71112d710503969b988aabc71403a0d6cf;hpb=e0dd731930fb63792def3924ddc137135e09dabe;p=gdcm.git diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h index 35c61e71..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/01/13 22:30:11 $ - Version: $Revision: 1.22 $ + 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 @@ -31,41 +31,46 @@ 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) - * This is static var and can be set at begining of code: + * This is static var and can be set at beginning of code: * gdcm::Debug::SetDebugOn(); */ class GDCM_EXPORT Debug { public: - /// This is a global flag that controls whether any debug, warning - /// messages are displayed. - static bool GetDebugFlag (); + Debug(); + ~Debug(); + + /// \brief This is a global flag that controls whether any debug, 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); }; - /// 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 (); + static std::ofstream &GetDebugFile (); }; } // end namespace gdcm @@ -96,6 +101,9 @@ public: * \brief Debug * @param msg message part */ +#ifdef NDEBUG +#define gdcmDebugMacro(msg) {} +#else #define gdcmDebugMacro(msg) \ { \ if( Debug::GetDebugFlag() ) \ @@ -111,17 +119,21 @@ public: std::cerr << osmacro.str() << std::endl; \ } \ } +#endif //NDEBUG /** - * \brief Verbose + * \brief Warning * @param msg message part */ -#define gdcmVerboseMacro(msg) \ +#ifdef NDEBUG +#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() ) \ @@ -130,15 +142,17 @@ public: std::cerr << osmacro.str() << std::endl; \ } \ } +#endif //NDEBUG /** * \brief Error * @param msg second message part */ +#ifdef NDEBUG +#define gdcmErrorMacro(msg) {} +#else #define gdcmErrorMacro(msg) \ { \ - if( Debug::GetDebugFlag() ) \ - { \ std::ostringstream osmacro; \ osmacro << "Error: In " __FILE__ ", line " << __LINE__ \ << ", function " << GDCM_FUNCTION << '\n' \ @@ -147,9 +161,8 @@ public: Debug::GetDebugFile() << osmacro.str() << std::endl; \ else \ std::cerr << osmacro.str() << std::endl; \ - exit(1); \ - } \ } +#endif //NDEBUG /** * \brief Assert @@ -157,6 +170,9 @@ public: * An easy solution to pass also a message is to do: * gdcmAssertMacro( "my message" && 2 < 3 ) */ +#ifdef NDEBUG +#define gdcmAssertMacro(arg) {} +#else #define gdcmAssertMacro(arg) \ { \ if( !(arg) ) \ @@ -172,5 +188,54 @@ public: assert ( arg ); \ } \ } +#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