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