Line data Source code
1 : /**********************************************************************
2 : *
3 : * Name: cpl_error.h
4 : * Project: CPL - Common Portability Library
5 : * Purpose: CPL Error handling
6 : * Author: Daniel Morissette, danmo@videotron.ca
7 : *
8 : **********************************************************************
9 : * Copyright (c) 1998, Daniel Morissette
10 : *
11 : * SPDX-License-Identifier: MIT
12 : ****************************************************************************/
13 :
14 : #ifndef CPL_ERROR_H_INCLUDED
15 : #define CPL_ERROR_H_INCLUDED
16 :
17 : #include "cpl_port.h"
18 :
19 : #include <stdarg.h>
20 : #include <stdbool.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 :
130 : #ifdef GDAL_COMPILATION
131 :
132 : const char CPL_DLL *CPLSPrintf(CPL_FORMAT_STRING(const char *fmt), ...)
133 : CPL_PRINT_FUNC_FORMAT(1, 2) CPL_WARN_UNUSED_RESULT;
134 :
135 : /** Similar to CPLError(), but only execute it once during the life-time
136 : * of a process.
137 : *
138 : * @since 3.11
139 : */
140 : #define CPLErrorOnce(eErrClass, err_no, ...) \
141 : do \
142 : { \
143 : static bool lbCPLErrorOnce = false; \
144 : if (!lbCPLErrorOnce) \
145 : { \
146 : lbCPLErrorOnce = true; \
147 : const char *lCPLErrorMsg = CPLSPrintf(__VA_ARGS__); \
148 : const size_t lCPLErrorMsgLen = strlen(lCPLErrorMsg); \
149 : const char *lCPLErrorMsgSuffix = \
150 : " Further messages of this type will be suppressed."; \
151 : if (lCPLErrorMsgLen && lCPLErrorMsg[lCPLErrorMsgLen - 1] == '.') \
152 : CPLError((eErrClass), (err_no), "%s%s", lCPLErrorMsg, \
153 : lCPLErrorMsgSuffix); \
154 : else \
155 : CPLError((eErrClass), (err_no), "%s.%s", lCPLErrorMsg, \
156 : lCPLErrorMsgSuffix); \
157 : } \
158 : } while (0)
159 : #endif
160 :
161 : void CPL_DLL CPLErrorV(CPLErr, CPLErrorNum, const char *, va_list);
162 : void CPL_DLL CPLEmergencyError(const char *) CPL_NO_RETURN;
163 : void CPL_DLL CPL_STDCALL CPLErrorReset(void);
164 : CPLErrorNum CPL_DLL CPL_STDCALL CPLGetLastErrorNo(void);
165 : CPLErr CPL_DLL CPL_STDCALL CPLGetLastErrorType(void);
166 : const char CPL_DLL *CPL_STDCALL CPLGetLastErrorMsg(void);
167 : GUInt32 CPL_DLL CPL_STDCALL CPLGetErrorCounter(void);
168 : void CPL_DLL *CPL_STDCALL CPLGetErrorHandlerUserData(void);
169 : void CPL_DLL CPLErrorSetState(CPLErr eErrClass, CPLErrorNum err_no,
170 : const char *pszMsg);
171 : void CPL_DLL CPLCallPreviousHandler(CPLErr eErrClass, CPLErrorNum err_no,
172 : const char *pszMsg);
173 : /*! @cond Doxygen_Suppress */
174 : void CPL_DLL CPLCleanupErrorMutex(void);
175 : /*! @endcond */
176 :
177 : /** Callback for a custom error handler */
178 : typedef void(CPL_STDCALL *CPLErrorHandler)(CPLErr, CPLErrorNum, const char *);
179 :
180 : void CPL_DLL CPL_STDCALL CPLLoggingErrorHandler(CPLErr, CPLErrorNum,
181 : const char *);
182 : void CPL_DLL CPL_STDCALL CPLDefaultErrorHandler(CPLErr, CPLErrorNum,
183 : const char *);
184 : void CPL_DLL CPL_STDCALL CPLQuietErrorHandler(CPLErr, CPLErrorNum,
185 : const char *);
186 : void CPL_DLL CPLTurnFailureIntoWarning(int bOn);
187 :
188 : CPLErrorHandler CPL_DLL CPLGetErrorHandler(void **ppUserData);
189 :
190 : CPLErrorHandler CPL_DLL CPL_STDCALL CPLSetErrorHandler(CPLErrorHandler);
191 : CPLErrorHandler CPL_DLL CPL_STDCALL CPLSetErrorHandlerEx(CPLErrorHandler,
192 : void *);
193 : void CPL_DLL CPL_STDCALL CPLPushErrorHandler(CPLErrorHandler);
194 : void CPL_DLL CPL_STDCALL CPLPushErrorHandlerEx(CPLErrorHandler, void *);
195 : void CPL_DLL CPL_STDCALL CPLSetCurrentErrorHandlerCatchDebug(int bCatchDebug);
196 : void CPL_DLL CPL_STDCALL CPLPopErrorHandler(void);
197 :
198 : #ifdef WITHOUT_CPLDEBUG
199 : #define CPLDebug(...) \
200 : do \
201 : { \
202 : } while (0) /* Eat all CPLDebug calls. */
203 : #define CPLDebugProgress(...) \
204 : do \
205 : { \
206 : } while (0) /* Eat all CPLDebugProgress calls. */
207 :
208 : #ifdef GDAL_COMPILATION
209 : /** Similar to CPLDebug(), but only execute it once during the life-time
210 : * of a process.
211 : *
212 : * @since 3.11
213 : */
214 : #define CPLDebugOnce(...) \
215 : do \
216 : { \
217 : } while (0)
218 : #endif
219 :
220 : #else
221 : void CPL_DLL CPLDebug(const char *, CPL_FORMAT_STRING(const char *), ...)
222 : CPL_PRINT_FUNC_FORMAT(2, 3);
223 : void CPL_DLL CPLDebugProgress(const char *, CPL_FORMAT_STRING(const char *),
224 : ...) CPL_PRINT_FUNC_FORMAT(2, 3);
225 :
226 : #ifdef GDAL_COMPILATION
227 : /** Similar to CPLDebug(), but only execute it once during the life-time
228 : * of a process.
229 : *
230 : * @since 3.11
231 : */
232 : #define CPLDebugOnce(category, ...) \
233 : do \
234 : { \
235 : static bool lbCPLDebugOnce = false; \
236 : if (!lbCPLDebugOnce) \
237 : { \
238 : lbCPLDebugOnce = true; \
239 : const char *lCPLDebugMsg = CPLSPrintf(__VA_ARGS__); \
240 : const size_t lCPLErrorMsgLen = strlen(lCPLDebugMsg); \
241 : const char *lCPLDebugMsgSuffix = \
242 : " Further messages of this type will be suppressed."; \
243 : if (lCPLErrorMsgLen && lCPLDebugMsg[lCPLErrorMsgLen - 1] == '.') \
244 : CPLDebug((category), "%s%s", lCPLDebugMsg, \
245 : lCPLDebugMsgSuffix); \
246 : else \
247 : CPLDebug((category), "%s.%s", lCPLDebugMsg, \
248 : lCPLDebugMsgSuffix); \
249 : } \
250 : } while (0)
251 : #endif
252 :
253 : #endif
254 :
255 : #if defined(DEBUG) || defined(GDAL_DEBUG)
256 : /** Same as CPLDebug(), but expands to nothing for non-DEBUG builds.
257 : * @since GDAL 3.1
258 : */
259 : #define CPLDebugOnly(...) CPLDebug(__VA_ARGS__)
260 : #else
261 : /** Same as CPLDebug(), but expands to nothing for non-DEBUG builds.
262 : * @since GDAL 3.1
263 : */
264 : #define CPLDebugOnly(...) \
265 : do \
266 : { \
267 : } while (0)
268 : #endif
269 :
270 : void CPL_DLL CPL_STDCALL _CPLAssert(const char *, const char *,
271 : int) CPL_NO_RETURN;
272 :
273 : #if defined(DEBUG) && !defined(CPPCHECK)
274 : /** Assert on an expression. Only enabled in DEBUG mode */
275 : #define CPLAssert(expr) \
276 : ((expr) ? (void)(0) : _CPLAssert(#expr, __FILE__, __LINE__))
277 : /** Assert on an expression in DEBUG mode. Evaluate it also in non-DEBUG mode
278 : * (useful to 'consume' a error return variable) */
279 : #define CPLAssertAlwaysEval(expr) CPLAssert(expr)
280 : #else
281 : /** Assert on an expression. Only enabled in DEBUG mode */
282 : #define CPLAssert(expr) \
283 : do \
284 : { \
285 : } while (0)
286 : #ifdef __cplusplus
287 : /** Assert on an expression in DEBUG mode. Evaluate it also in non-DEBUG mode
288 : * (useful to 'consume' a error return variable) */
289 : #define CPLAssertAlwaysEval(expr) CPL_IGNORE_RET_VAL(expr)
290 : #else
291 : /** Assert on an expression in DEBUG mode. Evaluate it also in non-DEBUG mode
292 : * (useful to 'consume' a error return variable) */
293 : #define CPLAssertAlwaysEval(expr) (void)(expr)
294 : #endif
295 : #endif
296 :
297 : CPL_C_END
298 :
299 : /*! @cond Doxygen_Suppress */
300 : /*
301 : * Helper macros used for input parameters validation.
302 : */
303 : #ifdef DEBUG
304 : #define VALIDATE_POINTER_ERR CE_Fatal
305 : #else
306 : #define VALIDATE_POINTER_ERR CE_Failure
307 : #endif
308 :
309 : /*! @endcond */
310 :
311 : #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
312 :
313 : extern "C++"
314 : {
315 : /*! @cond Doxygen_Suppress */
316 : template <class T> T *CPLAssertNotNull(T *x) CPL_RETURNS_NONNULL;
317 :
318 102 : template <class T> T *CPLAssertNotNull(T *x)
319 : {
320 102 : CPLAssert(x);
321 102 : return x;
322 : }
323 :
324 : #include <memory>
325 : #include <string>
326 :
327 : /*! @endcond */
328 :
329 : /** Class that installs a (thread-local) error handler on construction, and
330 : * restore the initial one on destruction.
331 : */
332 : class CPL_DLL CPLErrorHandlerPusher
333 : {
334 : public:
335 : /** Constructor that installs a thread-local temporary error handler
336 : * (typically CPLQuietErrorHandler)
337 : */
338 83116 : explicit CPLErrorHandlerPusher(CPLErrorHandler hHandler)
339 : {
340 83116 : CPLPushErrorHandler(hHandler);
341 83094 : }
342 :
343 : /** Constructor that installs a thread-local temporary error handler,
344 : * and its user data.
345 : */
346 3736 : CPLErrorHandlerPusher(CPLErrorHandler hHandler, void *user_data)
347 : {
348 3736 : CPLPushErrorHandlerEx(hHandler, user_data);
349 3734 : }
350 :
351 : /** Destructor that restores the initial error handler. */
352 86806 : ~CPLErrorHandlerPusher()
353 : {
354 86806 : CPLPopErrorHandler();
355 86823 : }
356 : };
357 :
358 : /** Class that saves the error state on construction, and
359 : * restores it on destruction.
360 : */
361 : class CPL_DLL CPLErrorStateBackuper
362 : {
363 : CPLErrorNum m_nLastErrorNum;
364 : CPLErr m_nLastErrorType;
365 : std::string m_osLastErrorMsg;
366 : GUInt32 m_nLastErrorCounter;
367 : std::unique_ptr<CPLErrorHandlerPusher> m_poErrorHandlerPusher;
368 :
369 : public:
370 : /** Constructor that backs up the error state, and optionally installs
371 : * a thread-local temporary error handler (typically CPLQuietErrorHandler).
372 : */
373 : explicit CPLErrorStateBackuper(CPLErrorHandler hHandler = nullptr);
374 :
375 : /** Destructor that restores the error state to its initial state
376 : * before construction.
377 : */
378 : ~CPLErrorStateBackuper();
379 : };
380 : }
381 :
382 : #ifdef GDAL_COMPILATION
383 : /*! @cond Doxygen_Suppress */
384 : // internal only
385 : bool CPLIsDefaultErrorHandlerAndCatchDebug();
386 : /*! @endcond */
387 : #endif
388 :
389 : #endif
390 :
391 : /** Validate that a pointer is not NULL */
392 : #define VALIDATE_POINTER0(ptr, func) \
393 : do \
394 : { \
395 : if (CPL_NULLPTR == ptr) \
396 : { \
397 : CPLErr const ret = VALIDATE_POINTER_ERR; \
398 : CPLError(ret, CPLE_ObjectNull, \
399 : "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
400 : return; \
401 : } \
402 : } while (0)
403 :
404 : /** Validate that a pointer is not NULL, and return rc if it is NULL */
405 : #define VALIDATE_POINTER1(ptr, func, rc) \
406 : do \
407 : { \
408 : if (CPL_NULLPTR == ptr) \
409 : { \
410 : CPLErr const ret = VALIDATE_POINTER_ERR; \
411 : CPLError(ret, CPLE_ObjectNull, \
412 : "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
413 : return (rc); \
414 : } \
415 : } while (0)
416 :
417 : #endif /* CPL_ERROR_H_INCLUDED */
|
