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. It provides the same
24 * functionnality than an hash table.
26 * Here is a little example of use:
27 * \verbatim xbt_dict_t mydict = xbt_dict_new();
30 sprintf(buff,"some very precious data");
31 xbt_dict_set(mydict,"my data", strdup(buff), free);
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 \endverbatim
39 /** @defgroup XBT_dict_cons Dict constructor and destructor
45 /** \brief Dictionnary 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(xbt_dict_t) xbt_dict_new_ext(int hashsize);
49 XBT_PUBLIC(void) xbt_dict_free(xbt_dict_t *dict);
50 XBT_PUBLIC(void) xbt_dict_hashsize_set(xbt_dict_t dict, int hashsize);
53 /** @defgroup XBT_dict_basic Dictionnaries basic usage
56 * Careful, those functions assume that the key is null-terminated.
61 XBT_PUBLIC(void) xbt_dict_set(xbt_dict_t dict, const char *key, void *data, 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);
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(xbt_dict_t dict, void (*output)(void*));
71 /** @defgroup XBT_dict_nnul Dictionnaries with non-nul terminated keys
74 * Those functions work even with non-null terminated keys.
78 XBT_PUBLIC(void) xbt_dict_set_ext(xbt_dict_t dict,
79 const char *key, int key_len,
81 void_f_pvoid_t *free_ctn);
82 XBT_PUBLIC(void*) xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len);
83 XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len);
87 /** @defgroup XBT_dict_curs Cursors on dictionnaries
90 * Don't get impressed, there is a lot of functions here, but traversing a
91 * dictionnary is imediate with the xbt_dict_foreach macro.
92 * You only need the other functions in rare cases (they are not used directly in SG itself).
94 * Here is an example (assuming that the dictionnary contains strings, ie
95 * that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
96 \verbatim xbt_dict_cursor_t cursor=NULL;
99 xbt_dict_foreach(dict,cursor,key,data) {
100 printf(" - Seen: %s->%s\n",key,data);
104 * \warning Do not add or remove entries to the cache while traversing !!
108 /** @brief Cursor on dictionnaries (opaque type) */
109 typedef struct xbt_dict_cursor_ *xbt_dict_cursor_t;
110 XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
111 XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t *cursor);
113 XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
116 XBT_PUBLIC(char *) xbt_dict_cursor_get_key (xbt_dict_cursor_t cursor);
117 XBT_PUBLIC(void *) xbt_dict_cursor_get_data (xbt_dict_cursor_t cursor);
119 XBT_PUBLIC(void) xbt_dict_cursor_first (const xbt_dict_t dict,
120 xbt_dict_cursor_t *cursor);
121 XBT_PUBLIC(void) xbt_dict_cursor_step (xbt_dict_cursor_t cursor);
122 XBT_PUBLIC(int) xbt_dict_cursor_get_or_free (xbt_dict_cursor_t *cursor,
125 /** @def xbt_dict_foreach
127 # define xbt_dict_foreach(dict,cursor,key,data) \
128 for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ; \
129 xbt_dict_cursor_get_or_free(&(cursor),&(key),(void**)(&data));\
130 xbt_dict_cursor_step(cursor) )
133 /** @defgroup XBT_dict_multi Multi-level dictionnaries
136 * They can be seen as dictionnary of multiple keys or as dictionnary of
137 * dictionnary of ... of data. Most of the functions here work the same way
138 * than their simple dictionnary counterpart.
140 * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
141 * Use xbt_dict_free() and xbt_dict_new() instead.
146 /** \brief To dump multicache, this function dumps a cache */
147 XBT_PUBLIC(void) xbt_dict_print(void *data);
148 /** \brief To dump multicache, this one dumps a string */
149 XBT_PUBLIC(void) xbt_dict_prints(void *data);
152 /*----[ xbt_multidict_set ]--------------------------------------------------*/
154 xbt_multidict_set(xbt_dict_t mdict,
156 void *data,void (*free_ctn)(void*));
158 xbt_multidict_set_ext(xbt_dict_t mdict,
159 xbt_dynar_t keys, xbt_dynar_t lens,
160 void *data,void_f_pvoid_t *free_ctn);
162 /*----[ xbt_multidict_get ]--------------------------------------------------*/
163 XBT_PUBLIC(void*) xbt_multidict_get (xbt_dict_t mdict, xbt_dynar_t keys);
164 XBT_PUBLIC(void*) xbt_multidict_get_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
166 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
167 /*---------------------------------------------------------------------------*/
168 XBT_PUBLIC(void) xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
169 XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
175 #endif /* _XBT_DICT_H */