include/xbt/fifo.h

   1 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef _XBT_FIFO_H
   8 #define _XBT_FIFO_H
   9 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
  10
  11 SG_BEGIN_DECL()
  12
  13 /** @addtogroup XBT_fifo
  14  *  @brief This section describes the API to generic workqueue.
  15  *
  16  * These functions provide the same kind of functionnality as dynamic arrays but in time O(1).
  17  * However these functions use malloc/free way too much often.
  18  */
  19 /** @defgroup XBT_fifo_cons Fifo constructor and destructor
  20  *  @ingroup XBT_fifo
  21  *
  22  *  @{
  23  */
  24 /** \brief  Bucket structure
  25 */
  26 typedef struct xbt_fifo_item *xbt_fifo_item_t;
  27
  28 /** \brief  FIFO structure
  29 */
  30 typedef struct xbt_fifo *xbt_fifo_t;
  31
  32 XBT_PUBLIC(xbt_fifo_t) xbt_fifo_new(void);
  33 XBT_PUBLIC(void) xbt_fifo_free(xbt_fifo_t);
  34 XBT_PUBLIC(void) xbt_fifo_reset(xbt_fifo_t);
  35 /** @} */
  36
  37 /** @defgroup XBT_fifo_perl Fifo perl-like functions
  38  *  @ingroup XBT_fifo
  39  *
  40  *  @{
  41  */
  42 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_push(xbt_fifo_t, void *);
  43 XBT_PUBLIC(void *) xbt_fifo_pop(xbt_fifo_t);
  44 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_unshift(xbt_fifo_t, void *);
  45 XBT_PUBLIC(void *) xbt_fifo_shift(xbt_fifo_t);
  46 XBT_PUBLIC(int) xbt_fifo_size(xbt_fifo_t);
  47 XBT_PUBLIC(int) xbt_fifo_is_in(xbt_fifo_t, void *);
  48 /** @} */
  49
  50 /** @defgroup XBT_fifo_direct Direct access to fifo elements
  51  *  @ingroup XBT_fifo
  52  *
  53  *  @{
  54  */
  55
  56 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_new_item(void);
  57 XBT_PUBLIC(void) xbt_fifo_set_item_content(xbt_fifo_item_t, void *);
  58 XBT_PUBLIC(void *) xbt_fifo_get_item_content(xbt_fifo_item_t);
  59 XBT_PUBLIC(void) xbt_fifo_free_item(xbt_fifo_item_t);
  60
  61 XBT_PUBLIC(void) xbt_fifo_push_item(xbt_fifo_t, xbt_fifo_item_t);
  62 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_pop_item(xbt_fifo_t);
  63 XBT_PUBLIC(void) xbt_fifo_unshift_item(xbt_fifo_t, xbt_fifo_item_t);
  64 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_shift_item(xbt_fifo_t);
  65
  66 XBT_PUBLIC(int) xbt_fifo_remove(xbt_fifo_t, void *);
  67 XBT_PUBLIC(int) xbt_fifo_remove_all(xbt_fifo_t, void *);
  68 XBT_PUBLIC(void) xbt_fifo_remove_item(xbt_fifo_t, xbt_fifo_item_t);
  69
  70 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_first_item(xbt_fifo_t l);
  71 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_last_item(xbt_fifo_t l);
  72 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_next_item(xbt_fifo_item_t i);
  73 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_prev_item(xbt_fifo_item_t i);
  74
  75 /**
  76  * \brief List iterator
  77  * asserts and stuff
  78  * \param f a list (#xbt_fifo_t)
  79  * \param i a bucket (#xbt_fifo_item_t)
  80  * \param type a type
  81  * \param n an object of type \a type.
  82  * @hideinitializer
  83  *
  84  * Iterates over the whole list.
  85  */
  86 #define xbt_fifo_foreach(f,i,n,type)                  \
  87    for(i=xbt_fifo_get_first_item(f);                    \
  88      ((i)?(n=(type)(xbt_fifo_get_item_content(i))):(NULL));             \
  89        i=xbt_fifo_get_next_item(i))
  90
  91 /** @} */
  92
  93 /** @defgroup XBT_fifo_misc Misc fifo functions
  94  *  @ingroup XBT_fifo
  95  *
  96  *  @{
  97  */
  98 XBT_PUBLIC(void **) xbt_fifo_to_array(xbt_fifo_t);
  99 XBT_PUBLIC(xbt_fifo_t) xbt_fifo_copy(xbt_fifo_t);
 100 /** @} */
 101
 102 /* Deprecated functions: don't use! */
 103 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_newitem(void);
 104 XBT_PUBLIC(void) xbt_fifo_freeitem(xbt_fifo_item_t);
 105
 106 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getFirstItem(xbt_fifo_t l);
 107 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getNextItem(xbt_fifo_item_t i);
 108 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getPrevItem(xbt_fifo_item_t i);
 109
 110
 111 SG_END_DECL()
 112 #endif                          /* _XBT_FIFO_H */