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 dictionary data structure (comparable to hash tables)
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.
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
39 /** @defgroup XBT_dict_cons Dict constructor and destructor
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);
52 /** @defgroup XBT_dict_basic Dictionaries basic usage
55 * Careful, those functions assume that the key is null-terminated.
60 XBT_PUBLIC(void) xbt_dict_set(xbt_dict_t dict, const char *key, void *data, void_f_pvoid_t free_ctn);
61 XBT_PUBLIC(void*) xbt_dict_get(xbt_dict_t dict,const char *key);
62 XBT_PUBLIC(void*) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
64 XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
65 XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
66 XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
67 XBT_PUBLIC(void) xbt_dict_dump_output_string(void *s);
68 XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output)(void*));
69 XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict);
73 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
76 * Those functions work even with non-null terminated keys.
80 XBT_PUBLIC(void) xbt_dict_set_ext(xbt_dict_t dict,
81 const char *key, int key_len,
83 void_f_pvoid_t free_ctn);
84 XBT_PUBLIC(void*) xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len);
85 XBT_PUBLIC(void*) xbt_dict_get_or_null_ext(xbt_dict_t dict, const char *key, int key_len);
86 XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len);
90 /** @defgroup XBT_dict_curs Cursors on dictionaries
93 * Don't get impressed, there is a lot of functions here, but traversing a
94 * dictionary is immediate with the xbt_dict_foreach macro.
95 * You only need the other functions in rare cases (they are not used directly in SG itself).
97 * Here is an example (assuming that the dictionary contains strings, ie
98 * that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
99 \verbatim xbt_dict_cursor_t cursor=NULL;
102 xbt_dict_foreach(dict,cursor,key,data) {
103 printf(" - Seen: %s->%s\n",key,data);
107 * \warning Do not add or remove entries to the cache while traversing !!
111 /** @brief Cursor on dictionaries (opaque type) */
112 typedef struct xbt_dict_cursor_ *xbt_dict_cursor_t;
113 XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
114 XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t *cursor);
116 XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
119 XBT_PUBLIC(char *) xbt_dict_cursor_get_key (xbt_dict_cursor_t cursor);
120 XBT_PUBLIC(void *) xbt_dict_cursor_get_data (xbt_dict_cursor_t cursor);
122 XBT_PUBLIC(void) xbt_dict_cursor_first (const xbt_dict_t dict,
123 xbt_dict_cursor_t *cursor);
124 XBT_PUBLIC(void) xbt_dict_cursor_step (xbt_dict_cursor_t cursor);
125 XBT_PUBLIC(int) xbt_dict_cursor_get_or_free (xbt_dict_cursor_t *cursor,
128 /** @def xbt_dict_foreach
130 # define xbt_dict_foreach(dict,cursor,key,data) \
131 for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ; \
132 xbt_dict_cursor_get_or_free(&(cursor),&(key),(void**)(&data));\
133 xbt_dict_cursor_step(cursor) )
136 /** @defgroup XBT_dict_multi Multi-level dictionaries
139 * They can be seen as dictionary of multiple keys or as dictionary of
140 * dictionary of ... of data. Most of the functions here work the same way
141 * than their simple dictionary counterpart.
143 * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
144 * Use xbt_dict_free() and xbt_dict_new() instead.
149 /** \brief To dump multicache, this function dumps a cache */
150 XBT_PUBLIC(void) xbt_dict_print(void *data);
151 /** \brief To dump multicache, this one dumps a string */
152 XBT_PUBLIC(void) xbt_dict_prints(void *data);
155 /*----[ xbt_multidict_set ]--------------------------------------------------*/
157 xbt_multidict_set(xbt_dict_t mdict,
159 void *data,void (*free_ctn)(void*));
161 xbt_multidict_set_ext(xbt_dict_t mdict,
162 xbt_dynar_t keys, xbt_dynar_t lens,
163 void *data,void_f_pvoid_t free_ctn);
165 /*----[ xbt_multidict_get ]--------------------------------------------------*/
166 XBT_PUBLIC(void*) xbt_multidict_get (xbt_dict_t mdict, xbt_dynar_t keys);
167 XBT_PUBLIC(void*) xbt_multidict_get_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
169 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
170 /*---------------------------------------------------------------------------*/
171 XBT_PUBLIC(void) xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
172 XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
178 #endif /* _XBT_DICT_H */