include/xbt/set.h

   1 /* xbt/set.h -- api to a generic dictionary                                 */
   2
   3 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #ifndef _XBT_SET_H
  10 #define _XBT_SET_H
  11
  12 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
  13 #include "xbt/function_types.h"
  14
  15 SG_BEGIN_DECL()
  16
  17 /** @addtogroup XBT_set
  18  *  @brief A data container consisting in \ref XBT_dict and \ref XBT_dynar
  19  *
  20  *  The elements stored in such a data structure can be retrieve both by
  21  *  name and by ID. For this to work, the first fields of the structures
  22  *  stored must begin with the following fields:
  23  *  \verbatim struct {
  24  unsigned int ID;
  25  char        *name;
  26  unsigned int name_len;
  27  // my other fields, constituting the payload
  28 } my_element_type_t; \endverbatim
  29  *
  30  *  Since we are casting elements around, no protection is ensured by the
  31  * compiler. It is thus safer to define the headers using the macro
  32  * defined to that extend:
  33  *  \verbatim struct {
  34  XBT_SET_HEADERS;
  35
  36  // my other fields, constituting the payload
  37 } my_element_type_t; \endverbatim
  38  *
  39  *  It is now possible to remove an element from such a data structure.
  40  *
  41  *  @todo
  42  *  Such a datastructure was necessary/useful to store the GRAS type
  43  *  descriptions, but it should be reworked to become generic.
  44  *
  45  */
  46 /** @defgroup XBT_set_cons Set and set elements, constructor/destructor
  47  *  @ingroup XBT_set
  48  *
  49  *  @{
  50  */
  51 /** \brief Opaque type representing a set */
  52 typedef struct xbt_set_ *xbt_set_t;
  53
  54 #define XBT_SET_HEADERS \
  55   unsigned int ID;      \
  56   char        *name;    \
  57   unsigned int name_len
  58
  59 /** \brief It must be possible to cast set elements to this type */
  60 typedef struct xbt_set_elm_ {
  61   unsigned int ID;      /**< Identificator (system assigned) */
  62   char *name;           /**< Name (user assigned) */
  63   unsigned int name_len;
  64                         /**< Length of the name */
  65 } s_xbt_set_elm_t, *xbt_set_elm_t;
  66
  67 /*####[ Functions ]##########################################################*/
  68 XBT_PUBLIC(xbt_set_t) xbt_set_new(void);
  69 XBT_PUBLIC(void) xbt_set_free(xbt_set_t * set);
  70
  71 /** @} */
  72 /** @defgroup XBT_set_basic Sets basic usage
  73  *  @ingroup XBT_set
  74  *
  75  *  @{
  76  */
  77
  78 XBT_PUBLIC(void) xbt_set_add(xbt_set_t set, xbt_set_elm_t elm,
  79                              void_f_pvoid_t free_func);
  80 XBT_PUBLIC(void) xbt_set_remove(xbt_set_t set, xbt_set_elm_t elm);
  81 XBT_PUBLIC(void) xbt_set_remove_by_name(xbt_set_t set, const char *key);
  82 XBT_PUBLIC(xbt_set_elm_t) xbt_set_get_by_name_or_null(xbt_set_t set,
  83                                                       const char *key);
  84 XBT_PUBLIC(void) xbt_set_remove_by_name_ext(xbt_set_t set, const char *key,
  85                                             int key_len);
  86 XBT_PUBLIC(void) xbt_set_remove_by_id(xbt_set_t set, int id);
  87
  88 XBT_PUBLIC(xbt_set_elm_t) xbt_set_get_by_name(xbt_set_t set,
  89                                               const char *key);
  90 XBT_PUBLIC(xbt_set_elm_t) xbt_set_get_by_name_ext(xbt_set_t set,
  91                                                   const char *key,
  92                                                   int key_len);
  93 XBT_PUBLIC(xbt_set_elm_t) xbt_set_get_by_id(xbt_set_t set, int id);
  94
  95 XBT_PUBLIC(unsigned long) xbt_set_length(const xbt_set_t set);
  96
  97
  98 /** @} */
  99 /** @defgroup XBT_set_curs Sets cursors
 100  *  @ingroup XBT_set
 101  *
 102  *  \warning Don't add or remove entries to the cache while traversing
 103  *
 104  *  @{
 105  */
 106
 107 /** @brief Cursor type */
 108 typedef struct xbt_set_cursor_ *xbt_set_cursor_t;
 109
 110 XBT_PUBLIC(void) xbt_set_cursor_first(xbt_set_t set,
 111                                       xbt_set_cursor_t * cursor);
 112 XBT_PUBLIC(void) xbt_set_cursor_step(xbt_set_cursor_t cursor);
 113 XBT_PUBLIC(int) xbt_set_cursor_get_or_free(xbt_set_cursor_t * cursor,
 114                                            xbt_set_elm_t * elm);
 115
 116 /** @brief Iterates over the whole set
 117  *  @hideinitializer
 118  */
 119 #define xbt_set_foreach(set,cursor,elm)                       \
 120   for ((cursor) = NULL, xbt_set_cursor_first((set),&(cursor)) ;   \
 121        xbt_set_cursor_get_or_free(&(cursor),(xbt_set_elm_t*)&(elm));          \
 122        xbt_set_cursor_step(cursor) )
 123
 124 /* @} */
 125 SG_END_DECL()
 126 #endif                          /* _XBT_SET_H */