1 /* xbt/dict.h -- api to a generic dictionary */
3 /* Copyright (c) 2004-2014. The SimGrid Team.
4 * All rights reserved. */
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. */
12 #include "xbt/misc.h" /* SG_BEGIN_DECL */
13 #include "xbt/dynar.h" /* void_f_pvoid_t */
14 #include <stdint.h> /* uintptr_t */
18 /** @addtogroup XBT_dict
19 * @brief The dictionary data structure (comparable to hash tables)
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.
25 * Here is a little example of use:
28 xbt_dict_t mydict = xbt_dict_new();
31 sprintf(buff,"some very precious data");
32 xbt_dict_set(mydict,"my data", strdup(buff), free);
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
40 /** @defgroup XBT_dict_cons Dict constructor and destructor
46 /** \brief Dictionary data type (opaque structure) */
48 typedef struct s_xbt_dict *xbt_dict_t;
49 typedef struct s_xbt_dictelm *xbt_dictelm_t;
50 typedef struct s_xbt_dictelm {
53 unsigned int hash_code;
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);
66 /** @defgroup XBT_dict_basic Dictionaries basic usage
69 * Careful, those functions assume that the key is null-terminated.
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);
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);
92 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
95 * Those functions work even with non-null terminated keys.
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,
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,
109 #ifdef XBT_USE_DEPRECATED
110 XBT_PUBLIC(void) xbt_dicti_set(xbt_dict_t dict, uintptr_t key,
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);
117 /** @defgroup XBT_dict_curs Cursors on dictionaries
120 * Don't get impressed, there is a lot of functions here, but traversing a
121 * dictionary is immediate with the xbt_dict_foreach macro.
122 * You only need the other functions in rare cases (they are not used directly in SG itself).
124 * Here is an example (assuming that the dictionary contains strings, ie
125 * that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
126 \verbatim xbt_dict_cursor_t cursor=NULL;
129 xbt_dict_foreach(dict,cursor,key,data) {
130 printf(" - Seen: %s->%s\n",key,data);
134 * \warning Do not add or remove entries to the cache while traversing !!
138 /** @brief Cursor on dictionaries (opaque type) */
139 struct s_xbt_dict_cursor {
140 xbt_dictelm_t current;
144 typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
146 static inline xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor) {
147 return cursor->current;
150 XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
151 XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t * cursor);
153 XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
155 xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor);
156 XBT_PUBLIC(char *) xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor);
157 XBT_PUBLIC(void *) xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor);
158 XBT_PUBLIC(void) xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor,
160 void_f_pvoid_t free_ctn);
162 XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict,
163 xbt_dict_cursor_t * cursor);
164 XBT_PUBLIC(void) xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
165 XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor,
166 char **key, void **data);
167 /** @def xbt_dict_foreach
168 * @param dict a \ref xbt_dict_t iterator
169 * @param cursor an \ref xbt_dict_cursor_t used as cursor
171 * @param data a void** output
174 * \note An example of usage:
176 xbt_dict_cursor_t cursor = NULL;
180 xbt_dict_foreach(head, cursor, key, data) {
181 printf("Key %s with data %s\n",key,data);
185 # define xbt_dict_foreach(dict,cursor,key,data) \
186 for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ; \
187 xbt_dict_cursor_get_or_free(&(cursor),(char**)&(key),(void**)(&data));\
188 xbt_dict_cursor_step(cursor) )
192 #ifdef XBT_USE_DEPRECATED
193 /** @defgroup XBT_dict_multi Multi-level dictionaries
196 * They can be seen as dictionary of multiple keys or as dictionary of
197 * dictionary of ... of data. Most of the functions here work the same way
198 * than their simple dictionary counterpart.
200 * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
201 * Use xbt_dict_free() and xbt_dict_new() instead.
206 /*----[ xbt_multidict_set ]--------------------------------------------------*/
208 xbt_multidict_set(xbt_dict_t mdict,
209 xbt_dynar_t keys, void *data, void (*free_ctn) (void *));
211 xbt_multidict_set_ext(xbt_dict_t mdict,
212 xbt_dynar_t keys, xbt_dynar_t lens,
213 void *data, void_f_pvoid_t free_ctn);
215 /*----[ xbt_multidict_get ]--------------------------------------------------*/
216 XBT_PUBLIC(void *) xbt_multidict_get(xbt_dict_t mdict, xbt_dynar_t keys);
217 XBT_PUBLIC(void *) xbt_multidict_get_ext(xbt_dict_t mdict,
221 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
222 /*---------------------------------------------------------------------------*/
223 XBT_PUBLIC(void) xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
224 XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict,
232 #endif /* _XBT_DICT_H */