/* 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.
*/
void xbt_swag_free(xbt_swag_t swag)
{
- xbt_free(swag);
+ free(swag);
}
/** Creates a new 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
*
swag->tail = obj;
}
-/**
+/**
* \param obj the objet to insert in the swag
* \param swag a swag
*
swag->head = obj;
}
-/**
+/**
* \param obj the objet to insert in the swag
* \param swag a 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
return NULL;
if(!xbt_swag_belongs(obj, swag)) /* Trying to remove an object that
was not in this swag */
- return NULL;
+ return NULL;
if (swag->head == swag->tail) { /* special case */
if (swag->head != obj) /* Trying to remove an object that was not in this swag */
return obj;
}
-/**
+/**
* \param swag a swag
* \return an object from the \a swag
*/
return obj;
}
-/**
+/**
* \param swag a swag
* \return the number of objects in \a 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));
+ || (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 */
