X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2d2995483b57463581ffdc4365fe1999ddc306c2..f67e9f5d0e553ae935bd6cad29df46f1565173bf:/src/xbt/dict.cpp diff --git a/src/xbt/dict.cpp b/src/xbt/dict.cpp index bac3293e2d..7a295c5b72 100644 --- a/src/xbt/dict.cpp +++ b/src/xbt/dict.cpp @@ -1,30 +1,29 @@ /* dict - a generic dictionary, variation over hash table */ -/* Copyright (c) 2004-2018. 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. */ -#include -#include - #include "xbt/dict.h" +#include "dict_private.h" +#include "simgrid/Exception.hpp" +#include "src/xbt_modinter.h" #include "xbt/ex.h" -#include #include "xbt/log.h" #include "xbt/mallocator.h" -#include "src/xbt_modinter.h" #include "xbt/str.h" -#include "dict_private.h" + +#include +#include XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict, xbt, "Dictionaries provide the same functionalities as hash tables"); /** - * \brief Constructor - * \param free_ctn function to call with (\a data as argument) when \a data is removed from the dictionary - * \return pointer to the destination - * \see xbt_dict_free() + * @brief Constructor + * @param free_ctn function to call with (@a data as argument) when @a data is removed from the dictionary + * @return pointer to the destination + * @see xbt_dict_free() * * Creates and initialize a new dictionary with a default hashtable size. * The dictionary is homogeneous: each element share the same free function. @@ -47,8 +46,8 @@ xbt_dict_t xbt_dict_new_homogeneous(void_f_pvoid_t free_ctn) } /** - * \brief Destructor - * \param dict the dictionary to be freed + * @brief Destructor + * @param dict the dictionary to be freed * * Frees a dictionary with all the data */ @@ -123,15 +122,15 @@ static void xbt_dict_rehash(xbt_dict_t dict) } /** - * \brief Add data to the dict (arbitrary key) - * \param dict the container - * \param key the key to set the new data - * \param key_len the size of the \a key - * \param data the data to add in the dict - * \param free_ctn unused parameter (kept for compatibility) + * @brief Add data to the dict (arbitrary key) + * @param dict the container + * @param key the key to set the new data + * @param key_len the size of the @a key + * @param data the data to add in the dict + * @param free_ctn unused parameter (kept for compatibility) * - * Set the \a data in the structure under the \a key, which can be any kind of data, as long as its length is provided - * in \a key_len. + * Set the @a data in the structure under the @a key, which can be any kind of data, as long as its length is provided + * in @a key_len. */ void xbt_dict_set_ext(xbt_dict_t dict, const char* key, int key_len, void* data, XBT_ATTRIB_UNUSED void_f_pvoid_t free_ctn) @@ -171,14 +170,14 @@ void xbt_dict_set_ext(xbt_dict_t dict, const char* key, int key_len, void* data, } /** - * \brief Add data to the dict (null-terminated key) + * @brief Add data to the dict (null-terminated key) * - * \param dict the dict - * \param key the key to set the new data - * \param data the data to add in the dict - * \param free_ctn unused parameter (kept for compatibility) + * @param dict the dict + * @param key the key to set the new data + * @param data the data to add in the dict + * @param free_ctn unused parameter (kept for compatibility) * - * set the \a data in the structure under the \a key, which is anull terminated string. + * set the @a data in the structure under the @a key, which is anull terminated string. */ void xbt_dict_set(xbt_dict_t dict, const char *key, void *data, void_f_pvoid_t free_ctn) { @@ -186,14 +185,14 @@ void xbt_dict_set(xbt_dict_t dict, const char *key, void *data, void_f_pvoid_t f } /** - * \brief Retrieve data from the dict (arbitrary key) + * @brief Retrieve data from the dict (arbitrary key) * - * \param dict the dealer of data - * \param key the key to find data - * \param key_len the size of the \a key - * \return the data that we are looking for + * @param dict the dealer of data + * @param key the key to find data + * @param key_len the size of the @a key + * @return the data that we are looking for * - * Search the given \a key. Throws not_found_error when not found. + * Search the given @a key. Throws not_found_error when not found. */ void *xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len) { @@ -247,13 +246,13 @@ char *xbt_dict_get_key(xbt_dict_t dict, const void *data) } /** - * \brief Retrieve data from the dict (null-terminated key) + * @brief Retrieve data from the dict (null-terminated key) * - * \param dict the dealer of data - * \param key the key to find data - * \return the data that we are looking for + * @param dict the dealer of data + * @param key the key to find data + * @return the data that we are looking for * - * Search the given \a key. Throws not_found_error when not found. + * Search the given @a key. Throws not_found_error when not found. * Check xbt_dict_get_or_null() for a version returning nullptr without exception when not found. */ void *xbt_dict_get(xbt_dict_t dict, const char *key) @@ -262,13 +261,13 @@ void *xbt_dict_get(xbt_dict_t dict, const char *key) } /** - * \brief Retrieve element from the dict (null-terminated key) + * @brief Retrieve element from the dict (null-terminated key) * - * \param dict the dealer of data - * \param key the key to find data - * \return the s_xbt_dictelm_t that we are looking for + * @param dict the dealer of data + * @param key the key to find data + * @return the s_xbt_dictelm_t that we are looking for * - * Search the given \a key. Throws not_found_error when not found. + * Search the given @a key. Throws not_found_error when not found. * Check xbt_dict_get_or_null() for a version returning nullptr without exception when not found. */ xbt_dictelm_t xbt_dict_get_elm(xbt_dict_t dict, const char *key) @@ -282,7 +281,7 @@ xbt_dictelm_t xbt_dict_get_elm(xbt_dict_t dict, const char *key) } /** - * \brief like xbt_dict_get(), but returning nullptr when not found + * @brief like xbt_dict_get(), but returning nullptr when not found */ void *xbt_dict_get_or_null(xbt_dict_t dict, const char *key) { @@ -295,7 +294,7 @@ void *xbt_dict_get_or_null(xbt_dict_t dict, const char *key) } /** - * \brief like xbt_dict_get_elm(), but returning nullptr when not found + * @brief like xbt_dict_get_elm(), but returning nullptr when not found */ xbt_dictelm_t xbt_dict_get_elm_or_null(xbt_dict_t dict, const char *key) { @@ -308,13 +307,13 @@ xbt_dictelm_t xbt_dict_get_elm_or_null(xbt_dict_t dict, const char *key) } /** - * \brief Remove data from the dict (arbitrary key) + * @brief Remove data from the dict (arbitrary key) * - * \param dict the trash can - * \param key the key of the data to be removed - * \param key_len the size of the \a key + * @param dict the trash can + * @param key the key of the data to be removed + * @param key_len the size of the @a key * - * Remove the entry associated with the given \a key (throws not_found) + * Remove the entry associated with the given @a key (throws not_found) */ void xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len) { @@ -346,12 +345,12 @@ void xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len) } /** - * \brief Remove data from the dict (null-terminated key) + * @brief Remove data from the dict (null-terminated key) * - * \param dict the dict - * \param key the key of the data to be removed + * @param dict the dict + * @param key the key of the data to be removed * - * Remove the entry associated with the given \a key + * Remove the entry associated with the given @a key */ void xbt_dict_remove(xbt_dict_t dict, const char *key) { @@ -380,8 +379,8 @@ void xbt_dict_reset(xbt_dict_t dict) } /** - * \brief Return the number of elements in the dict. - * \param dict a dictionary + * @brief Return the number of elements in the dict. + * @param dict a dictionary */ int xbt_dict_length(xbt_dict_t dict) { @@ -389,7 +388,7 @@ int xbt_dict_length(xbt_dict_t dict) } /** - * \brief test if the dict is empty or not + * @brief test if the dict is empty or not */ int xbt_dict_is_empty(xbt_dict_t dict) { @@ -397,13 +396,13 @@ int xbt_dict_is_empty(xbt_dict_t dict) } /** - * \brief Outputs the content of the structure (debugging purpose) + * @brief Outputs the content of the structure (debugging purpose) * - * \param dict the exibitionist - * \param output a function to dump each data in the tree + * @param dict the exibitionist + * @param output a function to dump each data in the tree * * Outputs the content of the structure. (for debugging purpose). - * \a output is a function to output the data. If nullptr, data won't be displayed. + * @a output is a function to output the data. If nullptr, data won't be displayed. */ void xbt_dict_dump(xbt_dict_t dict, void_f_pvoid_t output) { @@ -455,11 +454,11 @@ void xbt_dict_postexit() } #ifdef SIMGRID_TEST +#include "simgrid/Exception.hpp" #include "src/internal_config.h" #include "xbt.h" #include "xbt/ex.h" #include -#include XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_dict);