X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDebug.h;h=33d22690df1dd49e20cd718c074d08053b6e66e5;hb=17daf7e7caceddf44e73864ee8d366613a1f0c82;hp=6e719784368cea44e50db361ead48d3e582aef66;hpb=ba78e6c6d47d6db1528e8e88e5ebde7296a26692;p=gdcm.git diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h index 6e719784..33d22690 100644 --- a/src/gdcmDebug.h +++ b/src/gdcmDebug.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDebug.h,v $ Language: C++ - Date: $Date: 2004/12/03 20:16:57 $ - Version: $Revision: 1.9 $ + Date: $Date: 2005/11/28 16:50:32 $ + Version: $Revision: 1.51 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -20,45 +20,204 @@ #define GDCMDEBUG_H #include "gdcmCommon.h" +#include "gdcmCommand.h" + +#include +#include +#include +#include +#include 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 - * - 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 shown 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 + /// both debug and warning messages are displayed. + /// (used to warn user when file contains some oddity) + static void SetDebugFlag (bool flag); + /// \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); } - void SetDebug (int level); - void Verbose(int level, const char* msg1, const char* msg2 = "") ; - void Error (bool test, const char* msg1, const char* msg2 = ""); - void Error (const char* msg1, const char* msg2 = "", const char* msg3 = ""); + /// \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); } - void Assert(int level, bool test, const char * msg1, const char * msg2); - void Exit(int a); + static void SetOutputFileName (std::string const &filename); - static Debug &GetReference(); + static std::ostream &GetOutput (); + + static void SendToOutput(unsigned int type,std::string const &msg,const Base *object = NULL); private: -/// warning message level to be displayed - int DebugLevel; + 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 -/// Instance of debugging utility. -static gdcm::Debug dbg; +// 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 : To be used to help bug tracking developer + * @param msg message part + */ +#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); \ +} + +/** + * \brief Debug : To be used to help bug tracking developer + * @param msg message part + */ +#ifdef NDEBUG +#define gdcmDebugBodyMacro(obj,msg) {} +#define gdcmDebugMacro(msg) {} +#define gdcmStaticDebugMacro(msg) {} +#else +#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 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 !!! +#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 + */ +// No NDEBUG test to always have a return of errors !!! +#define gdcmErrorBodyMacro(obj,msg) \ +{ \ + gdcmMessageBodyMacro(gdcm::CMD_ERROR,obj,msg,""); \ +} +#define gdcmErrorMacro(msg) \ + gdcmErrorBodyMacro(this,msg) +#define gdcmStaticErrorMacro(msg) \ + gdcmErrorBodyMacro(NULL,msg) + +/** + * \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 ) + */ +// No NDEBUG test to always have a return of asserts !!! +#define gdcmAssertBodyMacro(obj,arg) \ +{ \ + if( !(arg) ) \ + { \ + gdcmMessageBodyMacro(gdcm::CMD_ASSERT,obj,"",""); \ + assert ( arg ); \ + } \ +} +#define gdcmAssertMacro(msg) \ + gdcmAssertBodyMacro(NULL,msg) +#define gdcmStaticAssertMacro(msg) \ + gdcmAssertBodyMacro(NULL,msg) + +//----------------------------------------------------------------------------- #endif