X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDebug.h;h=172464871634499bc06e3b3e4c4b2b663e141641;hb=33b1eec26f02131242fbfdef52184b24763cf4e6;hp=75d700ce90af33f52501e949ed2896c9c7885c7e;hpb=d1c68c2c2ae9fadf927053150f7fbc625a7c7366;p=gdcm.git diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h index 75d700ce..17246487 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/01 10:29:54 $ - Version: $Revision: 1.27 $ + Date: $Date: 2005/11/29 17:21:34 $ + Version: $Revision: 1.52 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -20,7 +20,9 @@ #define GDCMDEBUG_H #include "gdcmCommon.h" +#include "gdcmCommand.h" +#include #include #include #include @@ -29,16 +31,20 @@ namespace gdcm { //----------------------------------------------------------------------------- +class CommandManager; +//----------------------------------------------------------------------------- /** - * \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) + * A debugging message is only shown if the flag is on (DebugFlag) * This is static var and can be set at beginning of code: * gdcm::Debug::SetDebugOn(); */ @@ -48,27 +54,52 @@ 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 + /// both debug and warning messages are displayed. + /// (used to warn user when file contains some oddity) static void SetDebugFlag (bool flag); - static bool GetDebugFlag (); - static void DebugOn () { SetDebugFlag(true); }; - static void DebugOff () { SetDebugFlag(false); }; - - /// This is a global flag that controls if debug are redirected - /// to a file or not - static void SetDebugToFile (bool flag); - static bool GetDebugToFile (); - static void DebugToFileOn () { SetDebugToFile(true); }; - 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); - - /// Internal use only. Allow us to retrieve the static from anywhere - /// in gdcm code - static std::ofstream &GetDebugFile (); + /// \brief Gets the debug flag value + static bool GetDebugFlag () {return DebugFlag;} + /// \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 whether + /// warning messages are displayed. + static void SetWarningFlag (bool flag); + /// \brief Gets the warning flag value + static bool GetWarningFlag () {return WarningFlag;} + /// \brief Sets the Warning Flag to true + static void WarningOn () { SetWarningFlag(true); } + /// \brief Sets the Warning Flag to false + static void WarningOff () { SetWarningFlag(false); } + + /// \brief This is a global flag that controls if debug are redirected + /// to a file or not + static void SetOutputToFile (bool flag); + static bool GetOutputToFile (); + /// \brief Next debug messages will be sent in the debug file + static void OutputToFileOn () { SetOutputToFile(true); } + /// \brief Next debug messages will be sent in the standard output + static void OutputToFileOff () { SetOutputToFile(false); } + + static void SetOutputFileName (std::string const &filename); + + static std::ostream &GetOutput (); + + static void SendToOutput(unsigned int type,std::string const &msg, + const Base *object = NULL); + +private: + static bool DebugFlag; + static bool WarningFlag; + static bool OutputToFile; + + static std::ofstream OutputFileStream; + static std::ostream &StandardStream; + + static const int LINE_LENGTH; }; } // end namespace gdcm @@ -96,98 +127,101 @@ public: #endif //GDCM_COMPILER_HAS_FUNCTION /** - * \brief Debug + * \brief Debug : To be used to help bug tracking developer * @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; \ - } \ +#define gdcmMessageBodyMacro(type, obj, msg, adds) \ +{ \ + std::ostringstream osmacro; \ + osmacro << "In " __FILE__ ", line " << __LINE__ \ + << ", function " << GDCM_FUNCTION << "\n" \ + << adds << msg << "\n\n"; \ + gdcm::Debug::SendToOutput(type,osmacro.str(),obj); \ } -#endif //NDEBUG /** - * \brief Verbose + * \brief Debug : To be used to help bug tracking developer * @param msg message part */ #ifdef NDEBUG -#define gdcmVerboseMacro(msg) \ -{ \ -} +#define gdcmDebugBodyMacro(obj, msg) {} +#define gdcmDebugMacro(msg) {} +#define gdcmStaticDebugMacro(msg) {} #else -#define gdcmVerboseMacro(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; \ - } \ +#define gdcmDebugBodyMacro(obj, msg) \ +{ \ + if( Debug::GetDebugFlag() ) \ + { \ + std::string adds=""; \ + if( errno ) \ + { \ + adds = "Last system error was: "; \ + adds += strerror(errno); \ + adds += "\n"; \ + } \ + gdcmMessageBodyMacro(gdcm::CMD_DEBUG,obj,msg,adds); \ + } \ } +#define gdcmDebugMacro(msg) \ + gdcmDebugBodyMacro(NULL,msg) +#define gdcmStaticDebugMacro(msg) \ + gdcmDebugBodyMacro(NULL,msg) #endif //NDEBUG /** - * \brief Error + * \brief Warning : To be used to warn the user when some oddity occurs + * @param msg message part + */ +// No NDEBUG test to always have a return of warnings !!! +// -> Rien compris! JPRx +#define gdcmWarningBodyMacro(obj, msg) \ +{ \ + if( Debug::GetWarningFlag() ) \ + gdcmMessageBodyMacro(gdcm::CMD_WARNING,obj,msg,""); \ +} +#define gdcmWarningMacro(msg) \ + gdcmWarningBodyMacro(this,msg) +#define gdcmStaticWarningMacro(msg) \ + gdcmWarningBodyMacro(NULL,msg) + +/** + * \brief Error : To be used when unecoverabale error occurs + * at a 'deep' level. (don't use it if file is not ACR/DICOM!) * @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; \ +// No NDEBUG test to always have a return of errors !!! +// -> Rien compris! JPRx +#define gdcmErrorBodyMacro(obj, msg) \ +{ \ + gdcmMessageBodyMacro(gdcm::CMD_ERROR,obj,msg,""); \ } -#endif //NDEBUG +#define gdcmErrorMacro(msg) \ + gdcmErrorBodyMacro(this,msg) +#define gdcmStaticErrorMacro(msg) \ + gdcmErrorBodyMacro(NULL,msg) /** - * \brief Assert + * \brief Assert : To be used when an *absolutely* impossible error occurs + * No function should be allowed to stop the process instead of + * warning the caller! * @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 ); \ - } \ +// No NDEBUG test to always have a return of asserts !!! +// -> Rien compris! JPRx +#define gdcmAssertBodyMacro(obj, arg) \ +{ \ + if( !(arg) ) \ + { \ + gdcmMessageBodyMacro(gdcm::CMD_ASSERT,obj,"",""); \ + assert ( arg ); \ + } \ } -#endif //NDEBUG +#define gdcmAssertMacro(msg) \ + gdcmAssertBodyMacro(NULL,msg) +#define gdcmStaticAssertMacro(msg) \ + gdcmAssertBodyMacro(NULL,msg) +//----------------------------------------------------------------------------- #endif