X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9f091df92f0ee7966a3a75ff8461a134c93214a9..f497a65ba1f3ee297eb65e7ee1d3ca2d403223db:/include/xbt/dict.h diff --git a/include/xbt/dict.h b/include/xbt/dict.h index 8153b3ede9..9d3406348e 100644 --- a/include/xbt/dict.h +++ b/include/xbt/dict.h @@ -12,6 +12,7 @@ #define _XBT_DICT_H #include "xbt/misc.h" /* BEGIN_DECL */ +#include "xbt/dynar.h" /* void_f_pvoid_t */ #include "xbt/error.h" BEGIN_DECL() @@ -28,7 +29,7 @@ BEGIN_DECL() char buff[512]; sprintf(buff,"some very precious data"); - xbt_dict_set(mydict,"my data", strdump(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 @@ -60,9 +61,11 @@ BEGIN_DECL() * * @{ */ - 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_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*)); /** @} */ @@ -72,14 +75,12 @@ BEGIN_DECL() * * @{ */ - 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); + void xbt_dict_set_ext(xbt_dict_t head, + 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); /** @} */ @@ -103,7 +104,7 @@ BEGIN_DECL() * * @{ */ - /** \brief Cursor on dictionnaries (opaque type) */ + /** @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); @@ -111,10 +112,8 @@ BEGIN_DECL() 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); + char * xbt_dict_cursor_get_key (xbt_dict_cursor_t cursor); + void * xbt_dict_cursor_get_data (xbt_dict_cursor_t cursor); void xbt_dict_cursor_first (const xbt_dict_t dict, xbt_dict_cursor_t *cursor); @@ -122,69 +121,53 @@ BEGIN_DECL() int xbt_dict_cursor_get_or_free (xbt_dict_cursor_t *cursor, char **key, void **data); - /** \brief toto - \hideinitializer */ + /** @def xbt_dict_foreach + @hideinitializer */ # define xbt_dict_foreach(dict,cursor,key,data) \ for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ; \ xbt_dict_cursor_get_or_free(&(cursor),&(key),(void**)(&data));\ xbt_dict_cursor_step(cursor) ) /** @} */ -/** @} */ - -#if 0 - - MULTI-DICTS ARE BROKEN - +/** @name 5. Multi-dictionnary + * + * 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. + * + * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions. + * Use xbt_dict_free() and xbt_dict_new() instead. + * + * @{ + */ -/*####[ Multi cache functions ]##############################################*/ -/* The are cache of cache of data. Any function there works the same way */ -/* than their simple cache counterpart. */ -/*###############################"###########################################*/ -/* To dump multicache, this function dumps a cache */ +/** \brief To dump multicache, this function dumps a cache */ void xbt_dict_print(void *data); -/* To dump multicache, this one dumps a string */ +/** \brief To dump multicache, this one dumps a string */ void xbt_dict_prints(void *data); -/*----[ xbt_multidict_free ]------------------------------------------------*/ -/* This function does not exist. Use xbt_dict_free instead. */ -/*---------------------------------------------------------------------------*/ - -/*----[ xbt_multidict_set ]-------------------------------------------------*/ -/* Insert the data in the structure under the #keycount# #key#s. */ -/* The key are destroyed in the process. Think to strdup it before. */ -/* Returns if it was ok or not */ -/*---------------------------------------------------------------------------*/ -xbt_error_t xbt_multidict_set(xbt_dict_t *head, - int keycount,char **key, - void *data,void (*free_ctn)(void*)); - -xbt_error_t xbt_multidict_set_ext(xbt_dict_t *head, - int keycount,char **key,int *key_len, - void *data,void_f_pvoid_t *free_ctn); -/*----[ xbt_multidict_get ]-------------------------------------------------*/ -/* Search the given #key#. data=NULL when not found. */ -/* Returns true if anything went ok, and false on internal error. */ -/*---------------------------------------------------------------------------*/ -xbt_error_t xbt_multidict_get(xbt_dict_t head, - int keycount,const char **key, - /* OUT */void **data); +/*----[ xbt_multidict_set ]--------------------------------------------------*/ +void +xbt_multidict_set(xbt_dict_t mdict, + xbt_dynar_t keys, + void *data,void (*free_ctn)(void*)); +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_error_t xbt_multidict_get_ext(xbt_dict_t head, - int keycount,const char **key,int *key_len, - /* OUT */void **data); +/*----[ 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_multidict_remove ]----------------------------------------------*/ -/* Remove the entry associated with the given #key#. */ -/* Returns if ok. Removing a non-existant key is ok. */ +/*----[ xbt_multidict_remove ]-----------------------------------------------*/ /*---------------------------------------------------------------------------*/ -xbt_error_t xbt_multidict_remove(xbt_dict_t head, - int keycount,const char **key); +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_error_t xbt_multidict_remove_ext(xbt_dict_t head, - int keycount,const char **key,int *key_len); -#endif +/** @} */ +/** @} */ END_DECL()