-/* $Id$ */
-
/* xbt/dict.h -- api to a generic dictionary */
-/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */
+/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
+#ifndef XBT_DICT_H
+#define XBT_DICT_H
-#ifndef _XBT_DICT_H
-#define _XBT_DICT_H
-
-#include "xbt/misc.h" /* SG_BEGIN_DECL */
-#include "xbt/dynar.h" /* void_f_pvoid_t */
+#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 dictionnary data structure (comparable to hash tables)
- *
- * This section describes the API to a dictionnary structure that
- * associates as string to a void* key. It provides the same
- * functionnality than an hash table.
- *
+ * @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.
+ *
+ * @deprecated If you are using C++, you might want to use `std::unordered_map` instead.
+ *
* Here is a little example of use:
- * \verbatim xbt_dict_t mydict = xbt_dict_new();
+
+\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);
+ 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
-
- *
+ 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
* @{
*/
- /** \brief Dictionnary data type (opaque structure) */
- typedef struct xbt_dict_ *xbt_dict_t;
- xbt_dict_t xbt_dict_new(void);
- xbt_dict_t xbt_dict_new_ext(int hashsize);
- void xbt_dict_free(xbt_dict_t *dict);
- void xbt_dict_hashsize_set(xbt_dict_t dict, int hashsize);
+ /** \brief Dictionary data type (opaque structure) */
+typedef struct s_xbt_dict *xbt_dict_t;
+typedef struct s_xbt_dictelm *xbt_dictelm_t;
+typedef struct s_xbt_dictelm {
+ char *key;
+ int key_len;
+ unsigned int hash_code;
+
+ void *content;
+
+ xbt_dictelm_t next;
+} s_xbt_dictelm_t;
+
+XBT_PUBLIC(xbt_dict_t)
+XBT_ATTRIB_DEPRECATED_v319("Use xbt_dict_new_homogeneous(). v3.19 will turn this warning into an error") xbt_dict_new();
+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 Dictionnaries basic usage
+/** @defgroup XBT_dict_basic Dictionaries basic usage
* @ingroup XBT_dict
*
* Careful, those functions assume that the key is null-terminated.
* @{
*/
- void xbt_dict_set(xbt_dict_t dict, const char *key, void *data, void_f_pvoid_t *free_ctn);
- void *xbt_dict_get(xbt_dict_t dict,const char *key);
- void *xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
+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(char *) xbt_dict_get_elm_key(xbt_dictelm_t elem);
+XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm(xbt_dict_t dict, const char *key);
+XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm_or_null(xbt_dict_t dict, const char *key);
+
+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);
+
- void xbt_dict_remove(xbt_dict_t dict, const char *key);
- void xbt_dict_reset(xbt_dict_t dict);
- int xbt_dict_length(xbt_dict_t dict);
- void xbt_dict_dump(xbt_dict_t dict, void (*output)(void*));
-
/** @} */
-/** @defgroup XBT_dict_nnul Dictionnaries with non-nul terminated keys
+/** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
* @ingroup XBT_dict
*
* Those functions work even with non-null terminated keys.
*
* @{
*/
- void xbt_dict_set_ext(xbt_dict_t dict,
- const char *key, int key_len,
- void *data,
- void_f_pvoid_t *free_ctn);
- void *xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len);
- void xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len);
+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);
+struct s_xbt_dict_cursor {
+ xbt_dictelm_t current;
+ int line;
+ xbt_dict_t dict;
+};
/** @} */
-/** @defgroup XBT_dict_curs Cursors on dictionnaries
+/** @defgroup XBT_dict_curs Cursors on dictionaries
* @ingroup XBT_dict
*
- * Don't get impressed, there is a lot of functions here, but traversing a
- * dictionnary is imediate with the xbt_dict_foreach macro.
+ * 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 dictionnary contains strings, ie
- * that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
+ * Here is an example (assuming that the dictionary contains strings, i.e., 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;
*
* @{ */
- /** @brief Cursor on dictionnaries (opaque type) */
- typedef struct xbt_dict_cursor_ *xbt_dict_cursor_t;
- xbt_dict_cursor_t xbt_dict_cursor_new(const xbt_dict_t dict);
- void xbt_dict_cursor_free(xbt_dict_cursor_t *cursor);
+/** @brief Cursor on dictionaries (opaque type) */
+typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
- void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
+static inline xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor) {
+ return cursor->current;
+}
+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);
- char * xbt_dict_cursor_get_key (xbt_dict_cursor_t cursor);
- void * xbt_dict_cursor_get_data (xbt_dict_cursor_t cursor);
+XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
- void xbt_dict_cursor_first (const xbt_dict_t dict,
- xbt_dict_cursor_t *cursor);
- void xbt_dict_cursor_step (xbt_dict_cursor_t cursor);
- int xbt_dict_cursor_get_or_free (xbt_dict_cursor_t *cursor,
- char **key,
- void **data);
- /** @def xbt_dict_foreach
- @hideinitializer */
-# define xbt_dict_foreach(dict,cursor,key,data) \
- for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ; \
- xbt_dict_cursor_get_or_free(&(cursor),&(key),(void**)(&data));\
- xbt_dict_cursor_step(cursor) )
+xbt_dictelm_t xbt_dict_cursor_get_elm(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);
-/** @} */
-/** @defgroup XBT_dict_multi Multi-level dictionnaries
- * @ingroup XBT_dict
+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
*
- * They can be seen as dictionnary of multiple keys or as dictionnary of
- * dictionnary of ... of data. Most of the functions here work the same way
- * than their simple dictionnary counterpart.
- *
- * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
- * Use xbt_dict_free() and xbt_dict_new() instead.
- *
- * @{
+ * \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
*/
-
-/** \brief To dump multicache, this function dumps a cache */
-void xbt_dict_print(void *data);
-/** \brief To dump multicache, this one dumps a string */
-void xbt_dict_prints(void *data);
-
-
-/*----[ xbt_multidict_set ]--------------------------------------------------*/
-void
-xbt_multidict_set(xbt_dict_t mdict,
- xbt_dynar_t keys,
- void *data,void (*free_ctn)(void*));
-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 ]--------------------------------------------------*/
-void *xbt_multidict_get (xbt_dict_t mdict, xbt_dynar_t keys);
-void *xbt_multidict_get_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
-
-/*----[ xbt_multidict_remove ]-----------------------------------------------*/
-/*---------------------------------------------------------------------------*/
-void xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
-void xbt_multidict_remove_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
+# 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) )
/** @} */
SG_END_DECL()
-#endif /* _XBT_DICT_H */
+#endif /* XBT_DICT_H */
