Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/ai/src/libraries/util/SignalHandler.h @ 7763

Last change on this file since 7763 was 7457, checked in by landauf, 14 years ago

show file name and line number in the call stack (works only with msvc)
hack-fix for wrong call stack when calling some "noreturn" functions (e.g. _assert())
some cleanup

  • Property svn:eol-style set to native
File size: 4.1 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Christoph Renner
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file
31    @ingroup Util
32    @brief Declaration of the SignalHandler class.
33*/
34
35#ifndef _SignalHandler_H__
36#define _SignalHandler_H__
37
38#include "UtilPrereqs.h"
39
40#include <cassert>
41#include <string>
42
43#include "Singleton.h"
44#include "SpecialConfig.h"
45
46#if defined(ORXONOX_PLATFORM_LINUX)
47
48#include <list>
49#include <signal.h>
50
51namespace orxonox
52{
53    typedef int (*SignalCallback)( void * someData );
54
55    struct SignalRec
56    {
57        int signal;
58        sig_t handler;
59    };
60
61    struct SignalCallbackRec
62    {
63        SignalCallback cb;
64        void * someData;
65    };
66
67
68    typedef std::list<SignalRec> SignalRecList;
69    typedef std::list<SignalCallbackRec> SignalCallbackList;
70
71    /// The SignalHandler is used to catch signals like SIGSEGV and write a backtrace to the logfile.
72    class SignalHandler : public Singleton<SignalHandler>
73    {
74        friend class Singleton<SignalHandler>;
75
76        public:
77            void registerCallback( SignalCallback cb, void * someData );
78
79            void doCatch( const std::string & appName, const std::string & filename );
80            void dontCatch();
81
82        private:
83            static void sigHandler( int sig );
84
85            void catchSignal( int sig );
86            SignalRecList sigRecList;
87
88            SignalCallbackList callbackList;
89
90            static SignalHandler* singletonPtr_s;
91
92            std::string appName;
93            std::string filename;
94    };
95}
96
97#elif defined(ORXONOX_PLATFORM_WINDOWS) && defined(DBGHELP_FOUND)
98
99#include <windows.h>
100
101namespace orxonox
102{
103    /// The SignalHandler is used to catch unhandled exceptions like access violations and write a backtrace to the logfile.
104    class _UtilExport SignalHandler : public Singleton<SignalHandler>
105    {
106        friend class Singleton<SignalHandler>;
107
108        public:
109            SignalHandler();
110            ~SignalHandler();
111
112            void doCatch(const std::string& appName, const std::string& filename);
113
114            static std::string getStackTrace(PEXCEPTION_POINTERS pExceptionInfo = NULL);
115            static std::string getExceptionType(PEXCEPTION_POINTERS pExceptionInfo);
116
117        private:
118            static LONG WINAPI exceptionFilter(PEXCEPTION_POINTERS pExceptionInfo);
119
120            static std::string getModuleName(const std::string& path);
121            static DWORD getModuleBase(DWORD dwAddress);
122
123            template <typename T>
124            static std::string pointerToString(T pointer, bool bFillZeros = true);
125            template <typename T>
126            static std::string pointerToString(T* pointer);
127
128            static SignalHandler* singletonPtr_s;
129
130            std::string filename_;
131            LPTOP_LEVEL_EXCEPTION_FILTER prevExceptionFilter_;
132    };
133}
134
135#else
136
137namespace orxonox
138{
139    /// The SignalHandler is used to catch signals like SIGSEGV and write a backtrace to the logfile. Not implemented on systems except Linux and Windows.
140    class _UtilExport SignalHandler : public Singleton<SignalHandler>
141    {
142        friend class Singleton<SignalHandler>;
143
144        public:
145            void doCatch(const std::string& appName, const std::string& filename) {}
146
147        private:
148            static SignalHandler* singletonPtr_s;
149    };
150}
151
152#endif
153
154#endif /* _SignalHandler_H__ */
Note: See TracBrowser for help on using the repository browser.