RemotePlayer/LocalPlayer Player base class proper separation (code cleanup) (patch...

[dragonfireclient.git] / src / debug.h

diff --git a/src/debug.h b/src/debug.h
index 1532be824a2918a048e5dc592078fb2dead14c5d..2098942db7ec17e457fa72fb8e88d50f5e3c9d40 100644 (file)
--- a/src/debug.h
+++ b/src/debug.h
@@ -22,7 +22,9 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 #include <iostream>
 #include <exception>
+#include <assert.h>
 #include "gettime.h"
+#include "log.h"
 
 #if (defined(WIN32) || defined(_WIN32_WCE))
        #define WIN32_LEAN_AND_MEAN
@@ -33,15 +35,15 @@ with this program; if not, write to the Free Software Foundation, Inc.,
        #ifdef _MSC_VER
                #include <eh.h>
        #endif
-       #define __NORETURN __declspec(noreturn)
-       #define __FUNCTION_NAME __FUNCTION__
+       #define NORETURN __declspec(noreturn)
+       #define FUNCTION_NAME __FUNCTION__
 #else
-       #define __NORETURN __attribute__ ((__noreturn__))
-       #define __FUNCTION_NAME __PRETTY_FUNCTION__
+       #define NORETURN __attribute__ ((__noreturn__))
+       #define FUNCTION_NAME __PRETTY_FUNCTION__
 #endif
 
 // Whether to catch all std::exceptions.
-// Assert will be called on such an event.
+// When "catching", the program will abort with an error message.
 // In debug mode, leave these for the debugger and don't catch them.
 #ifdef NDEBUG
        #define CATCH_UNHANDLED_EXCEPTIONS 1
@@ -49,43 +51,39 @@ with this program; if not, write to the Free Software Foundation, Inc.,
        #define CATCH_UNHANDLED_EXCEPTIONS 0
 #endif
 
-/*
-       Debug output
-*/
+/* Abort program execution immediately
+ */
+NORETURN extern void fatal_error_fn(
+               const char *msg, const char *file,
+               unsigned int line, const char *function);
 
-#define DTIME (getTimestamp()+": ")
+#define FATAL_ERROR(msg) \
+       fatal_error_fn((msg), __FILE__, __LINE__, FUNCTION_NAME)
 
-extern void debugstreams_init(bool disable_stderr, const char *filename);
-extern void debugstreams_deinit();
-
-// This is used to redirect output to /dev/null
-class Nullstream : public std::ostream {
-public:
-       Nullstream():
-               std::ostream(0)
-       {
-       }
-private:
-};
-
-extern std::ostream dstream;
-extern std::ostream dstream_no_stderr;
-extern Nullstream dummyout;
+#define FATAL_ERROR_IF(expr, msg) \
+       ((expr) \
+       ? fatal_error_fn((msg), __FILE__, __LINE__, FUNCTION_NAME) \
+       : (void)(0))
 
 /*
-       Assert
+       sanity_check()
+       Equivalent to assert() but persists in Release builds (i.e. when NDEBUG is
+       defined)
 */
 
-__NORETURN extern void assert_fail(
+NORETURN extern void sanity_check_fn(
                const char *assertion, const char *file,
                unsigned int line, const char *function);
 
-#define ASSERT(expr)\
-       ((expr)\
-       ? (void)(0)\
-       : assert_fail(#expr, __FILE__, __LINE__, __FUNCTION_NAME))
+#define SANITY_CHECK(expr) \
+       ((expr) \
+       ? (void)(0) \
+       : sanity_check_fn(#expr, __FILE__, __LINE__, FUNCTION_NAME))
+
+#define sanity_check(expr) SANITY_CHECK(expr)
 
-#define assert(expr) ASSERT(expr)
+
+void debug_set_exception_handler();
 
 /*
        DebugStack
@@ -110,13 +108,12 @@ class DebugStacker
        bool m_overflowed;
 };
 
-#define DSTACK(msg)\
+#define DSTACK(msg) \
        DebugStacker __debug_stacker(msg);
 
-#define DSTACKF(...)\
-       char __buf[DEBUG_STACK_TEXT_SIZE];\
-       snprintf(__buf,\
-                       DEBUG_STACK_TEXT_SIZE, __VA_ARGS__);\
+#define DSTACKF(...) \
+       char __buf[DEBUG_STACK_TEXT_SIZE];                   \
+       snprintf(__buf, DEBUG_STACK_TEXT_SIZE, __VA_ARGS__); \
        DebugStacker __debug_stacker(__buf);
 
 /*
@@ -124,38 +121,17 @@ class DebugStacker
 */
 
 #if CATCH_UNHANDLED_EXCEPTIONS == 1
-       #define BEGIN_PORTABLE_DEBUG_EXCEPTION_HANDLER try{
-       #define END_PORTABLE_DEBUG_EXCEPTION_HANDLER(logstream)\
-               }catch(std::exception &e){\
-                       logstream<<"ERROR: An unhandled exception occurred: "\
-                                       <<e.what()<<std::endl;\
-                       assert(0);\
+       #define BEGIN_DEBUG_EXCEPTION_HANDLER try {
+       #define END_DEBUG_EXCEPTION_HANDLER                        \
+               } catch (std::exception &e) {                          \
+                       errorstream << "An unhandled exception occurred: " \
+                               << e.what() << std::endl;                      \
+                       FATAL_ERROR(e.what());                             \
                }
-       #ifdef _WIN32 // Windows
-               #ifdef _MSC_VER // MSVC
-void se_trans_func(unsigned int, EXCEPTION_POINTERS*);
-                       #define BEGIN_DEBUG_EXCEPTION_HANDLER \
-                               BEGIN_PORTABLE_DEBUG_EXCEPTION_HANDLER\
-                               _set_se_translator(se_trans_func);
-
-                       #define END_DEBUG_EXCEPTION_HANDLER(logstream) \
-                               END_PORTABLE_DEBUG_EXCEPTION_HANDLER(logstream)
-               #else // Probably mingw
-                       #define BEGIN_DEBUG_EXCEPTION_HANDLER\
-                               BEGIN_PORTABLE_DEBUG_EXCEPTION_HANDLER
-                       #define END_DEBUG_EXCEPTION_HANDLER(logstream)\
-                               END_PORTABLE_DEBUG_EXCEPTION_HANDLER(logstream)
-               #endif
-       #else // Posix
-               #define BEGIN_DEBUG_EXCEPTION_HANDLER\
-                       BEGIN_PORTABLE_DEBUG_EXCEPTION_HANDLER
-               #define END_DEBUG_EXCEPTION_HANDLER(logstream)\
-                       END_PORTABLE_DEBUG_EXCEPTION_HANDLER(logstream)
-       #endif
 #else
        // Dummy ones
        #define BEGIN_DEBUG_EXCEPTION_HANDLER
-       #define END_DEBUG_EXCEPTION_HANDLER(logstream)
+       #define END_DEBUG_EXCEPTION_HANDLER
 #endif
 
 #endif // DEBUG_HEADER