GException.cpp
13.6 KB
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
/***************************************************************************
* GException.cpp - exception handlers *
* ----------------------------------------------------------------------- *
* copyright (C) 2006-2013 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* 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 3 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. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GException.cpp
* @brief Exception handler interface implementation
* @author J. Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#include "GException.hpp"
#include "GTools.hpp"
/***********************************************************************//**
* @brief Exception message.
***************************************************************************/
const char* GExceptionHandler::what() const throw()
{
// Set error message
std::string message = "*** ERROR in " + m_origin + ": " + m_message;
// Return message as C character array
return (gammalib::tochar(message));
}
/***********************************************************************//**
* @brief Invalid value
*
* @param[in] origin Name of method that has thrown the exception.
* @param[in] message Error message.
***************************************************************************/
GException::invalid_value::invalid_value(const std::string& origin,
const std::string& message)
{
// Set origin
m_origin = origin;
// Set message string
m_message = "Invalid value.";
if (message.length() > 0) {
m_message += ("\n" + message);
}
// Return
return;
}
/***********************************************************************//**
* @brief Invalid argument
*
* @param[in] origin Name of method that has thrown the exception.
* @param[in] message Error message.
***************************************************************************/
GException::invalid_argument::invalid_argument(const std::string& origin,
const std::string& message)
{
// Set origin
m_origin = origin;
// Set message string
m_message = "Invalid argument.";
if (message.length() > 0) {
m_message += ("\n" + message);
}
// Return
return;
}
/***********************************************************************//**
* @brief Index is out of range [0,elements-1]
*
* @param[in] origin Method throwing the exception.
* @param[in] what Describes what is out of range.
* @param[in] index Index.
* @param[in] elements Number of elements.
* @param[in] message Optional error message.
*
* The @p what string specifies the index type that is out of range. For
* example what="Vector index" will lead to "Vector index <index> is ...".
* The first letter in @p what is expected to be a capital letter.
***************************************************************************/
GException::out_of_range::out_of_range(const std::string& origin,
const std::string& what,
const int& index,
const int& elements,
const std::string& message)
{
// Set origin
m_origin = origin;
// Set message
if (elements > 0) {
m_message = gammalib::strip_whitespace(what) + " " +
gammalib::str(index) + " is outside the"
" valid range [0," + gammalib::str(elements-1) + "].";
}
else {
m_message = "Invalid access to empty object with " +
gammalib::tolower(gammalib::strip_whitespace(what)) +
" " + gammalib::str(index) + ".";
}
if (message.length() > 0) {
m_message += ("\n" + message);
}
// Return
return;
}
/***********************************************************************//**
* @brief Feature not implement
*
* @param[in] origin Name of method that has thrown the exception.
* @param[in] message Optional message.
*
* This exception signals features that are not yet implemented. It may be
* thrown by modules that are still under development.
***************************************************************************/
GException::feature_not_implemented::feature_not_implemented(std::string origin,
std::string message)
{
// Set origin
m_origin = origin;
// Set message string
if (message.length() > 0) {
m_message = message;
}
else {
m_message = "Feature not implemented.";
}
m_message += " In case that you need this feature for your application"
" please submit a feature request on"
" https://sourceforge.net/projects/gammalib/,"
" join this error message and provide a detailed"
" description of your needs.";
// Return
return;
}
/***********************************************************************//**
* @brief Invalid argument
*
* @param[in] origin Name of method that has thrown the exception.
* @param[in] argument Argument name.
* @param[in] message Optional message.
*
* This exception signals that a specified argument was not valid.
***************************************************************************/
GException::invalid_argument::invalid_argument(const std::string& origin,
const std::string& argument,
const std::string& message)
{
// Set origin
m_origin = origin;
// Set message string
m_message = "Invalid argument \""+argument+"\" value.";
// Add optional error message
if (message.length() > 0) {
m_message += " " + message;
}
// Return
return;
}
/***********************************************************************//**
* @brief Invalid type conversion
*
* @param[in] origin Name of method that has thrown the exception.
* @param[in] message Optional message.
***************************************************************************/
GException::bad_type::bad_type(std::string origin, std::string message)
{
// Set origin
m_origin = origin;
// Set message string
m_message = "Invalid type conversion.";
if (message.length() > 0) {
m_message += " " + message;
}
// Return
return;
}
/***********************************************************************//**
* @brief Environment variable not found
*
* @param[in] origin Name of method that has thrown the exception.
* @param[in] envname Name of environment variable.
* @param[in] message Optional message.
*
* This exception signals that are required environment variable was not
* found.
***************************************************************************/
GException::env_not_found::env_not_found(std::string origin,
std::string envname,
std::string message)
{
// Set origin
m_origin = origin;
// Set message string
m_message = "Environment variable \""+envname+"\" not found.";
if (message.length() > 0) {
m_message += " " + message;
}
// Return
return;
}
/***********************************************************************//**
* @brief Memory allocation exception.
*
* @param[in] origin Name of method that has thrown the exception.
* @param[in] num Requested amount of memory.
***************************************************************************/
GException::mem_alloc::mem_alloc(std::string origin, unsigned num)
{
// Set origin
m_origin = origin;
// Set message string
m_message = "Memory allocation error (" + gammalib::str((int)num) + " elements)";
// Return
return;
}
/***********************************************************************//**
* @brief Not enough nodes in node array
*
* @param[in] origin Name of method that has thrown the exception.
* @param[in] num Number of nodes in node array.
***************************************************************************/
GException::not_enough_nodes::not_enough_nodes(std::string origin, int num)
{
// Set origin
m_origin = origin;
// Set message string
m_message = "Not enough nodes in node array (" + gammalib::str(num) + " nodes).";
// Return
return;
}
/***********************************************************************//**
* @brief File not found
*
* @param[in] origin Name of method that has thrown the exception.
* @param[in] filename Filename.
* @param[in] message Optional message.
***************************************************************************/
GException::file_not_found::file_not_found(std::string origin,
std::string filename,
std::string message)
{
// Set origin
m_origin = origin;
// Set message string
m_message = "File \"" + filename +"\" not found.";
if (message.length() > 0) {
m_message += " " + message;
}
// Return
return;
}
/***********************************************************************//**
* @brief File open error
*
* @param[in] origin Name of method that has thrown the exception.
* @param[in] filename Filename.
* @param[in] message Optional message.
***************************************************************************/
GException::file_open_error::file_open_error(std::string origin,
std::string filename,
std::string message)
{
// Set origin
m_origin = origin;
// Set message string
m_message = "Unable to open file \"" + filename +"\"";
if (message.length() > 0) {
m_message += " " + message;
}
// Return
return;
}
/***********************************************************************//**
* @brief Directory not found
*
* @param[in] origin Name of method that has thrown the exception.
* @param[in] dirname Directory name.
* @param[in] message Optional message.
***************************************************************************/
GException::directory_not_found::directory_not_found(std::string origin,
std::string dirname,
std::string message)
{
// Set origin
m_origin = origin;
// Set message string
m_message = "Directory \"" + dirname +"\" not found.";
if (message.length() > 0) {
m_message += " " + message;
}
// Return
return;
}
/***********************************************************************//**
* @brief Directory not accessible
*
* @param[in] origin Name of method that has thrown the exception.
* @param[in] dirname Directory name.
* @param[in] message Optional message.
***************************************************************************/
GException::directory_not_accessible::directory_not_accessible(std::string origin,
std::string dirname,
std::string message)
{
// Set origin
m_origin = origin;
// Set message string
m_message = "Directory \"" + dirname +"\" not accessible.";
if (message.length() > 0) {
m_message += " " + message;
}
// Return
return;
}
/***********************************************************************//**
* @brief Bad CSV columns encountered
*
* @param[in] origin Name of method that has thrown the exception.
* @param[in] filename Filename.
* @param[in] row CSV file row.
* @param[in] cols Expected number of columns.
* @param[in] elements Found number of columns.
* @param[in] message Optional message.
***************************************************************************/
GException::csv_bad_columns::csv_bad_columns(std::string origin,
std::string filename,
int row,
int cols,
int elements,
std::string message)
{
m_origin = origin;
m_message = "Inconsistent number of columns found in row "+gammalib::str(row)+
" of file \""+filename+"\" ("+gammalib::str(cols)+" expected, "+
gammalib::str(elements)+" encountered). "+message;
return;
}