Program: gdcm
Module: $RCSfile: gdcmDebug.h,v $
Language: C++
- Date: $Date: 2004/09/24 03:34:27 $
- Version: $Revision: 1.6 $
+ Date: $Date: 2005/01/13 22:39:15 $
+ Version: $Revision: 1.23 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
- http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+ http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
#include "gdcmCommon.h"
+#include <sstream>
+#include <fstream>
+#include <assert.h>
+#include <errno.h>
+
+namespace gdcm
+{
//-----------------------------------------------------------------------------
/**
- * \ingroup gdcmDebug
- * \brief gdcmDebug is an object for debugging in program.
+ * \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)
*
- * 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 show if the flag is on (DebugFlag)
+ * This is static var and can be set at begining of code:
+ * gdcm::Debug::SetDebugOn();
*/
-class GDCM_EXPORT gdcmDebug
+class GDCM_EXPORT Debug
{
public:
- gdcmDebug(int level = -1);
+ /// This is a global flag that controls whether any debug, warning
+ /// messages are displayed.
+ static bool GetDebugFlag ();
+ static void SetDebugFlag (bool flag);
+ static void SetDebugOn () { SetDebugFlag(true); };
+ static void SetDebugOff () { SetDebugFlag(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 = "");
+ /// This is a global flag that controls if debug are redirected
+ /// to a file or not
+ static bool GetDebugToFile ();
+ static void SetDebugToFile (bool flag);
+ static void SetDebugToFileOn () { SetDebugToFile(true); };
+ static void SetDebugToFileOff () { SetDebugToFile(false); };
- void Assert(int level, bool test, const char * msg1, const char * msg2);
- void Exit(int a);
+ /// 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);
- static gdcmDebug &GetReference();
+ /// Internal use only. Allow us to retrieve the static from anywhere
+ /// in gdcm code
+ static std::ofstream & GetDebugFile ();
+};
-private:
-/// warning message level to be displayed
- int DebugLevel;
+} // end namespace gdcm
-};
+// 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 "<unknow>"
+#endif //GDCM_COMPILER_HAS_FUNCTION
+
+/**
+ * \brief Debug
+ * @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; \
+ } \
+}
+#endif //NDEBUG
-/// Instance of debugging utility.
-static gdcmDebug dbg;
+/**
+ * \brief Verbose
+ * @param msg message part
+ */
+#ifdef NDEBUG
+#define gdcmVerboseMacro(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; \
+ } \
+}
+#endif //NDEBUG
+
+/**
+ * \brief Error
+ * @param msg second message part
+ */
+#ifdef NDEBUG
+#define gdcmErrorMacro(msg)
+#else
+#define gdcmErrorMacro(msg) \
+{ \
+ if( Debug::GetDebugFlag() ) \
+ { \
+ 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; \
+ exit(1); \
+ } \
+}
+#endif //NDEBUG
+
+/**
+ * \brief Assert
+ * @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 ); \
+ } \
+}
+#endif //NDEBUG
#endif
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff