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     xbt_assert0(!(swag->tail), "Inconsistent swag.");
  56     swag->head = obj;
  57     swag->tail = obj;
  58     return;
  59   }
  60
  61   PREV(obj, swag->offset) = swag->tail;
  62   NEXT(PREV(obj, swag->offset), swag->offset) = obj;
  63
  64   swag->tail = obj;
  65 }
  66
  67 void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
  68 {
  69
  70   if (xbt_swag_belongs(obj, swag))
  71     return;
  72
  73   (swag->count)++;
  74   if (swag->head == NULL) {
  75     xbt_assert0(!(swag->tail), "Inconsistent swag.");
  76     swag->head = obj;
  77     swag->tail = obj;
  78     return;
  79   }
  80
  81   NEXT(obj, swag->offset) = swag->head;
  82   PREV(NEXT(obj, swag->offset), swag->offset) = obj;
  83
  84   swag->head = obj;
  85 }
  86
  87 void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
  88 {
  89
  90   if (xbt_swag_belongs(obj, swag))
  91     return;
  92
  93   (swag->count)++;
  94   if (swag->head == NULL) {
  95     xbt_assert0(!(swag->tail), "Inconsistent swag.");
  96     swag->head = obj;
  97     swag->tail = obj;
  98     return;
  99   }
 100
 101   PREV(obj, swag->offset) = swag->tail;
 102   NEXT(PREV(obj, swag->offset), swag->offset) = obj;
 103
 104   swag->tail = obj;
 105 }
 106
 107 void *xbt_swag_remove(void *obj, xbt_swag_t swag)
 108 {
 109   size_t offset = swag->offset;
 110
 111   if ((!obj) || (!swag))
 112     return NULL;
 113   if(!xbt_swag_belongs(obj, swag)) /* Trying to remove an object that
 114                                       was not in this swag */
 115       return NULL;
 116
 117   if (swag->head == swag->tail) {       /* special case */
 118     if (swag->head != obj)      /* Trying to remove an object that was not in this swag */
 119       return NULL;
 120     swag->head = NULL;
 121     swag->tail = NULL;
 122     NEXT(obj, offset) = PREV(obj, offset) = NULL;
 123   } else if (obj == swag->head) {       /* It's the head */
 124     swag->head = NEXT(obj, offset);
 125     PREV(swag->head, offset) = NULL;
 126     NEXT(obj, offset) = NULL;
 127   } else if (obj == swag->tail) {       /* It's the tail */
 128     swag->tail = PREV(obj, offset);
 129     NEXT(swag->tail, offset) = NULL;
 130     PREV(obj, offset) = NULL;
 131   } else {                      /* It's in the middle */
 132     NEXT(PREV(obj, offset), offset) = NEXT(obj, offset);
 133     PREV(NEXT(obj, offset), offset) = PREV(obj, offset);
 134     PREV(obj, offset) = NEXT(obj, offset) = NULL;
 135   }
 136   (swag->count)--;
 137   return obj;
 138 }
 139
 140 void *xbt_swag_extract(xbt_swag_t swag)
 141 {
 142   size_t offset = swag->offset;
 143   void *obj = NULL;
 144
 145   if ((!swag) || (!(swag->head)))
 146     return NULL;
 147
 148   obj = swag->head;
 149
 150   if (swag->head == swag->tail) {       /* special case */
 151     swag->head = swag->tail = NULL;
 152     PREV(obj, offset) = NEXT(obj, offset) = NULL;
 153   } else {
 154     swag->head = NEXT(obj, offset);
 155     PREV(swag->head, offset) = NULL;
 156     NEXT(obj, offset) = NULL;
 157   }
 158   (swag->count)--;
 159
 160   return obj;
 161 }
 162
 163 int xbt_swag_size(xbt_swag_t swag)
 164 {
 165   return (swag->count);
 166 }
 167
 168 int xbt_swag_belongs(void *obj, xbt_swag_t swag)
 169 {
 170   return ((NEXT(obj, swag->offset)) || (PREV(obj, swag->offset))
 171           || (swag->head == obj));
 172 }