include/xbt/dict.h

   1 /* xbt/dict.h -- api to a generic dictionary                                */
   2
   3 /* Copyright (c) 2004-2014. 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_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
  27 \verbatim
  28  xbt_dict_t mydict = xbt_dict_new();
  29  char buff[512];
  30
  31  sprintf(buff,"some very precious data");
  32  xbt_dict_set(mydict,"my data", strdup(buff), free);
  33
  34  sprintf(buff,"another good stuff");
  35  xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add
  36 \endverbatim
  37  *
  38  */
  39
  40 /** @defgroup XBT_dict_cons Dict constructor and destructor
  41  *  @ingroup XBT_dict
  42  *
  43  *  @{
  44  */
  45
  46   /** \brief Dictionary data type (opaque structure) */
  47
  48 typedef struct s_xbt_dict *xbt_dict_t;
  49 typedef struct s_xbt_dictelm *xbt_dictelm_t;
  50 typedef struct s_xbt_dictelm {
  51   char *key;
  52   int key_len;
  53   unsigned int hash_code;
  54
  55   void *content;
  56
  57   xbt_dictelm_t next;
  58 } s_xbt_dictelm_t;
  59
  60 XBT_PUBLIC(xbt_dict_t) xbt_dict_new(void);
  61 XBT_PUBLIC(xbt_dict_t) xbt_dict_new_homogeneous(void_f_pvoid_t free_ctn);
  62 XBT_PUBLIC(void) xbt_dict_free(xbt_dict_t * dict);
  63 XBT_PUBLIC(unsigned int) xbt_dict_size(xbt_dict_t dict);
  64
  65 /** @} */
  66 /** @defgroup XBT_dict_basic Dictionaries basic usage
  67  *  @ingroup XBT_dict
  68  *
  69  * Careful, those functions assume that the key is null-terminated.
  70  *
  71  *  @{
  72  */
  73
  74 XBT_PUBLIC(void) xbt_dict_set(xbt_dict_t dict, const char *key, void *data,
  75                               void_f_pvoid_t free_ctn);
  76 XBT_PUBLIC(void *) xbt_dict_get(xbt_dict_t dict, const char *key);
  77 XBT_PUBLIC(void *) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
  78 XBT_PUBLIC(char *) xbt_dict_get_key(xbt_dict_t dict, const void *data);
  79 XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm(xbt_dict_t dict, const char *key);
  80 XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm_or_null(xbt_dict_t dict, const char *key);
  81
  82 XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
  83 XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
  84 XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
  85 XBT_PUBLIC(void) xbt_dict_dump_output_string(void *s);
  86 XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output) (void *));
  87 XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict);
  88 XBT_PUBLIC(int) xbt_dict_is_empty(xbt_dict_t dict);
  89
  90
  91 /** @} */
  92 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
  93  *  @ingroup XBT_dict
  94  *
  95  * Those functions work even with non-null terminated keys.
  96  *
  97  *  @{
  98  */
  99 XBT_PUBLIC(void) xbt_dict_set_ext(xbt_dict_t dict,
 100                                   const char *key, int key_len,
 101                                   void *data, void_f_pvoid_t free_ctn);
 102 XBT_PUBLIC(void *) xbt_dict_get_ext(xbt_dict_t dict, const char *key,
 103                                     int key_len);
 104 XBT_PUBLIC(void *) xbt_dict_get_or_null_ext(xbt_dict_t dict,
 105                                             const char *key, int key_len);
 106 XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key,
 107                                      int key_len);
 108
 109 #ifdef XBT_USE_DEPRECATED
 110 XBT_PUBLIC(void) xbt_dicti_set(xbt_dict_t dict, uintptr_t key,
 111                                uintptr_t data);
 112 XBT_PUBLIC(uintptr_t) xbt_dicti_get(xbt_dict_t dict, uintptr_t key);
 113 XBT_PUBLIC(void) xbt_dicti_remove(xbt_dict_t dict, uintptr_t key);
 114 #endif
 115
 116 struct s_xbt_dict_cursor {
 117   xbt_dictelm_t current;
 118   int line;
 119   xbt_dict_t dict;
 120 };
 121
 122 /** @} */
 123 /** @defgroup XBT_dict_curs Cursors on dictionaries
 124  *  @ingroup XBT_dict
 125  *
 126  *  Don't get impressed, there is a lot of functions here, but traversing a
 127  *  dictionary is immediate with the xbt_dict_foreach macro.
 128  *  You only need the other functions in rare cases (they are not used directly in SG itself).
 129  *
 130  *  Here is an example (assuming that the dictionary contains strings, ie
 131  *  that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
 132 \verbatim xbt_dict_cursor_t cursor=NULL;
 133  char *key,*data;
 134
 135  xbt_dict_foreach(dict,cursor,key,data) {
 136     printf("   - Seen:  %s->%s\n",key,data);
 137  }\endverbatim
 138
 139  *
 140  *  \warning Do not add or remove entries to the cache while traversing !!
 141  *
 142  *  @{ */
 143
 144   /** @brief Cursor on dictionaries (opaque type) */
 145 typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
 146
 147 static inline xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor) {
 148   return cursor->current;
 149 }
 150
 151 XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
 152 XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t * cursor);
 153
 154 XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
 155
 156 xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor);
 157 XBT_PUBLIC(char *) xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor);
 158 XBT_PUBLIC(void *) xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor);
 159 XBT_PUBLIC(void) xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor,
 160                                           void *data,
 161                                           void_f_pvoid_t free_ctn);
 162
 163 XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict,
 164                                        xbt_dict_cursor_t * cursor);
 165 XBT_PUBLIC(void) xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
 166 XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor,
 167                                             char **key, void **data);
 168 /** @def xbt_dict_foreach
 169  *  @param dict a \ref xbt_dict_t iterator
 170  *  @param cursor an \ref xbt_dict_cursor_t used as cursor
 171  *  @param key a char*
 172  *  @param data a void** output
 173  *  @hideinitializer
 174  *
 175  * \note An example of usage:
 176  * \code
 177 xbt_dict_cursor_t cursor = NULL;
 178 char *key;
 179 char *data;
 180
 181 xbt_dict_foreach(head, cursor, key, data) {
 182  printf("Key %s with data %s\n",key,data);
 183 }
 184 \endcode
 185  */
 186 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
 187     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \
 188          xbt_dict_cursor_get_or_free(&(cursor),(char**)&(key),(void**)(&data));\
 189          xbt_dict_cursor_step(cursor) )
 190
 191 /** @} */
 192
 193 #ifdef XBT_USE_DEPRECATED
 194 /** @defgroup XBT_dict_multi Multi-level dictionaries
 195  *  @ingroup XBT_dict
 196  *
 197  * They can be seen as dictionary of multiple keys or as dictionary of
 198  * dictionary of ... of data. Most of the functions here work the same way
 199  * than their simple dictionary counterpart.
 200  *
 201  * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
 202  * Use xbt_dict_free() and xbt_dict_new() instead.
 203  *
 204  * @{
 205  */
 206
 207 /*----[ xbt_multidict_set ]--------------------------------------------------*/
 208 XBT_PUBLIC(void)
 209 xbt_multidict_set(xbt_dict_t mdict,
 210                   xbt_dynar_t keys, void *data, void (*free_ctn) (void *));
 211 XBT_PUBLIC(void)
 212 xbt_multidict_set_ext(xbt_dict_t mdict,
 213                       xbt_dynar_t keys, xbt_dynar_t lens,
 214                       void *data, void_f_pvoid_t free_ctn);
 215
 216 /*----[ xbt_multidict_get ]--------------------------------------------------*/
 217 XBT_PUBLIC(void *) xbt_multidict_get(xbt_dict_t mdict, xbt_dynar_t keys);
 218 XBT_PUBLIC(void *) xbt_multidict_get_ext(xbt_dict_t mdict,
 219                                          xbt_dynar_t keys,
 220                                          xbt_dynar_t lens);
 221
 222 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
 223 /*---------------------------------------------------------------------------*/
 224 XBT_PUBLIC(void) xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
 225 XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict,
 226                                           xbt_dynar_t keys,
 227                                           xbt_dynar_t lens);
 228
 229 /** @} */
 230 #endif
 231
 232 SG_END_DECL()
 233 #endif                          /* _XBT_DICT_H */