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(char *) xbt_dict_get_elm_key(xbt_dictelm_t elem);
  80 XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm(xbt_dict_t dict, const char *key);
  81 XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm_or_null(xbt_dict_t dict, const char *key);
  82
  83 XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
  84 XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
  85 XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
  86 XBT_PUBLIC(void) xbt_dict_dump_output_string(void *s);
  87 XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output) (void *));
  88 XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict);
  89 XBT_PUBLIC(int) xbt_dict_is_empty(xbt_dict_t dict);
  90
  91
  92 /** @} */
  93 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
  94  *  @ingroup XBT_dict
  95  *
  96  * Those functions work even with non-null terminated keys.
  97  *
  98  *  @{
  99  */
 100 XBT_PUBLIC(void) xbt_dict_set_ext(xbt_dict_t dict,
 101                                   const char *key, int key_len,
 102                                   void *data, void_f_pvoid_t free_ctn);
 103 XBT_PUBLIC(void *) xbt_dict_get_ext(xbt_dict_t dict, const char *key,
 104                                     int key_len);
 105 XBT_PUBLIC(void *) xbt_dict_get_or_null_ext(xbt_dict_t dict,
 106                                             const char *key, int key_len);
 107 XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key,
 108                                      int key_len);
 109
 110 #ifdef XBT_USE_DEPRECATED
 111 XBT_PUBLIC(void) xbt_dicti_set(xbt_dict_t dict, uintptr_t key,
 112                                uintptr_t data);
 113 XBT_PUBLIC(uintptr_t) xbt_dicti_get(xbt_dict_t dict, uintptr_t key);
 114 XBT_PUBLIC(void) xbt_dicti_remove(xbt_dict_t dict, uintptr_t key);
 115 #endif
 116
 117 struct s_xbt_dict_cursor {
 118   xbt_dictelm_t current;
 119   int line;
 120   xbt_dict_t dict;
 121 };
 122
 123 /** @} */
 124 /** @defgroup XBT_dict_curs Cursors on dictionaries
 125  *  @ingroup XBT_dict
 126  *
 127  *  Don't get impressed, there is a lot of functions here, but traversing a
 128  *  dictionary is immediate with the xbt_dict_foreach macro.
 129  *  You only need the other functions in rare cases (they are not used directly in SG itself).
 130  *
 131  *  Here is an example (assuming that the dictionary contains strings, ie
 132  *  that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
 133 \verbatim xbt_dict_cursor_t cursor=NULL;
 134  char *key,*data;
 135
 136  xbt_dict_foreach(dict,cursor,key,data) {
 137     printf("   - Seen:  %s->%s\n",key,data);
 138  }\endverbatim
 139
 140  *
 141  *  \warning Do not add or remove entries to the cache while traversing !!
 142  *
 143  *  @{ */
 144
 145   /** @brief Cursor on dictionaries (opaque type) */
 146 typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
 147
 148 static inline xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor) {
 149   return cursor->current;
 150 }
 151
 152 XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
 153 XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t * cursor);
 154
 155 XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
 156
 157 xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor);
 158 XBT_PUBLIC(char *) xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor);
 159 XBT_PUBLIC(void *) xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor);
 160 XBT_PUBLIC(void) xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor,
 161                                           void *data,
 162                                           void_f_pvoid_t free_ctn);
 163
 164 XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict,
 165                                        xbt_dict_cursor_t * cursor);
 166 XBT_PUBLIC(void) xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
 167 XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor,
 168                                             char **key, void **data);
 169 /** @def xbt_dict_foreach
 170  *  @param dict a \ref xbt_dict_t iterator
 171  *  @param cursor an \ref xbt_dict_cursor_t used as cursor
 172  *  @param key a char*
 173  *  @param data a void** output
 174  *  @hideinitializer
 175  *
 176  * \note An example of usage:
 177  * \code
 178 xbt_dict_cursor_t cursor = NULL;
 179 char *key;
 180 char *data;
 181
 182 xbt_dict_foreach(head, cursor, key, data) {
 183  printf("Key %s with data %s\n",key,data);
 184 }
 185 \endcode
 186  */
 187 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
 188     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \
 189          xbt_dict_cursor_get_or_free(&(cursor),(char**)&(key),(void**)(&data));\
 190          xbt_dict_cursor_step(cursor) )
 191
 192 /** @} */
 193
 194 #ifdef XBT_USE_DEPRECATED
 195 /** @defgroup XBT_dict_multi Multi-level dictionaries
 196  *  @ingroup XBT_dict
 197  *
 198  * They can be seen as dictionary of multiple keys or as dictionary of
 199  * dictionary of ... of data. Most of the functions here work the same way
 200  * than their simple dictionary counterpart.
 201  *
 202  * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
 203  * Use xbt_dict_free() and xbt_dict_new() instead.
 204  *
 205  * @{
 206  */
 207
 208 /*----[ xbt_multidict_set ]--------------------------------------------------*/
 209 XBT_PUBLIC(void)
 210 xbt_multidict_set(xbt_dict_t mdict,
 211                   xbt_dynar_t keys, void *data, void (*free_ctn) (void *));
 212 XBT_PUBLIC(void)
 213 xbt_multidict_set_ext(xbt_dict_t mdict,
 214                       xbt_dynar_t keys, xbt_dynar_t lens,
 215                       void *data, void_f_pvoid_t free_ctn);
 216
 217 /*----[ xbt_multidict_get ]--------------------------------------------------*/
 218 XBT_PUBLIC(void *) xbt_multidict_get(xbt_dict_t mdict, xbt_dynar_t keys);
 219 XBT_PUBLIC(void *) xbt_multidict_get_ext(xbt_dict_t mdict,
 220                                          xbt_dynar_t keys,
 221                                          xbt_dynar_t lens);
 222
 223 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
 224 /*---------------------------------------------------------------------------*/
 225 XBT_PUBLIC(void) xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
 226 XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict,
 227                                           xbt_dynar_t keys,
 228                                           xbt_dynar_t lens);
 229
 230 /** @} */
 231 #endif
 232
 233 SG_END_DECL()
 234 #endif                          /* _XBT_DICT_H */