3 /* xbt/dict.h -- api to a generic dictionary */
5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */
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. */
14 #include "xbt/misc.h" /* SG_BEGIN_DECL */
15 #include "xbt/dynar.h" /* void_f_pvoid_t */
19 /** @addtogroup XBT_dict
20 * @brief The dictionnary data structure (comparable to hash tables)
22 * This section describes the API to a dictionnary structure that
23 * associates as string to a void* key. Even if it provides the same
24 * functionnality than an hash table, the implementation differs and the
25 * internal data-structure rather looks like a tree.
27 * Here is a little example of use:
28 * \verbatim 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 \endverbatim
40 /** @defgroup XBT_dict_cons Dict constructor and destructor
46 /** \brief Dictionnary data type (opaque structure) */
47 typedef struct xbt_dict_ *xbt_dict_t;
48 xbt_dict_t xbt_dict_new(void);
49 void xbt_dict_free(xbt_dict_t *dict);
52 /** @defgroup XBT_dict_basic Dictionnaries basic usage
55 * Careful, those functions assume that the key is null-terminated.
60 void xbt_dict_set(xbt_dict_t head, const char *key, void *data, void_f_pvoid_t *free_ctn);
61 void *xbt_dict_get(xbt_dict_t head,const char *key);
62 void *xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
64 void xbt_dict_remove(xbt_dict_t head, const char *key);
65 void xbt_dict_dump(xbt_dict_t head,void (*output)(void*));
68 /** @defgroup XBT_dict_nnul Dictionnaries with non-nul terminated keys
71 * Those functions work even with non-null terminated keys.
75 void xbt_dict_set_ext(xbt_dict_t head,
76 const char *key, int key_len,
78 void_f_pvoid_t *free_ctn);
79 void *xbt_dict_get_ext(xbt_dict_t head,const char *key, int key_len);
80 void xbt_dict_remove_ext(xbt_dict_t head, const char *key, int key_len);
84 /** @defgroup XBT_dict_curs Cursors on dictionnaries
87 * Don't get impressed, there is a lot of functions here, but traversing a
88 * dictionnary is imediate with the xbt_dict_foreach macro.
89 * You only need the other functions in rare cases (they are not used directly in SG itself).
91 * Here is an example (assuming that the dictionnary contains strings, ie
92 * that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
93 \verbatim xbt_dict_cursor_t cursor=NULL;
96 xbt_dict_foreach(head,cursor,key,data) {
97 printf(" - Seen: %s->%s\n",key,data);
101 * \warning Do not add or remove entries to the cache while traversing !!
105 /** @brief Cursor on dictionnaries (opaque type) */
106 typedef struct xbt_dict_cursor_ *xbt_dict_cursor_t;
107 xbt_dict_cursor_t xbt_dict_cursor_new(const xbt_dict_t head);
108 void xbt_dict_cursor_free(xbt_dict_cursor_t *cursor);
110 void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
113 char * xbt_dict_cursor_get_key (xbt_dict_cursor_t cursor);
114 void * xbt_dict_cursor_get_data (xbt_dict_cursor_t cursor);
116 void xbt_dict_cursor_first (const xbt_dict_t dict,
117 xbt_dict_cursor_t *cursor);
118 void xbt_dict_cursor_step (xbt_dict_cursor_t cursor);
119 int xbt_dict_cursor_get_or_free (xbt_dict_cursor_t *cursor,
122 /** @def xbt_dict_foreach
124 # define xbt_dict_foreach(dict,cursor,key,data) \
125 for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ; \
126 xbt_dict_cursor_get_or_free(&(cursor),&(key),(void**)(&data));\
127 xbt_dict_cursor_step(cursor) )
130 /** @defgroup XBT_dict_multi Multi-level dictionnaries
133 * They can be seen as dictionnary of multiple keys or as dictionnary of
134 * dictionnary of ... of data. Most of the functions here work the same way
135 * than their simple dictionnary counterpart.
137 * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
138 * Use xbt_dict_free() and xbt_dict_new() instead.
143 /** \brief To dump multicache, this function dumps a cache */
144 void xbt_dict_print(void *data);
145 /** \brief To dump multicache, this one dumps a string */
146 void xbt_dict_prints(void *data);
149 /*----[ xbt_multidict_set ]--------------------------------------------------*/
151 xbt_multidict_set(xbt_dict_t mdict,
153 void *data,void (*free_ctn)(void*));
155 xbt_multidict_set_ext(xbt_dict_t mdict,
156 xbt_dynar_t keys, xbt_dynar_t lens,
157 void *data,void_f_pvoid_t *free_ctn);
159 /*----[ xbt_multidict_get ]--------------------------------------------------*/
160 void *xbt_multidict_get (xbt_dict_t mdict, xbt_dynar_t keys);
161 void *xbt_multidict_get_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
163 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
164 /*---------------------------------------------------------------------------*/
165 void xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
166 void xbt_multidict_remove_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
172 #endif /* _XBT_DICT_H */