Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/util/Exception.cc @ 8858

Last change on this file since 8858 was 8858, checked in by landauf, 13 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

  • orxout levelname message
  • orxout_context levelname context message
  • shortcuts: log message, error message, warning message, status message, info message, debug message
  • Property svn:eol-style set to native
File size: 3.2 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    Implementation of the Exception class.
33*/
34
35#include "Exception.h"
36
37#include <cstddef>
38#include <CEGUIExceptions.h>
39#include "Output.h"
40
41namespace orxonox
42{
43    Exception::Exception(const std::string& description, unsigned int lineNumber,
44                         const char* filename, const char* functionName)
45        : description_(description)
46        , lineNumber_(lineNumber)
47        , functionName_(functionName)
48        , filename_(filename)
49    { }
50
51    Exception::Exception(const std::string& description)
52        : description_(description)
53        , lineNumber_(0)
54    { }
55
56    const std::string& Exception::getFullDescription() const
57    {
58        if (fullDescription_.empty())
59        {
60            std::ostringstream fullDesc;
61
62            fullDesc << this->getTypeName() << "Exception";
63
64            if (!this->filename_.empty())
65            {
66                fullDesc << " in " << this->filename_;
67                if (this->lineNumber_)
68                    fullDesc << '(' << this->lineNumber_ << ')';
69            }
70
71            if (!this->functionName_.empty())
72                fullDesc << " in function '" << this->functionName_ << '\'';
73
74            fullDesc << ": ";
75            if (!this->description_.empty())
76                fullDesc << this->description_;
77            else
78                fullDesc << "No description available.";
79
80            this->fullDescription_ = fullDesc.str();
81        }
82
83        return fullDescription_;
84    }
85
86    const char* Exception::what() const throw()
87    {
88        return getDescription().c_str();
89    }
90
91    /*static*/ std::string Exception::handleMessage()
92    {
93        try
94        {
95            // rethrow
96            throw;
97        }
98        catch (const CEGUI::Exception& ex)
99        {
100            return GeneralException(ex.getMessage().c_str(), ex.getLine(),
101                ex.getFileName().c_str(), ex.getName().c_str()).getDescription();
102        }
103        catch (const std::exception& ex)
104        {
105            return ex.what();
106        }
107        catch (const char* ex)
108        {
109            return ex;
110        }
111        catch (...)
112        {
113            orxout(user_error) << "BIG WARNING: Unknown exception type encountered."
114                               << " Rethrowing" << endl;
115            throw;
116        }
117    }
118}
Note: See TracBrowser for help on using the repository browser.