include/xbt/dict.h

   1 /* xbt/dict.h -- api to a generic dictionary                                */
   2
   3 /* Copyright (c) 2004-2011. 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
  10 #ifndef _XBT_DICT_H
  11 #define _XBT_DICT_H
  12
  13 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
  14 #include "xbt/dynar.h"          /* void_f_pvoid_t */
  15 #include <stdint.h>             /* uintptr_t */
  16
  17 SG_BEGIN_DECL()
  18
  19 /** @addtogroup XBT_dict
  20  *  @brief The dictionary data structure (comparable to hash tables)
  21  *
  22  *  This section describes the API to a dictionary structure that
  23  *  associates as string to a void* key. It provides the same
  24  *  functionality 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
  35 \endverbatim
  36  *
  37  */
  38
  39 /** @defgroup XBT_dict_cons Dict constructor and destructor
  40  *  @ingroup XBT_dict
  41  *
  42  *  @{
  43  */
  44
  45   /** \brief Dictionary data type (opaque structure) */
  46 typedef struct s_xbt_dict *xbt_dict_t;
  47 XBT_PUBLIC(xbt_dict_t) xbt_dict_new(void);
  48 XBT_PUBLIC(xbt_dict_t) xbt_dict_new_homogeneous(void_f_pvoid_t free_ctn);
  49 XBT_PUBLIC(void) xbt_dict_free(xbt_dict_t * dict);
  50 XBT_PUBLIC(unsigned int) xbt_dict_size(xbt_dict_t dict);
  51
  52 /** @} */
  53 /** @defgroup XBT_dict_basic Dictionaries 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,
  62                               void_f_pvoid_t free_ctn);
  63 XBT_PUBLIC(void *) xbt_dict_get(xbt_dict_t dict, const char *key);
  64 XBT_PUBLIC(void *) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
  65 XBT_PUBLIC(char *) xbt_dict_get_key(xbt_dict_t dict, const void *data);
  66
  67 XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
  68 XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
  69 XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
  70 XBT_PUBLIC(void) xbt_dict_dump_output_string(void *s);
  71 XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output) (void *));
  72 XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict);
  73 XBT_PUBLIC(int) xbt_dict_is_empty(xbt_dict_t dict);
  74
  75
  76 /** @} */
  77 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
  78  *  @ingroup XBT_dict
  79  *
  80  * Those functions work even with non-null terminated keys.
  81  *
  82  *  @{
  83  */
  84 XBT_PUBLIC(void) xbt_dict_set_ext(xbt_dict_t dict,
  85                                   const char *key, int key_len,
  86                                   void *data, void_f_pvoid_t free_ctn);
  87 XBT_PUBLIC(void *) xbt_dict_get_ext(xbt_dict_t dict, const char *key,
  88                                     int key_len);
  89 XBT_PUBLIC(void *) xbt_dict_get_or_null_ext(xbt_dict_t dict,
  90                                             const char *key, int key_len);
  91 XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key,
  92                                      int key_len);
  93
  94 #ifdef XBT_USE_DEPRECATED
  95 XBT_PUBLIC(void) xbt_dicti_set(xbt_dict_t dict, uintptr_t key,
  96                                uintptr_t data);
  97 XBT_PUBLIC(uintptr_t) xbt_dicti_get(xbt_dict_t dict, uintptr_t key);
  98 XBT_PUBLIC(void) xbt_dicti_remove(xbt_dict_t dict, uintptr_t key);
  99 #endif
 100
 101 /** @} */
 102 /** @defgroup XBT_dict_curs Cursors on dictionaries
 103  *  @ingroup XBT_dict
 104  *
 105  *  Don't get impressed, there is a lot of functions here, but traversing a
 106  *  dictionary is immediate with the xbt_dict_foreach macro.
 107  *  You only need the other functions in rare cases (they are not used directly in SG itself).
 108  *
 109  *  Here is an example (assuming that the dictionary contains strings, ie
 110  *  that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
 111 \verbatim xbt_dict_cursor_t cursor=NULL;
 112  char *key,*data;
 113
 114  xbt_dict_foreach(dict,cursor,key,data) {
 115     printf("   - Seen:  %s->%s\n",key,data);
 116  }\endverbatim
 117
 118  *
 119  *  \warning Do not add or remove entries to the cache while traversing !!
 120  *
 121  *  @{ */
 122
 123   /** @brief Cursor on dictionaries (opaque type) */
 124 typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
 125 XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
 126 XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t * cursor);
 127
 128 XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
 129
 130
 131 XBT_PUBLIC(char *) xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor);
 132 XBT_PUBLIC(void *) xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor);
 133 XBT_PUBLIC(void) xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor,
 134                                           void *data,
 135                                           void_f_pvoid_t free_ctn);
 136
 137 XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict,
 138                                        xbt_dict_cursor_t * cursor);
 139 XBT_PUBLIC(void) xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
 140 XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor,
 141                                             char **key, void **data);
 142 /** @def xbt_dict_foreach
 143  *  @param dict a \ref xbt_dict_t iterator
 144  *  @param cursor an \ref xbt_dict_cursor_t used as cursor
 145  *  @param key a char*
 146  *  @param data a void** output
 147  *  @hideinitializer
 148  *
 149  * \note An example of usage:
 150  * \code
 151 xbt_dict_cursor_t cursor = NULL;
 152 char *key;
 153 char *data;
 154
 155 xbt_dict_foreach(head, cursor, key, data) {
 156  printf("Key %s with data %s\n",key,data);
 157 }
 158 \endcode
 159  */
 160 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
 161     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \
 162          xbt_dict_cursor_get_or_free(&(cursor),(char**)&(key),(void**)(&data));\
 163          xbt_dict_cursor_step(cursor) )
 164
 165 /** @} */
 166
 167 #ifdef XBT_USE_DEPRECATED
 168 /** @defgroup XBT_dict_multi Multi-level dictionaries
 169  *  @ingroup XBT_dict
 170  *
 171  * They can be seen as dictionary of multiple keys or as dictionary of
 172  * dictionary of ... of data. Most of the functions here work the same way
 173  * than their simple dictionary counterpart.
 174  *
 175  * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
 176  * Use xbt_dict_free() and xbt_dict_new() instead.
 177  *
 178  * @{
 179  */
 180
 181 /*----[ xbt_multidict_set ]--------------------------------------------------*/
 182 XBT_PUBLIC(void)
 183 xbt_multidict_set(xbt_dict_t mdict,
 184                   xbt_dynar_t keys, void *data, void (*free_ctn) (void *));
 185 XBT_PUBLIC(void)
 186 xbt_multidict_set_ext(xbt_dict_t mdict,
 187                       xbt_dynar_t keys, xbt_dynar_t lens,
 188                       void *data, void_f_pvoid_t free_ctn);
 189
 190 /*----[ xbt_multidict_get ]--------------------------------------------------*/
 191 XBT_PUBLIC(void *) xbt_multidict_get(xbt_dict_t mdict, xbt_dynar_t keys);
 192 XBT_PUBLIC(void *) xbt_multidict_get_ext(xbt_dict_t mdict,
 193                                          xbt_dynar_t keys,
 194                                          xbt_dynar_t lens);
 195
 196 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
 197 /*---------------------------------------------------------------------------*/
 198 XBT_PUBLIC(void) xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
 199 XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict,
 200                                           xbt_dynar_t keys,
 201                                           xbt_dynar_t lens);
 202
 203 /** @} */
 204 #endif
 205
 206 SG_END_DECL()
 207 #endif                          /* _XBT_DICT_H */