Line data Source code
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 : * SPDX-License-Identifier: MIT
13 : ****************************************************************************/
14 :
15 : #ifndef CPL_ERROR_H_INCLUDED
16 : #define CPL_ERROR_H_INCLUDED
17 :
18 : #include "cpl_port.h"
19 :
20 : #include <stdarg.h>
21 : #include <stddef.h>
22 :
23 : /*=====================================================================
24 : Error handling functions (cpl_error.c)
25 : =====================================================================*/
26 :
27 : /**
28 : * \file cpl_error.h
29 : *
30 : * CPL error handling services.
31 : */
32 :
33 : CPL_C_START
34 :
35 : /** Error category */
36 : typedef enum
37 : {
38 : CE_None = 0,
39 : CE_Debug = 1,
40 : CE_Warning = 2,
41 : CE_Failure = 3,
42 : CE_Fatal = 4
43 : } CPLErr;
44 :
45 : /* ==================================================================== */
46 : /* Well known error codes. */
47 : /* ==================================================================== */
48 :
49 : #ifdef STRICT_CPLERRORNUM_TYPE
50 :
51 : /* This is not appropriate for the general case, as there are parts */
52 : /* of GDAL which use custom error codes, but this can help diagnose confusions
53 : */
54 : /* between CPLErr and CPLErrorNum */
55 : typedef enum
56 : {
57 : CPLE_None,
58 : CPLE_AppDefined,
59 : CPLE_OutOfMemory,
60 : CPLE_FileIO,
61 : CPLE_OpenFailed,
62 : CPLE_IllegalArg,
63 : CPLE_NotSupported,
64 : CPLE_AssertionFailed,
65 : CPLE_NoWriteAccess,
66 : CPLE_UserInterrupt,
67 : CPLE_ObjectNull,
68 : CPLE_HttpResponse,
69 : CPLE_AWSBucketNotFound,
70 : CPLE_AWSObjectNotFound,
71 : CPLE_AWSAccessDenied,
72 : CPLE_AWSInvalidCredentials,
73 : CPLE_AWSSignatureDoesNotMatch,
74 : } CPLErrorNum;
75 :
76 : #else
77 :
78 : /** Error number */
79 : typedef int CPLErrorNum;
80 :
81 : /** No error */
82 : #define CPLE_None 0
83 : /** Application defined error */
84 : #define CPLE_AppDefined 1
85 : /** Out of memory error */
86 : #define CPLE_OutOfMemory 2
87 : /** File I/O error */
88 : #define CPLE_FileIO 3
89 : /** Open failed */
90 : #define CPLE_OpenFailed 4
91 : /** Illegal argument */
92 : #define CPLE_IllegalArg 5
93 : /** Not supported */
94 : #define CPLE_NotSupported 6
95 : /** Assertion failed */
96 : #define CPLE_AssertionFailed 7
97 : /** No write access */
98 : #define CPLE_NoWriteAccess 8
99 : /** User interrupted */
100 : #define CPLE_UserInterrupt 9
101 : /** NULL object */
102 : #define CPLE_ObjectNull 10
103 :
104 : /*
105 : * Filesystem-specific errors
106 : */
107 : /** HTTP response */
108 : #define CPLE_HttpResponse 11
109 : /** AWSBucketNotFound */
110 : #define CPLE_AWSBucketNotFound 12
111 : /** AWSObjectNotFound */
112 : #define CPLE_AWSObjectNotFound 13
113 : /** AWSAccessDenied */
114 : #define CPLE_AWSAccessDenied 14
115 : /** AWSInvalidCredentials */
116 : #define CPLE_AWSInvalidCredentials 15
117 : /** AWSSignatureDoesNotMatch */
118 : #define CPLE_AWSSignatureDoesNotMatch 16
119 : /** VSIE_AWSError */
120 : #define CPLE_AWSError 17
121 :
122 : /* 100 - 299 reserved for GDAL */
123 :
124 : #endif
125 :
126 : void CPL_DLL CPLError(CPLErr eErrClass, CPLErrorNum err_no,
127 : CPL_FORMAT_STRING(const char *fmt), ...)
128 : CPL_PRINT_FUNC_FORMAT(3, 4);
129 : void CPL_DLL CPLErrorV(CPLErr, CPLErrorNum, const char *, va_list);
130 : void CPL_DLL CPLEmergencyError(const char *) CPL_NO_RETURN;
131 : void CPL_DLL CPL_STDCALL CPLErrorReset(void);
132 : CPLErrorNum CPL_DLL CPL_STDCALL CPLGetLastErrorNo(void);
133 : CPLErr CPL_DLL CPL_STDCALL CPLGetLastErrorType(void);
134 : const char CPL_DLL *CPL_STDCALL CPLGetLastErrorMsg(void);
135 : GUInt32 CPL_DLL CPL_STDCALL CPLGetErrorCounter(void);
136 : void CPL_DLL *CPL_STDCALL CPLGetErrorHandlerUserData(void);
137 : void CPL_DLL CPLErrorSetState(CPLErr eErrClass, CPLErrorNum err_no,
138 : const char *pszMsg);
139 : void CPL_DLL CPLCallPreviousHandler(CPLErr eErrClass, CPLErrorNum err_no,
140 : const char *pszMsg);
141 : /*! @cond Doxygen_Suppress */
142 : void CPL_DLL CPLCleanupErrorMutex(void);
143 : /*! @endcond */
144 :
145 : /** Callback for a custom error handler */
146 : typedef void(CPL_STDCALL *CPLErrorHandler)(CPLErr, CPLErrorNum, const char *);
147 :
148 : void CPL_DLL CPL_STDCALL CPLLoggingErrorHandler(CPLErr, CPLErrorNum,
149 : const char *);
150 : void CPL_DLL CPL_STDCALL CPLDefaultErrorHandler(CPLErr, CPLErrorNum,
151 : const char *);
152 : void CPL_DLL CPL_STDCALL CPLQuietErrorHandler(CPLErr, CPLErrorNum,
153 : const char *);
154 : void CPL_DLL CPLTurnFailureIntoWarning(int bOn);
155 :
156 : CPLErrorHandler CPL_DLL CPLGetErrorHandler(void **ppUserData);
157 :
158 : CPLErrorHandler CPL_DLL CPL_STDCALL CPLSetErrorHandler(CPLErrorHandler);
159 : CPLErrorHandler CPL_DLL CPL_STDCALL CPLSetErrorHandlerEx(CPLErrorHandler,
160 : void *);
161 : void CPL_DLL CPL_STDCALL CPLPushErrorHandler(CPLErrorHandler);
162 : void CPL_DLL CPL_STDCALL CPLPushErrorHandlerEx(CPLErrorHandler, void *);
163 : void CPL_DLL CPL_STDCALL CPLSetCurrentErrorHandlerCatchDebug(int bCatchDebug);
164 : void CPL_DLL CPL_STDCALL CPLPopErrorHandler(void);
165 :
166 : #ifdef WITHOUT_CPLDEBUG
167 : #define CPLDebug(...) \
168 : do \
169 : { \
170 : } while (0) /* Eat all CPLDebug calls. */
171 : #define CPLDebugProgress(...) \
172 : do \
173 : { \
174 : } while (0) /* Eat all CPLDebugProgress calls. */
175 : #else
176 : void CPL_DLL CPLDebug(const char *, CPL_FORMAT_STRING(const char *), ...)
177 : CPL_PRINT_FUNC_FORMAT(2, 3);
178 : void CPL_DLL CPLDebugProgress(const char *, CPL_FORMAT_STRING(const char *),
179 : ...) CPL_PRINT_FUNC_FORMAT(2, 3);
180 : #endif
181 :
182 : #ifdef DEBUG
183 : /** Same as CPLDebug(), but expands to nothing for non-DEBUG builds.
184 : * @since GDAL 3.1
185 : */
186 : #define CPLDebugOnly(...) CPLDebug(__VA_ARGS__)
187 : #else
188 : /** Same as CPLDebug(), but expands to nothing for non-DEBUG builds.
189 : * @since GDAL 3.1
190 : */
191 : #define CPLDebugOnly(...) \
192 : do \
193 : { \
194 : } while (0)
195 : #endif
196 :
197 : void CPL_DLL CPL_STDCALL _CPLAssert(const char *, const char *,
198 : int) CPL_NO_RETURN;
199 :
200 : #if defined(DEBUG) && !defined(CPPCHECK)
201 : /** Assert on an expression. Only enabled in DEBUG mode */
202 : #define CPLAssert(expr) \
203 : ((expr) ? (void)(0) : _CPLAssert(#expr, __FILE__, __LINE__))
204 : /** Assert on an expression in DEBUG mode. Evaluate it also in non-DEBUG mode
205 : * (useful to 'consume' a error return variable) */
206 : #define CPLAssertAlwaysEval(expr) CPLAssert(expr)
207 : #else
208 : /** Assert on an expression. Only enabled in DEBUG mode */
209 : #define CPLAssert(expr) \
210 : do \
211 : { \
212 : } while (0)
213 : #ifdef __cplusplus
214 : /** Assert on an expression in DEBUG mode. Evaluate it also in non-DEBUG mode
215 : * (useful to 'consume' a error return variable) */
216 : #define CPLAssertAlwaysEval(expr) CPL_IGNORE_RET_VAL(expr)
217 : #else
218 : /** Assert on an expression in DEBUG mode. Evaluate it also in non-DEBUG mode
219 : * (useful to 'consume' a error return variable) */
220 : #define CPLAssertAlwaysEval(expr) (void)(expr)
221 : #endif
222 : #endif
223 :
224 : CPL_C_END
225 :
226 : /*! @cond Doxygen_Suppress */
227 : /*
228 : * Helper macros used for input parameters validation.
229 : */
230 : #ifdef DEBUG
231 : #define VALIDATE_POINTER_ERR CE_Fatal
232 : #else
233 : #define VALIDATE_POINTER_ERR CE_Failure
234 : #endif
235 :
236 : /*! @endcond */
237 :
238 : #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
239 :
240 : extern "C++"
241 : {
242 : /*! @cond Doxygen_Suppress */
243 : template <class T> T *CPLAssertNotNull(T *x) CPL_RETURNS_NONNULL;
244 :
245 99 : template <class T> T *CPLAssertNotNull(T *x)
246 : {
247 99 : CPLAssert(x);
248 99 : return x;
249 : }
250 :
251 : #include <memory>
252 : #include <string>
253 :
254 : /*! @endcond */
255 :
256 : /** Class that installs a (thread-local) error handler on construction, and
257 : * restore the initial one on destruction.
258 : */
259 : class CPL_DLL CPLErrorHandlerPusher
260 : {
261 : public:
262 : /** Constructor that installs a thread-local temporary error handler
263 : * (typically CPLQuietErrorHandler)
264 : */
265 81914 : explicit CPLErrorHandlerPusher(CPLErrorHandler hHandler)
266 : {
267 81914 : CPLPushErrorHandler(hHandler);
268 81916 : }
269 :
270 : /** Constructor that installs a thread-local temporary error handler,
271 : * and its user data.
272 : */
273 3734 : CPLErrorHandlerPusher(CPLErrorHandler hHandler, void *user_data)
274 : {
275 3734 : CPLPushErrorHandlerEx(hHandler, user_data);
276 3734 : }
277 :
278 : /** Destructor that restores the initial error handler. */
279 85648 : ~CPLErrorHandlerPusher()
280 : {
281 85648 : CPLPopErrorHandler();
282 85648 : }
283 : };
284 :
285 : /** Class that saves the error state on construction, and
286 : * restores it on destruction.
287 : */
288 : class CPL_DLL CPLErrorStateBackuper
289 : {
290 : CPLErrorNum m_nLastErrorNum;
291 : CPLErr m_nLastErrorType;
292 : std::string m_osLastErrorMsg;
293 : GUInt32 m_nLastErrorCounter;
294 : std::unique_ptr<CPLErrorHandlerPusher> m_poErrorHandlerPusher;
295 :
296 : public:
297 : /** Constructor that backs up the error state, and optionally installs
298 : * a thread-local temporary error handler (typically CPLQuietErrorHandler).
299 : */
300 : explicit CPLErrorStateBackuper(CPLErrorHandler hHandler = nullptr);
301 :
302 : /** Destructor that restores the error state to its initial state
303 : * before construction.
304 : */
305 : ~CPLErrorStateBackuper();
306 : };
307 : }
308 :
309 : #ifdef GDAL_COMPILATION
310 : /*! @cond Doxygen_Suppress */
311 : // internal only
312 : bool CPLIsDefaultErrorHandlerAndCatchDebug();
313 : /*! @endcond */
314 : #endif
315 :
316 : #endif
317 :
318 : /** Validate that a pointer is not NULL */
319 : #define VALIDATE_POINTER0(ptr, func) \
320 : do \
321 : { \
322 : if (CPL_NULLPTR == ptr) \
323 : { \
324 : CPLErr const ret = VALIDATE_POINTER_ERR; \
325 : CPLError(ret, CPLE_ObjectNull, \
326 : "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
327 : return; \
328 : } \
329 : } while (0)
330 :
331 : /** Validate that a pointer is not NULL, and return rc if it is NULL */
332 : #define VALIDATE_POINTER1(ptr, func, rc) \
333 : do \
334 : { \
335 : if (CPL_NULLPTR == ptr) \
336 : { \
337 : CPLErr const ret = VALIDATE_POINTER_ERR; \
338 : CPLError(ret, CPLE_ObjectNull, \
339 : "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
340 : return (rc); \
341 : } \
342 : } while (0)
343 :
344 : #endif /* CPL_ERROR_H_INCLUDED */
|
