X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/215ed67257173f5e26c9489ec96c4ced08d1614a..0f5e8daaa6e9f74521068aa75837200bcd182ea6:/include/xbt/swag.h

diff --git a/include/xbt/swag.h b/include/xbt/swag.h
index be73804d75..a16c2544f7 100644
--- a/include/xbt/swag.h
+++ b/include/xbt/swag.h
@@ -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,18 +12,14 @@
 #define _XBT_SWAG_H
 
 #include "xbt/misc.h"
-#include "xbt/sysdep.h"
+#include "xbt/sysdep.h"         /* size_t */
 
+SG_BEGIN_DECL()
 
 /** 
  * @addtogroup XBT_swag
  * @brief a O(1) set based on linked lists
  * 
- * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]
- *                <tr><td><b>Prev</b>   <td> [\ref XBT_fifo]
- *                <tr><td><b>Next</b>   <td> [\ref XBT_heap]
- *                <tr><td><b>Down</b>   <td> [\ref XBT_swag_type]        </table></center>
- *
  *  Warning, this module is done to be efficient and performs tons of
  *  cast and dirty things. So make sure you know what you are doing while using it.
  *  It is basically a fifo but with restrictions so that
@@ -32,14 +27,9 @@
  *  no call to malloc/free is done.
  *
  */
-
 /** @defgroup XBT_swag_type Swag types
     @ingroup XBT_swag
 
-   <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_swag]
-                  <tr><td>   Prev       <td> 
-                  <tr><td><b>Next</b>   <td> [\ref XBT_swag_func]        </table></center>
-                  
     Specific set. 
 
 
@@ -51,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
@@ -78,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 {
@@ -93,31 +83,34 @@ typedef struct xbt_swag {
 /** @defgroup XBT_swag_func SWAG functions 
  *  @ingroup XBT_swag
  
-   <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_swag]
-                  <tr><td><b>Prev</b>   <td> [\ref XBT_swag_type]
-                  <tr><td><b>Next</b>   <td> [\ref XBT_swag_curs]        </table></center>
-                  
  *  @{
  */
 
-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);
-
-static _XBT_INLINE void *xbt_swag_getFirst(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_INLINE XBT_PUBLIC(void) xbt_swag_init(xbt_swag_t swag, size_t offset);
+XBT_PUBLIC(void) xbt_swag_insert(void *obj, xbt_swag_t 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_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)
+
+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
@@ -137,10 +130,6 @@ static _XBT_INLINE void *xbt_swag_getFirst(xbt_swag_t swag)
  * \defgroup XBT_swag_curs Swag cursor
  * @ingroup XBT_swag
 
-   <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_swag]
-                  <tr><td><b>Prev</b>   <td> [\ref XBT_swag_func]
-                  <tr><td>   Next       <td>                       </table></center>
- 
  * Iterates over the whole swag. 
  *
  * @{ */
@@ -176,4 +165,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 */