X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDebug.h;h=06a9654dbd9ba8eaf64d7716cd589f6520eb9be3;hb=713d0f3d28a6176fab6d57e031633061dc7354a7;hp=c7f7d65f6cda9230b9b20370108f69610129aa77;hpb=1e670813be403bc4ecd88fb78405d0a8969fca6c;p=gdcm.git diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h index c7f7d65f..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/09/02 07:10:03 $ - Version: $Revision: 1.42 $ + 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,61 +16,121 @@ =========================================================================*/ -#ifndef GDCMDEBUG_H -#define GDCMDEBUG_H +#ifndef _GDCMDEBUG_H_ +#define _GDCMDEBUG_H_ #include "gdcmCommon.h" +#include "gdcmCommand.h" +#include #include #include #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: Debug(); ~Debug(); - /// \brief 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 (); + /// \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 + /// 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; } + /// \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 SetDebugToFile (bool flag); - static bool GetDebugToFile (); + static void SetOutputToFile (bool flag); + static bool GetOutputToFile (); /// \brief Next debug messages will be sent in the debug file - static void DebugToFileOn () { SetDebugToFile(true); } + static void OutputToFileOn () { SetOutputToFile(true); } /// \brief Next debug messages will be sent in the standard output - static void DebugToFileOff () { SetDebugToFile(false); } + 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); - static void SetDebugFilename (std::string const &filename); +private: + static bool WarningFlag; + static bool LogFlag; + static bool DebugFlag; - static std::ofstream &GetDebugFile (); + static bool OutputToFile; + + static std::ofstream OutputFileStream; + static std::ostream &StandardStream; + + static const int LINE_LENGTH; }; } // end namespace gdcm @@ -98,154 +158,135 @@ public: #endif //GDCM_COMPILER_HAS_FUNCTION /** - * \brief Debug + * \brief Debug : To be used to help bug tracking developer + * @param type type + * @param obj obj + * @param msg message part + * @param adds adds + */ +#define gdcmMessageBodyMacro(type, obj, msg, adds) \ +{ \ + std::ostringstream osmacro; \ + osmacro << "In " __FILE__ ", line " << __LINE__ \ + << ", function " << GDCM_FUNCTION << "\n" \ + << adds << msg << "\n\n"; \ + 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 gdcmDebugMacro(msg) {} +#define gdcmStaticDebugMacro(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 gdcmDebugBodyMacro(obj, msg) \ +{ \ + if( Debug::GetDebugFlag() ) \ + { \ + std::string adds=""; \ + if( errno ) \ + { \ + adds = "Last system error was: "; \ + adds += strerror(errno); \ + adds += "\n"; \ + } \ + gdcmMessageBodyMacro(GDCM_NAME_SPACE::CMD_DEBUG,obj,msg,adds);\ + } \ } +#define gdcmDebugMacro(msg) \ + gdcmDebugBodyMacro(NULL,msg) +#define gdcmStaticDebugMacro(msg) \ + gdcmDebugBodyMacro(NULL,msg) #endif //NDEBUG +// ------------------------------------------------------------------------ + /** - * \brief Warning + * \brief Log : we display messages when anything is not Dicom Kosher + * @param obj current instance or NULL * @param msg message part */ -#ifdef NDEBUG -#define gdcmWarningMacro(msg) {} -#else -#define gdcmWarningMacro(msg) \ -{ \ - if( Debug::GetDebugFlag() ) \ - { \ - std::ostringstream osmacro; \ - 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; \ - } \ +// 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,"");\ } -#endif //NDEBUG +#define gdcmLogMacro(msg) \ + gdcmLogBodyMacro(this,msg) +#define gdcmStaticLogMacro(msg) \ + gdcmLogBodyMacro(NULL,msg) + +// ------------------------------------------------------------------------ /** - * \brief Error + * \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 !!! +// -> Rien compris! JPRx +#define gdcmWarningBodyMacro(obj, msg) \ +{ \ + if( Debug::GetWarningFlag() ) \ + 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 */ -#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_NAME_SPACE::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 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 ) */ -#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_NAME_SPACE::CMD_ASSERT,obj,"","");\ + assert ( arg ); \ + } \ } -#endif //NDEBUG +#define gdcmAssertMacro(msg) \ + gdcmAssertBodyMacro(NULL,msg) +#define gdcmStaticAssertMacro(msg) \ + gdcmAssertBodyMacro(NULL,msg) //----------------------------------------------------------------------------- -// -// Define GDCM_LEGACY macro to mark legacy methods where they are -// declared in their class. -// -// WARNING : Don't try to use it with 'inline' methods ! -// -//Example usage: -// -// // @deprecated Replaced by MyOtherMethod() as of gdcm 2.0. -// GDCM_LEGACY(void MyMethod()); -#if defined(GDCM_LEGACY_REMOVE) - // Remove legacy methods completely. -# define GDCM_LEGACY(method) -#elif defined(GDCM_LEGACY_SILENT) || defined(SWIG) - // Provide legacy methods with no warnings. -# define GDCM_LEGACY(method) method -#else - // Setup compile-time warnings for uses of deprecated methods if - // possible on this compiler. -# if defined(__GNUC__) && !defined(__INTEL_COMPILER) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)) -#if defined(__APPLE__) && (__GNUC__ == 3) && (__GNUC_MINOR__ == 3) -// Seems like there is a bug in APPLE gcc for deprecated attribute and ctor -// This is fixed in g++ 4.0 (Tiger) -# define GDCM_LEGACY(method) method -#else -# define GDCM_LEGACY(method) method __attribute__((deprecated)) -#endif -# elif defined(_MSC_VER) && _MSC_VER >= 1300 -# define GDCM_LEGACY(method) __declspec(deprecated) method -# else -# define GDCM_LEGACY(method) method -# endif -#endif - -// Macros to create runtime deprecation warning messages in function -// bodies. Example usage: -// -// void MyClass::MyOldMethod() -// { -// GDCM_LEGACY_BODY(MyClass::MyOldMethod, 2.0); -// } -// -// void MyClass::MyMethod() -// { -// GDCM_LEGACY_REPLACED_BODY(MyClass::MyMethod, 5.0, -// MyClass::MyOtherMethod); -// } -#if defined(GDCM_LEGACY_REMOVE) || defined(GDCM_LEGACY_SILENT) -# define GDCM_LEGACY_BODY(method, version) -# define GDCM_LEGACY_REPLACED_BODY(method, version, replace) -#else -# define GDCM_LEGACY_BODY(method, version) \ - gdcmWarningMacro(#method " was deprecated for gdcm" #version " and will be removed in a future version.") -# define GDCM_LEGACY_REPLACED_BODY(method, version, replace) \ - gdcmWarningMacro(#method " was deprecated for gdcm" #version " and will be removed in a future version. Use " #replace " instead.") -#endif - #endif