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(xbt_dict_t) xbt_dict_new_ext(int hashsize);
  49   XBT_PUBLIC(void) xbt_dict_free(xbt_dict_t *dict);
  50   XBT_PUBLIC(void) xbt_dict_hashsize_set(xbt_dict_t dict, int hashsize);
  51
  52 /** @} */
  53 /** @defgroup XBT_dict_basic Dictionnaries basic usage
  54  *  @ingroup XBT_dict
  55  *
  56  * Careful, those functions assume that the key is null-terminated.
  57  *
  58  *  @{
  59  */
  60
  61   XBT_PUBLIC(void)  xbt_dict_set(xbt_dict_t dict, const char *key, void *data, void_f_pvoid_t *free_ctn);
  62   XBT_PUBLIC(void*) xbt_dict_get(xbt_dict_t dict,const char *key);
  63   XBT_PUBLIC(void*) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
  64
  65   XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
  66   XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
  67   XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
  68   XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output)(void*));
  69
  70 /** @} */
  71 /** @defgroup XBT_dict_nnul Dictionnaries with non-nul terminated keys
  72  *  @ingroup XBT_dict
  73  *
  74  * Those functions work even with non-null terminated keys.
  75  *
  76  *  @{
  77  */
  78   XBT_PUBLIC(void)  xbt_dict_set_ext(xbt_dict_t     dict,
  79                          const char     *key, int  key_len,
  80                          void           *data,
  81                          void_f_pvoid_t *free_ctn);
  82   XBT_PUBLIC(void) *xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len);
  83   XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len);
  84
  85
  86 /** @} */
  87 /** @defgroup XBT_dict_curs Cursors on dictionnaries
  88  *  @ingroup XBT_dict
  89  *
  90  *  Don't get impressed, there is a lot of functions here, but traversing a
  91  *  dictionnary is imediate with the xbt_dict_foreach macro.
  92  *  You only need the other functions in rare cases (they are not used directly in SG itself).
  93  *
  94  *  Here is an example (assuming that the dictionnary contains strings, ie
  95  *  that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
  96 \verbatim xbt_dict_cursor_t cursor=NULL;
  97  char *key,*data;
  98
  99  xbt_dict_foreach(dict,cursor,key,data) {
 100     printf("   - Seen:  %s->%s\n",key,data);
 101  }\endverbatim
 102
 103  *
 104  *  \warning Do not add or remove entries to the cache while traversing !!
 105  *
 106  *  @{ */
 107
 108   /** @brief Cursor on dictionnaries (opaque type) */
 109   typedef struct xbt_dict_cursor_ *xbt_dict_cursor_t;
 110   XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
 111   XBT_PUBLIC(void)               xbt_dict_cursor_free(xbt_dict_cursor_t *cursor);
 112
 113   XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
 114
 115
 116   XBT_PUBLIC(char *) xbt_dict_cursor_get_key     (xbt_dict_cursor_t cursor);
 117   XBT_PUBLIC(void *) xbt_dict_cursor_get_data    (xbt_dict_cursor_t cursor);
 118
 119   XBT_PUBLIC(void) xbt_dict_cursor_first (const xbt_dict_t   dict,
 120                              xbt_dict_cursor_t *cursor);
 121   XBT_PUBLIC(void)         xbt_dict_cursor_step        (xbt_dict_cursor_t  cursor);
 122   XBT_PUBLIC(int)          xbt_dict_cursor_get_or_free (xbt_dict_cursor_t *cursor,
 123                                             char              **key,
 124                                             void              **data);
 125   /** @def xbt_dict_foreach
 126       @hideinitializer */
 127 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
 128     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \
 129          xbt_dict_cursor_get_or_free(&(cursor),&(key),(void**)(&data));\
 130          xbt_dict_cursor_step(cursor) )
 131
 132 /** @} */
 133 /** @defgroup XBT_dict_multi Multi-level dictionnaries
 134  *  @ingroup XBT_dict
 135  *
 136  * They can be seen as dictionnary of multiple keys or as dictionnary of
 137  * dictionnary of ... of data. Most of the functions here work the same way
 138  * than their simple dictionnary counterpart.
 139  *
 140  * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
 141  * Use xbt_dict_free() and xbt_dict_new() instead.
 142  *
 143  * @{
 144  */
 145
 146 /** \brief To dump multicache, this function dumps a cache                           */
 147 XBT_PUBLIC(void) xbt_dict_print(void *data);
 148 /** \brief To dump multicache, this one dumps a string                               */
 149 XBT_PUBLIC(void) xbt_dict_prints(void *data);
 150
 151
 152 /*----[ xbt_multidict_set ]--------------------------------------------------*/
 153 XBT_PUBLIC(void)
 154 xbt_multidict_set(xbt_dict_t mdict,
 155                   xbt_dynar_t keys,
 156                   void *data,void (*free_ctn)(void*));
 157 XBT_PUBLIC(void)
 158 xbt_multidict_set_ext(xbt_dict_t mdict,
 159                       xbt_dynar_t keys, xbt_dynar_t lens,
 160                       void *data,void_f_pvoid_t *free_ctn);
 161
 162 /*----[ xbt_multidict_get ]--------------------------------------------------*/
 163 XBT_PUBLIC(void*) xbt_multidict_get    (xbt_dict_t mdict, xbt_dynar_t keys);
 164 XBT_PUBLIC(void*) xbt_multidict_get_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
 165
 166 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
 167 /*---------------------------------------------------------------------------*/
 168 XBT_PUBLIC(void) xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
 169 XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
 170
 171 /** @} */
 172
 173 SG_END_DECL()
 174
 175 #endif /* _XBT_DICT_H */