GDAL
cpl_error.h
Go to the documentation of this file.
1 /**********************************************************************
2  * $Id: cpl_error.h 39218 2017-06-20 20:54:08Z rouault $
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 
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 /* between CPLErr and CPLErrorNum */
70 typedef enum
71 {
72  CPLE_None,
89 } CPLErrorNum;
90 
91 #else
92 
94 typedef int CPLErrorNum;
95 
97 #define CPLE_None 0
98 
99 #define CPLE_AppDefined 1
100 
101 #define CPLE_OutOfMemory 2
102 
103 #define CPLE_FileIO 3
104 
105 #define CPLE_OpenFailed 4
106 
107 #define CPLE_IllegalArg 5
108 
109 #define CPLE_NotSupported 6
110 
111 #define CPLE_AssertionFailed 7
112 
113 #define CPLE_NoWriteAccess 8
114 
115 #define CPLE_UserInterrupt 9
116 
117 #define CPLE_ObjectNull 10
118 
119 /*
120  * Filesystem-specific errors
121  */
123 #define CPLE_HttpResponse 11
124 
125 #define CPLE_AWSBucketNotFound 12
126 
127 #define CPLE_AWSObjectNotFound 13
128 
129 #define CPLE_AWSAccessDenied 14
130 
131 #define CPLE_AWSInvalidCredentials 15
132 
133 #define CPLE_AWSSignatureDoesNotMatch 16
134 
135 /* 100 - 299 reserved for GDAL */
136 
137 #endif
138 
139 void CPL_DLL CPLError(CPLErr eErrClass, CPLErrorNum err_no, CPL_FORMAT_STRING(const char *fmt), ...) CPL_PRINT_FUNC_FORMAT (3, 4);
140 void CPL_DLL CPLErrorV(CPLErr, CPLErrorNum, const char *, va_list );
141 void CPL_DLL CPLEmergencyError( const char * ) CPL_NO_RETURN;
142 void CPL_DLL CPL_STDCALL CPLErrorReset( void );
143 CPLErrorNum CPL_DLL CPL_STDCALL CPLGetLastErrorNo( void );
144 CPLErr CPL_DLL CPL_STDCALL CPLGetLastErrorType( void );
145 const char CPL_DLL * CPL_STDCALL CPLGetLastErrorMsg( void );
146 GUInt32 CPL_DLL CPL_STDCALL CPLGetErrorCounter( void );
147 void CPL_DLL * CPL_STDCALL CPLGetErrorHandlerUserData(void);
148 void CPL_DLL CPLErrorSetState( CPLErr eErrClass, CPLErrorNum err_no, const char* pszMsg );
150 void CPL_DLL CPLCleanupErrorMutex( void );
154 typedef void (CPL_STDCALL *CPLErrorHandler)(CPLErr, CPLErrorNum, const char*);
155 
156 void CPL_DLL CPL_STDCALL CPLLoggingErrorHandler( CPLErr, CPLErrorNum, const char * );
157 void CPL_DLL CPL_STDCALL CPLDefaultErrorHandler( CPLErr, CPLErrorNum, const char * );
158 void CPL_DLL CPL_STDCALL CPLQuietErrorHandler( CPLErr, CPLErrorNum, const char * );
159 void CPLTurnFailureIntoWarning( int bOn );
160 
161 CPLErrorHandler CPL_DLL CPL_STDCALL CPLSetErrorHandler( CPLErrorHandler );
162 CPLErrorHandler CPL_DLL CPL_STDCALL CPLSetErrorHandlerEx( CPLErrorHandler, void* );
163 void CPL_DLL CPL_STDCALL CPLPushErrorHandler( CPLErrorHandler );
164 void CPL_DLL CPL_STDCALL CPLPushErrorHandlerEx( CPLErrorHandler, void* );
165 void CPL_DLL CPL_STDCALL CPLSetCurrentErrorHandlerCatchDebug( int bCatchDebug );
166 void CPL_DLL CPL_STDCALL CPLPopErrorHandler(void);
167 
168 #ifdef WITHOUT_CPLDEBUG
169 #define CPLDebug(...) /* Eat all CPLDebug calls. */
170 #else
171 void CPL_DLL CPL_STDCALL CPLDebug(const char *, CPL_FORMAT_STRING(const char *), ...)
172  CPL_PRINT_FUNC_FORMAT(2, 3);
173 #endif
174 
175 void CPL_DLL CPL_STDCALL _CPLAssert( const char *, const char *, int ) CPL_NO_RETURN;
176 
177 #ifdef DEBUG
178 
179 # define CPLAssert(expr) ((expr) ? (void)(0) : _CPLAssert(#expr,__FILE__,__LINE__))
180 #else
181 
182 # define CPLAssert(expr)
183 #endif
184 
185 CPL_C_END
186 
188 /*
189  * Helper macros used for input parameters validation.
190  */
191 #ifdef DEBUG
192 # define VALIDATE_POINTER_ERR CE_Fatal
193 #else
194 # define VALIDATE_POINTER_ERR CE_Failure
195 #endif
196 
199 #define VALIDATE_POINTER0(ptr, func) \
200  do { if( NULL == ptr ) \
201  { \
202  CPLErr const ret = VALIDATE_POINTER_ERR; \
203  CPLError( ret, CPLE_ObjectNull, \
204  "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
205  return; }} while(0)
206 
208 #define VALIDATE_POINTER1(ptr, func, rc) \
209  do { if( NULL == ptr ) \
210  { \
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)
215 
216 #endif /* CPL_ERROR_H_INCLUDED */
#define CPLE_FileIO
File I/O error.
Definition: cpl_error.h:103
#define CPLE_AppDefined
Application defined error.
Definition: cpl_error.h:99
void CPLPushErrorHandler(CPLErrorHandler)
Push a new CPLError handler.
Definition: cpl_error.cpp:1134
CPLErr CPLGetLastErrorType(void)
Fetch the last error type.
Definition: cpl_error.cpp:788
Core portability definitions for CPL.
#define CPLE_AWSBucketNotFound
AWSBucketNotFound.
Definition: cpl_error.h:125
#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:1004
#define CPLE_OpenFailed
Open failed.
Definition: cpl_error.h:105
unsigned int GUInt32
Unsigned int32 type.
Definition: cpl_port.h:199
#define CPLE_NoWriteAccess
No write access.
Definition: cpl_error.h:113
void _CPLAssert(const char *, const char *, int) CPL_NO_RETURN
Report failure of a logical assertion.
Definition: cpl_error.cpp:1264
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:1230
const char * CPLGetLastErrorMsg(void)
Get the last error message.
Definition: cpl_error.cpp:812
#define CPLE_ObjectNull
NULL object.
Definition: cpl_error.h:117
void CPLDefaultErrorHandler(CPLErr, CPLErrorNum, const char *)
Default error handler.
Definition: cpl_error.cpp:849
#define CPLE_UserInterrupt
User interrupted.
Definition: cpl_error.h:115
#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:1036
void CPLPopErrorHandler(void)
Pop error handler off stack.
Definition: cpl_error.cpp:1191
#define CPLE_HttpResponse
HTTP response.
Definition: cpl_error.h:123
void CPLDebug(const char *, const char *,...)
Display a debugging message.
Definition: cpl_error.cpp:514
void CPLError(CPLErr eErrClass, CPLErrorNum err_no, const char *fmt,...)
Report an error.
Definition: cpl_error.cpp:232
void CPLErrorReset(void)
Erase any traces of previous errors.
Definition: cpl_error.cpp:675
#define CPLE_AWSSignatureDoesNotMatch
AWSSignatureDoesNotMatch.
Definition: cpl_error.h:133
#define CPLE_OutOfMemory
Out of memory error.
Definition: cpl_error.h:101
#define CPLE_NotSupported
Not supported.
Definition: cpl_error.h:109
void CPLQuietErrorHandler(CPLErr, CPLErrorNum, const char *)
Error handler that does not do anything, except for debug messages.
Definition: cpl_error.cpp:913
#define CPLE_AWSAccessDenied
AWSAccessDenied.
Definition: cpl_error.h:129
#define CPLE_AWSObjectNotFound
AWSObjectNotFound.
Definition: cpl_error.h:127
void * CPLGetErrorHandlerUserData(void)
Fetch the user data for the error context.
Definition: cpl_error.cpp:186
#define CPLE_AWSInvalidCredentials
AWSInvalidCredentials.
Definition: cpl_error.h:131
int CPLErrorNum
Error number.
Definition: cpl_error.h:94
CPLErrorNum CPLGetLastErrorNo(void)
Fetch the last error number.
Definition: cpl_error.cpp:764
void(* CPLErrorHandler)(CPLErr, CPLErrorNum, const char *)
Callback for a custom error handler.
Definition: cpl_error.h:154
CPLErrorHandler CPLSetErrorHandler(CPLErrorHandler)
Install custom error handler.
Definition: cpl_error.cpp:1113
void CPLErrorSetState(CPLErr eErrClass, CPLErrorNum err_no, const char *pszMsg)
Restore an error state, without emitting an error.
Definition: cpl_error.cpp:710
#define CPLE_AssertionFailed
Assertion failed.
Definition: cpl_error.h:111
void CPLEmergencyError(const char *) CPL_NO_RETURN
Fatal error when things are bad.
Definition: cpl_error.cpp:423
void CPLPushErrorHandlerEx(CPLErrorHandler, void *)
Push a new CPLError handler with user data on the error context.
Definition: cpl_error.cpp:1157
#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:248
#define CPLE_None
No error.
Definition: cpl_error.h:97
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:928
GUInt32 CPLGetErrorCounter(void)
Get the error counter.
Definition: cpl_error.cpp:835
CPLErr
Error category.
Definition: cpl_error.h:52
#define CPLE_IllegalArg
Illegal argument.
Definition: cpl_error.h:107

Generated for GDAL by doxygen 1.8.8.