X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1e129b9677a4073030b6533743c3a84056275548..b3a6228d1e65a6f7eea5b97ae0fa2668af06d59d:/src/xbt/swag.c

diff --git a/src/xbt/swag.c b/src/xbt/swag.c
index dc09977550..67319cc17b 100644
--- a/src/xbt/swag.c
+++ b/src/xbt/swag.c
@@ -1,7 +1,9 @@
-/* Authors: Arnaud Legrand                                                  */
+/* 	$Id$	 */
+
+/* Copyright (c) 2004 Arnaud Legrand. 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. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */
 
 /* Warning, this module is done to be efficient and performs tons of
    cast and dirty things. So avoid using it unless you really know
@@ -10,30 +12,61 @@
 /* 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"
 
 #define PREV(obj,offset) xbt_swag_getPrev(obj,offset)
 #define NEXT(obj,offset) xbt_swag_getNext(obj,offset)
 
-/*
-  Usage : xbt_swag_new(&obj.setA-&obj.setA);
- */
 
+/** 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); 
+ */
 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.
+ */
+void xbt_swag_free(xbt_swag_t swag)
+{
+  free(swag);
+}
+
+/** Creates a new swag.
+ * \param swag the swag to initialize
+ * \param offset where the hookup is located in the structure
+ * \see xbt_swag_offset
+ *
+ * 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
+ *
+ * insert \a obj in \a swag
+ */
 void xbt_swag_insert(void *obj, xbt_swag_t swag)
 {
 
@@ -42,6 +75,7 @@ void xbt_swag_insert(void *obj, xbt_swag_t swag)
 
   (swag->count)++;
   if (swag->head == NULL) {
+    xbt_assert0(!(swag->tail), "Inconsistent swag.");
     swag->head = obj;
     swag->tail = obj;
     return;
@@ -53,11 +87,72 @@ void xbt_swag_insert(void *obj, xbt_swag_t swag)
   swag->tail = obj;
 }
 
-void *xbt_swag_extract(void *obj, xbt_swag_t swag)
+/** 
+ * \param obj the objet to insert in the swag
+ * \param swag a swag
+ *
+ * insert (at the head... you probably had a very good reason to do
+ * that, I hope you know what you're doing) \a obj in \a swag
+ */
+void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
+{
+
+  if (xbt_swag_belongs(obj, swag))
+    return;
+
+  (swag->count)++;
+  if (swag->head == NULL) {
+    xbt_assert0(!(swag->tail), "Inconsistent swag.");
+    swag->head = obj;
+    swag->tail = obj;
+    return;
+  }
+
+  NEXT(obj, swag->offset) = swag->head;
+  PREV(NEXT(obj, swag->offset), swag->offset) = obj;
+
+  swag->head = obj;
+}
+
+/** 
+ * \param obj the objet to insert in the swag
+ * \param swag a swag
+ *
+ * insert (at the tail... you probably had a very good reason to do
+ * that, I hope you know what you're doing) \a obj in \a swag
+ */
+void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
+{
+
+  if (xbt_swag_belongs(obj, swag))
+    return;
+
+  (swag->count)++;
+  if (swag->head == NULL) {
+    xbt_assert0(!(swag->tail), "Inconsistent swag.");
+    swag->head = obj;
+    swag->tail = obj;
+    return;
+  }
+
+  PREV(obj, swag->offset) = swag->tail;
+  NEXT(PREV(obj, swag->offset), swag->offset) = obj;
+
+  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
+ *
+ * removes \a obj from \a swag
+ */
+void *xbt_swag_remove(void *obj, xbt_swag_t swag)
 {
   size_t offset = swag->offset;
 
-  if (!obj)
+  if ((!obj) || (!swag))
     return NULL;
   if(!xbt_swag_belongs(obj, swag)) /* Trying to remove an object that
 				      was not in this swag */
@@ -68,6 +163,7 @@ void *xbt_swag_extract(void *obj, xbt_swag_t 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 */
     swag->head = NEXT(obj, offset);
     PREV(swag->head, offset) = NULL;
@@ -85,13 +181,111 @@ void *xbt_swag_extract(void *obj, xbt_swag_t swag)
   return obj;
 }
 
+/** 
+ * \param swag a swag
+ * \return an object from the \a swag
+ */
+void *xbt_swag_extract(xbt_swag_t swag)
+{
+  size_t offset = swag->offset;
+  void *obj = NULL;
+
+  if ((!swag) || (!(swag->head)))
+    return NULL;
+
+  obj = swag->head;
+
+  if (swag->head == swag->tail) {	/* special case */
+    swag->head = swag->tail = NULL;
+    PREV(obj, offset) = NEXT(obj, offset) = NULL;
+  } else {
+    swag->head = NEXT(obj, offset);
+    PREV(swag->head, offset) = NULL;
+    NEXT(obj, offset) = NULL;
+  }
+  (swag->count)--;
+
+  return obj;
+}
+/** 
+ * \param swag a swag
+ * \return the number of objects in \a swag
+ */
 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
+ */
 int xbt_swag_belongs(void *obj, xbt_swag_t swag)
 {
   return ((NEXT(obj, swag->offset)) || (PREV(obj, swag->offset))
 	  || (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 */