X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/525f6a48d196fece2e4fbb032c604faccc1b0146..0bfb3cdebf6d1a0105a7a738a602015ed583a39e:/include/xbt/dict.h?ds=sidebyside diff --git a/include/xbt/dict.h b/include/xbt/dict.h index 38aab198f1..dd4de16526 100644 --- a/include/xbt/dict.h +++ b/include/xbt/dict.h @@ -11,18 +11,17 @@ #ifndef _XBT_DICT_H #define _XBT_DICT_H -#include "xbt/misc.h" /* BEGIN_DECL */ -#include "xbt/error.h" +#include "xbt/misc.h" /* SG_BEGIN_DECL */ #include "xbt/dynar.h" /* void_f_pvoid_t */ -BEGIN_DECL() +SG_BEGIN_DECL() /** @addtogroup XBT_dict + * @brief The dictionnary data structure (comparable to hash tables) * * 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(); @@ -35,56 +34,58 @@ BEGIN_DECL() xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add \endverbatim * - * \warning This section also gets bitten by the doxygen bug reordering the name sections. - * Make sure to read in this order: - * -# Constructor/destructor - * -# Dictionnaries basic usage - * -# Non-null terminated keys - * -# Traversing dictionnaries with cursors - * - * @{ -*/ + */ -/** @name 1. Constructor/destructor - * @{ +/** @defgroup XBT_dict_cons Dict constructor and destructor + * @ingroup XBT_dict + * + * @{ */ /** \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); /** @} */ -/** @name 2. Dictionnaries basic usage +/** @defgroup XBT_dict_basic Dictionnaries basic usage + * @ingroup XBT_dict * * Careful, those functions assume that the key is null-terminated. * - * @{ */ + * @{ + */ + + 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_set(xbt_dict_t head, const char *key, void *data, void_f_pvoid_t *free_ctn); - xbt_error_t xbt_dict_get(xbt_dict_t head,const char *key, /* OUT */void **data); - xbt_error_t 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*)); /** @} */ -/** @name 3. Non-null terminated keys +/** @defgroup XBT_dict_nnul Dictionnaries with non-nul terminated keys + * @ingroup XBT_dict * * Those functions work even with non-null terminated keys. * * @{ */ - void xbt_dict_set_ext(xbt_dict_t head, - const char *key, int key_len, - void *data, - void_f_pvoid_t *free_ctn); - xbt_error_t xbt_dict_get_ext(xbt_dict_t head,const char *key, int key_len, - /* OUT */void **data); - xbt_error_t xbt_dict_remove_ext(xbt_dict_t head, - const char *key, int key_len); + 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); + 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); /** @} */ -/** @name 4. Cursors on dictionnaries +/** @defgroup XBT_dict_curs Cursors on dictionnaries + * @ingroup XBT_dict * * Don't get impressed, there is a lot of functions here, but traversing a * dictionnary is imediate with the xbt_dict_foreach macro. @@ -95,7 +96,7 @@ BEGIN_DECL() \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 @@ -106,21 +107,19 @@ BEGIN_DECL() /** @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); - xbt_error_t xbt_dict_cursor_get_key (xbt_dict_cursor_t cursor, - /*OUT*/char **key); - xbt_error_t xbt_dict_cursor_get_data (xbt_dict_cursor_t cursor, - /*OUT*/void **data); + 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 @@ -131,7 +130,8 @@ BEGIN_DECL() xbt_dict_cursor_step(cursor) ) /** @} */ -/** @name 5. Multi-dictionnary +/** @defgroup XBT_dict_multi Multi-level dictionnaries + * @ingroup XBT_dict * * 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 @@ -144,42 +144,32 @@ BEGIN_DECL() */ /** \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 ]--------------------------------------------------*/ -xbt_error_t +XBT_PUBLIC(void) xbt_multidict_set(xbt_dict_t mdict, xbt_dynar_t keys, void *data,void (*free_ctn)(void*)); -xbt_error_t +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 ]--------------------------------------------------*/ -xbt_error_t -xbt_multidict_get(xbt_dict_t mdict, - xbt_dynar_t keys, - /*OUT*/void **data); -xbt_error_t -xbt_multidict_get_ext(xbt_dict_t mdict, - xbt_dynar_t keys, xbt_dynar_t lens, - /*OUT*/void **data); +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 ]-----------------------------------------------*/ /*---------------------------------------------------------------------------*/ -xbt_error_t -xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys); -xbt_error_t -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); /** @} */ -/** @} */ -END_DECL() +SG_END_DECL() #endif /* _XBT_DICT_H */