GDAL
cpl_error.h
Go to the documentation of this file.
1/**********************************************************************
2 * $Id: cpl_error.h e3511844a11959bd81f5956a1e7e2de96900e7ac 2019-04-25 11:53:15 +0200 Even 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
52typedef 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 */
70typedef enum
71{
90
91#else
92
94typedef int CPLErrorNum;
95
97#define CPLE_None 0
99#define CPLE_AppDefined 1
101#define CPLE_OutOfMemory 2
103#define CPLE_FileIO 3
105#define CPLE_OpenFailed 4
107#define CPLE_IllegalArg 5
109#define CPLE_NotSupported 6
111#define CPLE_AssertionFailed 7
113#define CPLE_NoWriteAccess 8
115#define CPLE_UserInterrupt 9
117#define CPLE_ObjectNull 10
118
119/*
120 * Filesystem-specific errors
121 */
123#define CPLE_HttpResponse 11
125#define CPLE_AWSBucketNotFound 12
127#define CPLE_AWSObjectNotFound 13
129#define CPLE_AWSAccessDenied 14
131#define CPLE_AWSInvalidCredentials 15
133#define CPLE_AWSSignatureDoesNotMatch 16
135#define CPLE_AWSError 17
136
137/* 100 - 299 reserved for GDAL */
138
139#endif
140
141void CPL_DLL CPLError(CPLErr eErrClass, CPLErrorNum err_no, CPL_FORMAT_STRING(const char *fmt), ...) CPL_PRINT_FUNC_FORMAT (3, 4);
142void CPL_DLL CPLErrorV(CPLErr, CPLErrorNum, const char *, va_list );
143void CPL_DLL CPLEmergencyError( const char * ) CPL_NO_RETURN;
144void CPL_DLL CPL_STDCALL CPLErrorReset( void );
145CPLErrorNum CPL_DLL CPL_STDCALL CPLGetLastErrorNo( void );
146CPLErr CPL_DLL CPL_STDCALL CPLGetLastErrorType( void );
147const char CPL_DLL * CPL_STDCALL CPLGetLastErrorMsg( void );
148GUInt32 CPL_DLL CPL_STDCALL CPLGetErrorCounter( void );
149void CPL_DLL * CPL_STDCALL CPLGetErrorHandlerUserData(void);
150void CPL_DLL CPLErrorSetState( CPLErr eErrClass, CPLErrorNum err_no, const char* pszMsg );
152void CPL_DLL CPLCleanupErrorMutex( void );
156typedef void (CPL_STDCALL *CPLErrorHandler)(CPLErr, CPLErrorNum, const char*);
157
158void CPL_DLL CPL_STDCALL CPLLoggingErrorHandler( CPLErr, CPLErrorNum, const char * );
159void CPL_DLL CPL_STDCALL CPLDefaultErrorHandler( CPLErr, CPLErrorNum, const char * );
160void CPL_DLL CPL_STDCALL CPLQuietErrorHandler( CPLErr, CPLErrorNum, const char * );
161void CPLTurnFailureIntoWarning( int bOn );
162
164CPLErrorHandler CPL_DLL CPL_STDCALL CPLSetErrorHandlerEx( CPLErrorHandler, void* );
165void CPL_DLL CPL_STDCALL CPLPushErrorHandler( CPLErrorHandler );
166void CPL_DLL CPL_STDCALL CPLPushErrorHandlerEx( CPLErrorHandler, void* );
167void CPL_DLL CPL_STDCALL CPLSetCurrentErrorHandlerCatchDebug( int bCatchDebug );
168void CPL_DLL CPL_STDCALL CPLPopErrorHandler(void);
169
170#ifdef WITHOUT_CPLDEBUG
171#define CPLDebug(...) /* Eat all CPLDebug calls. */
172#else
173void CPL_DLL CPL_STDCALL CPLDebug(const char *, CPL_FORMAT_STRING(const char *), ...)
175#endif
176
177void CPL_DLL CPL_STDCALL _CPLAssert( const char *, const char *, int ) CPL_NO_RETURN;
178
179#ifdef DEBUG
181# define CPLAssert(expr) ((expr) ? (void)(0) : _CPLAssert(#expr,__FILE__,__LINE__))
183# define CPLAssertAlwaysEval(expr) CPLAssert(expr)
184#else
186# define CPLAssert(expr)
187#ifdef __cplusplus
189# define CPLAssertAlwaysEval(expr) CPL_IGNORE_RET_VAL(expr)
190#else
192# define CPLAssertAlwaysEval(expr) (void)(expr)
193#endif
194#endif
195
197
199/*
200 * Helper macros used for input parameters validation.
201 */
202#ifdef DEBUG
203# define VALIDATE_POINTER_ERR CE_Fatal
204#else
205# define VALIDATE_POINTER_ERR CE_Failure
206#endif
207
208
209#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS) && !defined(DOXYGEN_SKIP)
210
211extern "C++"
212{
213
214#include <string>
215
216class CPLErrorHandlerPusher
217{
218 public:
219 explicit CPLErrorHandlerPusher(CPLErrorHandler hHandler)
220 {
221 CPLPushErrorHandler(hHandler);
222 }
223
224 CPLErrorHandlerPusher(CPLErrorHandler hHandler, void* user_data)
225 {
226 CPLPushErrorHandlerEx(hHandler, user_data);
227 }
228
229 ~CPLErrorHandlerPusher()
230 {
232 }
233};
234
235class CPLErrorStateBackuper
236{
237 CPLErrorNum m_nLastErrorNum;
238 CPLErr m_nLastErrorType;
239 std::string m_osLastErrorMsg;
240
241 public:
242 CPLErrorStateBackuper() :
243 m_nLastErrorNum(CPLGetLastErrorNo()),
244 m_nLastErrorType(CPLGetLastErrorType()),
245 m_osLastErrorMsg(CPLGetLastErrorMsg())
246 {}
247
248 ~CPLErrorStateBackuper()
249 {
250 CPLErrorSetState(m_nLastErrorType, m_nLastErrorNum,
251 m_osLastErrorMsg.c_str());
252 }
253};
254
255}
256
257#ifdef GDAL_COMPILATION
258// internal only
259bool CPLIsDefaultErrorHandlerAndCatchDebug();
260#endif
261
262#endif
263
267#define VALIDATE_POINTER0(ptr, func) \
268 do { if( CPL_NULLPTR == ptr ) \
269 { \
270 CPLErr const ret = VALIDATE_POINTER_ERR; \
271 CPLError( ret, CPLE_ObjectNull, \
272 "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
273 return; }} while(0)
274
276#define VALIDATE_POINTER1(ptr, func, rc) \
277 do { if( CPL_NULLPTR == ptr ) \
278 { \
279 CPLErr const ret = VALIDATE_POINTER_ERR; \
280 CPLError( ret, CPLE_ObjectNull, \
281 "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
282 return (rc); }} while(0)
283
284#endif /* CPL_ERROR_H_INCLUDED */
#define CPLE_IllegalArg
Illegal argument.
Definition: cpl_error.h:107
void CPLErrorSetState(CPLErr eErrClass, CPLErrorNum err_no, const char *pszMsg)
Restore an error state, without emitting an error.
Definition: cpl_error.cpp:764
GUInt32 CPLGetErrorCounter(void)
Get the error counter.
Definition: cpl_error.cpp:889
#define CPLE_AWSObjectNotFound
AWSObjectNotFound.
Definition: cpl_error.h:127
#define CPLE_AssertionFailed
Assertion failed.
Definition: cpl_error.h:111
void CPLPushErrorHandlerEx(CPLErrorHandler, void *)
Push a new CPLError handler with user data on the error context.
Definition: cpl_error.cpp:1208
#define CPLE_AWSSignatureDoesNotMatch
AWSSignatureDoesNotMatch.
Definition: cpl_error.h:133
#define CPLE_None
No error.
Definition: cpl_error.h:97
void CPLErrorReset(void)
Erase any traces of previous errors.
Definition: cpl_error.cpp:729
void _CPLAssert(const char *, const char *, int) CPL_NO_RETURN
Report failure of a logical assertion.
Definition: cpl_error.cpp:1315
void CPLLoggingErrorHandler(CPLErr, CPLErrorNum, const char *)
Error handler that logs into the file defined by the CPL_LOG configuration option,...
Definition: cpl_error.cpp:982
#define CPLE_NotSupported
Not supported.
Definition: cpl_error.h:109
#define CPLE_AWSInvalidCredentials
AWSInvalidCredentials.
Definition: cpl_error.h:131
CPLErr
Error category.
Definition: cpl_error.h:53
#define CPLE_FileIO
File I/O error.
Definition: cpl_error.h:103
CPLErrorNum CPLGetLastErrorNo(void)
Fetch the last error number.
Definition: cpl_error.cpp:818
#define CPLE_AppDefined
Application defined error.
Definition: cpl_error.h:99
#define CPLE_OpenFailed
Open failed.
Definition: cpl_error.h:105
const char * CPLGetLastErrorMsg(void)
Get the last error message.
Definition: cpl_error.cpp:866
CPLErrorHandler CPLSetErrorHandler(CPLErrorHandler)
Install custom error handler.
Definition: cpl_error.cpp:1164
void CPLEmergencyError(const char *) CPL_NO_RETURN
Fatal error when things are bad.
Definition: cpl_error.cpp:489
#define CPLE_AWSAccessDenied
AWSAccessDenied.
Definition: cpl_error.h:129
#define CPLE_ObjectNull
NULL object.
Definition: cpl_error.h:117
void CPLDefaultErrorHandler(CPLErr, CPLErrorNum, const char *)
Default error handler.
Definition: cpl_error.cpp:903
CPLErr CPLGetLastErrorType(void)
Fetch the last error type.
Definition: cpl_error.cpp:842
int CPLErrorNum
Error number.
Definition: cpl_error.h:94
void * CPLGetErrorHandlerUserData(void)
Fetch the user data for the error context.
Definition: cpl_error.cpp:186
void(* CPLErrorHandler)(CPLErr, CPLErrorNum, const char *)
Callback for a custom error handler.
Definition: cpl_error.h:156
void CPLTurnFailureIntoWarning(int bOn)
Whether failures should be turned into warnings.
Definition: cpl_error.cpp:1058
#define CPLE_HttpResponse
HTTP response.
Definition: cpl_error.h:123
#define CPLE_AWSBucketNotFound
AWSBucketNotFound.
Definition: cpl_error.h:125
void CPLPopErrorHandler(void)
Pop error handler off stack.
Definition: cpl_error.cpp:1242
void CPLDebug(const char *, const char *,...)
Display a debugging message.
Definition: cpl_error.cpp:602
void CPLPushErrorHandler(CPLErrorHandler)
Push a new CPLError handler.
Definition: cpl_error.cpp:1185
#define CPLE_NoWriteAccess
No write access.
Definition: cpl_error.h:113
#define CPLE_UserInterrupt
User interrupted.
Definition: cpl_error.h:115
void CPLErrorV(CPLErr, CPLErrorNum, const char *, va_list)
Same as CPLError() but with a va_list.
Definition: cpl_error.cpp:324
void CPLQuietErrorHandler(CPLErr, CPLErrorNum, const char *)
Error handler that does not do anything, except for debug messages.
Definition: cpl_error.cpp:967
#define CPLE_OutOfMemory
Out of memory error.
Definition: cpl_error.h:101
CPLErrorHandler CPLSetErrorHandlerEx(CPLErrorHandler, void *)
Install custom error handle with user's data.
Definition: cpl_error.cpp:1090
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:1281
void CPLError(CPLErr eErrClass, CPLErrorNum err_no, const char *fmt,...)
Report an error.
Definition: cpl_error.cpp:308
Core portability definitions for CPL.
#define CPL_NO_RETURN
Qualifier for a function that does not return at all (terminates the process)
Definition: cpl_port.h:956
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:929
unsigned int GUInt32
Unsigned int32 type.
Definition: cpl_port.h:207
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:914

Generated for GDAL by doxygen 1.9.4.