Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
980cca0b1e40b77a433fc99385e064f40e8f8b1d
[simgrid.git] / include / xbt / dict.h
1 /* $Id$ */
2
3 /* xbt/dict.h -- api to a generic dictionary                                */
4
5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
6
7 /* This program is free software; you can redistribute it and/or modify it
8  * under the terms of the license (GNU LGPL) which comes with this package. */
9
10
11 #ifndef _XBT_DICT_H
12 #define _XBT_DICT_H
13
14 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
15 #include "xbt/dynar.h"          /* void_f_pvoid_t */
16
17 SG_BEGIN_DECL();
18
19 /** @addtogroup XBT_dict
20  *  @brief The dictionary data structure (comparable to hash tables)
21  *
22  *  This section describes the API to a dictionary structure that
23  *  associates as string to a void* key. It provides the same
24  *  functionality than an hash table.
25  *
26  *  Here is a little example of use:
27  *  \verbatim xbt_dict_t mydict = xbt_dict_new();
28  char buff[512];
29
30  sprintf(buff,"some very precious data");
31  xbt_dict_set(mydict,"my data", strdup(buff), free);
32
33  sprintf(buff,"another good stuff");
34  xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add
35 \endverbatim
36  *
37  */
38
39 /** @defgroup XBT_dict_cons Dict constructor and destructor
40  *  @ingroup XBT_dict
41  *
42  *  @{
43  */
44
45   /** \brief Dictionary data type (opaque structure) */
46 typedef struct xbt_dict_ *xbt_dict_t;
47 XBT_PUBLIC(xbt_dict_t) xbt_dict_new(void);
48 XBT_PUBLIC(void) xbt_dict_free(xbt_dict_t * dict);
49 XBT_PUBLIC(unsigned int) xbt_dict_size(xbt_dict_t dict);
50
51 /** @} */
52 /** @defgroup XBT_dict_basic Dictionaries basic usage
53  *  @ingroup XBT_dict
54  *
55  * Careful, those functions assume that the key is null-terminated.
56  *
57  *  @{
58  */
59
60 XBT_PUBLIC(void) xbt_dict_set(xbt_dict_t dict, const char *key, void *data,
61                               void_f_pvoid_t free_ctn);
62 XBT_PUBLIC(void *) xbt_dict_get(xbt_dict_t dict, const char *key);
63 XBT_PUBLIC(void *) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
64
65 XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
66 XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
67 XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
68 XBT_PUBLIC(void) xbt_dict_dump_output_string(void *s);
69 XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output) (void *));
70 XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict);
71
72
73 /** @} */
74 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
75  *  @ingroup XBT_dict
76  *
77  * Those functions work even with non-null terminated keys.
78  *
79  *  @{
80  */
81 XBT_PUBLIC(void) xbt_dict_set_ext(xbt_dict_t dict,
82                                   const char *key, int key_len,
83                                   void *data, void_f_pvoid_t free_ctn);
84 XBT_PUBLIC(void *) xbt_dict_get_ext(xbt_dict_t dict, const char *key,
85                                     int key_len);
86 XBT_PUBLIC(void *) xbt_dict_get_or_null_ext(xbt_dict_t dict, const char *key,
87                                             int key_len);
88 XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key,
89                                      int key_len);
90
91
92 /** @} */
93 /** @defgroup XBT_dict_curs Cursors on dictionaries
94  *  @ingroup XBT_dict
95  *
96  *  Don't get impressed, there is a lot of functions here, but traversing a
97  *  dictionary is immediate with the xbt_dict_foreach macro.
98  *  You only need the other functions in rare cases (they are not used directly in SG itself).
99  *
100  *  Here is an example (assuming that the dictionary contains strings, ie
101  *  that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
102 \verbatim xbt_dict_cursor_t cursor=NULL;
103  char *key,*data;
104
105  xbt_dict_foreach(dict,cursor,key,data) {
106     printf("   - Seen:  %s->%s\n",key,data);
107  }\endverbatim
108
109  *
110  *  \warning Do not add or remove entries to the cache while traversing !!
111  *
112  *  @{ */
113
114   /** @brief Cursor on dictionaries (opaque type) */
115      typedef struct xbt_dict_cursor_ *xbt_dict_cursor_t;
116 XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
117 XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t * cursor);
118
119 XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
120
121
122 XBT_PUBLIC(char *) xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor);
123 XBT_PUBLIC(void *) xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor);
124
125 XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict,
126                                        xbt_dict_cursor_t * cursor);
127 XBT_PUBLIC(void) xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
128 XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor,
129                                             char **key, void **data);
130   /** @def xbt_dict_foreach
131       @hideinitializer */
132 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
133     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \
134          xbt_dict_cursor_get_or_free(&(cursor),&(key),(void**)(&data));\
135          xbt_dict_cursor_step(cursor) )
136
137 /** @} */
138 /** @defgroup XBT_dict_multi Multi-level dictionaries
139  *  @ingroup XBT_dict
140  *
141  * They can be seen as dictionary of multiple keys or as dictionary of
142  * dictionary of ... of data. Most of the functions here work the same way
143  * than their simple dictionary counterpart.
144  *
145  * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
146  * Use xbt_dict_free() and xbt_dict_new() instead.
147  *
148  * @{
149  */
150
151 /** \brief To dump multicache, this function dumps a cache                           */
152 XBT_PUBLIC(void) xbt_dict_print(void *data);
153 /** \brief To dump multicache, this one dumps a string                               */
154 XBT_PUBLIC(void) xbt_dict_prints(void *data);
155
156
157 /*----[ xbt_multidict_set ]--------------------------------------------------*/
158 XBT_PUBLIC(void)
159 xbt_multidict_set(xbt_dict_t mdict,
160                   xbt_dynar_t keys, void *data, void (*free_ctn) (void *));
161 XBT_PUBLIC(void)
162 xbt_multidict_set_ext(xbt_dict_t mdict,
163                       xbt_dynar_t keys, xbt_dynar_t lens,
164                       void *data, void_f_pvoid_t free_ctn);
165
166 /*----[ xbt_multidict_get ]--------------------------------------------------*/
167 XBT_PUBLIC(void *) xbt_multidict_get(xbt_dict_t mdict, xbt_dynar_t keys);
168 XBT_PUBLIC(void *) xbt_multidict_get_ext(xbt_dict_t mdict, xbt_dynar_t keys,
169                                          xbt_dynar_t lens);
170
171 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
172 /*---------------------------------------------------------------------------*/
173 XBT_PUBLIC(void) xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
174 XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict, xbt_dynar_t keys,
175                                           xbt_dynar_t lens);
176
177 /** @} */
178
179 SG_END_DECL()
180 #endif /* _XBT_DICT_H */