include/xbt/dict.h

   1 /* $Id$ */
   2
   3 /* xbt/dict.h -- api to a generic dictionary                                */
   4
   5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10
  11 #ifndef _XBT_DICT_H
  12 #define _XBT_DICT_H
  13
  14 #include "xbt/misc.h" /* SG_BEGIN_DECL */
  15 #include "xbt/dynar.h" /* void_f_pvoid_t */
  16
  17 SG_BEGIN_DECL()
  18
  19 /** @addtogroup XBT_dict
  20  *  @brief The dictionnary data structure (comparable to hash tables)
  21  *
  22  *  This section describes the API to a dictionnary structure that
  23  *  associates as string to a void* key. It provides the same
  24  *  functionnality than an hash table.
  25  *
  26  *  Here is a little example of use:
  27  *  \verbatim xbt_dict_t mydict = xbt_dict_new();
  28  char buff[512];
  29
  30  sprintf(buff,"some very precious data");
  31  xbt_dict_set(mydict,"my data", strdup(buff), free);
  32
  33  sprintf(buff,"another good stuff");
  34  xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add \endverbatim
  35
  36  *
  37  */
  38
  39 /** @defgroup XBT_dict_cons Dict constructor and destructor
  40  *  @ingroup XBT_dict
  41  *
  42  *  @{
  43  */
  44
  45   /** \brief Dictionnary data type (opaque structure) */
  46   typedef struct xbt_dict_ *xbt_dict_t;
  47   XBT_PUBLIC(xbt_dict_t) xbt_dict_new(void);
  48   XBT_PUBLIC(void) xbt_dict_free(xbt_dict_t *dict);
  49
  50 /** @} */
  51 /** @defgroup XBT_dict_basic Dictionnaries basic usage
  52  *  @ingroup XBT_dict
  53  *
  54  * Careful, those functions assume that the key is null-terminated.
  55  *
  56  *  @{
  57  */
  58
  59   XBT_PUBLIC(void)  xbt_dict_set(xbt_dict_t dict, const char *key, void *data, void_f_pvoid_t free_ctn);
  60   XBT_PUBLIC(void*) xbt_dict_get(xbt_dict_t dict,const char *key);
  61   XBT_PUBLIC(void*) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
  62
  63   XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
  64   XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
  65   XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
  66   XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output)(void*));
  67
  68 /** @} */
  69 /** @defgroup XBT_dict_nnul Dictionnaries with non-nul terminated keys
  70  *  @ingroup XBT_dict
  71  *
  72  * Those functions work even with non-null terminated keys.
  73  *
  74  *  @{
  75  */
  76   XBT_PUBLIC(void)  xbt_dict_set_ext(xbt_dict_t     dict,
  77                          const char     *key, int  key_len,
  78                          void           *data,
  79                          void_f_pvoid_t free_ctn);
  80   XBT_PUBLIC(void*) xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len);
  81   XBT_PUBLIC(void)  xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len);
  82
  83
  84 /** @} */
  85 /** @defgroup XBT_dict_curs Cursors on dictionnaries
  86  *  @ingroup XBT_dict
  87  *
  88  *  Don't get impressed, there is a lot of functions here, but traversing a
  89  *  dictionnary is imediate with the xbt_dict_foreach macro.
  90  *  You only need the other functions in rare cases (they are not used directly in SG itself).
  91  *
  92  *  Here is an example (assuming that the dictionnary contains strings, ie
  93  *  that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
  94 \verbatim xbt_dict_cursor_t cursor=NULL;
  95  char *key,*data;
  96
  97  xbt_dict_foreach(dict,cursor,key,data) {
  98     printf("   - Seen:  %s->%s\n",key,data);
  99  }\endverbatim
 100
 101  *
 102  *  \warning Do not add or remove entries to the cache while traversing !!
 103  *
 104  *  @{ */
 105
 106   /** @brief Cursor on dictionnaries (opaque type) */
 107   typedef struct xbt_dict_cursor_ *xbt_dict_cursor_t;
 108   XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
 109   XBT_PUBLIC(void)               xbt_dict_cursor_free(xbt_dict_cursor_t *cursor);
 110
 111   XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
 112
 113
 114   XBT_PUBLIC(char *) xbt_dict_cursor_get_key     (xbt_dict_cursor_t cursor);
 115   XBT_PUBLIC(void *) xbt_dict_cursor_get_data    (xbt_dict_cursor_t cursor);
 116
 117   XBT_PUBLIC(void) xbt_dict_cursor_first (const xbt_dict_t   dict,
 118                              xbt_dict_cursor_t *cursor);
 119   XBT_PUBLIC(void)         xbt_dict_cursor_step        (xbt_dict_cursor_t  cursor);
 120   XBT_PUBLIC(int)          xbt_dict_cursor_get_or_free (xbt_dict_cursor_t *cursor,
 121                                             char              **key,
 122                                             void              **data);
 123   /** @def xbt_dict_foreach
 124       @hideinitializer */
 125 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
 126     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \
 127          xbt_dict_cursor_get_or_free(&(cursor),&(key),(void**)(&data));\
 128          xbt_dict_cursor_step(cursor) )
 129
 130 /** @} */
 131 /** @defgroup XBT_dict_multi Multi-level dictionnaries
 132  *  @ingroup XBT_dict
 133  *
 134  * They can be seen as dictionnary of multiple keys or as dictionnary of
 135  * dictionnary of ... of data. Most of the functions here work the same way
 136  * than their simple dictionnary counterpart.
 137  *
 138  * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
 139  * Use xbt_dict_free() and xbt_dict_new() instead.
 140  *
 141  * @{
 142  */
 143
 144 /** \brief To dump multicache, this function dumps a cache                           */
 145 XBT_PUBLIC(void) xbt_dict_print(void *data);
 146 /** \brief To dump multicache, this one dumps a string                               */
 147 XBT_PUBLIC(void) xbt_dict_prints(void *data);
 148
 149
 150 /*----[ xbt_multidict_set ]--------------------------------------------------*/
 151 XBT_PUBLIC(void)
 152 xbt_multidict_set(xbt_dict_t mdict,
 153                   xbt_dynar_t keys,
 154                   void *data,void (*free_ctn)(void*));
 155 XBT_PUBLIC(void)
 156 xbt_multidict_set_ext(xbt_dict_t mdict,
 157                       xbt_dynar_t keys, xbt_dynar_t lens,
 158                       void *data,void_f_pvoid_t free_ctn);
 159
 160 /*----[ xbt_multidict_get ]--------------------------------------------------*/
 161 XBT_PUBLIC(void*) xbt_multidict_get    (xbt_dict_t mdict, xbt_dynar_t keys);
 162 XBT_PUBLIC(void*) xbt_multidict_get_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
 163
 164 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
 165 /*---------------------------------------------------------------------------*/
 166 XBT_PUBLIC(void) xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
 167 XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
 168
 169 /** @} */
 170
 171 SG_END_DECL()
 172
 173 #endif /* _XBT_DICT_H */