X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/aa7c707291dd1533fcac940f565b42188d558798..7392b17f0fee990af059ca94a2141236aa24d0c1:/src/xbt/dict.c diff --git a/src/xbt/dict.c b/src/xbt/dict.c index 6602cc0023..fb87393c85 100644 --- a/src/xbt/dict.c +++ b/src/xbt/dict.c @@ -2,14 +2,11 @@ /* dict - a generic dictionnary, variation over the B-tree concept */ -/* Authors: Martin Quinson */ -/* Copyright (C) 2003 the OURAGAN project. */ +/* Copyright (c) 2003,2004 Martin Quinson. 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. */ + * under the terms of the license (GNU LGPL) which comes with this package. */ - -#include "gras_private.h" #include "dict_private.h" #include /* malloc() */ @@ -17,191 +14,187 @@ #include -GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(dict,GRAS); - +XBT_LOG_NEW_DEFAULT_SUBCATEGORY(dict,xbt, + "Dictionaries provide the same functionnalities than hash tables"); /*####[ Private prototypes ]#################################################*/ - /*####[ Code ]###############################################################*/ /** - * gras_dict_new: + * \ingroup XBT_dict * - * @whereto: pointer to the destination + * \return pointer to the destination * * Creates and initialize a new dictionnary */ -gras_error_t -gras_dict_new(gras_dict_t **whereto) { - gras_dict_t *dict; - - if (!(dict = calloc(1, sizeof(gras_dict_t)))) - RAISE_MALLOC; - - dict->head=NULL; - - *whereto = dict; - - return no_error; +xbt_dict_t +xbt_dict_new(void) { + xbt_dict_t res= xbt_new(s_xbt_dict_t,1); + res->head=NULL; + return res; } /** - * gras_dict_free: - * @dict: the dictionnary to be freed + * \ingroup XBT_dict + * \param dict the dictionnary to be freed * * Frees a cache structure with all its childs. */ void -gras_dict_free(gras_dict_t **dict) { +xbt_dict_free(xbt_dict_t *dict) { if (dict && *dict) { if ((*dict)->head) { - gras_dictelm_free( &( (*dict)->head ) ); + xbt_dictelm_free( &( (*dict)->head ) ); (*dict)->head = NULL; } - free(*dict); + xbt_free(*dict); *dict=NULL; } } /** - * gras_dict_insert_ext: + * \ingroup XBT_dict * - * @p_dict: the container - * @key: the key to insert the new data - * @data: the data to add in the dict - * @Returns: a gras_error + * \param dict the container + * \param key the key to set the new data + * \param key_len the size of the #key + * \param data the data to add in the dict + * \param free_ctn function to call with (#key as argument) when + * #key is removed from the dictionnary * - * Insert the @data in the structure under the @key, which can be any kind - * of data, as long as its length is provided in @key_len. + * set the #data in the structure under the #key, which can be any kind + * of data, as long as its length is provided in #key_len. */ -gras_error_t -gras_dict_insert_ext(gras_dict_t *p_dict, - const char *key, - int key_len, - void *data, - void_f_pvoid_t *free_ctn) { +void +xbt_dict_set_ext(xbt_dict_t dict, + const char *key, + int key_len, + void *data, + void_f_pvoid_t *free_ctn) { - gras_assert(p_dict); + xbt_assert(dict); - return gras_dictelm_insert_ext(&(p_dict->head), - key, key_len, data, free_ctn); + xbt_dictelm_set_ext(&(dict->head), + key, key_len, data, free_ctn); } /** - * gras_dict_insert: + * \ingroup XBT_dict * - * @head: the head of the dict - * @key: the key to insert the new data - * @data: the data to add in the dict - * @Returns: a gras_error + * \param dict the head of the dict + * \param key the key to set the new data + * \param data the data to add in the dict + * \param free_ctn function to call with (#key as argument) when + * #key is removed from the dictionnary * - * Insert the @data in the structure under the @key, which is a + * set the #data in the structure under the #key, which is a * null terminated string. */ -gras_error_t -gras_dict_insert(gras_dict_t *p_dict, - const char *key, - void *data, - void_f_pvoid_t *free_ctn) { +void +xbt_dict_set(xbt_dict_t dict, + const char *key, + void *data, + void_f_pvoid_t *free_ctn) { - gras_assert(p_dict); + xbt_assert(dict); - return gras_dictelm_insert(&(p_dict->head), key, data, free_ctn); + xbt_dictelm_set(&(dict->head), key, data, free_ctn); } /** - * gras_dict_retrieve_ext: + * \ingroup XBT_dict * - * @dict: the dealer of data - * @key: the key to find data - * @data: the data that we are looking for - * @Returns: gras_error + * \param dict the dealer of data + * \param key the key to find data + * \param key_len the size of the #key + * \param data the data that we are looking for + * \return xbt_error * - * Search the given @key. mismatch_error when not found. + * Search the given #key. mismatch_error when not found. */ -gras_error_t -gras_dict_retrieve_ext(gras_dict_t *dict, - const char *key, - int key_len, - /* OUT */void **data) { +xbt_error_t +xbt_dict_get_ext(xbt_dict_t dict, + const char *key, + int key_len, + /* OUT */void **data) { - gras_assert(dict); + xbt_assert(dict); - return gras_dictelm_retrieve_ext(dict->head, key, key_len, data); + return xbt_dictelm_get_ext(dict->head, key, key_len, data); } /** - * gras_dict_retrieve: + * \ingroup XBT_dict * - * @dict: the dealer of data - * @key: the key to find data - * @data: the data that we are looking for - * @Returns: gras_error + * \param dict the dealer of data + * \param key the key to find data + * \param data the data that we are looking for + * \return xbt_error * - * Search the given @key. mismatch_error when not found. + * Search the given #key. mismatch_error when not found. */ -gras_error_t -gras_dict_retrieve(gras_dict_t *dict, - const char *key, - /* OUT */void **data) { - gras_assert(dict); +xbt_error_t +xbt_dict_get(xbt_dict_t dict, + const char *key, + /* OUT */void **data) { + xbt_assert(dict); - return gras_dictelm_retrieve(dict->head, key, data); + return xbt_dictelm_get(dict->head, key, data); } /** - * gras_dict_remove_ext: + * \ingroup XBT_dict * - * @dict: the trash can - * @key: the key of the data to be removed - * @Returns: gras_error_t + * \param dict the trash can + * \param key the key of the data to be removed + * \param key_len the size of the #key + * \return xbt_error_t * - * Remove the entry associated with the given @key + * Remove the entry associated with the given #key */ -gras_error_t -gras_dict_remove_ext(gras_dict_t *dict, +xbt_error_t +xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len) { - gras_assert(dict); + xbt_assert(dict); - return gras_dictelm_remove_ext(dict->head, key, key_len); + return xbt_dictelm_remove_ext(dict->head, key, key_len); } /** - * gras_dict_remove: + * \ingroup XBT_dict * - * @head: the head of the dict - * @key: the key of the data to be removed - * @Returns: gras_error_t + * \param dict the head of the dict + * \param key the key of the data to be removed + * \return xbt_error_t * - * Remove the entry associated with the given @key + * Remove the entry associated with the given #key */ -gras_error_t -gras_dict_remove(gras_dict_t *dict, +xbt_error_t +xbt_dict_remove(xbt_dict_t dict, const char *key) { if (!dict) RAISE1(mismatch_error,"Asked to remove key %s from NULL dict",key); - return gras_dictelm_remove(dict->head, key); + return xbt_dictelm_remove(dict->head, key); } /** - * gras_dict_dump: + * \ingroup XBT_dict * - * @dict: the exibitionist - * @output: a function to dump each data in the tree - * @Returns: gras_error_t + * \param dict the exibitionist + * \param output a function to dump each data in the tree + * \return xbt_error_t * - * Ouputs the content of the structure. (for debuging purpose). @ouput is a + * Ouputs the content of the structure. (for debuging purpose). #ouput is a * function to output the data. If NULL, data won't be displayed. */ -gras_error_t -gras_dict_dump(gras_dict_t *dict, +void +xbt_dict_dump(xbt_dict_t dict, void_f_pvoid_t *output) { - printf("Dict %p:\n", dict); - return gras_dictelm_dump(dict ? dict->head: NULL, output); + printf("Dict %p:\n", (void*)dict); + xbt_dictelm_dump(dict ? dict->head: NULL, output); } -