/** @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.
+ * 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:
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
*/
/** \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 {
* @{
*/
-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_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_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);
+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;
/** @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.
+ * 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*):
+ * 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 dictionaries (opaque type) */
+/** @brief Cursor on dictionaries (opaque type) */
typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
static inline xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t 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);
+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_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);
+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
/** @} */
SG_END_DECL()
+
#endif /* _XBT_DICT_H */