1 /* xbt/dict.h -- api to a generic dictionary */
3 /* Copyright (c) 2004-2017. 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/misc.h" /* SG_BEGIN_DECL */
12 #include "xbt/dynar.h" /* void_f_pvoid_t */
13 #include <stdint.h> /* uintptr_t */
17 /** @addtogroup XBT_dict
18 * @brief The dictionary data structure (comparable to hash tables)
20 * This section describes the API to a dictionary structure that associates as string to a void* key. It provides the
21 * same functionality than an hash table.
23 * @deprecated If you are using C++, you might want to use `std::unordered_map` instead.
25 * Here is a little example of use:
28 xbt_dict_t mydict = xbt_dict_new();
31 sprintf(buff,"some very precious data");
32 xbt_dict_set(mydict,"my data", strdup(buff), free);
34 sprintf(buff,"another good stuff");
35 xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add
39 /** @defgroup XBT_dict_cons Dict constructor and destructor
45 /** \brief Dictionary data type (opaque structure) */
46 typedef struct s_xbt_dict *xbt_dict_t;
47 typedef struct s_xbt_dictelm *xbt_dictelm_t;
48 typedef struct s_xbt_dictelm {
51 unsigned int hash_code;
58 XBT_ATTRIB_DEPRECATED_v319("Use xbt_dict_new_homogeneous(). v3.19 will turn this warning into an error.")
59 XBT_PUBLIC(xbt_dict_t) xbt_dict_new();
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(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, void_f_pvoid_t free_ctn);
74 XBT_PUBLIC(void *) xbt_dict_get(xbt_dict_t dict, const char *key);
75 XBT_PUBLIC(void *) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
76 XBT_PUBLIC(char*) xbt_dict_get_key(xbt_dict_t dict, const void* data);
77 XBT_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.") XBT_PUBLIC(char*)
78 xbt_dict_get_elm_key(xbt_dictelm_t elem);
79 XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm(xbt_dict_t dict, const char *key);
80 XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm_or_null(xbt_dict_t dict, const char *key);
82 XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
83 XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
84 XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
85 XBT_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.") XBT_PUBLIC(void)
86 xbt_dict_dump_output_string(void* s);
87 XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output) (void *));
88 XBT_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.") XBT_PUBLIC(void)
89 xbt_dict_dump_sizes(xbt_dict_t dict);
90 XBT_PUBLIC(int) xbt_dict_is_empty(xbt_dict_t dict);
93 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
96 * Those functions work even with non-null terminated keys.
100 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);
101 XBT_PUBLIC(void*) xbt_dict_get_ext(xbt_dict_t dict, const char* key, int key_len);
102 XBT_PUBLIC(void*) xbt_dict_get_or_null_ext(xbt_dict_t dict, const char* key, int key_len);
103 XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len);
105 struct s_xbt_dict_cursor {
106 xbt_dictelm_t current;
112 /** @defgroup XBT_dict_curs Cursors on dictionaries
115 * Don't get impressed, there is a lot of functions here, but traversing a dictionary is immediate with the
116 * xbt_dict_foreach macro.
117 * You only need the other functions in rare cases (they are not used directly in SG itself).
119 * Here is an example (assuming that the dictionary contains strings, i.e., that the <tt>data</tt> argument of
120 * xbt_dict_set was always a null-terminated char*):
121 \verbatim xbt_dict_cursor_t cursor=NULL;
124 xbt_dict_foreach(dict,cursor,key,data) {
125 printf(" - Seen: %s->%s\n",key,data);
129 * \warning Do not add or remove entries to the cache while traversing !!
133 /** @brief Cursor on dictionaries (opaque type) */
134 typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
136 static inline xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor) {
137 return cursor->current;
140 XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
141 XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t * cursor);
143 XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
145 XBT_PUBLIC(char *) xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor);
146 XBT_PUBLIC(void *) xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor);
147 XBT_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.") XBT_PUBLIC(void)
148 xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor, void* data, void_f_pvoid_t free_ctn);
150 XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict, xbt_dict_cursor_t * cursor);
151 XBT_PUBLIC(void) xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
152 XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor, char **key, void **data);
153 /** @def xbt_dict_foreach
154 * @param dict a \ref xbt_dict_t iterator
155 * @param cursor an \ref xbt_dict_cursor_t used as cursor
157 * @param data a void** output
160 * \note An example of usage:
162 xbt_dict_cursor_t cursor = NULL;
166 xbt_dict_foreach(head, cursor, key, data) {
167 printf("Key %s with data %s\n",key,data);
171 # define xbt_dict_foreach(dict,cursor,key,data) \
172 for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ; \
173 xbt_dict_cursor_get_or_free(&(cursor),(char**)&(key),(void**)(&data));\
174 xbt_dict_cursor_step(cursor) )
180 #endif /* XBT_DICT_H */