1 /*=========================================================================
4 Module: $RCSfile: gdcmDebug.h,v $
6 Date: $Date: 2005/02/01 13:11:49 $
7 Version: $Revision: 1.28 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See Doc/License.txt or
11 http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
22 #include "gdcmCommon.h"
31 //-----------------------------------------------------------------------------
34 * \brief Debug is an object for debugging in program.
35 * It has 2 debugging modes :
36 * - error : for bad library use, seriously wrong DICOM
37 * - debug : for information/debug messages
38 * - warning : for warning about DICOM quality (kosher)
40 * A debugging message is only show if the flag is on (DebugFlag)
41 * This is static var and can be set at beginning of code:
42 * gdcm::Debug::SetDebugOn();
44 class GDCM_EXPORT Debug
50 /// This is a global flag that controls whether any debug, warning
51 /// messages are displayed.
52 static void SetDebugFlag (bool flag);
53 static bool GetDebugFlag ();
54 static void DebugOn () { SetDebugFlag(true); };
55 static void DebugOff () { SetDebugFlag(false); };
57 /// This is a global flag that controls if debug are redirected
59 static void SetDebugToFile (bool flag);
60 static bool GetDebugToFile ();
61 static void DebugToFileOn () { SetDebugToFile(true); };
62 static void DebugToFileOff () { SetDebugToFile(false); };
64 /// Set the filename the debug stream should be redirect to
65 /// Settting a filename also set DebugToFile to true
66 static void SetDebugFilename (std::string const& filename);
68 /// Internal use only. Allow us to retrieve the static from anywhere
70 static std::ofstream &GetDebugFile ();
73 } // end namespace gdcm
75 // Here we define function this is the only way to be able to pass
76 // stuff with indirection like:
77 // gdcmDebug( "my message:" << i << '\t' );
78 // You cannot use function unless you use vnsprintf ...
80 // __FUNCTION is not always defined by preprocessor
81 // In c++ we should use __PRETTY_FUNCTION__ instead...
82 #ifdef GDCM_COMPILER_HAS_FUNCTION
83 // Handle particular case for GNU C++ which also defines __PRETTY_FUNCTION__
84 // which is a lot nice in C++
86 # define __FUNCTION__ __FUNC__
89 # define GDCM_FUNCTION __PRETTY_FUNCTION__
91 # define GDCM_FUNCTION __FUNCTION__
94 # define GDCM_FUNCTION "<unknow>"
95 #endif //GDCM_COMPILER_HAS_FUNCTION
99 * @param msg message part
102 #define gdcmDebugMacro(msg)
104 #define gdcmDebugMacro(msg) \
106 if( Debug::GetDebugFlag() ) \
108 std::ostringstream osmacro; \
109 osmacro << "Debug: In " __FILE__ ", line " << __LINE__ \
110 << ", function " << GDCM_FUNCTION << '\n' \
111 << "Last system error was: " << strerror(errno) \
112 << '\n' << msg << "\n\n"; \
113 if( Debug::GetDebugToFile() ) \
114 Debug::GetDebugFile() << osmacro.str() << std::endl; \
116 std::cerr << osmacro.str() << std::endl; \
123 * @param msg message part
126 #define gdcmVerboseMacro(msg) \
130 #define gdcmVerboseMacro(msg) \
132 if( Debug::GetDebugFlag() ) \
134 std::ostringstream osmacro; \
135 osmacro << "Verbose: In " __FILE__ ", line " << __LINE__ \
136 << ", function " << GDCM_FUNCTION << "\n" \
138 if( Debug::GetDebugToFile() ) \
139 Debug::GetDebugFile() << osmacro.str() << std::endl; \
141 std::cerr << osmacro.str() << std::endl; \
148 * @param msg second message part
151 #define gdcmErrorMacro(msg)
153 #define gdcmErrorMacro(msg) \
155 std::ostringstream osmacro; \
156 osmacro << "Error: In " __FILE__ ", line " << __LINE__ \
157 << ", function " << GDCM_FUNCTION << '\n' \
159 if( Debug::GetDebugToFile() ) \
160 Debug::GetDebugFile() << osmacro.str() << std::endl; \
162 std::cerr << osmacro.str() << std::endl; \
168 * @param arg argument to test
169 * An easy solution to pass also a message is to do:
170 * gdcmAssertMacro( "my message" && 2 < 3 )
173 #define gdcmAssertMacro(arg)
175 #define gdcmAssertMacro(arg) \
179 std::ostringstream osmacro; \
180 osmacro << "Assert: In " __FILE__ ", line " << __LINE__ \
181 << ", function " << GDCM_FUNCTION \
183 if( Debug::GetDebugToFile() ) \
184 Debug::GetDebugFile() << osmacro.str() << std::endl; \
186 std::cerr << osmacro.str() << std::endl; \