3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
31 #define _WIN32_WINNT 0x0501
37 #define NORETURN __declspec(noreturn)
38 #define FUNCTION_NAME __FUNCTION__
40 #define NORETURN __attribute__ ((__noreturn__))
41 #define FUNCTION_NAME __PRETTY_FUNCTION__
44 // Whether to catch all std::exceptions.
45 // When "catching", the program will abort with an error message.
46 // In debug mode, leave these for the debugger and don't catch them.
48 #define CATCH_UNHANDLED_EXCEPTIONS 1
50 #define CATCH_UNHANDLED_EXCEPTIONS 0
53 /* Abort program execution immediately
55 NORETURN extern void fatal_error_fn(
56 const char *msg, const char *file,
57 unsigned int line, const char *function);
59 #define FATAL_ERROR(msg) \
60 fatal_error_fn((msg), __FILE__, __LINE__, FUNCTION_NAME)
62 #define FATAL_ERROR_IF(expr, msg) \
64 ? fatal_error_fn((msg), __FILE__, __LINE__, FUNCTION_NAME) \
69 Equivalent to assert() but persists in Release builds (i.e. when NDEBUG is
73 NORETURN extern void sanity_check_fn(
74 const char *assertion, const char *file,
75 unsigned int line, const char *function);
77 #define SANITY_CHECK(expr) \
80 : sanity_check_fn(#expr, __FILE__, __LINE__, FUNCTION_NAME))
82 #define sanity_check(expr) SANITY_CHECK(expr)
85 void debug_set_exception_handler();
91 #define DEBUG_STACK_SIZE 50
92 #define DEBUG_STACK_TEXT_SIZE 300
94 extern void debug_stacks_print_to(std::ostream &os);
95 extern void debug_stacks_print();
101 DebugStacker(const char *text);
109 #define DSTACK(msg) \
110 DebugStacker __debug_stacker(msg);
112 #define DSTACKF(...) \
113 char __buf[DEBUG_STACK_TEXT_SIZE]; \
114 snprintf(__buf, DEBUG_STACK_TEXT_SIZE, __VA_ARGS__); \
115 DebugStacker __debug_stacker(__buf);
118 These should be put into every thread
121 #if CATCH_UNHANDLED_EXCEPTIONS == 1
122 #define BEGIN_DEBUG_EXCEPTION_HANDLER try {
123 #define END_DEBUG_EXCEPTION_HANDLER \
124 } catch (std::exception &e) { \
125 errorstream << "An unhandled exception occurred: " \
126 << e.what() << std::endl; \
127 FATAL_ERROR(e.what()); \
131 #define BEGIN_DEBUG_EXCEPTION_HANDLER
132 #define END_DEBUG_EXCEPTION_HANDLER
135 #endif // DEBUG_HEADER