2 Copyright (C) 2001-2006, William Joseph.
5 This file is part of GtkRadiant.
7 GtkRadiant is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 GtkRadiant is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GtkRadiant; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #if !defined(INCLUDED_DEBUGGING_DEBUGGING_H)
23 #define INCLUDED_DEBUGGING_DEBUGGING_H
26 /// \brief Debugging macros for fatal error/assert messages.
28 #include "stream/textstream.h"
30 #include "generic/static.h"
32 #if defined(_MSC_VER) && defined(_M_IX86)
33 #define DEBUGGER_BREAKPOINT() __asm { int 3 }
34 #elif defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
35 #define DEBUGGER_BREAKPOINT() __asm__ __volatile__ ("int $03")
39 #define DEBUGGER_BREAKPOINT() raise(SIGTRAP);
43 #define FILE_LINE __FILE__ ":" << __LINE__
45 #if defined(_DEBUG) || 1
49 class DebugMessageHandler
52 virtual TextOutputStream& getOutputStream() = 0;
53 virtual bool handleMessage() = 0;
56 class NullDebugMessageHandler : public NullOutputStream, public DebugMessageHandler
59 virtual TextOutputStream& getOutputStream()
63 virtual bool handleMessage()
69 class DefaultDebugMessageHandler : public DebugMessageHandler
72 virtual TextOutputStream& getOutputStream()
74 return globalErrorStream();
76 virtual bool handleMessage()
79 return false; // send debug-break
86 class DebugMessageHandlerRef : public DefaultDebugMessageHandler
88 DebugMessageHandler* m_handler;
90 DebugMessageHandlerRef()
94 void setHandler(DebugMessageHandler& handler)
98 DebugMessageHandler& getHandler()
104 typedef Static<DebugMessageHandlerRef> GlobalDebugMessageHandler;
106 inline DebugMessageHandler& globalDebugMessageHandler()
108 return GlobalDebugMessageHandler::instance().getHandler();
111 #if defined(DEBUG_ASSERTS)
113 /// \brief Sends a \p message to the current debug-message-handler text-output-stream if \p condition evaluates to false.
114 #define ASSERT_MESSAGE(condition, message)\
117 globalDebugMessageHandler().getOutputStream() << FILE_LINE << "\nassertion failure: " << message << "\n";\
118 if(!globalDebugMessageHandler().handleMessage()) { DEBUGGER_BREAKPOINT(); }\
121 /// \brief Sends a \p message to the current debug-message-handler text-output-stream.
122 #define ERROR_MESSAGE(message)\
123 globalDebugMessageHandler().getOutputStream() << FILE_LINE << "\nruntime error: " << message << "\n";\
124 if(!globalDebugMessageHandler().handleMessage()) { DEBUGGER_BREAKPOINT(); } else\
126 #define ASSERT_NOTNULL(ptr) ASSERT_MESSAGE(ptr != 0, "pointer \"" #ptr "\" is null")
130 #define ASSERT_MESSAGE(condition, message)
131 #define ERROR_MESSAGE(message)
132 #define ASSERT_NOTNULL(ptr)