1 /* xbt/dict.h -- api to a generic dictionary */
3 /* Copyright (c) 2004-2023. The SimGrid Team. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include <xbt/dynar.h> /* void_f_pvoid_t */
12 #include <xbt/misc.h> /* SG_BEGIN_DECL */
14 #include <stdint.h> /* uintptr_t */
18 /** @addtogroup XBT_dict
19 * @brief The dictionary data structure (comparable to hash tables)
21 * This section describes the API to a dictionary structure that associates as string to a void* key. It provides the
22 * same functionality than an hash table.
24 * @deprecated If you are using C++, you might want to use `std::unordered_map` instead.
26 * Here is a little example of use:
29 xbt_dict_t mydict = xbt_dict_new_homogeneous(free);
32 sprintf(buff,"some very precious data");
33 xbt_dict_set(mydict,"my data", strdup(buff));
35 sprintf(buff,"another good stuff");
36 xbt_dict_set(mydict,"my data", strdup(buff)); // previous data gets erased (and freed) by second add
40 /** @defgroup XBT_dict_cons Dict constructor and destructor
46 /** @brief Dictionary data type (opaque structure) */
47 typedef struct s_xbt_dict *xbt_dict_t;
48 typedef const struct s_xbt_dict* const_xbt_dict_t;
49 typedef struct s_xbt_dictelm *xbt_dictelm_t;
50 typedef struct s_xbt_dictelm {
53 unsigned int hash_code;
60 XBT_PUBLIC xbt_dict_t xbt_dict_new_homogeneous(void_f_pvoid_t free_ctn);
61 XBT_PUBLIC void xbt_dict_free(xbt_dict_t* dict);
62 XBT_PUBLIC unsigned int xbt_dict_size(const_xbt_dict_t dict);
65 /** @defgroup XBT_dict_basic Dictionaries basic usage
68 * Careful, those functions assume that the key is null-terminated.
73 XBT_PUBLIC void xbt_dict_set(xbt_dict_t dict, const char* key, void* data);
74 XBT_PUBLIC void* xbt_dict_get_or_null(const_xbt_dict_t dict, const char* key);
75 XBT_PUBLIC xbt_dictelm_t xbt_dict_get_elm_or_null(const_xbt_dict_t dict, const char* key);
77 XBT_PUBLIC int xbt_dict_length(const_xbt_dict_t dict);
78 XBT_PUBLIC int xbt_dict_is_empty(const_xbt_dict_t dict);
81 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
84 * Those functions work even with non-null terminated keys.
88 XBT_PUBLIC void xbt_dict_set_ext(xbt_dict_t dict, const char* key, int key_len, void* data);
89 XBT_PUBLIC void* xbt_dict_get_or_null_ext(const_xbt_dict_t dict, const char* key, int key_len);
90 XBT_PUBLIC void xbt_dict_remove_ext(xbt_dict_t dict, const char* key, int key_len);
92 struct s_xbt_dict_cursor {
93 xbt_dictelm_t current;
95 const_xbt_dict_t dict;
99 /** @defgroup XBT_dict_curs Cursors on dictionaries
102 * Don't get impressed, there is a lot of functions here, but traversing a dictionary is immediate with the
103 * xbt_dict_foreach macro.
104 * You only need the other functions in rare cases (they are not used directly in SG itself).
106 * Here is an example (assuming that the dictionary contains strings, i.e., that the <tt>data</tt> argument of
107 * xbt_dict_set was always a null-terminated char*):
108 @verbatim xbt_dict_cursor_t cursor=NULL;
111 xbt_dict_foreach(dict,cursor,key,data) {
112 printf(" - Seen: %s->%s\n",key,data);
116 * @warning Do not add or remove entries to the cache while traversing !!
120 /** @brief Cursor on dictionaries (opaque type) */
121 typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
122 typedef const struct s_xbt_dict_cursor* const_xbt_dict_cursor_t;
124 XBT_PUBLIC xbt_dict_cursor_t xbt_dict_cursor_new(const_xbt_dict_t dict);
125 XBT_PUBLIC void xbt_dict_cursor_free(xbt_dict_cursor_t* cursor);
127 XBT_PUBLIC void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
129 XBT_PUBLIC char* xbt_dict_cursor_get_key(const_xbt_dict_cursor_t cursor);
130 XBT_PUBLIC void* xbt_dict_cursor_get_data(const_xbt_dict_cursor_t cursor);
132 XBT_PUBLIC void xbt_dict_cursor_first(const_xbt_dict_t dict, xbt_dict_cursor_t* cursor);
133 XBT_PUBLIC void xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
134 XBT_PUBLIC int xbt_dict_cursor_get_or_free(xbt_dict_cursor_t* cursor, char** key, void** data);
135 /** @def xbt_dict_foreach
136 * @param dict a @ref xbt_dict_t iterator
137 * @param cursor an @ref xbt_dict_cursor_t used as cursor
139 * @param data a void** output
142 * @note An example of usage:
144 xbt_dict_cursor_t cursor = NULL;
148 xbt_dict_foreach(head, cursor, key, data) {
149 printf("Key %s with data %s\n",key,data);
153 #define xbt_dict_foreach(dict, cursor, key, data) \
154 for ((cursor) = NULL, xbt_dict_cursor_first((dict), &(cursor)); \
155 xbt_dict_cursor_get_or_free(&(cursor), (char**)&(key), (void**)&(data)); xbt_dict_cursor_step(cursor))
161 #endif /* XBT_DICT_H */