ODE  0.13.1
 All Data Structures Functions Variables Typedefs Enumerations Groups
error.h
1 /*************************************************************************
2  * *
3  * Open Dynamics Engine, Copyright (C) 2001,2002 Russell L. Smith. *
4  * All rights reserved. Email: russ@q12.org Web: www.q12.org *
5  * *
6  * This library is free software; you can redistribute it and/or *
7  * modify it under the terms of EITHER: *
8  * (1) The GNU Lesser General Public License as published by the Free *
9  * Software Foundation; either version 2.1 of the License, or (at *
10  * your option) any later version. The text of the GNU Lesser *
11  * General Public License is included with this library in the *
12  * file LICENSE.TXT. *
13  * (2) The BSD-style license that is included with this library in *
14  * the file LICENSE-BSD.TXT. *
15  * *
16  * This library is distributed in the hope that it will be useful, *
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the files *
19  * LICENSE.TXT and LICENSE-BSD.TXT for more details. *
20  * *
21  *************************************************************************/
22 
23 /* this comes from the `reuse' library. copy any changes back to the source */
24 
25 #ifndef _ODE_ERROR_H_
26 #define _ODE_ERROR_H_
27 
28 #include <ode/odeconfig.h>
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 /* all user defined error functions have this type. error and debug functions
35  * should not return.
36  */
37 typedef void dMessageFunction (int errnum, const char *msg, va_list ap);
38 
39 /* set a new error, debug or warning handler. if fn is 0, the default handlers
40  * are used.
41  */
42 ODE_API void dSetErrorHandler (dMessageFunction *fn);
43 ODE_API void dSetDebugHandler (dMessageFunction *fn);
44 ODE_API void dSetMessageHandler (dMessageFunction *fn);
45 
46 /* return the current error, debug or warning handler. if the return value is
47  * 0, the default handlers are in place.
48  */
49 ODE_API dMessageFunction *dGetErrorHandler(void);
50 ODE_API dMessageFunction *dGetDebugHandler(void);
51 ODE_API dMessageFunction *dGetMessageHandler(void);
52 
53 /* generate a fatal error, debug trap or a message. */
54 ODE_API void dError (int num, const char *msg, ...);
55 ODE_API void dDebug (int num, const char *msg, ...);
56 ODE_API void dMessage (int num, const char *msg, ...);
57 
58 
59 #ifdef __cplusplus
60 }
61 #endif
62 
63 #endif