X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/19bdb25835da6ee353675dfb995cf9ca886361b2..725184f3bce66a3eff87cc3a01e5d96477a5d28a:/src/xbt/swag.c

diff --git a/src/xbt/swag.c b/src/xbt/swag.c
index dd837835c8..a87c7452e7 100644
--- a/src/xbt/swag.c
+++ b/src/xbt/swag.c
@@ -12,47 +12,31 @@
 /* This type should be added to a type that is to be used in such a swag */
 
 #include "xbt/sysdep.h"
-#include "xbt/error.h"
+#include "xbt/log.h"
 #include "xbt/swag.h"
 
-/** \defgroup XBT_swag A O(1) set datatype
- *  \brief a O(1) set based on linked lists
- *
- *  Warning, this module is done to be efficient and performs tons of
- *  cast and dirty things. So avoid using it unless you really know
- *  what you are doing. It is basically a fifo but with restrictions so that 
- *  it can be used as a set. Any operation (add, remove, belongs) is O(1) and 
- *  no call to malloc/free is done.
- */
-
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(swag,xbt,"Swag : O(1) set library");
-
 #define PREV(obj,offset) xbt_swag_getPrev(obj,offset)
 #define NEXT(obj,offset) xbt_swag_getNext(obj,offset)
 
-/** \name Functions 
- *  \ingroup XBT_swag
- */
-/* @{ */
 
 /** Creates a new swag.
  * \param offset where the hookup is located in the structure
  * \see xbt_swag_offset
  *
- * Usage : xbt_swag_new(&obj.setA-&obj); 
+ * Usage : xbt_swag_new(&obj.setA-&obj);
  */
 xbt_swag_t xbt_swag_new(size_t offset)
 {
   xbt_swag_t swag = xbt_new0(s_xbt_swag_t, 1);
 
-  swag->offset = offset;
+  xbt_swag_init(swag, offset);
 
   return swag;
 }
 
-/** 
+/**
  * \param swag poor victim
- * 
+ *
  * kilkil a swag but not it's content. If you do not understand why
  * xbt_swag_free should not free its content, don't use swags.
  */
@@ -66,15 +50,18 @@ void xbt_swag_free(xbt_swag_t swag)
  * \param offset where the hookup is located in the structure
  * \see xbt_swag_offset
  *
- * Usage : xbt_swag_init(swag,&obj.setA-&obj); 
+ * Usage : xbt_swag_init(swag,&obj.setA-&obj);
  */
 void xbt_swag_init(xbt_swag_t swag, size_t offset)
 {
+  swag->tail = NULL;
+  swag->head = NULL;
   swag->offset = offset;
+  swag->count = 0;
 }
 
 
-/** 
+/**
  * \param obj the objet to insert in the swag
  * \param swag a swag
  *
@@ -100,7 +87,7 @@ void xbt_swag_insert(void *obj, xbt_swag_t swag)
   swag->tail = obj;
 }
 
-/** 
+/**
  * \param obj the objet to insert in the swag
  * \param swag a swag
  *
@@ -127,7 +114,7 @@ void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
   swag->head = obj;
 }
 
-/** 
+/**
  * \param obj the objet to insert in the swag
  * \param swag a swag
  *
@@ -154,7 +141,7 @@ void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
   swag->tail = obj;
 }
 
-/** 
+/**
  * \param obj the objet to remove from the swag
  * \param swag a swag
  * \return \a obj if it was in the \a swag and NULL otherwise
@@ -167,25 +154,25 @@ void *xbt_swag_remove(void *obj, xbt_swag_t swag)
 
   if ((!obj) || (!swag))
     return NULL;
-  if(!xbt_swag_belongs(obj, swag)) /* Trying to remove an object that
-				      was not in this swag */
-      return NULL;
+  if (!xbt_swag_belongs(obj, swag))     /* Trying to remove an object that
+                                           was not in this swag */
+    return NULL;
 
-  if (swag->head == swag->tail) {	/* special case */
-    if (swag->head != obj)	/* Trying to remove an object that was not in this swag */
+  if (swag->head == swag->tail) {       /* special case */
+    if (swag->head != obj)      /* Trying to remove an object that was not in this swag */
       return NULL;
     swag->head = NULL;
     swag->tail = NULL;
     NEXT(obj, offset) = PREV(obj, offset) = NULL;
-  } else if (obj == swag->head) {	/* It's the head */
+  } else if (obj == swag->head) {       /* It's the head */
     swag->head = NEXT(obj, offset);
     PREV(swag->head, offset) = NULL;
     NEXT(obj, offset) = NULL;
-  } else if (obj == swag->tail) {	/* It's the tail */
+  } else if (obj == swag->tail) {       /* It's the tail */
     swag->tail = PREV(obj, offset);
     NEXT(swag->tail, offset) = NULL;
     PREV(obj, offset) = NULL;
-  } else {			/* It's in the middle */
+  } else {                      /* It's in the middle */
     NEXT(PREV(obj, offset), offset) = NEXT(obj, offset);
     PREV(NEXT(obj, offset), offset) = PREV(obj, offset);
     PREV(obj, offset) = NEXT(obj, offset) = NULL;
@@ -194,7 +181,7 @@ void *xbt_swag_remove(void *obj, xbt_swag_t swag)
   return obj;
 }
 
-/** 
+/**
  * \param swag a swag
  * \return an object from the \a swag
  */
@@ -208,7 +195,7 @@ void *xbt_swag_extract(xbt_swag_t swag)
 
   obj = swag->head;
 
-  if (swag->head == swag->tail) {	/* special case */
+  if (swag->head == swag->tail) {       /* special case */
     swag->head = swag->tail = NULL;
     PREV(obj, offset) = NEXT(obj, offset) = NULL;
   } else {
@@ -220,7 +207,8 @@ void *xbt_swag_extract(xbt_swag_t swag)
 
   return obj;
 }
-/** 
+
+/**
  * \param swag a swag
  * \return the number of objects in \a swag
  */
@@ -229,7 +217,7 @@ int xbt_swag_size(xbt_swag_t swag)
   return (swag->count);
 }
 
-/** 
+/**
  * \param obj an object
  * \param swag a swag
  * \return 1 if \a obj is in the \a swag and 0 otherwise
@@ -237,6 +225,69 @@ int xbt_swag_size(xbt_swag_t swag)
 int xbt_swag_belongs(void *obj, xbt_swag_t swag)
 {
   return ((NEXT(obj, swag->offset)) || (PREV(obj, swag->offset))
-	  || (swag->head == obj));
+          || (swag->head == obj));
 }
-/* @} */
+
+
+#ifdef SIMGRID_TEST
+
+XBT_TEST_SUITE("swag", "Swag data container");
+
+typedef struct {
+  s_xbt_swag_hookup_t setA;
+  s_xbt_swag_hookup_t setB;
+  const char *name;
+} shmurtz, s_shmurtz_t, *shmurtz_t;
+
+
+XBT_TEST_UNIT("basic", test_swag_basic, "Basic usage")
+{
+  shmurtz_t obj1, obj2, obj;
+  xbt_swag_t setA, setB;
+
+  obj1 = xbt_new0(s_shmurtz_t, 1);
+  obj2 = xbt_new0(s_shmurtz_t, 1);
+
+  obj1->name = "Obj 1";
+  obj2->name = "Obj 2";
+
+  xbt_test_add0("Basic usage");
+  xbt_test_log3("%p %p %ld\n", obj1, &(obj1->setB),
+                (long) ((char *) &(obj1->setB) - (char *) obj1));
+
+  setA = xbt_swag_new(xbt_swag_offset(*obj1, setA));
+  setB = xbt_swag_new(xbt_swag_offset(*obj1, setB));
+
+  xbt_swag_insert(obj1, setA);
+  xbt_swag_insert(obj1, setB);
+  xbt_swag_insert(obj2, setA);
+  xbt_swag_insert(obj2, setB);
+
+  xbt_swag_remove(obj1, setB);
+  /*  xbt_swag_remove(obj2, setB); */
+
+  xbt_test_add0("Traverse set A");
+  xbt_swag_foreach(obj, setA) {
+    xbt_test_log1("Saw: %s", obj->name);
+  }
+
+  xbt_test_add0("Traverse set B");
+  xbt_swag_foreach(obj, setB) {
+    xbt_test_log1("Saw: %s", obj->name);
+  }
+
+  xbt_test_add0("Ensure set content and length");
+  xbt_test_assert(xbt_swag_belongs(obj1, setA));
+  xbt_test_assert(xbt_swag_belongs(obj2, setA));
+
+  xbt_test_assert(!xbt_swag_belongs(obj1, setB));
+  xbt_test_assert(xbt_swag_belongs(obj2, setB));
+
+  xbt_test_assert(xbt_swag_size(setA) == 2);
+  xbt_test_assert(xbt_swag_size(setB) == 1);
+
+  xbt_swag_free(setA);
+  xbt_swag_free(setB);
+}
+
+#endif /* SIMGRID_TEST */