1 /*=========================================================================
4 Module: $RCSfile: gdcmDebug.h,v $
6 Date: $Date: 2005/01/20 11:07:07 $
7 Version: $Revision: 1.24 $
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 //-----------------------------------------------------------------------------
35 * \brief Debug is an object for debugging in program.
36 * It has 2 debugging modes :
37 * - error : for bad library use, seriously wrong DICOM
38 * - debug : for information/debug messages
39 * - warning : for warning about DICOM quality (kosher)
41 * A debugging message is only show if the flag is on (DebugFlag)
42 * This is static var and can be set at begining of code:
43 * gdcm::Debug::SetDebugOn();
45 class GDCM_EXPORT Debug
48 /// This is a global flag that controls whether any debug, warning
49 /// messages are displayed.
50 static bool GetDebugFlag ();
51 static void SetDebugFlag (bool flag);
52 static void SetDebugOn () { SetDebugFlag(true); };
53 static void SetDebugOff () { SetDebugFlag(false); };
55 /// This is a global flag that controls if debug are redirected
57 static bool GetDebugToFile ();
58 static void SetDebugToFile (bool flag);
59 static void SetDebugToFileOn () { SetDebugToFile(true); };
60 static void SetDebugToFileOff () { SetDebugToFile(false); };
62 /// Set the filename the debug stream should be redirect to
63 /// Settting a filename also set DebugToFile to true
64 static void SetDebugFilename (std::string const& filename);
66 /// Internal use only. Allow us to retrieve the static from anywhere
68 static std::ofstream & GetDebugFile ();
71 } // end namespace gdcm
73 // Here we define function this is the only way to be able to pass
74 // stuff with indirection like:
75 // gdcmDebug( "my message:" << i << '\t' );
76 // You cannot use function unless you use vnsprintf ...
78 // __FUNCTION is not always defined by preprocessor
79 // In c++ we should use __PRETTY_FUNCTION__ instead...
80 #ifdef GDCM_COMPILER_HAS_FUNCTION
81 // Handle particular case for GNU C++ which also defines __PRETTY_FUNCTION__
82 // which is a lot nice in C++
84 # define __FUNCTION__ __FUNC__
87 # define GDCM_FUNCTION __PRETTY_FUNCTION__
89 # define GDCM_FUNCTION __FUNCTION__
92 # define GDCM_FUNCTION "<unknow>"
93 #endif //GDCM_COMPILER_HAS_FUNCTION
97 * @param msg message part
100 #define gdcmDebugMacro(msg)
102 #define gdcmDebugMacro(msg) \
104 if( Debug::GetDebugFlag() ) \
106 std::ostringstream osmacro; \
107 osmacro << "Debug: In " __FILE__ ", line " << __LINE__ \
108 << ", function " << GDCM_FUNCTION << '\n' \
109 << "Last system error was: " << strerror(errno) \
110 << '\n' << msg << "\n\n"; \
111 if( Debug::GetDebugToFile() ) \
112 Debug::GetDebugFile() << osmacro.str() << std::endl; \
114 std::cerr << osmacro.str() << std::endl; \
121 * @param msg message part
124 #define gdcmVerboseMacro(msg) \
128 #define gdcmVerboseMacro(msg) \
130 if( Debug::GetDebugFlag() ) \
132 std::ostringstream osmacro; \
133 osmacro << "Verbose: In " __FILE__ ", line " << __LINE__ \
134 << ", function " << GDCM_FUNCTION << "\n" \
136 if( Debug::GetDebugToFile() ) \
137 Debug::GetDebugFile() << osmacro.str() << std::endl; \
139 std::cerr << osmacro.str() << std::endl; \
146 * @param msg second message part
149 #define gdcmErrorMacro(msg)
151 #define gdcmErrorMacro(msg) \
153 std::ostringstream osmacro; \
154 osmacro << "Error: In " __FILE__ ", line " << __LINE__ \
155 << ", function " << GDCM_FUNCTION << '\n' \
157 if( Debug::GetDebugToFile() ) \
158 Debug::GetDebugFile() << osmacro.str() << std::endl; \
160 std::cerr << osmacro.str() << std::endl; \
166 * @param arg argument to test
167 * An easy solution to pass also a message is to do:
168 * gdcmAssertMacro( "my message" && 2 < 3 )
171 #define gdcmAssertMacro(arg)
173 #define gdcmAssertMacro(arg) \
177 std::ostringstream osmacro; \
178 osmacro << "Assert: In " __FILE__ ", line " << __LINE__ \
179 << ", function " << GDCM_FUNCTION \
181 if( Debug::GetDebugToFile() ) \
182 Debug::GetDebugFile() << osmacro.str() << std::endl; \
184 std::cerr << osmacro.str() << std::endl; \