OGR
cpl_error.h
Go to the documentation of this file.
1 /**********************************************************************
2  * $Id: cpl_error.h 27384 2014-05-24 12:28:12Z 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 /*=====================================================================
37  Error handling functions (cpl_error.c)
38  =====================================================================*/
39 
46 CPL_C_START
47 
48 typedef enum
49 {
50  CE_None = 0,
51  CE_Debug = 1,
52  CE_Warning = 2,
53  CE_Failure = 3,
54  CE_Fatal = 4
55 } CPLErr;
56 
57 void CPL_DLL CPLError(CPLErr eErrClass, int err_no, const char *fmt, ...) CPL_PRINT_FUNC_FORMAT (3, 4);
58 void CPL_DLL CPLErrorV(CPLErr, int, const char *, va_list );
59 void CPL_DLL CPLEmergencyError( const char * );
60 void CPL_DLL CPL_STDCALL CPLErrorReset( void );
61 int CPL_DLL CPL_STDCALL CPLGetLastErrorNo( void );
62 CPLErr CPL_DLL CPL_STDCALL CPLGetLastErrorType( void );
63 const char CPL_DLL * CPL_STDCALL CPLGetLastErrorMsg( void );
64 void CPL_DLL * CPL_STDCALL CPLGetErrorHandlerUserData(void);
65 void CPL_DLL CPLErrorSetState( CPLErr eErrClass, int err_no, const char* pszMsg );
66 void CPL_DLL CPLCleanupErrorMutex( void );
67 
68 typedef void (CPL_STDCALL *CPLErrorHandler)(CPLErr, int, const char*);
69 
70 void CPL_DLL CPL_STDCALL CPLLoggingErrorHandler( CPLErr, int, const char * );
71 void CPL_DLL CPL_STDCALL CPLDefaultErrorHandler( CPLErr, int, const char * );
72 void CPL_DLL CPL_STDCALL CPLQuietErrorHandler( CPLErr, int, const char * );
73 void CPLTurnFailureIntoWarning(int bOn );
74 
75 CPLErrorHandler CPL_DLL CPL_STDCALL CPLSetErrorHandler(CPLErrorHandler);
76 CPLErrorHandler CPL_DLL CPL_STDCALL CPLSetErrorHandlerEx(CPLErrorHandler, void*);
77 void CPL_DLL CPL_STDCALL CPLPushErrorHandler( CPLErrorHandler );
78 void CPL_DLL CPL_STDCALL CPLPushErrorHandlerEx( CPLErrorHandler, void* );
79 void CPL_DLL CPL_STDCALL CPLPopErrorHandler(void);
80 
81 void CPL_DLL CPL_STDCALL CPLDebug( const char *, const char *, ... ) CPL_PRINT_FUNC_FORMAT (2, 3);
82 void CPL_DLL CPL_STDCALL _CPLAssert( const char *, const char *, int );
83 
84 #ifdef DEBUG
85 # define CPLAssert(expr) ((expr) ? (void)(0) : _CPLAssert(#expr,__FILE__,__LINE__))
86 #else
87 # define CPLAssert(expr)
88 #endif
89 
90 CPL_C_END
91 
92 /*
93  * Helper macros used for input parameters validation.
94  */
95 #ifdef DEBUG
96 # define VALIDATE_POINTER_ERR CE_Fatal
97 #else
98 # define VALIDATE_POINTER_ERR CE_Failure
99 #endif
100 
101 #define VALIDATE_POINTER0(ptr, func) \
102  do { if( NULL == ptr ) \
103  { \
104  CPLErr const ret = VALIDATE_POINTER_ERR; \
105  CPLError( ret, CPLE_ObjectNull, \
106  "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
107  return; }} while(0)
108 
109 #define VALIDATE_POINTER1(ptr, func, rc) \
110  do { if( NULL == ptr ) \
111  { \
112  CPLErr const ret = VALIDATE_POINTER_ERR; \
113  CPLError( ret, CPLE_ObjectNull, \
114  "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
115  return (rc); }} while(0)
116 
117 /* ==================================================================== */
118 /* Well known error codes. */
119 /* ==================================================================== */
120 
121 #define CPLE_None 0
122 #define CPLE_AppDefined 1
123 #define CPLE_OutOfMemory 2
124 #define CPLE_FileIO 3
125 #define CPLE_OpenFailed 4
126 #define CPLE_IllegalArg 5
127 #define CPLE_NotSupported 6
128 #define CPLE_AssertionFailed 7
129 #define CPLE_NoWriteAccess 8
130 #define CPLE_UserInterrupt 9
131 #define CPLE_ObjectNull 10
132 
133 /* 100 - 299 reserved for GDAL */
134 
135 #endif /* CPL_ERROR_H_INCLUDED */
void CPLPushErrorHandler(CPLErrorHandler)
Definition: cpl_error.cpp:896
CPLErr CPLGetLastErrorType(void)
Definition: cpl_error.cpp:591
void _CPLAssert(const char *, const char *, int)
Definition: cpl_error.cpp:979
const char * CPLGetLastErrorMsg(void)
Definition: cpl_error.cpp:613
CPLErrorHandler CPLSetErrorHandlerEx(CPLErrorHandler, void *)
Definition: cpl_error.cpp:801
void CPLPopErrorHandler(void)
Definition: cpl_error.cpp:947
void CPLDebug(const char *, const char *,...)
Definition: cpl_error.cpp:394
void CPLErrorReset(void)
Definition: cpl_error.cpp:524
void CPLEmergencyError(const char *)
Definition: cpl_error.cpp:306
void * CPLGetErrorHandlerUserData(void)
Definition: cpl_error.cpp:116
void CPLErrorSetState(CPLErr eErrClass, int err_no, const char *pszMsg)
Definition: cpl_error.cpp:546
CPLErrorHandler CPLSetErrorHandler(CPLErrorHandler)
Definition: cpl_error.cpp:875
void CPLPushErrorHandlerEx(CPLErrorHandler, void *)
Definition: cpl_error.cpp:920
int CPLGetLastErrorNo(void)
Definition: cpl_error.cpp:570
void CPLError(CPLErr eErrClass, int err_no, const char *fmt,...)
Definition: cpl_error.cpp:158

Generated for GDAL by doxygen 1.8.9.1.