+#include "xbt/misc.h" /* SG_BEGIN_DECL */
+#include "xbt/dynar.h" /* void_f_pvoid_t */
+#include <stdint.h> /* uintptr_t */
+
+SG_BEGIN_DECL()
+
+/** @addtogroup XBT_dict
+ * @brief The dictionary data structure (comparable to hash tables)
+ *
+ * This section describes the API to a dictionary structure that
+ * associates as string to a void* key. It provides the same
+ * functionality than an hash table.
+ *
+ * Here is a little example of use:
+
+\verbatim
+ xbt_dict_t mydict = xbt_dict_new();
+ char buff[512];
+
+ sprintf(buff,"some very precious data");
+ xbt_dict_set(mydict,"my data", strdup(buff), free);
+
+ sprintf(buff,"another good stuff");
+ xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add
+\endverbatim
+ *
+ */
+
+/** @defgroup XBT_dict_cons Dict constructor and destructor
+ * @ingroup XBT_dict
+ *
+ * @{
+ */
+
+ /** \brief Dictionary data type (opaque structure) */
+typedef struct s_xbt_dict *xbt_dict_t;
+XBT_PUBLIC(xbt_dict_t) xbt_dict_new(void);
+XBT_PUBLIC(xbt_dict_t) xbt_dict_new_homogeneous(void_f_pvoid_t free_ctn);
+XBT_PUBLIC(void) xbt_dict_free(xbt_dict_t * dict);
+XBT_PUBLIC(unsigned int) xbt_dict_size(xbt_dict_t dict);
+
+/** @} */
+/** @defgroup XBT_dict_basic Dictionaries basic usage
+ * @ingroup XBT_dict
+ *
+ * Careful, those functions assume that the key is null-terminated.
+ *
+ * @{
+ */
+
+XBT_PUBLIC(void) xbt_dict_set(xbt_dict_t dict, const char *key, void *data,
+ void_f_pvoid_t free_ctn);
+XBT_PUBLIC(void *) xbt_dict_get(xbt_dict_t dict, const char *key);
+XBT_PUBLIC(void *) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
+XBT_PUBLIC(char *) xbt_dict_get_key(xbt_dict_t dict, const void *data);
+
+XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
+XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
+XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
+XBT_PUBLIC(void) xbt_dict_dump_output_string(void *s);
+XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output) (void *));
+XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict);
+XBT_PUBLIC(int) xbt_dict_is_empty(xbt_dict_t dict);
+
+
+/** @} */
+/** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
+ * @ingroup XBT_dict
+ *
+ * Those functions work even with non-null terminated keys.
+ *
+ * @{
+ */
+XBT_PUBLIC(void) xbt_dict_set_ext(xbt_dict_t dict,
+ const char *key, int key_len,
+ void *data, void_f_pvoid_t free_ctn);
+XBT_PUBLIC(void *) xbt_dict_get_ext(xbt_dict_t dict, const char *key,
+ int key_len);
+XBT_PUBLIC(void *) xbt_dict_get_or_null_ext(xbt_dict_t dict,
+ const char *key, int key_len);
+XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key,
+ int key_len);
+
+#ifdef XBT_USE_DEPRECATED
+XBT_PUBLIC(void) xbt_dicti_set(xbt_dict_t dict, uintptr_t key,
+ uintptr_t data);
+XBT_PUBLIC(uintptr_t) xbt_dicti_get(xbt_dict_t dict, uintptr_t key);
+XBT_PUBLIC(void) xbt_dicti_remove(xbt_dict_t dict, uintptr_t key);
+#endif
+
+/** @} */
+/** @defgroup XBT_dict_curs Cursors on dictionaries
+ * @ingroup XBT_dict
+ *
+ * Don't get impressed, there is a lot of functions here, but traversing a
+ * dictionary is immediate with the xbt_dict_foreach macro.
+ * You only need the other functions in rare cases (they are not used directly in SG itself).
+ *
+ * Here is an example (assuming that the dictionary contains strings, ie
+ * that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
+\verbatim xbt_dict_cursor_t cursor=NULL;
+ char *key,*data;
+
+ xbt_dict_foreach(dict,cursor,key,data) {
+ printf(" - Seen: %s->%s\n",key,data);
+ }\endverbatim
+
+ *
+ * \warning Do not add or remove entries to the cache while traversing !!
+ *
+ * @{ */
+
+ /** @brief Cursor on dictionaries (opaque type) */
+typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
+XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
+XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t * cursor);
+
+XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
+
+
+XBT_PUBLIC(char *) xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor);
+XBT_PUBLIC(void *) xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor);
+XBT_PUBLIC(void) xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor,
+ void *data,
+ void_f_pvoid_t free_ctn);
+
+XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict,
+ xbt_dict_cursor_t * cursor);
+XBT_PUBLIC(void) xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
+XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor,
+ char **key, void **data);
+/** @def xbt_dict_foreach
+ * @param dict a \ref xbt_dict_t iterator
+ * @param cursor an \ref xbt_dict_cursor_t used as cursor
+ * @param key a char*
+ * @param data a void** output
+ * @hideinitializer
+ *
+ * \note An example of usage:
+ * \code
+xbt_dict_cursor_t cursor = NULL;
+char *key;
+char *data;
+
+xbt_dict_foreach(head, cursor, key, data) {
+ printf("Key %s with data %s\n",key,data);
+}
+\endcode
+ */
+# define xbt_dict_foreach(dict,cursor,key,data) \
+ for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ; \
+ xbt_dict_cursor_get_or_free(&(cursor),(char**)&(key),(void**)(&data));\
+ xbt_dict_cursor_step(cursor) )
+
+/** @} */
+
+#ifdef XBT_USE_DEPRECATED
+/** @defgroup XBT_dict_multi Multi-level dictionaries
+ * @ingroup XBT_dict
+ *
+ * They can be seen as dictionary of multiple keys or as dictionary of
+ * dictionary of ... of data. Most of the functions here work the same way
+ * than their simple dictionary counterpart.
+ *
+ * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
+ * Use xbt_dict_free() and xbt_dict_new() instead.
+ *
+ * @{
+ */
+
+/*----[ xbt_multidict_set ]--------------------------------------------------*/
+XBT_PUBLIC(void)
+xbt_multidict_set(xbt_dict_t mdict,
+ xbt_dynar_t keys, void *data, void (*free_ctn) (void *));
+XBT_PUBLIC(void)
+xbt_multidict_set_ext(xbt_dict_t mdict,
+ xbt_dynar_t keys, xbt_dynar_t lens,
+ void *data, void_f_pvoid_t free_ctn);
+
+/*----[ xbt_multidict_get ]--------------------------------------------------*/
+XBT_PUBLIC(void *) xbt_multidict_get(xbt_dict_t mdict, xbt_dynar_t keys);
+XBT_PUBLIC(void *) xbt_multidict_get_ext(xbt_dict_t mdict,
+ xbt_dynar_t keys,
+ xbt_dynar_t lens);
+
+/*----[ xbt_multidict_remove ]-----------------------------------------------*/