1 /* xbt/dict.h -- api to a generic dictionary */
3 /* Copyright (c) 2004-2013. 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. */
13 #include "xbt/misc.h" /* SG_BEGIN_DECL */
14 #include "xbt/dynar.h" /* void_f_pvoid_t */
15 #include <stdint.h> /* uintptr_t */
19 /** @addtogroup XBT_dict
20 * @brief The dictionary data structure (comparable to hash tables)
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.
26 * Here is a little example of use:
29 xbt_dict_t mydict = xbt_dict_new();
32 sprintf(buff,"some very precious data");
33 xbt_dict_set(mydict,"my data", strdup(buff), free);
35 sprintf(buff,"another good stuff");
36 xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add
41 /** @defgroup XBT_dict_cons Dict constructor and destructor
47 /** \brief Dictionary data type (opaque structure) */
49 typedef struct s_xbt_dict *xbt_dict_t;
50 typedef struct s_xbt_dictelm *xbt_dictelm_t;
51 typedef struct s_xbt_dictelm {
54 unsigned int hash_code;
61 XBT_PUBLIC(xbt_dict_t) xbt_dict_new(void);
62 XBT_PUBLIC(xbt_dict_t) xbt_dict_new_homogeneous(void_f_pvoid_t free_ctn);
63 XBT_PUBLIC(void) xbt_dict_free(xbt_dict_t * dict);
64 XBT_PUBLIC(unsigned int) xbt_dict_size(xbt_dict_t dict);
67 /** @defgroup XBT_dict_basic Dictionaries basic usage
70 * Careful, those functions assume that the key is null-terminated.
75 XBT_PUBLIC(void) xbt_dict_set(xbt_dict_t dict, const char *key, void *data,
76 void_f_pvoid_t free_ctn);
77 XBT_PUBLIC(void *) xbt_dict_get(xbt_dict_t dict, const char *key);
78 XBT_PUBLIC(void *) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
79 XBT_PUBLIC(char *) xbt_dict_get_key(xbt_dict_t dict, const void *data);
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);
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);
93 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
96 * Those functions work even with non-null terminated keys.
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,
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,
110 #ifdef XBT_USE_DEPRECATED
111 XBT_PUBLIC(void) xbt_dicti_set(xbt_dict_t dict, uintptr_t key,
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);
118 /** @defgroup XBT_dict_curs Cursors on dictionaries
121 * Don't get impressed, there is a lot of functions here, but traversing a
122 * dictionary is immediate with the xbt_dict_foreach macro.
123 * You only need the other functions in rare cases (they are not used directly in SG itself).
125 * Here is an example (assuming that the dictionary contains strings, ie
126 * that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
127 \verbatim xbt_dict_cursor_t cursor=NULL;
130 xbt_dict_foreach(dict,cursor,key,data) {
131 printf(" - Seen: %s->%s\n",key,data);
135 * \warning Do not add or remove entries to the cache while traversing !!
139 /** @brief Cursor on dictionaries (opaque type) */
140 struct s_xbt_dict_cursor {
141 xbt_dictelm_t current;
145 typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
147 static inline xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor) {
148 return cursor->current;
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);
154 XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
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,
161 void_f_pvoid_t free_ctn);
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
172 * @param data a void** output
175 * \note An example of usage:
177 xbt_dict_cursor_t cursor = NULL;
181 xbt_dict_foreach(head, cursor, key, data) {
182 printf("Key %s with data %s\n",key,data);
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) )
193 #ifdef XBT_USE_DEPRECATED
194 /** @defgroup XBT_dict_multi Multi-level dictionaries
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.
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.
207 /*----[ xbt_multidict_set ]--------------------------------------------------*/
209 xbt_multidict_set(xbt_dict_t mdict,
210 xbt_dynar_t keys, void *data, void (*free_ctn) (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);
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,
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,
233 #endif /* _XBT_DICT_H */