00001 /********************************************************************** 00002 * $Id: cpl_error.h,v 1.19 2005/08/31 03:32:13 fwarmerdam Exp $ 00003 * 00004 * Name: cpl_error.h 00005 * Project: CPL - Common Portability Library 00006 * Purpose: CPL Error handling 00007 * Author: Daniel Morissette, danmo@videotron.ca 00008 * 00009 ********************************************************************** 00010 * Copyright (c) 1998, Daniel Morissette 00011 * 00012 * Permission is hereby granted, free of charge, to any person obtaining a 00013 * copy of this software and associated documentation files (the "Software"), 00014 * to deal in the Software without restriction, including without limitation 00015 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 00016 * and/or sell copies of the Software, and to permit persons to whom the 00017 * Software is furnished to do so, subject to the following conditions: 00018 * 00019 * The above copyright notice and this permission notice shall be included 00020 * in all copies or substantial portions of the Software. 00021 * 00022 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 00023 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 00024 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 00025 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 00026 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 00027 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 00028 * DEALINGS IN THE SOFTWARE. 00029 ********************************************************************** 00030 * 00031 * $Log: cpl_error.h,v $ 00032 * Revision 1.19 2005/08/31 03:32:13 fwarmerdam 00033 * fixed void arg list 00034 * 00035 * Revision 1.18 2005/08/25 18:05:36 fwarmerdam 00036 * Added void in empty arg lists. 00037 * 00038 * Revision 1.17 2005/04/04 15:23:31 fwarmerdam 00039 * some functions now CPL_STDCALL 00040 * 00041 * Revision 1.16 2001/11/02 22:07:58 warmerda 00042 * added logging error handler 00043 * 00044 * Revision 1.15 2001/01/19 21:16:41 warmerda 00045 * expanded tabs 00046 * 00047 * Revision 1.14 2000/11/30 17:30:10 warmerda 00048 * added CPLGetLastErrorType 00049 * 00050 * Revision 1.13 2000/08/24 18:08:17 warmerda 00051 * made default and quiet error handlers public on windows 00052 * 00053 * Revision 1.12 2000/06/26 21:44:07 warmerda 00054 * added CPLE_UserInterrupt for progress terminations 00055 * 00056 * Revision 1.11 2000/03/31 14:11:55 warmerda 00057 * added CPLErrorV 00058 * 00059 * Revision 1.10 2000/01/10 17:35:45 warmerda 00060 * added push down stack of error handlers 00061 * 00062 * Revision 1.9 1999/07/23 14:27:47 warmerda 00063 * CPLSetErrorHandler returns old handler 00064 * 00065 * Revision 1.8 1999/05/20 14:59:05 warmerda 00066 * added CPLDebug() 00067 * 00068 * Revision 1.7 1999/05/20 02:54:38 warmerda 00069 * Added API documentation 00070 * 00071 * Revision 1.6 1999/02/17 05:40:47 danmo 00072 * Fixed CPLAssert() macro to work with EGCS. 00073 * 00074 * Revision 1.5 1999/01/11 15:34:29 warmerda 00075 * added reserved range comment 00076 * 00077 * Revision 1.4 1998/12/15 19:02:27 warmerda 00078 * Avoid use of errno as a variable 00079 * 00080 * Revision 1.3 1998/12/06 22:20:42 warmerda 00081 * Added error code. 00082 * 00083 * Revision 1.2 1998/12/06 02:52:52 warmerda 00084 * Implement assert support 00085 * 00086 * Revision 1.1 1998/12/03 18:26:02 warmerda 00087 * New 00088 * 00089 **********************************************************************/ 00090 00091 #ifndef _CPL_ERROR_H_INCLUDED_ 00092 #define _CPL_ERROR_H_INCLUDED_ 00093 00094 #include "cpl_port.h" 00095 00096 /*===================================================================== 00097 Error handling functions (cpl_error.c) 00098 =====================================================================*/ 00099 00106 CPL_C_START 00107 00108 typedef enum 00109 { 00110 CE_None = 0, 00111 CE_Debug = 1, 00112 CE_Warning = 2, 00113 CE_Failure = 3, 00114 CE_Fatal = 4 00115 00116 } CPLErr; 00117 00118 void CPL_DLL CPLError(CPLErr eErrClass, int err_no, const char *fmt, ...); 00119 void CPL_DLL CPLErrorV(CPLErr, int, const char *, va_list ); 00120 void CPL_DLL CPL_STDCALL CPLErrorReset( void ); 00121 int CPL_DLL CPL_STDCALL CPLGetLastErrorNo( void ); 00122 CPLErr CPL_DLL CPL_STDCALL CPLGetLastErrorType( void ); 00123 const char CPL_DLL * CPL_STDCALL CPLGetLastErrorMsg( void ); 00124 00125 typedef void (CPL_STDCALL *CPLErrorHandler)(CPLErr, int, const char*); 00126 CPLErrorHandler CPL_DLL CPL_STDCALL CPLSetErrorHandler(CPLErrorHandler); 00127 void CPL_DLL CPL_STDCALL CPLPushErrorHandler( CPLErrorHandler ); 00128 void CPL_DLL CPL_STDCALL CPLPopErrorHandler(); 00129 void CPL_DLL CPL_STDCALL CPLDefaultErrorHandler( CPLErr, int, const char * ); 00130 void CPL_DLL CPL_STDCALL CPLQuietErrorHandler( CPLErr, int, const char * ); 00131 void CPL_DLL CPL_STDCALL CPLLoggingErrorHandler( CPLErr, int, const char * ); 00132 00133 void CPL_DLL CPL_STDCALL CPLDebug( const char *, const char *, ... ); 00134 void CPL_DLL CPL_STDCALL _CPLAssert( const char *, const char *, int ); 00135 00136 #ifdef DEBUG 00137 # define CPLAssert(expr) ((expr) ? (void)(0) : _CPLAssert(#expr,__FILE__,__LINE__)) 00138 #else 00139 # define CPLAssert(expr) 00140 #endif 00141 00142 CPL_C_END 00143 00144 /* ==================================================================== */ 00145 /* Well known error codes. */ 00146 /* ==================================================================== */ 00147 00148 #define CPLE_None 0 00149 #define CPLE_AppDefined 1 00150 #define CPLE_OutOfMemory 2 00151 #define CPLE_FileIO 3 00152 #define CPLE_OpenFailed 4 00153 #define CPLE_IllegalArg 5 00154 #define CPLE_NotSupported 6 00155 #define CPLE_AssertionFailed 7 00156 #define CPLE_NoWriteAccess 8 00157 #define CPLE_UserInterrupt 9 00158 00159 /* 100 - 299 reserved for GDAL */ 00160 00161 #endif /* _CPL_ERROR_H_INCLUDED_ */