Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
XBT documentation reorganization. module-xbt only contains the structure, module...
[simgrid.git] / include / xbt / asserts.h
1 /* $Id$ */
2 /*  xbt/asserts.h -- assertion mecanism                                     */
3
4 /* Copyright (c) 2004,2005 Martin Quinson. All rights reserved.             */
5
6 /* This program is free software; you can redistribute it and/or modify it
7  * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 #ifndef _XBT_ASSERTS_H
10 #define _XBT_ASSERTS_H
11
12 #include "xbt/misc.h"
13   
14 SG_BEGIN_DECL()
15
16 /**
17  * @addtogroup XBT_error
18  * @brief Those are the SimGrid version of the good ol' assert macro.
19  *
20  * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]
21  *                <tr><td><b>Prev</b>   <td> [\ref XBT_log]
22  *                <tr><td><b>Next</b>   <td> [\ref XBT_config]     </table></center>
23  *
24  * You can pass them a format message and arguments, just as if it where a printf.
25  * It is converted to a CRITICALn logging request.
26  *
27  * @{
28  */
29 #ifdef NDEBUG
30 #define xbt_assert(cond)
31 #define xbt_assert0(cond,msg)
32 #define xbt_assert1(cond,msg,a)
33 #define xbt_assert2(cond,msg,a,b)
34 #define xbt_assert3(cond,msg,a,b,c)
35 #define xbt_assert4(cond,msg,a,b,c,d)
36 #define xbt_assert5(cond,msg,a,b,c,d,e)
37 #define xbt_assert6(cond,msg,a,b,c,d,e,f)
38 #else
39      /** @brief The condition which failed will be displayed.
40          @hideinitializer  */
41 #define xbt_assert(cond)                  if (!(cond)) { CRITICAL1("Assertion %s failed", #cond); xbt_abort(); }
42      /** @hideinitializer  */
43 #define xbt_assert0(cond,msg)             if (!(cond)) { CRITICAL0(msg); xbt_abort(); }
44      /** @hideinitializer  */
45 #define xbt_assert1(cond,msg,a)           if (!(cond)) { CRITICAL1(msg,a); xbt_abort(); }
46      /** @hideinitializer  */
47 #define xbt_assert2(cond,msg,a,b)         if (!(cond)) { CRITICAL2(msg,a,b); xbt_abort(); }
48      /** @hideinitializer  */
49 #define xbt_assert3(cond,msg,a,b,c)       if (!(cond)) { CRITICAL3(msg,a,b,c); xbt_abort(); }
50      /** @hideinitializer  */
51 #define xbt_assert4(cond,msg,a,b,c,d)     if (!(cond)) { CRITICAL4(msg,a,b,c,d); xbt_abort(); }
52      /** @hideinitializer  */
53 #define xbt_assert5(cond,msg,a,b,c,d,e)   if (!(cond)) { CRITICAL5(msg,a,b,c,d,e); xbt_abort(); }
54      /** @hideinitializer  */
55 #define xbt_assert6(cond,msg,a,b,c,d,e,f) if (!(cond)) { CRITICAL6(msg,a,b,c,d,e,f); xbt_abort(); }
56 #endif
57      
58 void xbt_abort(void) _XBT_GNUC_NORETURN;
59 void xbt_die(const char *msg) _XBT_GNUC_NORETURN;
60
61 /** @} */     
62   
63 SG_END_DECL()
64
65 #endif /* _XBT_ASSERTS_H */