X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDebug.h;h=85eda8b3cae08ec08fdc3d24982d99946ff3af16;hb=066996143ee597cc94ffc6d27751301931afad30;hp=886e2ec4e5dca24f8f3c4c20749ff4a0c283a6b2;hpb=0e82725d64f17545e782c18039ced7ea898f8cad;p=gdcm.git diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h index 886e2ec4..85eda8b3 100644 --- a/src/gdcmDebug.h +++ b/src/gdcmDebug.h @@ -1,38 +1,241 @@ -// gdcmDebug.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDebug.h,v $ + Language: C++ + 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 + http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details. + + This software is distributed WITHOUT ANY WARRANTY; without even + the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the above copyright notices for more information. + +=========================================================================*/ + #ifndef GDCMDEBUG_H #define GDCMDEBUG_H -#define GDCM_DEBUG -1 +#include "gdcmCommon.h" + +#include +#include +#include +#include + +namespace gdcm +{ +//----------------------------------------------------------------------------- /** - * \ingroup gdcmDebug - * \brief gdcmDebug is an object for debugging in program. + * \brief Debug is an object for debugging in program. * It has 2 debugging modes : - * - error : for bad library use - * - debug : for debugging messages + * - 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 has a level of priority and is - * Shown only when the debug level is higher than the - * message level. + * A debugging message is only show if the flag is on (DebugFlag) + * This is static var and can be set at beginning of code: + * gdcm::Debug::SetDebugOn(); */ -class gdcmDebug { +class GDCM_EXPORT Debug +{ public: - gdcmDebug(int level = GDCM_DEBUG); + Debug(); + ~Debug(); + + /// \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 + static void DebugOn () { SetDebugFlag(true); }; + /// \brief Sets the Debug Flag to false + static void DebugOff () { SetDebugFlag(false); }; - void SetDebug (int level); - void Verbose(int, const char*, const char* =""); - void Error(bool, const char*, const char* =""); - void Error(const char*, const char* ="", const char* =""); + /// \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 + static void DebugToFileOn () { SetDebugToFile(true); }; + /// \brief Next debug messages will be sent in the standard output + static void DebugToFileOff () { SetDebugToFile(false); }; - void Assert(int, bool, const char*, const char*); - void Exit(int); + static void SetDebugFilename (std::string const &filename); -private: -/// warning message level to be displayed - int DebugLevel; + static std::ofstream &GetDebugFile (); }; -extern gdcmDebug dbg; +} // end namespace gdcm + +// Here we define function this is the only way to be able to pass +// stuff with indirection like: +// gdcmDebug( "my message:" << i << '\t' ); +// You cannot use function unless you use vnsprintf ... + +// __FUNCTION is not always defined by preprocessor +// In c++ we should use __PRETTY_FUNCTION__ instead... +#ifdef GDCM_COMPILER_HAS_FUNCTION +// Handle particular case for GNU C++ which also defines __PRETTY_FUNCTION__ +// which is a lot nice in C++ +#ifdef __BORLANDC__ +# define __FUNCTION__ __FUNC__ +#endif +#ifdef __GNUC__ +# define GDCM_FUNCTION __PRETTY_FUNCTION__ +#else +# define GDCM_FUNCTION __FUNCTION__ +#endif //__GNUC__ +#else +# define GDCM_FUNCTION "" +#endif //GDCM_COMPILER_HAS_FUNCTION + +/** + * \brief Debug + * @param msg message part + */ +#ifdef NDEBUG +#define gdcmDebugMacro(msg) {} +#else +#define gdcmDebugMacro(msg) \ +{ \ + if( Debug::GetDebugFlag() ) \ + { \ + std::ostringstream osmacro; \ + osmacro << "Debug: In " __FILE__ ", line " << __LINE__ \ + << ", function " << GDCM_FUNCTION << '\n' \ + << "Last system error was: " << strerror(errno) \ + << '\n' << msg << "\n\n"; \ + if( Debug::GetDebugToFile() ) \ + Debug::GetDebugFile() << osmacro.str() << std::endl; \ + else \ + std::cerr << osmacro.str() << std::endl; \ + } \ +} +#endif //NDEBUG + +/** + * \brief Warning + * @param msg message part + */ +#ifdef NDEBUG +#define gdcmWarningMacro(msg) {} +#else +#define gdcmWarningMacro(msg) \ +{ \ + if( Debug::GetDebugFlag() ) \ + { \ + std::ostringstream osmacro; \ + osmacro << "Warning: In " __FILE__ ", line " << __LINE__ \ + << ", function " << GDCM_FUNCTION << "\n" \ + << msg << "\n\n"; \ + if( Debug::GetDebugToFile() ) \ + Debug::GetDebugFile() << osmacro.str() << std::endl; \ + else \ + std::cerr << osmacro.str() << std::endl; \ + } \ +} +#endif //NDEBUG + +/** + * \brief Error + * @param msg second message part + */ +#ifdef NDEBUG +#define gdcmErrorMacro(msg) {} +#else +#define gdcmErrorMacro(msg) \ +{ \ + std::ostringstream osmacro; \ + osmacro << "Error: In " __FILE__ ", line " << __LINE__ \ + << ", function " << GDCM_FUNCTION << '\n' \ + << msg << "\n\n"; \ + if( Debug::GetDebugToFile() ) \ + Debug::GetDebugFile() << osmacro.str() << std::endl; \ + else \ + std::cerr << osmacro.str() << std::endl; \ +} +#endif //NDEBUG + +/** + * \brief Assert + * @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) {} +#else +#define gdcmAssertMacro(arg) \ +{ \ + if( !(arg) ) \ + { \ + std::ostringstream osmacro; \ + osmacro << "Assert: In " __FILE__ ", line " << __LINE__ \ + << ", function " << GDCM_FUNCTION \ + << "\n\n"; \ + if( Debug::GetDebugToFile() ) \ + Debug::GetDebugFile() << osmacro.str() << std::endl; \ + else \ + std::cerr << osmacro.str() << std::endl; \ + 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