Main Page Class Hierarchy Compound List File List Compound Members File Members Related Pages

# cpl_error.h

Go to the documentation of this file.

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