Add Lua on_mapgen_init callback, and minetest.set_mapgen_params API
[oweals/minetest.git] / src / debug.h
index 44fcf4b5150f83aa20312efdad2e1cd7d6140f91..31855cce705a9bcaed118919a6310e27c86a8eec 100644 (file)
@@ -1,27 +1,22 @@
 /*
-Minetest-c55
-Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
+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 General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+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 General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
+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.
 */
 
-
-/*
-       Debug stuff
-*/
-
 #ifndef DEBUG_HEADER
 #define DEBUG_HEADER
 
@@ -29,13 +24,40 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include <jmutex.h>
 #include <jmutexautolock.h>
 #include <iostream>
-#include "common_irrlicht.h"
+#include "irrlichttypes.h"
+#include <irrMap.h>
 #include "threads.h"
+#include "gettime.h"
+#include "exceptions.h"
+#include <map>
+
+#ifdef _WIN32
+       #define WIN32_LEAN_AND_MEAN
+       #ifndef _WIN32_WINNT
+               #define _WIN32_WINNT 0x0501
+       #endif
+       #include <windows.h>
+       #ifdef _MSC_VER
+               #include <eh.h>
+       #endif
+#else
+#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()+": ")
+
 #define DEBUGSTREAM_COUNT 2
 
 extern FILE *g_debugstreams[DEBUGSTREAM_COUNT];
@@ -69,21 +91,21 @@ public:
                        if(g_debugstreams[i] == stderr && m_disable_stderr)
                                continue;
                        if(g_debugstreams[i] != NULL)
-                               fwrite(&c, 1, 1, g_debugstreams[i]);
+                               (void)fwrite(&c, 1, 1, g_debugstreams[i]);
                        //TODO: Is this slow?
                        fflush(g_debugstreams[i]);
                }
                
                return c;
        }
-       int xsputn(const char *s, int n)
+       std::streamsize xsputn(const char *s, std::streamsize n)
        {
                for(int i=0; i<DEBUGSTREAM_COUNT; i++)
                {
                        if(g_debugstreams[i] == stderr && m_disable_stderr)
                                continue;
                        if(g_debugstreams[i] != NULL)
-                               fwrite(s, 1, n, g_debugstreams[i]);
+                               (void)fwrite(s, 1, n, g_debugstreams[i]);
                        //TODO: Is this slow?
                        fflush(g_debugstreams[i]);
                }
@@ -136,6 +158,7 @@ struct DebugStack
 {
        DebugStack(threadid_t id);
        void print(FILE *file, bool everything);
+       void print(std::ostream &os, bool everything);
        
        threadid_t threadid;
        char stack[DEBUG_STACK_SIZE][DEBUG_STACK_TEXT_SIZE];
@@ -143,10 +166,11 @@ struct DebugStack
        int stack_max_i; // Highest i that was seen
 };
 
-extern core::map<threadid_t, DebugStack*> g_debug_stacks;
+extern std::map<threadid_t, DebugStack*> g_debug_stacks;
 extern JMutex g_debug_stacks_mutex;
 
 extern void debug_stacks_init();
+extern void debug_stacks_print_to(std::ostream &os);
 extern void debug_stacks_print();
 
 class DebugStacker
@@ -160,7 +184,10 @@ private:
        bool m_overflowed;
 };
 
-#define DSTACK(...)\
+#define DSTACK(msg)\
+       DebugStacker __debug_stacker(msg);
+
+#define DSTACKF(...)\
        char __buf[DEBUG_STACK_TEXT_SIZE];\
        snprintf(__buf,\
                        DEBUG_STACK_TEXT_SIZE, __VA_ARGS__);\
@@ -179,44 +206,90 @@ public:
 
        void add(u16 command)
        {
-               core::map<u16, u16>::Node *n = m_packets.find(command);
-               if(n == NULL)
+               std::map<u16, u16>::iterator n = m_packets.find(command);
+               if(n == m_packets.end())
                {
                        m_packets[command] = 1;
                }
                else
                {
-                       n->setValue(n->getValue()+1);
+                       n->second++;
                }
        }
 
        void clear()
        {
-               for(core::map<u16, u16>::Iterator
-                               i = m_packets.getIterator();
-                               i.atEnd() == false; i++)
+               for(std::map<u16, u16>::iterator
+                               i = m_packets.begin();
+                               i != m_packets.end(); ++i)
                {
-                       i.getNode()->setValue(0);
+                       i->second = 0;
                }
        }
 
        void print(std::ostream &o)
        {
-               for(core::map<u16, u16>::Iterator
-                               i = m_packets.getIterator();
-                               i.atEnd() == false; i++)
+               for(std::map<u16, u16>::iterator
+                               i = m_packets.begin();
+                               i != m_packets.end(); ++i)
                {
-                       o<<"cmd "<<i.getNode()->getKey()
-                                       <<" count "<<i.getNode()->getValue()
+                       o<<"cmd "<<i->first
+                                       <<" count "<<i->second
                                        <<std::endl;
                }
        }
 
 private:
        // command, count
-       core::map<u16, u16> m_packets;
+       std::map<u16, u16> m_packets;
 };
 
+/*
+       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*);
+
+class FatalSystemException : public BaseException
+{
+public:
+       FatalSystemException(const char *s):
+               BaseException(s)
+       {}
+};
+                       #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