X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/76704f3ac0573d64cecc0f39d9f9f7296234bb93..d24f6738f58de48ac1fea23849f12285034f86c4:/include/xbt/dict.h diff --git a/include/xbt/dict.h b/include/xbt/dict.h index e35a5224ff..4f2a88c3be 100644 --- a/include/xbt/dict.h +++ b/include/xbt/dict.h @@ -1,8 +1,7 @@ -/* $Id$ */ - /* xbt/dict.h -- api to a generic dictionary */ -/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */ +/* Copyright (c) 2004-2013. 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. */ @@ -13,9 +12,9 @@ #include "xbt/misc.h" /* SG_BEGIN_DECL */ #include "xbt/dynar.h" /* void_f_pvoid_t */ -#include /* uintptr_t */ +#include /* uintptr_t */ -SG_BEGIN_DECL(); +SG_BEGIN_DECL() /** @addtogroup XBT_dict * @brief The dictionary data structure (comparable to hash tables) @@ -25,7 +24,9 @@ SG_BEGIN_DECL(); * functionality than an hash table. * * Here is a little example of use: - * \verbatim xbt_dict_t mydict = xbt_dict_new(); + +\verbatim + xbt_dict_t mydict = xbt_dict_new(); char buff[512]; sprintf(buff,"some very precious data"); @@ -44,8 +45,21 @@ SG_BEGIN_DECL(); */ /** \brief Dictionary data type (opaque structure) */ -typedef struct xbt_dict_ *xbt_dict_t; + +typedef struct s_xbt_dict *xbt_dict_t; +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(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); @@ -62,7 +76,9 @@ 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_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); @@ -70,6 +86,7 @@ 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); /** @} */ @@ -85,16 +102,17 @@ XBT_PUBLIC(void) xbt_dict_set_ext(xbt_dict_t dict, 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_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_dicti_set(xbt_dict_t dict, uintptr_t key, uintptr_t data); +#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 /** @} */ /** @defgroup XBT_dict_curs Cursors on dictionaries @@ -119,29 +137,60 @@ XBT_PUBLIC(void) xbt_dicti_remove(xbt_dict_t dict, uintptr_t key); * @{ */ /** @brief Cursor on dictionaries (opaque type) */ - typedef struct xbt_dict_cursor_ *xbt_dict_cursor_t; +struct s_xbt_dict_cursor { + xbt_dictelm_t current; + int line; + xbt_dict_t dict; +}; +typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t; + +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_INLINE 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(void) xbt_dict_cursor_first(const xbt_dict_t dict, xbt_dict_cursor_t * cursor); -XBT_INLINE XBT_PUBLIC(void) xbt_dict_cursor_step(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 - @hideinitializer */ +/** @def xbt_dict_foreach + * @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 +xbt_dict_cursor_t cursor = NULL; +char *key; +char *data; + +xbt_dict_foreach(head, cursor, key, data) { + printf("Key %s with data %s\n",key,data); +} +\endcode + */ # 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_get_or_free(&(cursor),(char**)&(key),(void**)(&data));\ xbt_dict_cursor_step(cursor) ) /** @} */ + +#ifdef XBT_USE_DEPRECATED /** @defgroup XBT_dict_multi Multi-level dictionaries * @ingroup XBT_dict * @@ -155,12 +204,6 @@ XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor, * @{ */ -/** \brief To dump multicache, this function dumps a cache */ -XBT_PUBLIC(void) xbt_dict_print(void *data); -/** \brief To dump multicache, this one dumps a string */ -XBT_PUBLIC(void) xbt_dict_prints(void *data); - - /*----[ xbt_multidict_set ]--------------------------------------------------*/ XBT_PUBLIC(void) xbt_multidict_set(xbt_dict_t mdict, @@ -172,16 +215,19 @@ xbt_multidict_set_ext(xbt_dict_t mdict, /*----[ 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_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_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 */