Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[doc] @deprecate XBT structures
[simgrid.git] / include / xbt / dict.h
1 /* xbt/dict.h -- api to a generic dictionary                                */
2
3 /* Copyright (c) 2004-2014. The SimGrid Team.
4  * All rights reserved.                                                     */
5
6 /* This program is free software; you can redistribute it and/or modify it
7  * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 #ifndef _XBT_DICT_H
10 #define _XBT_DICT_H
11
12 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
13 #include "xbt/dynar.h"          /* void_f_pvoid_t */
14 #include <stdint.h>             /* uintptr_t */
15
16 SG_BEGIN_DECL()
17
18 /** @addtogroup XBT_dict
19  *  @brief The dictionary data structure (comparable to hash tables)
20  *
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.
23  *
24  *  @deprecated If you are using C++, you might want to use `std::unordered_map` instead.
25  *
26  *  Here is a little example of use:
27
28 \verbatim
29  xbt_dict_t mydict = xbt_dict_new();
30  char buff[512];
31
32  sprintf(buff,"some very precious data");
33  xbt_dict_set(mydict,"my data", strdup(buff), free);
34
35  sprintf(buff,"another good stuff");
36  xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add
37 \endverbatim
38  */
39
40 /** @defgroup XBT_dict_cons Dict constructor and destructor
41  *  @ingroup XBT_dict
42  *
43  *  @{
44  */
45
46   /** \brief Dictionary data type (opaque structure) */
47 typedef struct s_xbt_dict *xbt_dict_t;
48 typedef struct s_xbt_dictelm *xbt_dictelm_t;
49 typedef struct s_xbt_dictelm {
50   char *key;
51   int key_len;
52   unsigned int hash_code;
53
54   void *content;
55
56   xbt_dictelm_t next;
57 } s_xbt_dictelm_t;
58
59 XBT_PUBLIC(xbt_dict_t) xbt_dict_new(void);
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);
63
64 /** @} */
65 /** @defgroup XBT_dict_basic Dictionaries basic usage
66  *  @ingroup XBT_dict
67  *
68  * Careful, those functions assume that the key is null-terminated.
69  *
70  *  @{
71  */
72
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_PUBLIC(char *) xbt_dict_get_elm_key(xbt_dictelm_t elem);
78 XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm(xbt_dict_t dict, const char *key);
79 XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm_or_null(xbt_dict_t dict, const char *key);
80
81 XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
82 XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
83 XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
84 XBT_PUBLIC(void) xbt_dict_dump_output_string(void *s);
85 XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output) (void *));
86 XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict);
87 XBT_PUBLIC(int) xbt_dict_is_empty(xbt_dict_t dict);
88
89
90 /** @} */
91 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
92  *  @ingroup XBT_dict
93  *
94  * Those functions work even with non-null terminated keys.
95  *
96  *  @{
97  */
98 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);
99 XBT_PUBLIC(void *) xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len);
100 XBT_PUBLIC(void *) xbt_dict_get_or_null_ext(xbt_dict_t dict, const char *key, int key_len);
101 XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len);
102
103 struct s_xbt_dict_cursor {
104   xbt_dictelm_t current;
105   int line;
106   xbt_dict_t dict;
107 };
108
109 /** @} */
110 /** @defgroup XBT_dict_curs Cursors on dictionaries
111  *  @ingroup XBT_dict
112  *
113  *  Don't get impressed, there is a lot of functions here, but traversing a dictionary is immediate with the
114  *  xbt_dict_foreach macro.
115  *  You only need the other functions in rare cases (they are not used directly in SG itself).
116  *
117  *  Here is an example (assuming that the dictionary contains strings, i.e., that the <tt>data</tt> argument of
118  *  xbt_dict_set was always a null-terminated char*):
119 \verbatim xbt_dict_cursor_t cursor=NULL;
120  char *key,*data;
121
122  xbt_dict_foreach(dict,cursor,key,data) {
123     printf("   - Seen:  %s->%s\n",key,data);
124  }\endverbatim
125
126  *
127  *  \warning Do not add or remove entries to the cache while traversing !!
128  *
129  *  @{ */
130
131 /** @brief Cursor on dictionaries (opaque type) */
132 typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
133
134 static inline xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor) {
135   return cursor->current;
136 }
137
138 XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
139 XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t * cursor);
140
141 XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
142
143 xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor);
144 XBT_PUBLIC(char *) xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor);
145 XBT_PUBLIC(void *) xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor);
146 XBT_PUBLIC(void) xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor, void *data, void_f_pvoid_t free_ctn);
147
148 XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict, xbt_dict_cursor_t * cursor);
149 XBT_PUBLIC(void) xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
150 XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor, char **key, void **data);
151 /** @def xbt_dict_foreach
152  *  @param dict a \ref xbt_dict_t iterator
153  *  @param cursor an \ref xbt_dict_cursor_t used as cursor
154  *  @param key a char*
155  *  @param data a void** output
156  *  @hideinitializer
157  *
158  * \note An example of usage:
159  * \code
160 xbt_dict_cursor_t cursor = NULL;
161 char *key;
162 char *data;
163
164 xbt_dict_foreach(head, cursor, key, data) {
165  printf("Key %s with data %s\n",key,data);
166 }
167 \endcode
168  */
169 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
170     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \
171          xbt_dict_cursor_get_or_free(&(cursor),(char**)&(key),(void**)(&data));\
172          xbt_dict_cursor_step(cursor) )
173
174 /** @} */
175
176 SG_END_DECL()
177
178 #endif                          /* _XBT_DICT_H */