Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix compilation warnings in ISO-C99 mode.
[simgrid.git] / include / xbt / swag.h
index caa54e5..9ebd506 100644 (file)
@@ -1,6 +1,5 @@
-/*     $Id$     */
-
-/* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -13,7 +12,9 @@
 #define _XBT_SWAG_H
 
 #include "xbt/misc.h"
-#include "xbt/sysdep.h" /* sizeof */
+#include "xbt/sysdep.h"         /* size_t */
+
+SG_BEGIN_DECL()
 
 /** 
  * @addtogroup XBT_swag
@@ -26,7 +27,6 @@
  *  no call to malloc/free is done.
  *
  */
-
 /** @defgroup XBT_swag_type Swag types
     @ingroup XBT_swag
 
@@ -41,7 +41,7 @@
 typedef struct xbt_swag_hookup {
   void *next;
   void *prev;
-} s_xbt_swag_hookup_t; 
+} s_xbt_swag_hookup_t;
 /**< This type should be added to a type that is to be used in a swag. 
  *
  *  Whenever a new object with this struct is created, all fields have
@@ -68,7 +68,7 @@ typedef struct foo {
 }
 \endcode
 */
-typedef s_xbt_swag_hookup_t  *xbt_swag_hookup_t;
+typedef s_xbt_swag_hookup_t *xbt_swag_hookup_t;
 
 
 typedef struct xbt_swag {
@@ -86,24 +86,40 @@ typedef struct xbt_swag {
  *  @{
  */
 
-xbt_swag_t xbt_swag_new(size_t offset);
-void xbt_swag_free(xbt_swag_t swag);
-void xbt_swag_init(xbt_swag_t swag, size_t offset);
-void xbt_swag_insert(void *obj, xbt_swag_t swag);
-void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag);
-void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag);
-void *xbt_swag_remove(void *obj, xbt_swag_t swag);
-void *xbt_swag_extract(xbt_swag_t swag);
-int xbt_swag_size(xbt_swag_t swag);
-int xbt_swag_belongs(void *obj, xbt_swag_t swag);
+XBT_PUBLIC(xbt_swag_t) xbt_swag_new(size_t offset);
+XBT_PUBLIC(void) xbt_swag_free(xbt_swag_t swag);
+XBT_PUBLIC(void) xbt_swag_init(xbt_swag_t swag, size_t offset);
+
+/**
+ * \param obj the objet to insert in the swag
+ * \param swag a swag
+ * @hideinitializer
+ *
+ * insert \a obj in \a swag
+ */
+#define xbt_swag_insert(obj, swag) xbt_swag_insert_at_tail(obj, swag)
+
+XBT_PUBLIC(void) xbt_swag_insert_at_head(void *obj, xbt_swag_t swag);
+XBT_PUBLIC(void) xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag);
+XBT_PUBLIC(void *) xbt_swag_remove(void *obj, xbt_swag_t swag);
+XBT_PUBLIC(void *) xbt_swag_extract(xbt_swag_t swag);
+XBT_PUBLIC(int) xbt_swag_size(xbt_swag_t swag);
+
+#define xbt_swag_getPrev(obj,offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->prev)
+#define xbt_swag_getNext(obj,offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->next)
+
+static XBT_INLINE int xbt_swag_belongs(void *obj, xbt_swag_t swag)
+{
+  return ((xbt_swag_getNext(obj, swag->offset))
+          || (xbt_swag_getPrev(obj, swag->offset))
+          || (swag->head == obj));
+}
 
 static XBT_INLINE void *xbt_swag_getFirst(xbt_swag_t swag)
 {
   return (swag->head);
 }
 
-#define xbt_swag_getNext(obj,offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->prev)
-#define xbt_swag_getPrev(obj,offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->next)
 
 /**
  * \brief Offset computation
@@ -158,4 +174,5 @@ static XBT_INLINE void *xbt_swag_getFirst(xbt_swag_t swag)
                  (obj_next=NULL))     )
 /* @} */
 
-#endif    /* _XBT_SWAG_H */
+SG_END_DECL()
+#endif                          /* _XBT_SWAG_H */