include/xbt/swag.h

   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 #ifndef _XBT_SWAG_H
  13 #define _XBT_SWAG_H
  14
  15 #include "xbt/sysdep.h"
  16
  17 /* This type should be added to a type that is to be used in such a swag */
  18 /* Whenever a new object with this struct is created, all fields have
  19    to be set to NULL */
  20
  21 /** \name Swag types
  22     \ingroup XBT_swag
  23
  24     Specific set.
  25
  26     These typedefs are public so that the compiler can
  27     do his job but believe me, you don't want to try to play with
  28     those structs directly. Use them as an abstract datatype.
  29 */
  30 /*@{*/
  31 typedef struct xbt_swag_hookup {
  32   void *next;
  33   void *prev;
  34 } s_xbt_swag_hookup_t;
  35 /**< This type should be added to a type that is to be used in a swag.
  36  * For example like that :
  37
  38 \code
  39 typedef struct foo {
  40   s_xbt_swag_hookup_t set1_hookup;
  41   s_xbt_swag_hookup_t set2_hookup;
  42
  43   double value;
  44 } s_foo_t, *foo_t;
  45 ...
  46 {
  47   s_foo_t elem;
  48   xbt_swag_t set1=NULL;
  49   xbt_swag_t set2=NULL;
  50
  51   set1 = xbt_swag_new(xbt_swag_offset(elem, set1_hookup));
  52   set2 = xbt_swag_new(xbt_swag_offset(elem, set2_hookup));
  53
  54 }
  55 \endcode
  56 */
  57 typedef s_xbt_swag_hookup_t  *xbt_swag_hookup_t;
  58
  59
  60 typedef struct xbt_swag {
  61   void *head;
  62   void *tail;
  63   size_t offset;
  64   int count;
  65 } s_xbt_swag_t, *xbt_swag_t;
  66 /**< A typical swag */
  67 /*@}*/
  68
  69 xbt_swag_t xbt_swag_new(size_t offset);
  70 void xbt_swag_free(xbt_swag_t swag);
  71 void xbt_swag_init(xbt_swag_t swag, size_t offset);
  72 void xbt_swag_insert(void *obj, xbt_swag_t swag);
  73 void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag);
  74 void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag);
  75 void *xbt_swag_remove(void *obj, xbt_swag_t swag);
  76 void *xbt_swag_extract(xbt_swag_t swag);
  77 int xbt_swag_size(xbt_swag_t swag);
  78 int xbt_swag_belongs(void *obj, xbt_swag_t swag);
  79
  80 static __inline__ void *xbt_swag_getFirst(xbt_swag_t swag)
  81 {
  82   return (swag->head);
  83 }
  84
  85 #define xbt_swag_getNext(obj,offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->prev)
  86 #define xbt_swag_getPrev(obj,offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->next)
  87
  88 /**
  89  * \ingroup XBT_swag
  90  * \brief Offset computation
  91  * \arg var a variable of type <tt>struct</tt> something
  92  * \arg field a field of <tt>struct</tt> something
  93  * \return the offset of \a field in <tt>struct</tt> something.
  94  *
  95  * It is very similar to offsetof except that is done at runtime and that
  96  * you have to declare a variable. Why defining such a macro then ?
  97  * Because it is portable...
  98  */
  99 #define xbt_swag_offset(var,field) ((char *)&( (var).field ) - (char *)&(var))
 100
 101 /**
 102  \name Swag iterator
 103  \ingroup XBT_swag
 104  *
 105  * Iterates over the whole swag.
 106  */
 107 /*@{*/
 108 #define xbt_swag_foreach(obj,swag)                            \
 109    for((obj)=xbt_swag_getFirst((swag));                       \
 110        (obj)!=NULL;                                           \
 111        (obj)=xbt_swag_getNext((obj),(swag)->offset))
 112 /**<  A simple swag iterator
 113  * \param obj the indice of the loop
 114  * \param swag what to iterate over
 115
 116     \warning you cannot modify the \a swag while using this loop  */
 117 #define xbt_swag_foreach_safe(obj,obj_next,swag)                  \
 118    for((obj)=xbt_swag_getFirst((swag)),                           \
 119        ((obj)?(obj_next=xbt_swag_getNext((obj),(swag)->offset)):  \
 120                  (obj_next=NULL));                                \
 121        (obj)!=NULL;                                               \
 122        (obj)=obj_next,                                            \
 123        ((obj)?(obj_next=xbt_swag_getNext((obj),(swag)->offset)):  \
 124                  (obj_next=NULL))     )
 125 /**< A safe swag iterator
 126  * \param obj the indice of the loop
 127  * \param obj_next the object that is right after (if any) \a obj in the swag
 128  * \param swag what to iterate over
 129
 130     You can safely modify the \a swag while using this loop.
 131     Well, safely... Err. You can remove \a obj without having any
 132     trouble at least.  */
 133 /*@}*/
 134
 135 #endif    /* _XBT_SWAG_H */