Go to the documentation of this file.
31 #ifndef CPL_ERROR_H_INCLUDED
32 #define CPL_ERROR_H_INCLUDED
65 #ifdef STRICT_CPLERRORNUM_TYPE
100 #define CPLE_AppDefined 1
102 #define CPLE_OutOfMemory 2
104 #define CPLE_FileIO 3
106 #define CPLE_OpenFailed 4
108 #define CPLE_IllegalArg 5
110 #define CPLE_NotSupported 6
112 #define CPLE_AssertionFailed 7
114 #define CPLE_NoWriteAccess 8
116 #define CPLE_UserInterrupt 9
118 #define CPLE_ObjectNull 10
124 #define CPLE_HttpResponse 11
126 #define CPLE_AWSBucketNotFound 12
128 #define CPLE_AWSObjectNotFound 13
130 #define CPLE_AWSAccessDenied 14
132 #define CPLE_AWSInvalidCredentials 15
134 #define CPLE_AWSSignatureDoesNotMatch 16
136 #define CPLE_AWSError 17
156 void CPL_DLL CPLCleanupErrorMutex(
void);
180 #ifdef WITHOUT_CPLDEBUG
181 #define CPLDebug(...)
191 #define CPLDebugOnly(...) CPLDebug(__VA_ARGS__)
196 #define CPLDebugOnly(...)
199 void CPL_DLL CPL_STDCALL
_CPLAssert(
const char *,
const char *,
202 #if defined(DEBUG) && !defined(CPPCHECK)
204 #define CPLAssert(expr) \
205 ((expr) ? (void)(0) : _CPLAssert(#expr, __FILE__, __LINE__))
208 #define CPLAssertAlwaysEval(expr) CPLAssert(expr)
211 #define CPLAssert(expr)
215 #define CPLAssertAlwaysEval(expr) CPL_IGNORE_RET_VAL(expr)
219 #define CPLAssertAlwaysEval(expr) (void)(expr)
230 #define VALIDATE_POINTER_ERR CE_Fatal
232 #define VALIDATE_POINTER_ERR CE_Failure
235 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS) && \
236 !defined(DOXYGEN_SKIP)
241 template <
class T> T *CPLAssertNotNull(T *x)
249 class CPLErrorHandlerPusher
262 ~CPLErrorHandlerPusher()
268 class CPLErrorStateBackuper
272 std::string m_osLastErrorMsg;
275 CPLErrorStateBackuper()
282 ~CPLErrorStateBackuper()
285 m_osLastErrorMsg.c_str());
290 #ifdef GDAL_COMPILATION
292 bool CPLIsDefaultErrorHandlerAndCatchDebug();
300 #define VALIDATE_POINTER0(ptr, func) \
303 if (CPL_NULLPTR == ptr) \
305 CPLErr const ret = VALIDATE_POINTER_ERR; \
306 CPLError(ret, CPLE_ObjectNull, \
307 "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
313 #define VALIDATE_POINTER1(ptr, func, rc) \
316 if (CPL_NULLPTR == ptr) \
318 CPLErr const ret = VALIDATE_POINTER_ERR; \
319 CPLError(ret, CPLE_ObjectNull, \
320 "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
GUInt32 CPLGetErrorCounter(void)
Get the error counter.
Definition: cpl_error.cpp:915
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:959
void _CPLAssert(const char *, const char *, int)
Report failure of a logical assertion.
Definition: cpl_error.cpp:1359
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
const char * CPLGetLastErrorMsg(void)
Get the last error message.
Definition: cpl_error.cpp:892
void(* CPLErrorHandler)(CPLErr, CPLErrorNum, const char *)
Callback for a custom error handler.
Definition: cpl_error.h:160
#define CPLE_UserInterrupt
User interrupted.
Definition: cpl_error.h:116
void CPLPopErrorHandler(void)
Pop error handler off stack.
Definition: cpl_error.cpp:1286
CPLErrorHandler CPLSetErrorHandlerEx(CPLErrorHandler, void *)
Install custom error handle with user's data.
Definition: cpl_error.cpp:1135
#define CPLE_NoWriteAccess
No write access.
Definition: cpl_error.h:114
#define CPL_NO_RETURN
Qualifier for a function that does not return at all (terminates the process)
Definition: cpl_port.h:1004
void CPLDefaultErrorHandler(CPLErr, CPLErrorNum, const char *)
Default error handler.
Definition: cpl_error.cpp:949
void CPLPushErrorHandler(CPLErrorHandler)
Push a new CPLError handler.
Definition: cpl_error.cpp:1229
#define CPLAssert(expr)
Assert on an expression.
Definition: cpl_error.h:211
#define CPLE_AWSBucketNotFound
AWSBucketNotFound.
Definition: cpl_error.h:126
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:315
#define CPLE_OutOfMemory
Out of memory error.
Definition: cpl_error.h:102
CPLErrorNum CPLGetLastErrorNo(void)
Fetch the last error number.
Definition: cpl_error.cpp:844
#define CPLE_ObjectNull
NULL object.
Definition: cpl_error.h:118
int CPLErrorNum
Error number.
Definition: cpl_error.h:95
#define CPLE_OpenFailed
Open failed.
Definition: cpl_error.h:106
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:319
#define CPLE_HttpResponse
HTTP response.
Definition: cpl_error.h:124
void CPLDebug(const char *, const char *,...)
Display a debugging message.
Definition: cpl_error.cpp:623
#define CPLE_AWSSignatureDoesNotMatch
AWSSignatureDoesNotMatch.
Definition: cpl_error.h:134
void CPLErrorReset(void)
Erase any traces of previous errors.
Definition: cpl_error.cpp:755
#define CPLE_AWSObjectNotFound
AWSObjectNotFound.
Definition: cpl_error.h:128
void CPLError(CPLErr eErrClass, CPLErrorNum err_no, const char *fmt,...)
Report an error.
Definition: cpl_error.cpp:329
void CPLEmergencyError(const char *)
Fatal error when things are bad.
Definition: cpl_error.cpp:509
#define CPLE_AssertionFailed
Assertion failed.
Definition: cpl_error.h:112
CPLErrorHandler CPLSetErrorHandler(CPLErrorHandler)
Install custom error handler.
Definition: cpl_error.cpp:1208
#define CPLE_NotSupported
Not supported.
Definition: cpl_error.h:110
void CPLPushErrorHandlerEx(CPLErrorHandler, void *)
Push a new CPLError handler with user data on the error context.
Definition: cpl_error.cpp:1252
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:975
CPLErrorHandler CPLGetErrorHandler(void **ppUserData)
Fetch the current error handler for the current error context.
Definition: cpl_error.cpp:201
void CPLErrorSetState(CPLErr eErrClass, CPLErrorNum err_no, const char *pszMsg)
Restore an error state, without emitting an error.
Definition: cpl_error.cpp:790
#define CPLE_None
No error.
Definition: cpl_error.h:98
CPLErr
Error category.
Definition: cpl_error.h:52
#define CPLE_AWSAccessDenied
AWSAccessDenied.
Definition: cpl_error.h:130
CPLErr CPLGetLastErrorType(void)
Fetch the last error type.
Definition: cpl_error.cpp:868
#define CPLE_AWSInvalidCredentials
AWSInvalidCredentials.
Definition: cpl_error.h:132
#define CPLE_IllegalArg
Illegal argument.
Definition: cpl_error.h:108
void * CPLGetErrorHandlerUserData(void)
Fetch the user data for the error context.
Definition: cpl_error.cpp:160
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
void CPLQuietErrorHandler(CPLErr, CPLErrorNum, const char *)
Error handler that does not do anything, except for debug messages.
Definition: cpl_error.cpp:1015
void CPLErrorV(CPLErr, CPLErrorNum, const char *, va_list)
Same as CPLError() but with a va_list.
Definition: cpl_error.cpp:345
#define CPLE_FileIO
File I/O error.
Definition: cpl_error.h:104
#define CPL_RETURNS_NONNULL
Qualifier for a function that does not return NULL.
Definition: cpl_port.h:1023
void CPLTurnFailureIntoWarning(int bOn)
Whether failures should be turned into warnings.
Definition: cpl_error.cpp:1103
#define CPLE_AppDefined
Application defined error.
Definition: cpl_error.h:100
unsigned int GUInt32
Unsigned int32 type.
Definition: cpl_port.h:197