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
148 void CPL_DLL
CPLErrorSetState( CPLErr eErrClass, CPLErrorNum err_no, const
char* pszMsg );
150 void CPL_DLL CPLCleanupErrorMutex(
void );
168 #ifdef WITHOUT_CPLDEBUG
169 #define CPLDebug(...)
175 void CPL_DLL CPL_STDCALL
_CPLAssert(
const char *,
const char *,
int ) CPL_NO_RETURN;
179 # define CPLAssert(expr) ((expr) ? (void)(0) : _CPLAssert(#expr,__FILE__,__LINE__))
182 # define CPLAssert(expr)
192 # define VALIDATE_POINTER_ERR CE_Fatal
194 # define VALIDATE_POINTER_ERR CE_Failure
199 #define VALIDATE_POINTER0(ptr, func) \
200 do { if( NULL == ptr ) \
202 CPLErr const ret = VALIDATE_POINTER_ERR; \
203 CPLError( ret, CPLE_ObjectNull, \
204 "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
208 #define VALIDATE_POINTER1(ptr, func, rc) \
209 do { if( NULL == ptr ) \
211 CPLErr const ret = VALIDATE_POINTER_ERR; \
212 CPLError( ret, CPLE_ObjectNull, \
213 "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
214 return (rc); }} while(0)
#define CPLE_FileIO
File I/O error.
Definition: cpl_error.h:104
#define CPLE_AppDefined
Application defined error.
Definition: cpl_error.h:100
void CPLPushErrorHandler(CPLErrorHandler)
Push a new CPLError handler.
Definition: cpl_error.cpp:1083
CPLErr CPLGetLastErrorType(void)
Fetch the last error type.
Definition: cpl_error.cpp:760
Core portability definitions for CPL.
#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:352
void CPLTurnFailureIntoWarning(int bOn)
Whether failures should be turned into warnings.
Definition: cpl_error.cpp:953
#define CPLE_OpenFailed
Open failed.
Definition: cpl_error.h:106
#define CPLE_NoWriteAccess
No write access.
Definition: cpl_error.h:114
void _CPLAssert(const char *, const char *, int) CPL_NO_RETURN
Report failure of a logical assertion.
Definition: cpl_error.cpp:1213
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:1179
const char * CPLGetLastErrorMsg(void)
Get the last error message.
Definition: cpl_error.cpp:784
void(* CPLErrorHandler)(CPLErr, CPLErrorNum, const char *)
Callback for a custom error handler.
Definition: cpl_error.h:154
#define CPLE_ObjectNull
NULL object.
Definition: cpl_error.h:118
void CPLDefaultErrorHandler(CPLErr, CPLErrorNum, const char *)
Default error handler.
Definition: cpl_error.cpp:798
#define CPLE_UserInterrupt
User interrupted.
Definition: cpl_error.h:116
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:967
#define CPL_NO_RETURN
Qualifier for a function that does not return at all (terminates the process)
Definition: cpl_port.h:1016
CPLErrorHandler CPLSetErrorHandlerEx(CPLErrorHandler, void *)
Install custom error handle with user's data.
Definition: cpl_error.cpp:985
void CPLPopErrorHandler(void)
Pop error handler off stack.
Definition: cpl_error.cpp:1140
#define CPLE_HttpResponse
HTTP response.
Definition: cpl_error.h:124
void CPLDebug(const char *, const char *,...)
Display a debugging message.
Definition: cpl_error.cpp:488
void CPLError(CPLErr eErrClass, CPLErrorNum err_no, const char *fmt,...)
Report an error.
Definition: cpl_error.cpp:211
void CPLErrorReset(void)
Erase any traces of previous errors.
Definition: cpl_error.cpp:649
#define CPLE_AWSSignatureDoesNotMatch
AWSSignatureDoesNotMatch.
Definition: cpl_error.h:134
#define CPLE_OutOfMemory
Out of memory error.
Definition: cpl_error.h:102
#define CPLE_NotSupported
Not supported.
Definition: cpl_error.h:110
void CPLQuietErrorHandler(CPLErr, CPLErrorNum, const char *)
Error handler that does not do anything, except for debug messages.
Definition: cpl_error.cpp:862
#define CPLE_AWSAccessDenied
AWSAccessDenied.
Definition: cpl_error.h:130
#define CPLE_AWSObjectNotFound
AWSObjectNotFound.
Definition: cpl_error.h:128
void * CPLGetErrorHandlerUserData(void)
Fetch the user data for the error context.
Definition: cpl_error.cpp:165
#define CPLE_AWSInvalidCredentials
AWSInvalidCredentials.
Definition: cpl_error.h:132
int CPLErrorNum
Error number.
Definition: cpl_error.h:95
CPLErrorNum CPLGetLastErrorNo(void)
Fetch the last error number.
Definition: cpl_error.cpp:736
CPLErrorHandler CPLSetErrorHandler(CPLErrorHandler)
Install custom error handler.
Definition: cpl_error.cpp:1062
void CPLErrorSetState(CPLErr eErrClass, CPLErrorNum err_no, const char *pszMsg)
Restore an error state, without emitting an error.
Definition: cpl_error.cpp:683
#define CPLE_AssertionFailed
Assertion failed.
Definition: cpl_error.h:112
void CPLEmergencyError(const char *) CPL_NO_RETURN
Fatal error when things are bad.
Definition: cpl_error.cpp:397
void CPLPushErrorHandlerEx(CPLErrorHandler, void *)
Push a new CPLError handler with user data on the error context.
Definition: cpl_error.cpp:1106
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:989
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:354
void CPLErrorV(CPLErr, CPLErrorNum, const char *, va_list)
Same as CPLError() but with a va_list.
Definition: cpl_error.cpp:227
#define CPLE_None
No error.
Definition: cpl_error.h:98
void CPLLoggingErrorHandler(CPLErr, CPLErrorNum, const char *)
Error handler that logs into the file defined by the CPL_LOG configuration option, or stderr otherwise.
Definition: cpl_error.cpp:877
CPLErr
Error category.
Definition: cpl_error.h:52
#define CPLE_IllegalArg
Illegal argument.
Definition: cpl_error.h:108