Program: gdcm
Module: $RCSfile: gdcmDebug.h,v $
Language: C++
- Date: $Date: 2005/01/12 21:53:32 $
- Version: $Revision: 1.20 $
+ Date: $Date: 2005/06/21 14:05:06 $
+ Version: $Revision: 1.35 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#include "gdcmCommon.h"
#include <sstream>
+#include <fstream>
#include <assert.h>
#include <errno.h>
//-----------------------------------------------------------------------------
/**
- * \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)
- * This is static var and can be set at begining of code:
+ * This is static var and can be set at beginning of code:
* gdcm::Debug::SetDebugOn();
*/
class GDCM_EXPORT Debug
{
public:
- /// This is a global flag that controls whether any debug, warning
- /// messages are displayed.
- static int GetDebugFlag ();
- static void SetDebugFlag (int flag);
- static void SetDebugOn () { SetDebugFlag(1); };
- static void SetDebugOff () { SetDebugFlag(0); };
+ 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); };
+
+ /// \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 SetDebugFilename (std::string const &filename);
+
+ static std::ofstream &GetDebugFile ();
};
} // end namespace gdcm
* \brief Debug
* @param msg message part
*/
-#define gdcmDebugMacro(msg) \
-{ \
- if( gdcm::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"; \
- std::cerr << osmacro.str() << std::endl; \
- } \
+#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
+ * \brief Warning
* @param msg message part
*/
-#define gdcmVerboseMacro(msg) \
+#ifdef NDEBUG
+#define gdcmWarningMacro(msg) {}
+#else
+#define gdcmWarningMacro(msg) \
{ \
- if( gdcm::Debug::GetDebugFlag() ) \
+ if( Debug::GetDebugFlag() ) \
{ \
std::ostringstream osmacro; \
- osmacro << "Verbose: In " __FILE__ ", line " << __LINE__ \
+ osmacro << "Warning: In " __FILE__ ", line " << __LINE__ \
<< ", function " << GDCM_FUNCTION << "\n" \
<< msg << "\n\n"; \
- std::cerr << osmacro.str() << std::endl; \
+ 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
*/
-#define gdcmErrorMacro(msg) \
-{ \
- if( gdcm::Debug::GetDebugFlag() ) \
- { \
- std::ostringstream osmacro; \
- osmacro << "Error: In " __FILE__ ", line " << __LINE__ \
- << ", function " << GDCM_FUNCTION << '\n' \
- << msg << "\n\n"; \
- std::cerr << osmacro.str() << std::endl; \
- exit(1); \
- } \
+#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
* An easy solution to pass also a message is to do:
* gdcmAssertMacro( "my message" && 2 < 3 )
*/
-#define gdcmAssertMacro(arg) \
-{ \
- if( !(arg) ) \
- { \
- std::ostringstream osmacro; \
- osmacro << "Assert: In " __FILE__ ", line " << __LINE__ \
- << ", function " << GDCM_FUNCTION \
- << "\n\n"; \
- std::cerr << osmacro.str() << std::endl; \
- assert ( arg ); \
- } \
+#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