172 lines
4.1 KiB
C++
172 lines
4.1 KiB
C++
/*
|
|
Minetest
|
|
Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU Lesser General Public License as published by
|
|
the Free Software Foundation; either version 2.1 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public License along
|
|
with this program; if not, write to the Free Software Foundation, Inc.,
|
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
|
|
#ifndef DEBUG_HEADER
|
|
#define DEBUG_HEADER
|
|
|
|
#include <iostream>
|
|
#include <exception>
|
|
#include "gettime.h"
|
|
|
|
#if (defined(WIN32) || defined(_WIN32_WCE))
|
|
#define WIN32_LEAN_AND_MEAN
|
|
#ifndef _WIN32_WINNT
|
|
#define _WIN32_WINNT 0x0501
|
|
#endif
|
|
#include <windows.h>
|
|
#ifdef _MSC_VER
|
|
#include <eh.h>
|
|
#endif
|
|
#define __NORETURN __declspec(noreturn)
|
|
#define __FUNCTION_NAME __FUNCTION__
|
|
#else
|
|
#define __NORETURN __attribute__ ((__noreturn__))
|
|
#define __FUNCTION_NAME __PRETTY_FUNCTION__
|
|
#endif
|
|
|
|
// Whether to catch all std::exceptions.
|
|
// Assert will be called on such an event.
|
|
// In debug mode, leave these for the debugger and don't catch them.
|
|
#ifdef NDEBUG
|
|
#define CATCH_UNHANDLED_EXCEPTIONS 1
|
|
#else
|
|
#define CATCH_UNHANDLED_EXCEPTIONS 0
|
|
#endif
|
|
|
|
/*
|
|
Debug output
|
|
*/
|
|
|
|
#define DTIME (getTimestamp()+": ")
|
|
|
|
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;
|
|
|
|
/*
|
|
Include assert.h and immediately undef assert so that it can't override
|
|
our assert later on. leveldb/slice.h is a notable offender.
|
|
*/
|
|
|
|
#include <assert.h>
|
|
#undef assert
|
|
|
|
/*
|
|
Assert
|
|
*/
|
|
|
|
__NORETURN extern void assert_fail(
|
|
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 assert(expr) ASSERT(expr)
|
|
|
|
/*
|
|
DebugStack
|
|
*/
|
|
|
|
#define DEBUG_STACK_SIZE 50
|
|
#define DEBUG_STACK_TEXT_SIZE 300
|
|
|
|
extern void debug_stacks_init();
|
|
extern void debug_stacks_print_to(std::ostream &os);
|
|
extern void debug_stacks_print();
|
|
|
|
struct DebugStack;
|
|
class DebugStacker
|
|
{
|
|
public:
|
|
DebugStacker(const char *text);
|
|
~DebugStacker();
|
|
|
|
private:
|
|
DebugStack *m_stack;
|
|
bool m_overflowed;
|
|
};
|
|
|
|
#define DSTACK(msg)\
|
|
DebugStacker __debug_stacker(msg);
|
|
|
|
#define DSTACKF(...)\
|
|
char __buf[DEBUG_STACK_TEXT_SIZE];\
|
|
snprintf(__buf,\
|
|
DEBUG_STACK_TEXT_SIZE, __VA_ARGS__);\
|
|
DebugStacker __debug_stacker(__buf);
|
|
|
|
/*
|
|
These should be put into every thread
|
|
*/
|
|
|
|
#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);\
|
|
}
|
|
#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)
|
|
#endif
|
|
|
|
#endif // DEBUG_HEADER
|
|
|
|
|