/** @addtogroup XBT_dict
* @brief The dictionnary data structure (comparable to hash tables)
*
- * <center><table><tr><td><b>Top</b> <td> [\ref index]::[\ref XBT_API]
- * <tr><td><b>Prev</b> <td> [\ref XBT_dynar]
- * <tr><td><b>Next</b> <td> [\ref XBT_set]
- * <tr><td><b>Down</b> <td> [\ref XBT_dict_cons] </table></center>
- *
* This section describes the API to a dictionnary structure that
- * associates as string to a void* key. Even if it provides the same
- * functionnality than an hash table, the implementation differs and the
- * internal data-structure rather looks like a tree.
+ * associates as string to a void* key. It provides the same
+ * functionnality than an hash table.
*
* Here is a little example of use:
* \verbatim xbt_dict_t mydict = xbt_dict_new();
/** @defgroup XBT_dict_cons Dict constructor and destructor
* @ingroup XBT_dict
*
- * <center><table><tr><td><b>Top</b> <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dict]
- * <tr><td> Prev <td>
- * <tr><td><b>Next</b> <td> [\ref XBT_dict_basic] </table></center>
- *
* @{
*/
/** \brief Dictionnary data type (opaque structure) */
typedef struct xbt_dict_ *xbt_dict_t;
- xbt_dict_t xbt_dict_new(void);
- void xbt_dict_free(xbt_dict_t *dict);
+ XBT_PUBLIC(xbt_dict_t) xbt_dict_new(void);
+ XBT_PUBLIC(xbt_dict_t) xbt_dict_new_ext(int hashsize);
+ XBT_PUBLIC(void) xbt_dict_free(xbt_dict_t *dict);
+ XBT_PUBLIC(void) xbt_dict_hashsize_set(xbt_dict_t dict, int hashsize);
/** @} */
/** @defgroup XBT_dict_basic Dictionnaries basic usage
* @ingroup XBT_dict
*
- * <center><table><tr><td><b>Top</b> <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dict]
- * <tr><td><b>Prev</b> <td> [\ref XBT_dict_cons]
- * <tr><td><b>Next</b> <td> [\ref XBT_dict_nnul] </table></center>
- *
* Careful, those functions assume that the key is null-terminated.
*
* @{
*/
- void xbt_dict_set(xbt_dict_t head, const char *key, void *data, void_f_pvoid_t *free_ctn);
- void *xbt_dict_get(xbt_dict_t head,const char *key);
- void *xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
+ XBT_PUBLIC(void) xbt_dict_set(xbt_dict_t dict, const char *key, void *data, void_f_pvoid_t *free_ctn);
+ XBT_PUBLIC(void*) xbt_dict_get(xbt_dict_t dict,const char *key);
+ XBT_PUBLIC(void*) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
- void xbt_dict_remove(xbt_dict_t head, const char *key);
- void xbt_dict_dump(xbt_dict_t head,void (*output)(void*));
+ XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
+ XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
+ XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
+ XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output)(void*));
/** @} */
/** @defgroup XBT_dict_nnul Dictionnaries with non-nul terminated keys
* @ingroup XBT_dict
*
- * <center><table><tr><td><b>Top</b> <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dict]
- * <tr><td><b>Prev</b> <td> [\ref XBT_dict_basic]
- * <tr><td><b>Next</b> <td> [\ref XBT_dict_curs] </table></center>
- *
* Those functions work even with non-null terminated keys.
*
* @{
*/
- void xbt_dict_set_ext(xbt_dict_t head,
+ 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);
- void *xbt_dict_get_ext(xbt_dict_t head,const char *key, int key_len);
- void xbt_dict_remove_ext(xbt_dict_t head, const char *key, int key_len);
+ XBT_PUBLIC(void*) xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len);
+ XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len);
/** @} */
/** @defgroup XBT_dict_curs Cursors on dictionnaries
* @ingroup XBT_dict
*
- * <center><table><tr><td><b>Top</b> <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dict]
- * <tr><td><b>Prev</b> <td> [\ref XBT_dict_nnul]
- * <tr><td><b>Next</b> <td> [\ref XBT_dict_multi] </table></center>
- *
* Don't get impressed, there is a lot of functions here, but traversing a
* dictionnary is imediate with the xbt_dict_foreach macro.
* You only need the other functions in rare cases (they are not used directly in SG itself).
\verbatim xbt_dict_cursor_t cursor=NULL;
char *key,*data;
- xbt_dict_foreach(head,cursor,key,data) {
+ xbt_dict_foreach(dict,cursor,key,data) {
printf(" - Seen: %s->%s\n",key,data);
}\endverbatim
/** @brief Cursor on dictionnaries (opaque type) */
typedef struct xbt_dict_cursor_ *xbt_dict_cursor_t;
- xbt_dict_cursor_t xbt_dict_cursor_new(const xbt_dict_t head);
- void xbt_dict_cursor_free(xbt_dict_cursor_t *cursor);
+ XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
+ XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t *cursor);
- void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
+ XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
- char * xbt_dict_cursor_get_key (xbt_dict_cursor_t cursor);
- void * xbt_dict_cursor_get_data (xbt_dict_cursor_t cursor);
+ XBT_PUBLIC(char *) xbt_dict_cursor_get_key (xbt_dict_cursor_t cursor);
+ XBT_PUBLIC(void *) xbt_dict_cursor_get_data (xbt_dict_cursor_t cursor);
- void xbt_dict_cursor_first (const xbt_dict_t dict,
+ XBT_PUBLIC(void) xbt_dict_cursor_first (const xbt_dict_t dict,
xbt_dict_cursor_t *cursor);
- void xbt_dict_cursor_step (xbt_dict_cursor_t cursor);
- int xbt_dict_cursor_get_or_free (xbt_dict_cursor_t *cursor,
+ XBT_PUBLIC(void) xbt_dict_cursor_step (xbt_dict_cursor_t cursor);
+ XBT_PUBLIC(int) xbt_dict_cursor_get_or_free (xbt_dict_cursor_t *cursor,
char **key,
void **data);
/** @def xbt_dict_foreach
/** @defgroup XBT_dict_multi Multi-level dictionnaries
* @ingroup XBT_dict
*
- * <center><table><tr><td><b>Top</b> <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dict]
- * <tr><td><b>Prev</b> <td> [\ref XBT_dict_curs]
- * <tr><td> Next <td> </table></center>
- *
* They can be seen as dictionnary of multiple keys or as dictionnary of
* dictionnary of ... of data. Most of the functions here work the same way
* than their simple dictionnary counterpart.
*/
/** \brief To dump multicache, this function dumps a cache */
-void xbt_dict_print(void *data);
+XBT_PUBLIC(void) xbt_dict_print(void *data);
/** \brief To dump multicache, this one dumps a string */
-void xbt_dict_prints(void *data);
+XBT_PUBLIC(void) xbt_dict_prints(void *data);
/*----[ xbt_multidict_set ]--------------------------------------------------*/
-void
+XBT_PUBLIC(void)
xbt_multidict_set(xbt_dict_t mdict,
xbt_dynar_t keys,
void *data,void (*free_ctn)(void*));
-void
+XBT_PUBLIC(void)
xbt_multidict_set_ext(xbt_dict_t mdict,
xbt_dynar_t keys, xbt_dynar_t lens,
void *data,void_f_pvoid_t *free_ctn);
/*----[ xbt_multidict_get ]--------------------------------------------------*/
-void *xbt_multidict_get (xbt_dict_t mdict, xbt_dynar_t keys);
-void *xbt_multidict_get_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
+XBT_PUBLIC(void*) xbt_multidict_get (xbt_dict_t mdict, xbt_dynar_t keys);
+XBT_PUBLIC(void*) xbt_multidict_get_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
/*----[ xbt_multidict_remove ]-----------------------------------------------*/
/*---------------------------------------------------------------------------*/
-void xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
-void xbt_multidict_remove_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
+XBT_PUBLIC(void) xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
+XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
/** @} */
