X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4b0e03554c924939511bdc75e81f7531765c3160..c41f6db03c1da0871287a5b70f919ab44278d938:/include/xbt/dict.h diff --git a/include/xbt/dict.h b/include/xbt/dict.h index 00b5c80dba..daa0a4cef5 100644 --- a/include/xbt/dict.h +++ b/include/xbt/dict.h @@ -11,13 +11,18 @@ #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) + * + *
Top [\ref index]::[\ref XBT_API] + *
Prev [\ref XBT_dynar] + *
Next [\ref XBT_set] + *
Down [\ref XBT_dict_cons]
* * This section describes the API to a dictionnary structure that * associates as string to a void* key. Even if it provides the same @@ -35,18 +40,16 @@ 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 + * + *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_dict] + *
Prev + *
Next [\ref XBT_dict_basic]
+ * + * @{ */ /** \brief Dictionnary data type (opaque structure) */ @@ -55,36 +58,52 @@ BEGIN_DECL() void xbt_dict_free(xbt_dict_t *dict); /** @} */ -/** @name 2. Dictionnaries basic usage +/** @defgroup XBT_dict_basic Dictionnaries basic usage + * @ingroup XBT_dict + * + *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_dict] + *
Prev [\ref XBT_dict_cons] + *
Next [\ref XBT_dict_nnul]
* * 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); - 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_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 Dictionnaries with non-nul terminated keys + * @ingroup XBT_dict + * + *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_dict] + *
Prev [\ref XBT_dict_basic] + *
Next [\ref XBT_dict_curs]
* * 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); + 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); /** @} */ -/** @name 4. Cursors on dictionnaries +/** @defgroup XBT_dict_curs Cursors on dictionnaries + * @ingroup XBT_dict + * + *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_dict] + *
Prev [\ref XBT_dict_nnul] + *
Next [\ref XBT_dict_multi]
* * Don't get impressed, there is a lot of functions here, but traversing a * dictionnary is imediate with the xbt_dict_foreach macro. @@ -104,7 +123,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); @@ -112,10 +131,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); @@ -123,15 +140,20 @@ 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) ) /** @} */ -/** @name 5. Multi-dictionnary +/** @defgroup XBT_dict_multi Multi-level dictionnaries + * @ingroup XBT_dict + * + *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_dict] + *
Prev [\ref XBT_dict_curs] + *
Next
* * 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 @@ -150,36 +172,26 @@ void xbt_dict_prints(void *data); /*----[ xbt_multidict_set ]--------------------------------------------------*/ -xbt_error_t +void xbt_multidict_set(xbt_dict_t mdict, xbt_dynar_t keys, void *data,void (*free_ctn)(void*)); -xbt_error_t +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); +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 ]-----------------------------------------------*/ /*---------------------------------------------------------------------------*/ -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); +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); /** @} */ -/** @} */ -END_DECL() +SG_END_DECL() #endif /* _XBT_DICT_H */