X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDebug.h;h=8bb1aa465458fcc24776046da7b181bdca5bc23d;hb=4efd58d718e072fa7909efa78e75d5dbbda3755f;hp=1b193986ec33b2fd65ab31b53643a85ee474b24e;hpb=70b9dde9da207191fa6d799fdf03c2aff7941273;p=gdcm.git diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h index 1b193986..8bb1aa46 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 16:26:12 $ - Version: $Revision: 1.11 $ + Date: $Date: 2005/02/11 15:22:18 $ + Version: $Revision: 1.32 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -21,39 +21,170 @@ #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) * - * 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: - Debug(int level = -1); + 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); }; - /// This is a global flag that controls whether any debug, warning - /// messages are displayed. - static void SetDebugLevel (int level); - static int GetDebugLevel (); + /// \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 Verbose(int level, const char *msg1, const char *msg2 = "") ; - static void Error (bool test, const char *msg1, const char *msg2 = ""); - static void Error (const char *msg1, const char *msg2 = "", const char *msg3 = ""); + static void SetDebugFilename (std::string const &filename); - static void Assert(int level, bool test, const char *msg1, const char *msg2); - static void Exit (int a); + static std::ofstream &GetDebugFile (); }; } // 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 Verbose + * @param msg message part + */ +#ifdef NDEBUG +#define gdcmWarningMacro(msg) +#else +#define gdcmWarningMacro(msg) \ +{ \ + if( Debug::GetDebugFlag() ) \ + { \ + std::ostringstream osmacro; \ + osmacro << "Verbose: 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 + #endif