1 /* xbt/dict.h -- api to a generic dictionary */
3 /* Copyright (c) 2004-2011. 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) */
48 typedef struct s_xbt_dict *xbt_dict_t;
49 XBT_PUBLIC(xbt_dict_t) xbt_dict_new(void);
50 XBT_PUBLIC(xbt_dict_t) xbt_dict_new_homogeneous(void_f_pvoid_t free_ctn);
51 XBT_PUBLIC(void) xbt_dict_free(xbt_dict_t * dict);
52 XBT_PUBLIC(unsigned int) xbt_dict_size(xbt_dict_t dict);
55 /** @defgroup XBT_dict_basic Dictionaries basic usage
58 * Careful, those functions assume that the key is null-terminated.
63 XBT_PUBLIC(void) xbt_dict_set(xbt_dict_t dict, const char *key, void *data,
64 void_f_pvoid_t free_ctn);
65 XBT_PUBLIC(void *) xbt_dict_get(xbt_dict_t dict, const char *key);
66 XBT_PUBLIC(void *) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
67 XBT_PUBLIC(char *) xbt_dict_get_key(xbt_dict_t dict, const void *data);
69 XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
70 XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
71 XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
72 XBT_PUBLIC(void) xbt_dict_dump_output_string(void *s);
73 XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output) (void *));
74 XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict);
75 XBT_PUBLIC(int) xbt_dict_is_empty(xbt_dict_t dict);
79 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
82 * Those functions work even with non-null terminated keys.
86 XBT_PUBLIC(void) xbt_dict_set_ext(xbt_dict_t dict,
87 const char *key, int key_len,
88 void *data, void_f_pvoid_t free_ctn);
89 XBT_PUBLIC(void *) xbt_dict_get_ext(xbt_dict_t dict, const char *key,
91 XBT_PUBLIC(void *) xbt_dict_get_or_null_ext(xbt_dict_t dict,
92 const char *key, int key_len);
93 XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key,
96 #ifdef XBT_USE_DEPRECATED
97 XBT_PUBLIC(void) xbt_dicti_set(xbt_dict_t dict, uintptr_t key,
99 XBT_PUBLIC(uintptr_t) xbt_dicti_get(xbt_dict_t dict, uintptr_t key);
100 XBT_PUBLIC(void) xbt_dicti_remove(xbt_dict_t dict, uintptr_t key);
104 /** @defgroup XBT_dict_curs Cursors on dictionaries
107 * Don't get impressed, there is a lot of functions here, but traversing a
108 * dictionary is immediate with the xbt_dict_foreach macro.
109 * You only need the other functions in rare cases (they are not used directly in SG itself).
111 * Here is an example (assuming that the dictionary contains strings, ie
112 * that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
113 \verbatim xbt_dict_cursor_t cursor=NULL;
116 xbt_dict_foreach(dict,cursor,key,data) {
117 printf(" - Seen: %s->%s\n",key,data);
121 * \warning Do not add or remove entries to the cache while traversing !!
125 /** @brief Cursor on dictionaries (opaque type) */
126 typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
127 XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
128 XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t * cursor);
130 XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
133 XBT_PUBLIC(char *) xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor);
134 XBT_PUBLIC(void *) xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor);
135 XBT_PUBLIC(void) xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor,
137 void_f_pvoid_t free_ctn);
139 XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict,
140 xbt_dict_cursor_t * cursor);
141 XBT_PUBLIC(void) xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
142 XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor,
143 char **key, void **data);
144 /** @def xbt_dict_foreach
145 * @param dict a \ref xbt_dict_t iterator
146 * @param cursor an \ref xbt_dict_cursor_t used as cursor
148 * @param data a void** output
151 * \note An example of usage:
153 xbt_dict_cursor_t cursor = NULL;
157 xbt_dict_foreach(head, cursor, key, data) {
158 printf("Key %s with data %s\n",key,data);
162 # define xbt_dict_foreach(dict,cursor,key,data) \
163 for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ; \
164 xbt_dict_cursor_get_or_free(&(cursor),(char**)&(key),(void**)(&data));\
165 xbt_dict_cursor_step(cursor) )
169 #ifdef XBT_USE_DEPRECATED
170 /** @defgroup XBT_dict_multi Multi-level dictionaries
173 * They can be seen as dictionary of multiple keys or as dictionary of
174 * dictionary of ... of data. Most of the functions here work the same way
175 * than their simple dictionary counterpart.
177 * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
178 * Use xbt_dict_free() and xbt_dict_new() instead.
183 /*----[ xbt_multidict_set ]--------------------------------------------------*/
185 xbt_multidict_set(xbt_dict_t mdict,
186 xbt_dynar_t keys, void *data, void (*free_ctn) (void *));
188 xbt_multidict_set_ext(xbt_dict_t mdict,
189 xbt_dynar_t keys, xbt_dynar_t lens,
190 void *data, void_f_pvoid_t free_ctn);
192 /*----[ xbt_multidict_get ]--------------------------------------------------*/
193 XBT_PUBLIC(void *) xbt_multidict_get(xbt_dict_t mdict, xbt_dynar_t keys);
194 XBT_PUBLIC(void *) xbt_multidict_get_ext(xbt_dict_t mdict,
198 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
199 /*---------------------------------------------------------------------------*/
200 XBT_PUBLIC(void) xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
201 XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict,
209 #endif /* _XBT_DICT_H */