cpl_error.h
Go to the documentation of this file.00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031 #ifndef CPL_ERROR_H_INCLUDED
00032 #define CPL_ERROR_H_INCLUDED
00033
00034 #include "cpl_port.h"
00035
00036
00037
00038
00039
00046 CPL_C_START
00047
00048 typedef enum
00049 {
00050 CE_None = 0,
00051 CE_Debug = 1,
00052 CE_Warning = 2,
00053 CE_Failure = 3,
00054 CE_Fatal = 4
00055 } CPLErr;
00056
00057 void CPL_DLL CPLError(CPLErr eErrClass, int err_no, const char *fmt, ...) CPL_PRINT_FUNC_FORMAT (3, 4);
00058 void CPL_DLL CPLErrorV(CPLErr, int, const char *, va_list );
00059 void CPL_DLL CPL_STDCALL CPLErrorReset( void );
00060 int CPL_DLL CPL_STDCALL CPLGetLastErrorNo( void );
00061 CPLErr CPL_DLL CPL_STDCALL CPLGetLastErrorType( void );
00062 const char CPL_DLL * CPL_STDCALL CPLGetLastErrorMsg( void );
00063
00064 typedef void (CPL_STDCALL *CPLErrorHandler)(CPLErr, int, const char*);
00065
00066 void CPL_DLL CPL_STDCALL CPLLoggingErrorHandler( CPLErr, int, const char * );
00067 void CPL_DLL CPL_STDCALL CPLDefaultErrorHandler( CPLErr, int, const char * );
00068 void CPL_DLL CPL_STDCALL CPLQuietErrorHandler( CPLErr, int, const char * );
00069 void CPLTurnFailureIntoWarning(int bOn );
00070
00071 CPLErrorHandler CPL_DLL CPL_STDCALL CPLSetErrorHandler(CPLErrorHandler);
00072 void CPL_DLL CPL_STDCALL CPLPushErrorHandler( CPLErrorHandler );
00073 void CPL_DLL CPL_STDCALL CPLPopErrorHandler(void);
00074
00075 void CPL_DLL CPL_STDCALL CPLDebug( const char *, const char *, ... ) CPL_PRINT_FUNC_FORMAT (2, 3);
00076 void CPL_DLL CPL_STDCALL _CPLAssert( const char *, const char *, int );
00077
00078 #ifdef DEBUG
00079 # define CPLAssert(expr) ((expr) ? (void)(0) : _CPLAssert(#expr,__FILE__,__LINE__))
00080 #else
00081 # define CPLAssert(expr)
00082 #endif
00083
00084 CPL_C_END
00085
00086
00087
00088
00089 #ifdef DEBUG
00090 # define VALIDATE_POINTER_ERR CE_Fatal
00091 #else
00092 # define VALIDATE_POINTER_ERR CE_Failure
00093 #endif
00094
00095 #define VALIDATE_POINTER0(ptr, func) \
00096 do { if( NULL == ptr ) \
00097 { \
00098 CPLErr const ret = VALIDATE_POINTER_ERR; \
00099 CPLError( ret, CPLE_ObjectNull, \
00100 "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
00101 return; }} while(0)
00102
00103 #define VALIDATE_POINTER1(ptr, func, rc) \
00104 do { if( NULL == ptr ) \
00105 { \
00106 CPLErr const ret = VALIDATE_POINTER_ERR; \
00107 CPLError( ret, CPLE_ObjectNull, \
00108 "Pointer \'%s\' is NULL in \'%s\'.\n", #ptr, (func)); \
00109 return (rc); }} while(0)
00110
00111
00112
00113
00114
00115 #define CPLE_None 0
00116 #define CPLE_AppDefined 1
00117 #define CPLE_OutOfMemory 2
00118 #define CPLE_FileIO 3
00119 #define CPLE_OpenFailed 4
00120 #define CPLE_IllegalArg 5
00121 #define CPLE_NotSupported 6
00122 #define CPLE_AssertionFailed 7
00123 #define CPLE_NoWriteAccess 8
00124 #define CPLE_UserInterrupt 9
00125 #define CPLE_ObjectNull 10
00126
00127
00128
00129 #endif