GDAL

cpl_error.h
Go to the documentation of this file.
1 /**********************************************************************
2 * $Id$
3 *
4 * Name: cpl_error.h
5 * Project: CPL - Common Portability Library
6 * Purpose: CPL Error handling
7 * Author: Daniel Morissette, danmo@videotron.ca
8 *
9 **********************************************************************
10 * Copyright (c) 1998, Daniel Morissette
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be included
20 * in all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28 * DEALINGS IN THE SOFTWARE.
29 ****************************************************************************/
30
31 #ifndef CPL_ERROR_H_INCLUDED
32 #define CPL_ERROR_H_INCLUDED
33
34 #include "cpl_port.h"
35
36 #include <stdarg.h>
37 #include <stddef.h>
38
39 /*=====================================================================
40 Error handling functions (cpl_error.c)
41 =====================================================================*/
42
49 CPL_C_START
50
52 typedef enum
53 {
54 CE_None = 0,
55 CE_Debug = 1,
56 CE_Warning = 2,
57 CE_Failure = 3,
58 CE_Fatal = 4
59 } CPLErr;
60
61 /* ==================================================================== */
62 /* Well known error codes. */
63 /* ==================================================================== */
64
65 #ifdef STRICT_CPLERRORNUM_TYPE
66
67 /* This is not appropriate for the general case, as there are parts */
68 /* of GDAL which use custom error codes, but this can help diagnose confusions
69 */
70 /* between CPLErr and CPLErrorNum */
71 typedef enum
72 {
73 CPLE_None,
74 CPLE_AppDefined,
75 CPLE_OutOfMemory,
76 CPLE_FileIO,
77 CPLE_OpenFailed,
78 CPLE_IllegalArg,
79 CPLE_NotSupported,
80 CPLE_AssertionFailed,
81 CPLE_NoWriteAccess,
82 CPLE_UserInterrupt,
83 CPLE_ObjectNull,
84 CPLE_HttpResponse,
85 CPLE_AWSBucketNotFound,
86 CPLE_AWSObjectNotFound,
87 CPLE_AWSAccessDenied,
88 CPLE_AWSInvalidCredentials,
89 CPLE_AWSSignatureDoesNotMatch,
90 } CPLErrorNum;
91
92 #else
93
95 typedef int CPLErrorNum;
96
98 #define CPLE_None 0
99
100 #define CPLE_AppDefined 1
101
102 #define CPLE_OutOfMemory 2
103
104 #define CPLE_FileIO 3
105
106 #define CPLE_OpenFailed 4
107
108 #define CPLE_IllegalArg 5
109
110 #define CPLE_NotSupported 6
111
112 #define CPLE_AssertionFailed 7
113
114 #define CPLE_NoWriteAccess 8
115
116 #define CPLE_UserInterrupt 9
117
118 #define CPLE_ObjectNull 10
119
120 /*
121 * Filesystem-specific errors
122 */
124 #define CPLE_HttpResponse 11
125
126 #define CPLE_AWSBucketNotFound 12
127
128 #define CPLE_AWSObjectNotFound 13
129
130 #define CPLE_AWSAccessDenied 14
131
132 #define CPLE_AWSInvalidCredentials 15
133
134 #define CPLE_AWSSignatureDoesNotMatch 16
135
136 #define CPLE_AWSError 17
137
138 /* 100 - 299 reserved for GDAL */
139
140 #endif
141
142 void CPL_DLL CPLError(CPLErr eErrClass, CPLErrorNum err_no,
143 CPL_FORMAT_STRING(const char *fmt), ...)
144 CPL_PRINT_FUNC_FORMAT(3, 4);
145 void CPL_DLL CPLErrorV(CPLErr, CPLErrorNum, const char *, va_list);
146 void CPL_DLL CPLEmergencyError(const char *) CPL_NO_RETURN;
147 void CPL_DLL CPL_STDCALL CPLErrorReset(void);
148 CPLErrorNum CPL_DLL CPL_STDCALL CPLGetLastErrorNo(void);
149 CPLErr CPL_DLL CPL_STDCALL CPLGetLastErrorType(void);
150 const char CPL_DLL *CPL_STDCALL CPLGetLastErrorMsg(void);
151 GUInt32 CPL_DLL CPL_STDCALL CPLGetErrorCounter(void);
152 void CPL_DLL *CPL_STDCALL CPLGetErrorHandlerUserData(void);
153 void CPL_DLL CPLErrorSetState(CPLErr eErrClass, CPLErrorNum err_no,
154 const char *pszMsg);
156 void CPL_DLL CPLCleanupErrorMutex(void);
160 typedef void(CPL_STDCALL *CPLErrorHandler)(CPLErr, CPLErrorNum, const char *);
161
162 void CPL_DLL CPL_STDCALL CPLLoggingErrorHandler(CPLErr, CPLErrorNum,
163 const char *);
164 void CPL_DLL CPL_STDCALL CPLDefaultErrorHandler(CPLErr, CPLErrorNum,
165 const char *);
166 void CPL_DLL CPL_STDCALL CPLQuietErrorHandler(CPLErr, CPLErrorNum,
167 const char *);
168 void CPLTurnFailureIntoWarning(int bOn);
169
170 CPLErrorHandler CPL_DLL CPLGetErrorHandler(void **ppUserData);
171
172 CPLErrorHandler CPL_DLL CPL_STDCALL CPLSetErrorHandler(CPLErrorHandler);
173 CPLErrorHandler CPL_DLL CPL_STDCALL CPLSetErrorHandlerEx(CPLErrorHandler,
174 void *);
175 void CPL_DLL CPL_STDCALL CPLPushErrorHandler(CPLErrorHandler);
176 void CPL_DLL CPL_STDCALL CPLPushErrorHandlerEx(CPLErrorHandler, void *);
177 void CPL_DLL CPL_STDCALL CPLSetCurrentErrorHandlerCatchDebug(int bCatchDebug);
178 void CPL_DLL CPL_STDCALL CPLPopErrorHandler(void);
179
180 #ifdef WITHOUT_CPLDEBUG
181 #define CPLDebug(...) /* Eat all CPLDebug calls. */
182 #else
183 void CPL_DLL CPLDebug(const char *, CPL_FORMAT_STRING(const char *), ...)
184 CPL_PRINT_FUNC_FORMAT(2, 3);
185 #endif
186
187 #ifdef DEBUG
188
191 #define CPLDebugOnly(...) CPLDebug(__VA_ARGS__)
192 #else
193
196 #define CPLDebugOnly(...)
197 #endif
198
199 void CPL_DLL CPL_STDCALL _CPLAssert(const char *, const char *,
200 int) CPL_NO_RETURN;
201
202 #if defined(DEBUG) && !defined(CPPCHECK)
203
204 #define CPLAssert(expr) \
205 ((expr) ? (void)(0) : _CPLAssert(#expr, __FILE__, __LINE__))
206
208 #define CPLAssertAlwaysEval(expr) CPLAssert(expr)
209 #else
210
211 #define CPLAssert(expr)
212 #ifdef __cplusplus
213
215 #define CPLAssertAlwaysEval(expr) CPL_IGNORE_RET_VAL(expr)
216 #else
217
219 #define CPLAssertAlwaysEval(expr) (void)(expr)
220 #endif
221 #endif
222
223 CPL_C_END
224
226 /*
227 * Helper macros used for input parameters validation.
228 */
229 #ifdef DEBUG
230 #define VALIDATE_POINTER_ERR CE_Fatal
231 #else
232 #define VALIDATE_POINTER_ERR CE_Failure
233 #endif
234
235 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS) && \
236 !defined(DOXYGEN_SKIP)
237
238 extern "C++"
239 {
240 template <class T> T *CPLAssertNotNull(T *x) CPL_RETURNS_NONNULL;
241 template <class T> T *CPLAssertNotNull(T *x)
242 {
243 CPLAssert(x);
244 return x;
245 }
246
247 #include <string>
248
249 class CPLErrorHandlerPusher
250 {
251 public:
252 explicit CPLErrorHandlerPusher(CPLErrorHandler hHandler)
253 {
254 CPLPushErrorHandler(hHandler);
255 }
256
257 CPLErrorHandlerPusher(CPLErrorHandler hHandler, void *user_data)
258 {
259 CPLPushErrorHandlerEx(hHandler, user_data);
260 }
261
262 ~CPLErrorHandlerPusher()
263 {
264 CPLPopErrorHandler();
265 }
266 };
267
268 class CPLErrorStateBackuper
269 {
270 CPLErrorNum m_nLastErrorNum;
271 CPLErr m_nLastErrorType;
272 std::string m_osLastErrorMsg;
273
274 public:
275 CPLErrorStateBackuper()
276 : m_nLastErrorNum(CPLGetLastErrorNo()),
277 m_nLastErrorType(CPLGetLastErrorType()),
278 m_osLastErrorMsg(CPLGetLastErrorMsg())
279 {
280 }
281
282 ~CPLErrorStateBackuper()
283 {
284 CPLErrorSetState(m_nLastErrorType, m_nLastErrorNum,
285 m_osLastErrorMsg.c_str());
286 }
287 };
288 }
289
290 #ifdef GDAL_COMPILATION
291 // internal only
292 bool CPLIsDefaultErrorHandlerAndCatchDebug();
293 #endif
294
295 #endif
296
300 #define VALIDATE_POINTER0(ptr, func) \
301 do \
302 { \
303 if (CPL_NULLPTR == ptr) \
304 { \
305 CPLErr const ret = VALIDATE_POINTER_ERR; \
306 CPLError(ret, CPLE_ObjectNull, \
307 "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
308 return; \
309 } \
310 } while (0)
311
313 #define VALIDATE_POINTER1(ptr, func, rc) \
314 do \
315 { \
316 if (CPL_NULLPTR == ptr) \
317 { \
318 CPLErr const ret = VALIDATE_POINTER_ERR; \
319 CPLError(ret, CPLE_ObjectNull, \
320 "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
321 return (rc); \
322 } \
323 } while (0)
324
325 #endif /* CPL_ERROR_H_INCLUDED */
CPLGetErrorCounter
GUInt32 CPLGetErrorCounter(void)
Get the error counter.
Definition: cpl_error.cpp:915
CPL_PRINT_FUNC_FORMAT
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:959
_CPLAssert
void _CPLAssert(const char *, const char *, int)
Report failure of a logical assertion.
Definition: cpl_error.cpp:1359
CPLLoggingErrorHandler
void CPLLoggingErrorHandler(CPLErr, CPLErrorNum, const char *)
Error handler that logs into the file defined by the CPL_LOG configuration option,...
Definition: cpl_error.cpp:1030
CPLGetLastErrorMsg
const char * CPLGetLastErrorMsg(void)
Get the last error message.
Definition: cpl_error.cpp:892
CPLErrorHandler
void(* CPLErrorHandler)(CPLErr, CPLErrorNum, const char *)
Callback for a custom error handler.
Definition: cpl_error.h:160
CPLE_UserInterrupt
#define CPLE_UserInterrupt
User interrupted.
Definition: cpl_error.h:116
CPLPopErrorHandler
void CPLPopErrorHandler(void)
Pop error handler off stack.
Definition: cpl_error.cpp:1286
CPLSetErrorHandlerEx
CPLErrorHandler CPLSetErrorHandlerEx(CPLErrorHandler, void *)
Install custom error handle with user's data.
Definition: cpl_error.cpp:1135
CPLE_NoWriteAccess
#define CPLE_NoWriteAccess
No write access.
Definition: cpl_error.h:114
CPL_NO_RETURN
#define CPL_NO_RETURN
Qualifier for a function that does not return at all (terminates the process)
Definition: cpl_port.h:1004
CPLDefaultErrorHandler
void CPLDefaultErrorHandler(CPLErr, CPLErrorNum, const char *)
Default error handler.
Definition: cpl_error.cpp:949
CPLPushErrorHandler
void CPLPushErrorHandler(CPLErrorHandler)
Push a new CPLError handler.
Definition: cpl_error.cpp:1229
CPLAssert
#define CPLAssert(expr)
Assert on an expression.
Definition: cpl_error.h:211
CPLE_AWSBucketNotFound
#define CPLE_AWSBucketNotFound
AWSBucketNotFound.
Definition: cpl_error.h:126
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:315
CPLE_OutOfMemory
#define CPLE_OutOfMemory
Out of memory error.
Definition: cpl_error.h:102
CPLGetLastErrorNo
CPLErrorNum CPLGetLastErrorNo(void)
Fetch the last error number.
Definition: cpl_error.cpp:844
CPLE_ObjectNull
#define CPLE_ObjectNull
NULL object.
Definition: cpl_error.h:118
CPLErrorNum
int CPLErrorNum
Error number.
Definition: cpl_error.h:95
CPLE_OpenFailed
#define CPLE_OpenFailed
Open failed.
Definition: cpl_error.h:106
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:319
CPLE_HttpResponse
#define CPLE_HttpResponse
HTTP response.
Definition: cpl_error.h:124
CPLDebug
void CPLDebug(const char *, const char *,...)
Display a debugging message.
Definition: cpl_error.cpp:623
CPLE_AWSSignatureDoesNotMatch
#define CPLE_AWSSignatureDoesNotMatch
AWSSignatureDoesNotMatch.
Definition: cpl_error.h:134
CPLErrorReset
void CPLErrorReset(void)
Erase any traces of previous errors.
Definition: cpl_error.cpp:755
CPLE_AWSObjectNotFound
#define CPLE_AWSObjectNotFound
AWSObjectNotFound.
Definition: cpl_error.h:128
CPLError
void CPLError(CPLErr eErrClass, CPLErrorNum err_no, const char *fmt,...)
Report an error.
Definition: cpl_error.cpp:329
CPLEmergencyError
void CPLEmergencyError(const char *)
Fatal error when things are bad.
Definition: cpl_error.cpp:509
CPLE_AssertionFailed
#define CPLE_AssertionFailed
Assertion failed.
Definition: cpl_error.h:112
CPLSetErrorHandler
CPLErrorHandler CPLSetErrorHandler(CPLErrorHandler)
Install custom error handler.
Definition: cpl_error.cpp:1208
CPLE_NotSupported
#define CPLE_NotSupported
Not supported.
Definition: cpl_error.h:110
CPLPushErrorHandlerEx
void CPLPushErrorHandlerEx(CPLErrorHandler, void *)
Push a new CPLError handler with user data on the error context.
Definition: cpl_error.cpp:1252
CPL_FORMAT_STRING
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:975
cpl_port.h
CPLGetErrorHandler
CPLErrorHandler CPLGetErrorHandler(void **ppUserData)
Fetch the current error handler for the current error context.
Definition: cpl_error.cpp:201
CPLErrorSetState
void CPLErrorSetState(CPLErr eErrClass, CPLErrorNum err_no, const char *pszMsg)
Restore an error state, without emitting an error.
Definition: cpl_error.cpp:790
CPLE_None
#define CPLE_None
No error.
Definition: cpl_error.h:98
CPLErr
CPLErr
Error category.
Definition: cpl_error.h:52
CPLE_AWSAccessDenied
#define CPLE_AWSAccessDenied
AWSAccessDenied.
Definition: cpl_error.h:130
CPLGetLastErrorType
CPLErr CPLGetLastErrorType(void)
Fetch the last error type.
Definition: cpl_error.cpp:868
CPLE_AWSInvalidCredentials
#define CPLE_AWSInvalidCredentials
AWSInvalidCredentials.
Definition: cpl_error.h:132
CPLE_IllegalArg
#define CPLE_IllegalArg
Illegal argument.
Definition: cpl_error.h:108
CPLGetErrorHandlerUserData
void * CPLGetErrorHandlerUserData(void)
Fetch the user data for the error context.
Definition: cpl_error.cpp:160
CPLSetCurrentErrorHandlerCatchDebug
void CPLSetCurrentErrorHandlerCatchDebug(int bCatchDebug)
Set if the current error handler should intercept debug messages, or if they should be processed by t...
Definition: cpl_error.cpp:1325
CPLQuietErrorHandler
void CPLQuietErrorHandler(CPLErr, CPLErrorNum, const char *)
Error handler that does not do anything, except for debug messages.
Definition: cpl_error.cpp:1015
CPLErrorV
void CPLErrorV(CPLErr, CPLErrorNum, const char *, va_list)
Same as CPLError() but with a va_list.
Definition: cpl_error.cpp:345
CPLE_FileIO
#define CPLE_FileIO
File I/O error.
Definition: cpl_error.h:104
CPL_RETURNS_NONNULL
#define CPL_RETURNS_NONNULL
Qualifier for a function that does not return NULL.
Definition: cpl_port.h:1023
CPLTurnFailureIntoWarning
void CPLTurnFailureIntoWarning(int bOn)
Whether failures should be turned into warnings.
Definition: cpl_error.cpp:1103
CPLE_AppDefined
#define CPLE_AppDefined
Application defined error.
Definition: cpl_error.h:100
GUInt32
unsigned int GUInt32
Unsigned int32 type.
Definition: cpl_port.h:197