Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/src/libraries/util/Exception.h @ 7331

Last change on this file since 7331 was 7297, checked in by landauf, 14 years ago

fixed lots of Doxygen warnings

Note: Doxygen prints a warning if only a part of the parameters of a function are documented.

Added documentation for missing parameters (as good as I could), removed documentation of obsolete parameters and fixed names of renamed parameters.
Some parameters are tagged with "FIXME", please replace this with an appropriate documentation if you know what it does.

  • Property svn:eol-style set to native
File size: 7.3 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 *      Reto Grieder
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30@file
31@brief
32    Declaration of facilities to handle exceptions.
33*/
34
35#ifndef _Exception_H__
36#define _Exception_H__
37
38#include "UtilPrereqs.h"
39
40#include <exception>
41#include <sstream>
42#include <string>
43#include "Debug.h"
44
45namespace orxonox
46{
47    /**
48    @brief
49        Base class for all exceptions (derived from std::exception).
50    @details
51        This class provides support for information about the file, the line
52        and the function the error occured.
53    */
54    class _UtilExport Exception : public std::exception
55    {
56    public:
57        /**
58        @brief
59            Creates the exception but doesn't yet compose the full descrption (because of the virtual functions)
60        @param description
61            Exception description as string. This message is supposed to help developers!
62        @param lineNumber
63            The number of the code-line in which the exception occurred
64        @param filename
65            The file in which the exception occurred
66        @param functionName
67            The function in which the exception occurred
68        */
69        Exception(const std::string& description, unsigned int lineNumber,
70                  const char* filename, const char* functionName);
71        //! Simplified constructor with just a description. If you need more, use the other one.
72        Exception(const std::string& description);
73
74        //! Needed for compatibility with std::exception
75        virtual ~Exception() throw() { }
76        const char* what() const throw();
77
78        //! Returns a full description with type, line, file and function
79        virtual const std::string& getFullDescription() const;
80        //! Returns the string name of the exception type
81        virtual std::string        getTypeName()        const = 0;
82        //! Returns the short developer written exception
83        virtual const std::string& getDescription()     const { return this->description_; }
84        //! Returns the line number on which the exception occurred.
85        virtual const unsigned int getLineNumber()      const { return this->lineNumber_; }
86        //! Returns the function in which the exception occurred.
87        virtual const std::string& getFunctionName()    const { return this->functionName_; }
88        //! Returns the filename in which the exception occurred.
89        virtual const std::string& getFilename()        const { return this->filename_; }
90
91        /**
92        @brief
93            Retrieves information from an exception caught with "..."
94            Works for std::exception and CEGUI::Exception
95        @remarks
96            Never ever call this function without an exception in the stack!
97        */
98        static std::string handleMessage();
99
100    protected:
101        std::string description_;             //!< User typed text about why the exception occurred
102        unsigned int lineNumber_;             //!< Line on which the exception occurred
103        std::string functionName_;            //!< Function (including namespace and class) where the exception occurred
104        std::string filename_;                //!< File where the exception occurred
105        // mutable because "what()" is a const method
106        mutable std::string fullDescription_; //!< Full description with line, file and function
107    };
108
109//! Creates a new type of exception that inherits from tracker::Exception
110#define CREATE_ORXONOX_EXCEPTION(ExceptionName)                                     \
111    class ExceptionName##Exception : public Exception                               \
112    {                                                                               \
113    public:                                                                         \
114        ExceptionName##Exception(const std::string& description,                    \
115                unsigned int lineNumber, const char* filename,                      \
116                const char* functionName)                                           \
117            : Exception(description, lineNumber, filename, functionName)            \
118        { }                                                                         \
119                                                                                    \
120        ExceptionName##Exception(const std::string& description)                    \
121            : Exception(description)                                                \
122        { }                                                                         \
123                                                                                    \
124        ~ExceptionName##Exception() throw() { }                                     \
125                                                                                    \
126        std::string getTypeName() const { return #ExceptionName; }                  \
127    }
128
129    // Creates all possible exception types.
130    // If you want to add a new type, simply copy and adjust a new line here.
131#ifndef DOXYGEN_SHOULD_SKIP_THIS
132    CREATE_ORXONOX_EXCEPTION(General);
133    CREATE_ORXONOX_EXCEPTION(FileNotFound);
134    CREATE_ORXONOX_EXCEPTION(Argument);
135    CREATE_ORXONOX_EXCEPTION(PhysicsViolation);
136    CREATE_ORXONOX_EXCEPTION(ParseError);
137    CREATE_ORXONOX_EXCEPTION(PluginsNotFound);
138    CREATE_ORXONOX_EXCEPTION(InitialisationFailed);
139    CREATE_ORXONOX_EXCEPTION(InitialisationAborted);
140    CREATE_ORXONOX_EXCEPTION(NotImplemented);
141    CREATE_ORXONOX_EXCEPTION(GameState);
142    CREATE_ORXONOX_EXCEPTION(NoGraphics);
143    CREATE_ORXONOX_EXCEPTION(AbortLoading);
144#endif
145
146    /**
147    @brief
148        Helper function that forwards an exception and displays the message.
149    @details
150        This is necessary because only when using 'throw' the objects storage is managed.
151    */
152    template <class T>
153    inline const T& exceptionThrowerHelper(const T& exception)
154    {
155        // let the catcher decide whether to display the message below level 4
156        COUT(4) << exception.getFullDescription() << std::endl;
157        return exception;
158    }
159
160/**
161@brief
162    Throws an exception and logs a message beforehand.
163@param type
164    Type of the exception as literal (General, Initialisation, etc.)
165@param description
166    Exception description as string
167*/
168#define ThrowException(type, description) \
169    throw orxonox::exceptionThrowerHelper(type##Exception(static_cast<std::ostringstream&>(std::ostringstream().flush() << description).str(), __LINE__, __FILE__, __FUNCTIONNAME__))
170
171} /* namespace orxonox */
172
173#endif /* _Exception_H__ */
Note: See TracBrowser for help on using the repository browser.