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   Usage : xbt_swag_new(&obj.setA-&obj);
  25  */
  26
  27 xbt_swag_t xbt_swag_new(size_t offset)
  28 {
  29   xbt_swag_t swag = xbt_new0(s_xbt_swag_t, 1);
  30
  31   swag->offset = offset;
  32
  33   return swag;
  34 }
  35
  36
  37 void xbt_swag_free(xbt_swag_t swag)
  38 {
  39   xbt_free(swag);
  40 }
  41
  42 void xbt_swag_init(xbt_swag_t swag, size_t offset)
  43 {
  44   swag->offset = offset;
  45 }
  46
  47 void xbt_swag_insert(void *obj, xbt_swag_t swag)
  48 {
  49
  50   if (xbt_swag_belongs(obj, swag))
  51     return;
  52
  53   (swag->count)++;
  54   if (swag->head == NULL) {
  55     swag->head = obj;
  56     swag->tail = obj;
  57     return;
  58   }
  59
  60   PREV(obj, swag->offset) = swag->tail;
  61   NEXT(PREV(obj, swag->offset), swag->offset) = obj;
  62
  63   swag->tail = obj;
  64 }
  65
  66 void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
  67 {
  68
  69   if (xbt_swag_belongs(obj, swag))
  70     return;
  71
  72   (swag->count)++;
  73   if (swag->head == NULL) {
  74     swag->head = obj;
  75     swag->tail = obj;
  76     return;
  77   }
  78
  79   NEXT(obj, swag->offset) = swag->head;
  80   PREV(NEXT(obj, swag->offset), swag->offset) = obj;
  81
  82   swag->head = obj;
  83 }
  84
  85 void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
  86 {
  87
  88   if (xbt_swag_belongs(obj, swag))
  89     return;
  90
  91   (swag->count)++;
  92   if (swag->head == NULL) {
  93     swag->head = obj;
  94     swag->tail = obj;
  95     return;
  96   }
  97
  98   PREV(obj, swag->offset) = swag->tail;
  99   NEXT(PREV(obj, swag->offset), swag->offset) = obj;
 100
 101   swag->tail = obj;
 102 }
 103
 104 void *xbt_swag_remove(void *obj, xbt_swag_t swag)
 105 {
 106   size_t offset = swag->offset;
 107
 108   if ((!obj) || (!swag))
 109     return NULL;
 110   if(!xbt_swag_belongs(obj, swag)) /* Trying to remove an object that
 111                                       was not in this swag */
 112       return NULL;
 113
 114   if (swag->head == swag->tail) {       /* special case */
 115     if (swag->head != obj)      /* Trying to remove an object that was not in this swag */
 116       return NULL;
 117     swag->head = NULL;
 118     swag->tail = NULL;
 119   } else if (obj == swag->head) {       /* It's the head */
 120     swag->head = NEXT(obj, offset);
 121     PREV(swag->head, offset) = NULL;
 122     NEXT(obj, offset) = NULL;
 123   } else if (obj == swag->tail) {       /* It's the tail */
 124     swag->tail = PREV(obj, offset);
 125     NEXT(swag->tail, offset) = NULL;
 126     PREV(obj, offset) = NULL;
 127   } else {                      /* It's in the middle */
 128     NEXT(PREV(obj, offset), offset) = NEXT(obj, offset);
 129     PREV(NEXT(obj, offset), offset) = PREV(obj, offset);
 130     PREV(obj, offset) = NEXT(obj, offset) = NULL;
 131   }
 132   (swag->count)--;
 133   return obj;
 134 }
 135
 136 void *xbt_swag_extract(xbt_swag_t swag)
 137 {
 138   size_t offset = swag->offset;
 139   void *obj = NULL;
 140
 141   if ((!swag) || (!(swag->head)))
 142     return NULL;
 143
 144   obj = swag->head;
 145
 146   if (swag->head == swag->tail) {       /* special case */
 147     swag->head = swag->tail = NULL;
 148   } else {
 149     swag->head = NEXT(obj, offset);
 150     PREV(swag->head, offset) = NULL;
 151     NEXT(obj, offset) = NULL;
 152   }
 153   (swag->count)--;
 154
 155   return obj;
 156 }
 157
 158 int xbt_swag_size(xbt_swag_t swag)
 159 {
 160   return (swag->count);
 161 }
 162
 163 int xbt_swag_belongs(void *obj, xbt_swag_t swag)
 164 {
 165   return ((NEXT(obj, swag->offset)) || (PREV(obj, swag->offset))
 166           || (swag->head == obj));
 167 }