X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a460df7816cc70842156226878a57bd8aa1f9833..3297da9f47ce18371941b2b48a2f4018b4793ced:/include/xbt/dict.h diff --git a/include/xbt/dict.h b/include/xbt/dict.h index ac3917c042..89aaba22ea 100644 --- a/include/xbt/dict.h +++ b/include/xbt/dict.h @@ -1,6 +1,6 @@ /* xbt/dict.h -- api to a generic dictionary */ -/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -8,8 +8,9 @@ #ifndef XBT_DICT_H #define XBT_DICT_H -#include "xbt/misc.h" /* SG_BEGIN_DECL */ -#include "xbt/dynar.h" /* void_f_pvoid_t */ +#include /* void_f_pvoid_t */ +#include /* SG_BEGIN_DECL */ + #include /* uintptr_t */ SG_BEGIN_DECL() @@ -24,16 +25,16 @@ SG_BEGIN_DECL() * * Here is a little example of use: -\verbatim - xbt_dict_t mydict = xbt_dict_new(); +@verbatim + xbt_dict_t mydict = xbt_dict_new_homogeneous(free); 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), NULL); sprintf(buff,"another good stuff"); - xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add -\endverbatim + xbt_dict_set(mydict,"my data", strdup(buff), NULL); // previous data gets erased (and freed) by second add +@endverbatim */ /** @defgroup XBT_dict_cons Dict constructor and destructor @@ -42,7 +43,7 @@ SG_BEGIN_DECL() * @{ */ - /** \brief Dictionary data type (opaque structure) */ +/** @brief Dictionary data type (opaque structure) */ typedef struct s_xbt_dict *xbt_dict_t; typedef struct s_xbt_dictelm *xbt_dictelm_t; typedef struct s_xbt_dictelm { @@ -55,11 +56,9 @@ typedef struct s_xbt_dictelm { xbt_dictelm_t next; } s_xbt_dictelm_t; -XBT_PUBLIC(xbt_dict_t) -XBT_ATTRIB_DEPRECATED_v319("Use xbt_dict_new_homogeneous(). v3.19 will turn this warning into an error") xbt_dict_new(); -XBT_PUBLIC(xbt_dict_t) xbt_dict_new_homogeneous(void_f_pvoid_t free_ctn); -XBT_PUBLIC(void) xbt_dict_free(xbt_dict_t * dict); -XBT_PUBLIC(unsigned int) xbt_dict_size(xbt_dict_t dict); +XBT_PUBLIC xbt_dict_t xbt_dict_new_homogeneous(void_f_pvoid_t free_ctn); +XBT_PUBLIC void xbt_dict_free(xbt_dict_t* dict); +XBT_PUBLIC unsigned int xbt_dict_size(xbt_dict_t dict); /** @} */ /** @defgroup XBT_dict_basic Dictionaries basic usage @@ -70,22 +69,18 @@ XBT_PUBLIC(unsigned int) xbt_dict_size(xbt_dict_t dict); * @{ */ -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(char *) xbt_dict_get_key(xbt_dict_t dict, const void *data); -XBT_PUBLIC(char *) xbt_dict_get_elm_key(xbt_dictelm_t elem); -XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm(xbt_dict_t dict, const char *key); -XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm_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_output_string(void *s); -XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output) (void *)); -XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict); -XBT_PUBLIC(int) xbt_dict_is_empty(xbt_dict_t dict); +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 char* xbt_dict_get_key(xbt_dict_t dict, const void* data); +XBT_PUBLIC xbt_dictelm_t xbt_dict_get_elm(xbt_dict_t dict, const char* key); +XBT_PUBLIC xbt_dictelm_t xbt_dict_get_elm_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 int xbt_dict_is_empty(xbt_dict_t dict); /** @} */ /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys @@ -95,10 +90,10 @@ XBT_PUBLIC(int) xbt_dict_is_empty(xbt_dict_t dict); * * @{ */ -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_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); +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_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); struct s_xbt_dict_cursor { xbt_dictelm_t current; @@ -116,15 +111,15 @@ struct s_xbt_dict_cursor { * * Here is an example (assuming that the dictionary contains strings, i.e., that the data argument of * xbt_dict_set was always a null-terminated char*): -\verbatim xbt_dict_cursor_t cursor=NULL; +@verbatim xbt_dict_cursor_t cursor=NULL; char *key,*data; xbt_dict_foreach(dict,cursor,key,data) { printf(" - Seen: %s->%s\n",key,data); - }\endverbatim + }@endverbatim * - * \warning Do not add or remove entries to the cache while traversing !! + * @warning Do not add or remove entries to the cache while traversing !! * * @{ */ @@ -135,28 +130,26 @@ static inline xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor) { return cursor->current; } -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); +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); -XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor); +XBT_PUBLIC void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor); -xbt_dictelm_t xbt_dict_cursor_get_elm(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); -XBT_PUBLIC(void) xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor, void *data, void_f_pvoid_t free_ctn); +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); -XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict, 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); +XBT_PUBLIC void xbt_dict_cursor_first(const xbt_dict_t dict, 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 - * @param dict a \ref xbt_dict_t iterator - * @param cursor an \ref xbt_dict_cursor_t used as cursor + * @param dict a @ref xbt_dict_t iterator + * @param cursor an @ref xbt_dict_cursor_t used as cursor * @param key a char* * @param data a void** output * @hideinitializer * - * \note An example of usage: - * \code + * @note An example of usage: + * @code xbt_dict_cursor_t cursor = NULL; char *key; char *data; @@ -164,7 +157,7 @@ char *data; xbt_dict_foreach(head, cursor, key, data) { printf("Key %s with data %s\n",key,data); } -\endcode +@endcode */ # define xbt_dict_foreach(dict,cursor,key,data) \ for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ; \