Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Declare swag as const when possible.
[simgrid.git] / src / xbt / swag.c
index dcee5ef..6bf90c0 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+/* Copyright (c) 2004-2017. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
 #include "xbt/log.h"
 #include "xbt/swag.h"
 
-
 /** 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_INLINE xbt_swag_t xbt_swag_new(size_t offset)
+inline xbt_swag_t xbt_swag_new(size_t offset)
 {
   xbt_swag_t swag = xbt_new0(s_xbt_swag_t, 1);
 
@@ -33,10 +32,10 @@ XBT_INLINE xbt_swag_t xbt_swag_new(size_t offset)
 /**
  * \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.
+ * 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.
  */
-XBT_INLINE void xbt_swag_free(xbt_swag_t swag)
+inline void xbt_swag_free(xbt_swag_t swag)
 {
   free(swag);
 }
@@ -48,7 +47,7 @@ XBT_INLINE void xbt_swag_free(xbt_swag_t swag)
  *
  * Usage : xbt_swag_init(swag,&obj.setA-&obj);
  */
-XBT_INLINE void xbt_swag_init(xbt_swag_t swag, size_t offset)
+inline void xbt_swag_init(xbt_swag_t swag, size_t offset)
 {
   swag->tail = NULL;
   swag->head = NULL;
@@ -60,10 +59,10 @@ XBT_INLINE void xbt_swag_init(xbt_swag_t swag, size_t offset)
  * \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
+ * 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
  */
-XBT_INLINE void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
+inline void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
 {
   xbt_assert(!xbt_swag_belongs(obj, swag) || swag->tail,
       "This object belongs to an empty swag! Did you correctly initialize the object's hookup?");
@@ -73,8 +72,7 @@ XBT_INLINE void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
     swag->head = obj;
     swag->tail = obj;
     swag->count++;
-  }
-  else if (obj != swag->head && !xbt_swag_getPrev(obj, swag->offset)) {
+  } else if (obj != swag->head && !xbt_swag_getPrev(obj, swag->offset)) {
     xbt_swag_getNext(obj, swag->offset) = swag->head;
     xbt_swag_getPrev(swag->head, swag->offset) = obj;
     swag->head = obj;
@@ -86,10 +84,10 @@ XBT_INLINE void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
  * \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
+ * 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
  */
-XBT_INLINE void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
+inline void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
 {
   xbt_assert(!xbt_swag_belongs(obj, swag) || swag->tail,
       "This object belongs to an empty swag! Did you correctly initialize the object's hookup?");
@@ -99,8 +97,7 @@ XBT_INLINE void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
     swag->head = obj;
     swag->tail = obj;
     swag->count++;
-  }
-  else if (obj != swag->tail && !xbt_swag_getNext(obj, swag->offset)) {
+  } else if (obj != swag->tail && !xbt_swag_getNext(obj, swag->offset)) {
     xbt_swag_getPrev(obj, swag->offset) = swag->tail;
     xbt_swag_getNext(swag->tail, swag->offset) = obj;
     swag->tail = obj;
@@ -115,7 +112,7 @@ XBT_INLINE void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
  *
  * removes \a obj from \a swag
  */
-XBT_INLINE void *xbt_swag_remove(void *obj, xbt_swag_t swag)
+inline void *xbt_swag_remove(void *obj, xbt_swag_t swag)
 {
   if (!obj)
     return NULL;
@@ -130,19 +127,16 @@ XBT_INLINE void *xbt_swag_remove(void *obj, xbt_swag_t swag)
     if (next) {
       xbt_swag_getPrev(next, offset) = prev;
       xbt_swag_getNext(obj, offset) = NULL;
-    }
-    else {
+    } else {
       swag->tail = prev;
     }
     swag->count--;
-  }
-  else if (next) {
+  } else if (next) {
     xbt_swag_getPrev(next, offset) = NULL;
     xbt_swag_getNext(obj, offset) = NULL;
     swag->head = next;
     swag->count--;
-  }
-  else if (obj == swag->head) {
+  } else if (obj == swag->head) {
     swag->head = swag->tail = NULL;
     swag->count--;
   }
@@ -178,12 +172,11 @@ void *xbt_swag_extract(xbt_swag_t swag)
  * \param swag a swag
  * \return the number of objects in \a swag
  */
-XBT_INLINE int xbt_swag_size(xbt_swag_t swag)
+inline int xbt_swag_size(const_xbt_swag_t swag)
 {
   return (swag->count);
 }
 
-
 #ifdef SIMGRID_TEST
 
 XBT_TEST_SUITE("swag", "Swag data container");
@@ -207,8 +200,7 @@ XBT_TEST_UNIT("basic", test_swag_basic, "Basic usage")
   obj2->name = "Obj 2";
 
   xbt_test_add("Basic usage");
-  xbt_test_log("%p %p %ld\n", obj1, &(obj1->setB),
-                (long) ((char *) &(obj1->setB) - (char *) obj1));
+  xbt_test_log("%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));
@@ -218,8 +210,8 @@ XBT_TEST_UNIT("basic", test_swag_basic, "Basic usage")
   xbt_swag_insert(obj2, setA);
   xbt_swag_insert(obj2, setB);
 
-  xbt_swag_remove(obj1, setB);
-  /*  xbt_swag_remove(obj2, setB); */
+  xbt_test_assert(xbt_swag_remove(NULL, setB) == NULL);
+  xbt_test_assert(xbt_swag_remove(obj1, setB) == obj1);
 
   xbt_test_add("Traverse set A");
   xbt_swag_foreach(obj, setA) {
@@ -247,5 +239,4 @@ XBT_TEST_UNIT("basic", test_swag_basic, "Basic usage")
   xbt_free(obj1);
   xbt_free(obj2);
 }
-
 #endif                          /* SIMGRID_TEST */