X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/40c50e73054c04f97b5e5a618f1676eb5c3c9658..79d9a0eadea4d00dbf2de0c19f6a8c0451f40e34:/include/xbt/dict.h diff --git a/include/xbt/dict.h b/include/xbt/dict.h index 1dc5685c94..589af4a591 100644 --- a/include/xbt/dict.h +++ b/include/xbt/dict.h @@ -1,17 +1,16 @@ /* xbt/dict.h -- api to a generic dictionary */ -/* Copyright (c) 2004-2011. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2004-2019. 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. */ +#ifndef XBT_DICT_H +#define XBT_DICT_H -#ifndef _XBT_DICT_H -#define _XBT_DICT_H +#include /* void_f_pvoid_t */ +#include /* SG_BEGIN_DECL */ -#include "xbt/misc.h" /* SG_BEGIN_DECL */ -#include "xbt/dynar.h" /* void_f_pvoid_t */ #include /* uintptr_t */ SG_BEGIN_DECL() @@ -19,21 +18,23 @@ SG_BEGIN_DECL() /** @addtogroup XBT_dict * @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. + * 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. + * + * @deprecated If you are using C++, you might want to use `std::unordered_map` instead. * * 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,12 +43,22 @@ SG_BEGIN_DECL() * @{ */ - /** \brief Dictionary data type (opaque structure) */ +/** @brief Dictionary data type (opaque structure) */ typedef struct s_xbt_dict *xbt_dict_t; -XBT_PUBLIC(xbt_dict_t) xbt_dict_new(void); -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); +typedef struct s_xbt_dictelm *xbt_dictelm_t; +typedef struct s_xbt_dictelm { + char *key; + int key_len; + unsigned int hash_code; + + void *content; + + xbt_dictelm_t next; +} s_xbt_dictelm_t; + +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 @@ -58,20 +69,17 @@ 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(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 int xbt_dict_is_empty(xbt_dict_t dict); /** @} */ /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys @@ -81,73 +89,66 @@ 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); - -#ifdef XBT_USE_DEPRECATED -XBT_PUBLIC(void) xbt_dicti_set(xbt_dict_t dict, uintptr_t key, - uintptr_t data); -XBT_PUBLIC(uintptr_t) xbt_dicti_get(xbt_dict_t dict, uintptr_t key); -XBT_PUBLIC(void) xbt_dicti_remove(xbt_dict_t dict, uintptr_t key); -#endif +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; + int line; + xbt_dict_t dict; +}; /** @} */ /** @defgroup XBT_dict_curs Cursors on dictionaries * @ingroup XBT_dict * - * Don't get impressed, there is a lot of functions here, but traversing a - * dictionary is immediate 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 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; + * 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; 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 !! * * @{ */ - /** @brief Cursor on dictionaries (opaque type) */ +/** @brief Cursor on dictionaries (opaque type) */ typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t; -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); +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 void xbt_dict_cursor_rewind(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; @@ -155,7 +156,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)) ; \ @@ -164,44 +165,6 @@ xbt_dict_foreach(head, cursor, key, data) { /** @} */ -#ifdef XBT_USE_DEPRECATED -/** @defgroup XBT_dict_multi Multi-level dictionaries - * @ingroup XBT_dict - * - * 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. - * - * @{ - */ - -/*----[ xbt_multidict_set ]--------------------------------------------------*/ -XBT_PUBLIC(void) -xbt_multidict_set(xbt_dict_t mdict, - xbt_dynar_t keys, void *data, void (*free_ctn) (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); - -/*----[ xbt_multidict_get ]--------------------------------------------------*/ -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_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); - -/** @} */ -#endif - SG_END_DECL() -#endif /* _XBT_DICT_H */ + +#endif /* XBT_DICT_H */