Program: gdcm
Module: $RCSfile: gdcmDebug.h,v $
Language: C++
- Date: $Date: 2005/02/01 13:11:49 $
- Version: $Revision: 1.28 $
+ Date: $Date: 2008/04/10 12:15:36 $
+ Version: $Revision: 1.59 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
=========================================================================*/
-#ifndef GDCMDEBUG_H
-#define GDCMDEBUG_H
+#ifndef _GDCMDEBUG_H_
+#define _GDCMDEBUG_H_
#include "gdcmCommon.h"
+#include "gdcmCommand.h"
+#include <iostream>
#include <sstream>
#include <fstream>
#include <assert.h>
+#include <string.h> // strerror
#include <errno.h>
-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 show if the flag is on (DebugFlag)
+ * 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();
- /// 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 ();
- static void DebugOn () { SetDebugFlag(true); };
- static void DebugOff () { SetDebugFlag(false); };
-
- /// 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 DebugToFileOn () { SetDebugToFile(true); };
- static void DebugToFileOff () { SetDebugToFile(false); };
-
- /// 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);
-
- /// Internal use only. Allow us to retrieve the static from anywhere
- /// in gdcm code
- static std::ofstream &GetDebugFile ();
+ /// \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 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); }
+
+ 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);
+
+private:
+ static bool WarningFlag;
+ static bool LogFlag;
+ static bool DebugFlag;
+
+ static bool OutputToFile;
+
+ static std::ofstream OutputFileStream;
+ static std::ostream &StandardStream;
+
+ static const int LINE_LENGTH;
};
} // end namespace gdcm
#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 gdcmDebugMacro(msg)
+#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 Verbose
+ * \brief Log : we display messages when anything is not Dicom Kosher
+ * @param obj current instance or NULL
* @param msg message part
*/
-#ifdef NDEBUG
-#define gdcmVerboseMacro(msg) \
-{ \
+// 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,"");\
}
-#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; \
- } \
+#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 !!!
+// -> Rien compris! JPRx
+#define gdcmWarningBodyMacro(obj, msg) \
+{ \
+ if( Debug::GetWarningFlag() ) \
+ gdcmMessageBodyMacro(GDCM_NAME_SPACE::CMD_WARNING,obj,msg,"");\
}
-#endif //NDEBUG
+#define gdcmWarningMacro(msg) \
+ gdcmWarningBodyMacro(this,msg)
+#define gdcmStaticWarningMacro(msg) \
+ gdcmWarningBodyMacro(NULL,msg)
+
+// ------------------------------------------------------------------------
/**
- * \brief Error
+ * \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)
+//-----------------------------------------------------------------------------
#endif
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff