X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDebug.h;h=5f834ce192c8373a0fe8d7c96b14320020bc932e;hb=d9145e01b1e8f7f5378def524f6ffd5f9491abaf;hp=a173a8115cec77f6eb2847c922464c3cf3a48094;hpb=abd6bfcc2b10b5f7447d1758938d7c15c31240af;p=gdcm.git diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h index a173a811..5f834ce1 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/07 19:20:38 $ - Version: $Revision: 1.13 $ + Date: $Date: 2005/06/21 14:05:06 $ + Version: $Revision: 1.35 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -21,30 +21,56 @@ #include "gdcmCommon.h" +#include +#include +#include +#include + namespace gdcm { //----------------------------------------------------------------------------- /** - * \ingroup Debug * \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 GDCM_EXPORT Debug { public: - /// This is a global flag that controls whether any debug, warning - /// messages are displayed. - static int GetDebugFlag (); - static void SetDebugFlag (int flag); - static void SetDebugOn () { SetDebugFlag(1); }; - static void SetDebugOff () { SetDebugFlag(0); }; + 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); }; + + /// \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); }; + + static void SetDebugFilename (std::string const &filename); + + static std::ofstream &GetDebugFile (); }; } // end namespace gdcm @@ -55,83 +81,113 @@ public: // You cannot use function unless you use vnsprintf ... // __FUNCTION is not always defined by preprocessor -#ifndef __FUNCTION__ -# define __FUNCTION__ "" +// 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 Verbose - * @param level level - * @param msg1 first message part - * @param msg2 second message part + * \brief Debug + * @param msg message part */ -#define gdcmDebugMacro(x) \ -{ \ - if( gdcm::Debug::GetDebugFlag() ) \ - { \ - std::ostringstream osmacro; \ - osmacro << "Debug: In " __FILE__ ", line " << __LINE__ \ - << ", function " << __FUNCTION__ << '\n' \ - << x << "\n\n"; \ - std::cerr << osmacro.str() << std::endl; \ - } \ +#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 Verbose - * @param level level - * @param msg1 first message part - * @param msg2 second message part + * \brief Warning + * @param msg message part */ -#define gdcmVerboseMacro(x) \ +#ifdef NDEBUG +#define gdcmWarningMacro(msg) {} +#else +#define gdcmWarningMacro(msg) \ { \ - if( gdcm::Debug::GetDebugFlag() ) \ + if( Debug::GetDebugFlag() ) \ { \ std::ostringstream osmacro; \ - osmacro << "Verbose: In " __FILE__ ", line " << __LINE__ \ - << ", function " __FUNCTION__ "\n" \ - << x << "\n\n"; \ - std::cerr << osmacro.str() << std::endl; \ + 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 test test - * @param msg1 first message part - * @param msg2 second message part + * @param msg second message part */ -#define gdcmErrorMacro(x) \ -{ \ - if( gdcm::Debug::GetDebugFlag() ) \ - { \ - std::ostringstream osmacro; \ - osmacro << "Error: In " __FILE__ ", line " << __LINE__ \ - << ", function " << __FUNCTION__ << '\n' \ - << x << "\n\n"; \ - std::cerr << osmacro.str() << std::endl; \ - exit(1); \ - } \ +#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 level level - * @param test test - * @param msg1 first message part - * @param msg2 second message part + * @param arg argument to test + * An easy solution to pass also a message is to do: + * gdcmAssertMacro( "my message" && 2 < 3 ) */ -#define gdcmAssertMacro(x) \ -{ \ - if( x ) \ - { \ - std::ostringstream osmacro; \ - osmacro << "Assert: In " __FILE__ ", line " << __LINE__ \ - << ", function " << __FUNCTION__ \ - << "\n\n"; \ - std::cerr << osmacro.str() << std::endl; \ - assert ( x ); \ - } \ +#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 #endif