error.h

00001 /*************************************************************************
00002  *                                                                       *
00003  * Open Dynamics Engine, Copyright (C) 2001,2002 Russell L. Smith.       *
00004  * All rights reserved.  Email: russ@q12.org   Web: www.q12.org          *
00005  *                                                                       *
00006  * This library is free software; you can redistribute it and/or         *
00007  * modify it under the terms of EITHER:                                  *
00008  *   (1) The GNU Lesser General Public License as published by the Free  *
00009  *       Software Foundation; either version 2.1 of the License, or (at  *
00010  *       your option) any later version. The text of the GNU Lesser      *
00011  *       General Public License is included with this library in the     *
00012  *       file LICENSE.TXT.                                               *
00013  *   (2) The BSD-style license that is included with this library in     *
00014  *       the file LICENSE-BSD.TXT.                                       *
00015  *                                                                       *
00016  * This library is distributed in the hope that it will be useful,       *
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the files    *
00019  * LICENSE.TXT and LICENSE-BSD.TXT for more details.                     *
00020  *                                                                       *
00021  *************************************************************************/
00022 
00023 /* this comes from the `reuse' library. copy any changes back to the source */
00024 
00025 #ifndef _ODE_ERROR_H_
00026 #define _ODE_ERROR_H_
00027 
00028 #include <ode/config.h>
00029 
00030 #ifdef __cplusplus
00031 extern "C" {
00032 #endif
00033 
00034 /* all user defined error functions have this type. error and debug functions
00035  * should not return.
00036  */
00037 typedef void dMessageFunction (int errnum, const char *msg, va_list ap);
00038 
00039 /* set a new error, debug or warning handler. if fn is 0, the default handlers
00040  * are used.
00041  */
00042 ODE_API void dSetErrorHandler (dMessageFunction *fn);
00043 ODE_API void dSetDebugHandler (dMessageFunction *fn);
00044 ODE_API void dSetMessageHandler (dMessageFunction *fn);
00045 
00046 /* return the current error, debug or warning handler. if the return value is
00047  * 0, the default handlers are in place.
00048  */
00049 ODE_API dMessageFunction *dGetErrorHandler(void);
00050 ODE_API dMessageFunction *dGetDebugHandler(void);
00051 ODE_API dMessageFunction *dGetMessageHandler(void);
00052 
00053 /* generate a fatal error, debug trap or a message. */
00054 ODE_API void dError (int num, const char *msg, ...);
00055 ODE_API void dDebug (int num, const char *msg, ...);
00056 ODE_API void dMessage (int num, const char *msg, ...);
00057 
00058 
00059 #ifdef __cplusplus
00060 }
00061 #endif
00062 
00063 #endif

Generated on Fri Oct 12 08:36:51 2007 for Open Dynamics Engine by  doxygen 1.5.3