1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* Copyright (c) 2004 - 2008 Olof Naess�n and Per Larsson
* Copyright (C) 2011-2014 The ManaPlus Developers
*
*
* Per Larsson a.k.a finalman
* Olof Naess�n a.k.a jansem/yakslem
*
* Visit: http://guichan.sourceforge.net
*
* License: (BSD)
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name of Guichan nor the names of its contributors may
* be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef GCN_EXCEPTION_HPP
#define GCN_EXCEPTION_HPP
#include <string>
#include "localconsts.h"
#ifndef __FUNCTION__
#define __FUNCTION__ "?"
#endif
/*
* A macro used to create a standard exception object.
* What it basicly does is that it creates a new exception
* and automatically sets the filename and line number where
* the exception occured by using other compiler macros.
*/
#define GCN_EXCEPTION(mess) gcn::Exception(mess, \
__FUNCTION__, \
__FILE__, \
__LINE__)
namespace gcn
{
/**
* An exception containing a message, a file and a line number
* where the exception occured. Guichan will only throw exceptions
* of this class.
*
* You can use this class for your own exceptions that has
* something to do with a GUI exception. A nifty feature of the
* excpetion class is that it can tell you from which line and
* file it was thrown. To make things easier when throwing
* exceptions there exists a macro for creating exceptions
* which automatically sets the filename and line number.
*
* EXAMPLE: @code
* throw GCN_EXCEPTION("my error message");
* @endcode
*/
class Exception final
{
public:
/**
* Constructor.
*/
Exception();
/**
* Constructor.
*
* @param message The error message of the exception.
*/
explicit Exception(const std::string& message);
/**
* Constructor.
*
* NOTE: Don't use this constructor. Use the GCN_EXCEPTION macro instead.
* This constructor merely exists for the GCN_EXCEPTION macro to
* use.
*
* @param message The error message of the exception.
* @param function The function name where the exception occured.
* @param filename The name of the file where the exception occured.
* @param line The line number in the source code where the exception
* occured.
*/
Exception(const std::string& message,
const std::string& function,
const std::string& filename,
const unsigned int line);
/**
* Gets the function name where the exception occured.
*
* @return The function name where the exception occured.
*/
const std::string& getFunction() const A_WARN_UNUSED;
/**
* Gets the error message of the exception.
*
* @return The error message of the exception.
*/
const std::string& getMessage() const A_WARN_UNUSED;
/**
* Gets the filename where the exception occured.
*
* @return The filename where the exception occured.
*/
const std::string& getFilename() const A_WARN_UNUSED;
/**
* Gets the line number where the exception occured.
*
* @return The line number where the exception occured.
*/
unsigned int getLine() const A_WARN_UNUSED;
protected:
/**
* Holds the name of the function name where the
* exception occured.
*/
std::string mFunction;
/**
* Holds the error message of the exception.
*/
std::string mMessage;
/**
* Holds the filename where the exception occured.
*/
std::string mFilename;
/**
* Holds the line number where the exception occured.
*/
unsigned int mLine;
};
} // namespace gcn
#endif // end GCN_EXCEPTION_HPP
/*
* "Final Fantasy XI is the BEST!... It's even better then water!"
* - Astrolite
* I believe it's WoW now days.
*/
|
