cpl_error.h

Go to the documentation of this file.
00001 /**********************************************************************
00002  * $Id: cpl_error.h,v 1.16 2001/11/02 22:07:58 warmerda 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.16  2001/11/02 22:07:58  warmerda
00033  * added logging error handler
00034  *
00035  * Revision 1.15  2001/01/19 21:16:41  warmerda
00036  * expanded tabs
00037  *
00038  * Revision 1.14  2000/11/30 17:30:10  warmerda
00039  * added CPLGetLastErrorType
00040  *
00041  * Revision 1.13  2000/08/24 18:08:17  warmerda
00042  * made default and quiet error handlers public on windows
00043  *
00044  * Revision 1.12  2000/06/26 21:44:07  warmerda
00045  * added CPLE_UserInterrupt for progress terminations
00046  *
00047  * Revision 1.11  2000/03/31 14:11:55  warmerda
00048  * added CPLErrorV
00049  *
00050  * Revision 1.10  2000/01/10 17:35:45  warmerda
00051  * added push down stack of error handlers
00052  *
00053  * Revision 1.9  1999/07/23 14:27:47  warmerda
00054  * CPLSetErrorHandler returns old handler
00055  *
00056  * Revision 1.8  1999/05/20 14:59:05  warmerda
00057  * added CPLDebug()
00058  *
00059  * Revision 1.7  1999/05/20 02:54:38  warmerda
00060  * Added API documentation
00061  *
00062  * Revision 1.6  1999/02/17 05:40:47  danmo
00063  * Fixed CPLAssert() macro to work with EGCS.
00064  *
00065  * Revision 1.5  1999/01/11 15:34:29  warmerda
00066  * added reserved range comment
00067  *
00068  * Revision 1.4  1998/12/15 19:02:27  warmerda
00069  * Avoid use of errno as a variable
00070  *
00071  * Revision 1.3  1998/12/06 22:20:42  warmerda
00072  * Added error code.
00073  *
00074  * Revision 1.2  1998/12/06 02:52:52  warmerda
00075  * Implement assert support
00076  *
00077  * Revision 1.1  1998/12/03 18:26:02  warmerda
00078  * New
00079  *
00080  **********************************************************************/
00081 
00082 #ifndef _CPL_ERROR_H_INCLUDED_
00083 #define _CPL_ERROR_H_INCLUDED_
00084 
00085 #include "cpl_port.h"
00086 
00087 /*=====================================================================
00088                    Error handling functions (cpl_error.c)
00089  =====================================================================*/
00090 
00097 CPL_C_START
00098 
00099 typedef enum
00100 {
00101     CE_None = 0,
00102     CE_Debug = 1,
00103     CE_Warning = 2,
00104     CE_Failure = 3,
00105     CE_Fatal = 4
00106   
00107 } CPLErr;
00108 
00109 void CPL_DLL CPLError(CPLErr eErrClass, int err_no, const char *fmt, ...);
00110 void CPL_DLL CPLErrorV(CPLErr, int, const char *, va_list );
00111 void CPL_DLL CPLErrorReset();
00112 int CPL_DLL CPLGetLastErrorNo();
00113 CPLErr CPL_DLL CPLGetLastErrorType();
00114 const char CPL_DLL * CPLGetLastErrorMsg();
00115 
00116 typedef void (*CPLErrorHandler)(CPLErr, int, const char*);
00117 CPLErrorHandler CPL_DLL CPLSetErrorHandler(CPLErrorHandler);
00118 void CPL_DLL CPLPushErrorHandler( CPLErrorHandler );
00119 void CPL_DLL CPLPopErrorHandler();
00120 void CPL_DLL CPLDefaultErrorHandler( CPLErr, int, const char * );
00121 void CPL_DLL CPLQuietErrorHandler( CPLErr, int, const char * );
00122 void CPL_DLL CPLLoggingErrorHandler( CPLErr, int, const char * );
00123 
00124 void CPL_DLL CPLDebug( const char *, const char *, ... );
00125 void CPL_DLL _CPLAssert( const char *, const char *, int );
00126 
00127 #ifdef DEBUG
00128 #  define CPLAssert(expr)  ((expr) ? (void)(0) : _CPLAssert(#expr,__FILE__,__LINE__))
00129 #else
00130 #  define CPLAssert(expr)
00131 #endif
00132 
00133 CPL_C_END
00134 
00135 /* ==================================================================== */
00136 /*      Well known error codes.                                         */
00137 /* ==================================================================== */
00138 
00139 #define CPLE_None                       0
00140 #define CPLE_AppDefined                 1
00141 #define CPLE_OutOfMemory                2
00142 #define CPLE_FileIO                     3
00143 #define CPLE_OpenFailed                 4
00144 #define CPLE_IllegalArg                 5
00145 #define CPLE_NotSupported               6
00146 #define CPLE_AssertionFailed            7
00147 #define CPLE_NoWriteAccess              8
00148 #define CPLE_UserInterrupt              9
00149 
00150 /* 100 - 299 reserved for GDAL */
00151 
00152 #endif /* _CPL_ERROR_H_INCLUDED_ */

Generated on Mon Jan 9 18:03:31 2006 for OGR by  doxygen 1.4.6