X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDebug.h;h=06a9654dbd9ba8eaf64d7716cd589f6520eb9be3;hb=b06cbd9177331d793223eac6bf8b2bccf874e7e3;hp=33d22690df1dd49e20cd718c074d08053b6e66e5;hpb=6d79b5e185867ef00629f1ccb279c32daa6357d2;p=gdcm.git diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h index 33d22690..06a9654d 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/11/28 16:50:32 $ - Version: $Revision: 1.51 $ + Date: $Date: 2007/08/22 16:14:03 $ + Version: $Revision: 1.58 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -16,8 +16,8 @@ =========================================================================*/ -#ifndef GDCMDEBUG_H -#define GDCMDEBUG_H +#ifndef _GDCMDEBUG_H_ +#define _GDCMDEBUG_H_ #include "gdcmCommon.h" #include "gdcmCommand.h" @@ -28,26 +28,45 @@ #include #include -namespace gdcm +namespace GDCM_NAME_SPACE { //----------------------------------------------------------------------------- class CommandManager; //----------------------------------------------------------------------------- /** - * \brief Debug is an object for debugging in program. - * It has 2 debugging modes : + * \brief Debug is an object for warning/logging/tracing programs. + * It has the following modes : * - error : for bad library use, seriously wrong DICOM * - debug : for information/debug messages - * - warning : for warning about DICOM quality (kosher) + * - warning : Warns the user when some oddity occured. + * - log : we display messages when anything is not Dicom Kosher + * - debug : we help developper to trace, at a glance, the execution * - 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 shown if the flag is on (DebugFlag) * This is static var and can be set at beginning of code: - * gdcm::Debug::SetDebugOn(); + * GDCM_NAME_SPACE::Debug::SetDebugOn(); + * + * Warning : Warns the user when some oddity occured, and we used an heuristics + * to bypass the trouble. + * e.g. : SamplesPerPixel missing, we assume it's a grey level image + * e.g : Pixel Representation missing : we assume 'unsigned' + * (we hope our assumption is OK, but user may disagree.) + * Log : we display messages when anything is not Dicom Kosher + * e.g. : non even length field + * e.g : file is declared as Explicit VR, but a DataElement + * is Implicit + * e.g : a file holds an illegal group (0x0005, ...) + * Debug : We help developper to trace, at a glance, the execution. + * (before refining with a debugging tool) + * + * Setting ON Debug leads to set ON Warning (but not Log) + * Setting ON Log leads to set ON Warning (but not Debug) */ + class GDCM_EXPORT Debug { public: @@ -59,21 +78,31 @@ public: /// (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;} + 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 + /// log messages are displayed. + static void SetLogFlag (bool flag); + /// \brief Gets the Log flag value + static bool GetLogFlag () {return LogFlag; } + /// \brief Sets the Log Flag to true + static void LogOn () { SetLogFlag(true); } + /// \brief Sets the Log Flag to false + static void LogOff () { SetLogFlag(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;} + 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); } + static void WarningOff () { SetWarningFlag(false); } /// \brief This is a global flag that controls if debug are redirected /// to a file or not @@ -88,11 +117,14 @@ public: static std::ostream &GetOutput (); - static void SendToOutput(unsigned int type,std::string const &msg,const Base *object = NULL); + static void SendToOutput(unsigned int type,std::string const &msg, + const Base *object = NULL); private: - static bool DebugFlag; static bool WarningFlag; + static bool LogFlag; + static bool DebugFlag; + static bool OutputToFile; static std::ofstream OutputFileStream; @@ -127,27 +159,33 @@ private: /** * \brief Debug : To be used to help bug tracking developer - * @param msg message part + * @param type type + * @param obj obj + * @param msg message part + * @param adds adds */ -#define gdcmMessageBodyMacro(type,obj,msg,adds) \ +#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); \ + GDCM_NAME_SPACE::Debug::SendToOutput(type,osmacro.str(),obj);\ } +// ------------------------------------------------------------------------ + /** * \brief Debug : To be used to help bug tracking developer + * @param obj current instance or NULL * @param msg message part */ #ifdef NDEBUG -#define gdcmDebugBodyMacro(obj,msg) {} +#define gdcmDebugBodyMacro(obj, msg) {} #define gdcmDebugMacro(msg) {} #define gdcmStaticDebugMacro(msg) {} #else -#define gdcmDebugBodyMacro(obj,msg) \ +#define gdcmDebugBodyMacro(obj, msg) \ { \ if( Debug::GetDebugFlag() ) \ { \ @@ -158,7 +196,7 @@ private: adds += strerror(errno); \ adds += "\n"; \ } \ - gdcmMessageBodyMacro(gdcm::CMD_DEBUG,obj,msg,adds); \ + gdcmMessageBodyMacro(GDCM_NAME_SPACE::CMD_DEBUG,obj,msg,adds);\ } \ } #define gdcmDebugMacro(msg) \ @@ -167,50 +205,81 @@ private: gdcmDebugBodyMacro(NULL,msg) #endif //NDEBUG +// ------------------------------------------------------------------------ + +/** + * \brief Log : we display messages when anything is not Dicom Kosher + * @param obj current instance or NULL + * @param msg message part + */ +// No NDEBUG test to always have a return of warnings !!! +// -> Rien compris! JPRx +#define gdcmLogBodyMacro(obj, msg) \ +{ \ + if( Debug::GetLogFlag() ) \ + gdcmMessageBodyMacro(GDCM_NAME_SPACE::CMD_LOG,obj,msg,"");\ +} +#define gdcmLogMacro(msg) \ + gdcmLogBodyMacro(this,msg) +#define gdcmStaticLogMacro(msg) \ + gdcmLogBodyMacro(NULL,msg) + +// ------------------------------------------------------------------------ + /** * \brief Warning : To be used to warn the user when some oddity occurs + * @param obj current instance or NULL * @param msg message part */ // No NDEBUG test to always have a return of warnings !!! -#define gdcmWarningBodyMacro(obj,msg) \ +// -> Rien compris! JPRx +#define gdcmWarningBodyMacro(obj, msg) \ { \ if( Debug::GetWarningFlag() ) \ - gdcmMessageBodyMacro(gdcm::CMD_WARNING,obj,msg,""); \ + gdcmMessageBodyMacro(GDCM_NAME_SPACE::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 obj current instance or NULL * @param msg second message part */ // No NDEBUG test to always have a return of errors !!! -#define gdcmErrorBodyMacro(obj,msg) \ +// -> Rien compris! JPRx +#define gdcmErrorBodyMacro(obj, msg) \ { \ - gdcmMessageBodyMacro(gdcm::CMD_ERROR,obj,msg,""); \ + gdcmMessageBodyMacro(GDCM_NAME_SPACE::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 obj current instance or NULL * @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) \ +// -> Rien compris! JPRx +#define gdcmAssertBodyMacro(obj, arg) \ { \ if( !(arg) ) \ { \ - gdcmMessageBodyMacro(gdcm::CMD_ASSERT,obj,"",""); \ + gdcmMessageBodyMacro(GDCM_NAME_SPACE::CMD_ASSERT,obj,"","");\ assert ( arg ); \ } \ }