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
|
/*-------------------------------------------------------------------------
* C-Pluff, a plug-in framework for C
* Copyright 2007 Johannes Lehtinen
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*-----------------------------------------------------------------------*/
/** @file
* Declares exceptions.
*/
#ifndef CPLUFFXX_EXCEPT_H_
#define CPLUFFXX_EXCEPT_H_
#include <cpluffxx/defines.h>
namespace cpluff {
/**
* Thrown to indicate an error in a C-Pluff API call. API functions that may
* fail throw this exception on error conditions. This class is not intended
* to be instantiated or subclassed by the client program.
*/
class api_error {
public:
/** Error codes included in cp_api_error. */
enum code {
/** Not enough memory or other operating system resources available */
RESOURCE = 1,
/** The specified object is unknown to the framework */
UNKNOWN,
/** An I/O error occurred */
IO,
/** Malformed plug-in descriptor was encountered when loading a plug-in */
MALFORMED,
/** Plug-in or symbol conflicts with another plug-in or symbol */
CONFLICT,
/** Plug-in dependencies could not be satisfied */
DEPENDENCY,
/** Plug-in runtime signaled an error */
RUNTIME
};
/**
* @internal
* Constructs a new instance from the specified error code and error
* message. The error message is not copied so the pointer should point to
* static storage or be valid for the life time of the created object.
*
* @param reason the error code
* @param message the error message
*/
inline api_error(code reason, const char* message):
error_code(reason), error_message(message) {};
/**
* Returns an error code describing the type of error.
*
* @return an error code describing the type of error
*/
inline code reason() const {
return error_code;
}
/**
* Returns an error message intended for display purposes. The error
* message may be localized. The returned error message is valid until this
* exception object is destructed.
*
* @return a possibly localized error message intended for display purposes
*/
inline const char* message() const {
return error_message;
}
protected:
/** @internal The associated error code */
code error_code;
/** @internal The associated error message */
const char* error_message;
};
}
#endif /*CPLUFFXX_EXCEPT_H_*/
|
