include/xbt/dict.h

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