src/xbt/swag.c

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 /* Warning, this module is done to be efficient and performs tons of
   9    cast and dirty things. So avoid using it unless you really know
  10    what you are doing. */
  11
  12 /* This type should be added to a type that is to be used in such a swag */
  13
  14 #include "xbt/sysdep.h"
  15 #include "xbt/error.h"
  16 #include "xbt/swag.h"
  17
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(swag,xbt,"Swag : O(1) set library");
  19
  20 #define PREV(obj,offset) xbt_swag_getPrev(obj,offset)
  21 #define NEXT(obj,offset) xbt_swag_getNext(obj,offset)
  22
  23
  24 /** Creates a new swag.
  25  * \param offset where the hookup is located in the structure
  26  * \see xbt_swag_offset
  27  *
  28  * Usage : xbt_swag_new(&obj.setA-&obj);
  29  */
  30 xbt_swag_t xbt_swag_new(size_t offset)
  31 {
  32   xbt_swag_t swag = xbt_new0(s_xbt_swag_t, 1);
  33
  34   swag->offset = offset;
  35
  36   return swag;
  37 }
  38
  39 /**
  40  * \param swag poor victim
  41  *
  42  * kilkil a swag but not it's content. If you do not understand why
  43  * xbt_swag_free should not free its content, don't use swags.
  44  */
  45 void xbt_swag_free(xbt_swag_t swag)
  46 {
  47   free(swag);
  48 }
  49
  50 /** Creates a new swag.
  51  * \param swag the swag to initialize
  52  * \param offset where the hookup is located in the structure
  53  * \see xbt_swag_offset
  54  *
  55  * Usage : xbt_swag_init(swag,&obj.setA-&obj);
  56  */
  57 void xbt_swag_init(xbt_swag_t swag, size_t offset)
  58 {
  59   swag->offset = offset;
  60 }
  61
  62
  63 /**
  64  * \param obj the objet to insert in the swag
  65  * \param swag a swag
  66  *
  67  * insert \a obj in \a swag
  68  */
  69 void xbt_swag_insert(void *obj, xbt_swag_t swag)
  70 {
  71
  72   if (xbt_swag_belongs(obj, swag))
  73     return;
  74
  75   (swag->count)++;
  76   if (swag->head == NULL) {
  77     xbt_assert0(!(swag->tail), "Inconsistent swag.");
  78     swag->head = obj;
  79     swag->tail = obj;
  80     return;
  81   }
  82
  83   PREV(obj, swag->offset) = swag->tail;
  84   NEXT(PREV(obj, swag->offset), swag->offset) = obj;
  85
  86   swag->tail = obj;
  87 }
  88
  89 /**
  90  * \param obj the objet to insert in the swag
  91  * \param swag a swag
  92  *
  93  * insert (at the head... you probably had a very good reason to do
  94  * that, I hope you know what you're doing) \a obj in \a swag
  95  */
  96 void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
  97 {
  98
  99   if (xbt_swag_belongs(obj, swag))
 100     return;
 101
 102   (swag->count)++;
 103   if (swag->head == NULL) {
 104     xbt_assert0(!(swag->tail), "Inconsistent swag.");
 105     swag->head = obj;
 106     swag->tail = obj;
 107     return;
 108   }
 109
 110   NEXT(obj, swag->offset) = swag->head;
 111   PREV(NEXT(obj, swag->offset), swag->offset) = obj;
 112
 113   swag->head = obj;
 114 }
 115
 116 /**
 117  * \param obj the objet to insert in the swag
 118  * \param swag a swag
 119  *
 120  * insert (at the tail... you probably had a very good reason to do
 121  * that, I hope you know what you're doing) \a obj in \a swag
 122  */
 123 void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
 124 {
 125
 126   if (xbt_swag_belongs(obj, swag))
 127     return;
 128
 129   (swag->count)++;
 130   if (swag->head == NULL) {
 131     xbt_assert0(!(swag->tail), "Inconsistent swag.");
 132     swag->head = obj;
 133     swag->tail = obj;
 134     return;
 135   }
 136
 137   PREV(obj, swag->offset) = swag->tail;
 138   NEXT(PREV(obj, swag->offset), swag->offset) = obj;
 139
 140   swag->tail = obj;
 141 }
 142
 143 /**
 144  * \param obj the objet to remove from the swag
 145  * \param swag a swag
 146  * \return \a obj if it was in the \a swag and NULL otherwise
 147  *
 148  * removes \a obj from \a swag
 149  */
 150 void *xbt_swag_remove(void *obj, xbt_swag_t swag)
 151 {
 152   size_t offset = swag->offset;
 153
 154   if ((!obj) || (!swag))
 155     return NULL;
 156   if(!xbt_swag_belongs(obj, swag)) /* Trying to remove an object that
 157                                       was not in this swag */
 158       return NULL;
 159
 160   if (swag->head == swag->tail) {       /* special case */
 161     if (swag->head != obj)      /* Trying to remove an object that was not in this swag */
 162       return NULL;
 163     swag->head = NULL;
 164     swag->tail = NULL;
 165     NEXT(obj, offset) = PREV(obj, offset) = NULL;
 166   } else if (obj == swag->head) {       /* It's the head */
 167     swag->head = NEXT(obj, offset);
 168     PREV(swag->head, offset) = NULL;
 169     NEXT(obj, offset) = NULL;
 170   } else if (obj == swag->tail) {       /* It's the tail */
 171     swag->tail = PREV(obj, offset);
 172     NEXT(swag->tail, offset) = NULL;
 173     PREV(obj, offset) = NULL;
 174   } else {                      /* It's in the middle */
 175     NEXT(PREV(obj, offset), offset) = NEXT(obj, offset);
 176     PREV(NEXT(obj, offset), offset) = PREV(obj, offset);
 177     PREV(obj, offset) = NEXT(obj, offset) = NULL;
 178   }
 179   (swag->count)--;
 180   return obj;
 181 }
 182
 183 /**
 184  * \param swag a swag
 185  * \return an object from the \a swag
 186  */
 187 void *xbt_swag_extract(xbt_swag_t swag)
 188 {
 189   size_t offset = swag->offset;
 190   void *obj = NULL;
 191
 192   if ((!swag) || (!(swag->head)))
 193     return NULL;
 194
 195   obj = swag->head;
 196
 197   if (swag->head == swag->tail) {       /* special case */
 198     swag->head = swag->tail = NULL;
 199     PREV(obj, offset) = NEXT(obj, offset) = NULL;
 200   } else {
 201     swag->head = NEXT(obj, offset);
 202     PREV(swag->head, offset) = NULL;
 203     NEXT(obj, offset) = NULL;
 204   }
 205   (swag->count)--;
 206
 207   return obj;
 208 }
 209 /**
 210  * \param swag a swag
 211  * \return the number of objects in \a swag
 212  */
 213 int xbt_swag_size(xbt_swag_t swag)
 214 {
 215   return (swag->count);
 216 }
 217
 218 /**
 219  * \param obj an object
 220  * \param swag a swag
 221  * \return 1 if \a obj is in the \a swag and 0 otherwise
 222  */
 223 int xbt_swag_belongs(void *obj, xbt_swag_t swag)
 224 {
 225   return ((NEXT(obj, swag->offset)) || (PREV(obj, swag->offset))
 226           || (swag->head == obj));
 227 }