doxygenification

[simgrid.git] / include / xbt / sysdep.h

diff --git a/include/xbt/sysdep.h b/include/xbt/sysdep.h
index 9435c96a57a774003eb14b3a5c0e7c23ca2ef22a..18077561ef89c568ff755a90249275e33c222c88 100644 (file)
--- a/include/xbt/sysdep.h
+++ b/include/xbt/sysdep.h
@@ -12,38 +12,49 @@
 #ifndef _XBT_SYSDEP_H
 #define _XBT_SYSDEP_H
 
-#include <string.h> /* Included directly for speed */
-
-#include <time.h> /* FIXME: remove */
-#include <unistd.h> /* FIXME: remove */
+#include <string.h>
 #include <stdlib.h> 
-
+   
 #include "xbt/misc.h"
-BEGIN_DECL
-#if 0
-#define __CALLOC_OP(n, s)  calloc((n), (s))
-  #define __REALLOC_OP(n, s)  realloc((n), (s))
-#define CALLOC(n, s)  ((__CALLOC_OP  ((n)?:(FAILURE("attempt to alloc 0 bytes"), 0), (s)?:(FAILURE("attempt to alloc 0 bytes"), 0)))?:(FAILURE("memory allocation error"), NULL))
-  /* #define REALLOC(p, s) ((__REALLOC_OP ((p), (s)?:(FAILURE("attempt to alloc 0 bytes"), 0)))?:(FAILURE("memory reallocation error"), NULL)) */
-  #define REALLOC(p, s) (__REALLOC_OP ((p), (s)))
-#endif
-  
+BEGIN_DECL()
+
+/** @addtogroup XBT_syscall
+ *  @{
+ */
+
+/** @brief like strdup, but xbt_die() on error 
+    @hideinitializer */
 #define xbt_strdup(s)  ((s)?(strdup(s)?:(xbt_die("memory allocation error"),NULL))\
                            :(NULL))
+/** @brief like malloc, but xbt_die() on error 
+    @hideinitializer */
 #define xbt_malloc(n)   (malloc(n) ?: (xbt_die("memory allocation error"),NULL))
+
+/** @brief like malloc, but xbt_die() on error and memset data to 0
+    @hideinitializer */
 #define xbt_malloc0(n)  (calloc( (n),1 ) ?: (xbt_die("memory allocation error"),NULL))
-#define xbt_realloc(p,s) (s? (p? (realloc(p,s)?:xbt_die("memory allocation error"),NULL) \
+  
+/** @brief like realloc, but xbt_die() on error 
+    @hideinitializer */
+#define xbt_realloc(p,s) (s? (p? (realloc(p,s)?:(xbt_die("memory allocation error"),NULL)) \
                                : xbt_malloc(s)) \
                            : (p? (free(p),NULL) \
                                : NULL))
+/** @brief like free
+    @hideinitializer */
 #define xbt_free free /*nothing specific to do here. A poor valgrind replacement?*/
-#define xbt_free_fct free /* replacement with the guareenty of being a function */
+/*#define xbt_free_fct free * replacement with the guareenty of being a function  FIXME:KILLME*/
    
+/** @brief like calloc, but xbt_die() on error and don't memset to 0
+    @hideinitializer */
 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
+/** @brief like calloc, but xbt_die() on error
+    @hideinitializer */
 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 
+/** @} */
+  
 /* Attributes are only in recent versions of GCC */
-
 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
 # define _XBT_GNUC_PRINTF( format_idx, arg_idx )    \
           __attribute__((__format__ (__printf__, format_idx, arg_idx)))
@@ -61,7 +72,7 @@ BEGIN_DECL
 
 #endif  /* !__GNUC__ */
 
-/* inline and __FUNCTION__ are only in GCC when -ansi is of */
+/* inline and __FUNCTION__ are only in GCC when -ansi is off */
 
 #if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
 
@@ -72,10 +83,7 @@ BEGIN_DECL
 # define _XBT_INLINE 
 #endif
 
-
-void xbt_abort(void) _XBT_GNUC_NORETURN;
-
-END_DECL
+END_DECL()
    
 #include "xbt/error.h" /* needed for xbt_die */