X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/25d6952dcf52e6ffc1e4a402af0e2d3c17ac3935..3a3e6844ae7c79aca66a93c63cd583086d9df432:/include/xbt/dict.h diff --git a/include/xbt/dict.h b/include/xbt/dict.h index 395f53e9bd..9ebe9995d6 100644 --- a/include/xbt/dict.h +++ b/include/xbt/dict.h @@ -11,90 +11,94 @@ #ifndef _XBT_DICT_H #define _XBT_DICT_H -#include "xbt/misc.h" /* BEGIN_DECL */ +#include "xbt/misc.h" /* SG_BEGIN_DECL */ #include "xbt/dynar.h" /* void_f_pvoid_t */ -BEGIN_DECL() +SG_BEGIN_DECL(); /** @addtogroup XBT_dict - * - * 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. - * + * @brief The dictionary data structure (comparable to hash tables) + * + * This section describes the API to a dictionary structure that + * associates as string to a void* key. It provides the same + * functionality than an hash table. + * * Here is a little example of use: * \verbatim xbt_dict_t mydict = xbt_dict_new(); char buff[512]; sprintf(buff,"some very precious data"); - xbt_dict_set(mydict,"my data", strdup(buff), free); + xbt_dict_set(mydict,"my data", strdup(buff), free); sprintf(buff,"another good stuff"); - 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 + xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add +\endverbatim * - * @{ -*/ + */ -/** @name 1. Constructor/destructor - * @{ +/** @defgroup XBT_dict_cons Dict constructor and destructor + * @ingroup XBT_dict + * + * @{ */ - /** \brief Dictionnary data type (opaque structure) */ + /** \brief Dictionary 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(void) xbt_dict_free(xbt_dict_t *dict); + XBT_PUBLIC(unsigned int) xbt_dict_size(xbt_dict_t dict); /** @} */ -/** @name 2. Dictionnaries basic usage +/** @defgroup XBT_dict_basic Dictionaries 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); + + 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*)); + XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict); - 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); - void xbt_dict_remove(xbt_dict_t head, const char *key); - void xbt_dict_dump(xbt_dict_t head,void (*output)(void*)); - /** @} */ -/** @name 3. Non-null terminated keys +/** @defgroup XBT_dict_nnul Dictionaries 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, + 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); + 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_get_or_null_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 dictionaries + * @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. + * Don't get impressed, there is a lot of functions here, but traversing a + * dictionary is immediate with the xbt_dict_foreach macro. * You only need the other functions in rare cases (they are not used directly in SG itself). * - * Here is an example (assuming that the dictionnary contains strings, ie + * Here is an example (assuming that the dictionary contains strings, ie * that the data argument of xbt_dict_set was always a null-terminated char*): \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 @@ -103,21 +107,21 @@ BEGIN_DECL() * * @{ */ - /** @brief Cursor on dictionnaries (opaque type) */ + /** @brief Cursor on dictionaries (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 @@ -128,11 +132,12 @@ BEGIN_DECL() xbt_dict_cursor_step(cursor) ) /** @} */ -/** @name 5. Multi-dictionnary +/** @defgroup XBT_dict_multi Multi-level dictionaries + * @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 - * than their simple dictionnary counterpart. + * They can be seen as dictionary of multiple keys or as dictionary of + * dictionary of ... of data. Most of the functions here work the same way + * than their simple dictionary counterpart. * * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions. * Use xbt_dict_free() and xbt_dict_new() instead. @@ -141,33 +146,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 ]--------------------------------------------------*/ -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); + 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); -/** @} */ /** @} */ -END_DECL() +SG_END_DECL() #endif /* _XBT_DICT_H */