X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/17616c140fdd6df448bf3b89e258e0bcd4f0ff0d..84402e8e2ee2a2d0bef25fdceb0a263ed8b471f6:/include/xbt/dict.h?ds=sidebyside diff --git a/include/xbt/dict.h b/include/xbt/dict.h index 89e18d743f..02ca030a76 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-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2020. 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. */ @@ -30,10 +30,10 @@ SG_BEGIN_DECL char buff[512]; sprintf(buff,"some very precious data"); - xbt_dict_set(mydict,"my data", strdup(buff), NULL); + xbt_dict_set(mydict,"my data", strdup(buff)); sprintf(buff,"another good stuff"); - xbt_dict_set(mydict,"my data", strdup(buff), NULL); // previous data gets erased (and freed) by second add + xbt_dict_set(mydict,"my data", strdup(buff)); // previous data gets erased (and freed) by second add @endverbatim */ @@ -45,6 +45,7 @@ SG_BEGIN_DECL /** @brief Dictionary data type (opaque structure) */ typedef struct s_xbt_dict *xbt_dict_t; +typedef const struct s_xbt_dict* const_xbt_dict_t; typedef struct s_xbt_dictelm *xbt_dictelm_t; typedef struct s_xbt_dictelm { char *key; @@ -58,7 +59,7 @@ typedef struct s_xbt_dictelm { 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 unsigned int xbt_dict_size(const_xbt_dict_t dict); /** @} */ /** @defgroup XBT_dict_basic Dictionaries basic usage @@ -69,17 +70,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 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_set(xbt_dict_t dict, const char* key, void* data); +XBT_PUBLIC void* xbt_dict_get(const_xbt_dict_t dict, const char* key); +XBT_PUBLIC void* xbt_dict_get_or_null(const_xbt_dict_t dict, const char* key); +XBT_PUBLIC char* xbt_dict_get_key(const_xbt_dict_t dict, const void* data); +XBT_PUBLIC xbt_dictelm_t xbt_dict_get_elm(const_xbt_dict_t dict, const char* key); +XBT_PUBLIC xbt_dictelm_t xbt_dict_get_elm_or_null(const_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); +XBT_PUBLIC int xbt_dict_length(const_xbt_dict_t dict); +XBT_PUBLIC int xbt_dict_is_empty(const_xbt_dict_t dict); /** @} */ /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys @@ -89,15 +90,15 @@ 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_set_ext(xbt_dict_t dict, const char* key, int key_len, void* data); +XBT_PUBLIC void* xbt_dict_get_ext(const_xbt_dict_t dict, const char* key, int key_len); +XBT_PUBLIC void* xbt_dict_get_or_null_ext(const_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; + const_xbt_dict_t dict; }; /** @} */ @@ -124,20 +125,22 @@ struct s_xbt_dict_cursor { /** @brief Cursor on dictionaries (opaque type) */ typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t; +typedef const struct s_xbt_dict_cursor* const_xbt_dict_cursor_t; -static inline xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor) { +static inline xbt_dictelm_t xbt_dict_cursor_get_elm(const_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 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 char* xbt_dict_cursor_get_key(const_xbt_dict_cursor_t cursor); +XBT_PUBLIC void* xbt_dict_cursor_get_data(const_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_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