X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f1068773bda2a9c50385808a643a04e4a1fc2c7a..a07e0280b245200f483e170d446156f1dea261f3:/include/xbt/dict.h diff --git a/include/xbt/dict.h b/include/xbt/dict.h index ad95cc9004..b3cfd35ef3 100644 --- a/include/xbt/dict.h +++ b/include/xbt/dict.h @@ -1,151 +1,178 @@ -/* $Id$ */ +/* xbt/dict.h -- api to a generic dictionary */ -/* gras/dict.h -- api to a generic dictionary */ - -/* Authors: Martin Quinson */ -/* Copyright (C) 2003 the OURAGAN project. */ +/* Copyright (c) 2004-2014. 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 _GRAS_DICT_H -#define _GRAS_DICT_H - -#ifdef __cplusplus -extern "C" -#endif - -/*####[ Type definition ]####################################################*/ -typedef struct gras_dict_ gras_dict_t; - -/*####[ Simple dict functions ]#############################################*/ - -gras_error_t gras_dict_new(gras_dict_t **dict); -void gras_dict_free(gras_dict_t **dict); - - -gras_error_t gras_dict_set (gras_dict_t *head, - const char *key, - void *data, - void_f_pvoid_t *free_ctn); -gras_error_t gras_dict_set_ext(gras_dict_t *head, - const char *key, - int key_len, - void *data, - void_f_pvoid_t *free_ctn); - -/*----[ gras_dict_get ]------------------------------------------------------*/ -/* Search the given #key#. data=NULL when not found. */ -/* Returns true if anything went ok, and false on internal error. */ -/*---------------------------------------------------------------------------*/ -gras_error_t gras_dict_get(gras_dict_t *head,const char *key, - /* OUT */void **data); -gras_error_t gras_dict_get_ext(gras_dict_t *head,const char *key, - int key_len, - /* OUT */void **data); -/*----[ gras_dict_remove ]---------------------------------------------------*/ -/* Remove the entry associated with the given #key#. */ -/* Returns if ok. Removing a non-existant key is ok. */ -/*---------------------------------------------------------------------------*/ -gras_error_t gras_dict_remove(gras_dict_t *head,const char *key); - -gras_error_t gras_dict_remove_ext(gras_dict_t *head,const char *key, - int key_len); - -/*----[ gras_dict_dump ]-----------------------------------------------------*/ -/* Outputs the content of the structure. (for debuging purpose) */ -/* #output# is a function to output the data.If NULL, data won't be displayed*/ -/* Returns if it was ok or not */ -/*---------------------------------------------------------------------------*/ -gras_error_t gras_dict_dump(gras_dict_t *head, - void (*output)(void*)); -/*----[ gras_dict_print ]----------------------------------------------------*/ -/* To dump multicache, this function dump a cache */ -/*---------------------------------------------------------------------------*/ -void gras_dict_print(void *data); -/* To dump multicache, this one dumps a string */ -void gras_dict_prints(void *data); - - -/*####[ Multi cache functions ]##############################################*/ -/* The are cache of cache of data. Any function there works the same way */ -/* than their simple cache counterpart. */ -/*###############################"###########################################*/ - -/*----[ gras_multidict_free ]------------------------------------------------*/ -/* This function does not exist. Use gras_dict_free instead. */ -/*---------------------------------------------------------------------------*/ - -/*----[ gras_multidict_set ]-------------------------------------------------*/ -/* Insert the data in the structure under the #keycount# #key#s. */ -/* The key are destroyed in the process. Think to strdup it before. */ -/* Returns if it was ok or not */ -/*---------------------------------------------------------------------------*/ -gras_error_t gras_multidict_set(gras_dict_t **head, - int keycount,char **key, - void *data,void (*free_ctn)(void*)); - -gras_error_t gras_multidict_set_ext(gras_dict_t **head, - int keycount,char **key,int *key_len, - void *data,void_f_pvoid_t *free_ctn); - -/*----[ gras_multidict_get ]-------------------------------------------------*/ -/* Search the given #key#. data=NULL when not found. */ -/* Returns true if anything went ok, and false on internal error. */ -/*---------------------------------------------------------------------------*/ -gras_error_t gras_multidict_get(gras_dict_t *head, - int keycount,const char **key, - /* OUT */void **data); - -gras_error_t gras_multidict_get_ext(gras_dict_t *head, - int keycount,const char **key,int *key_len, - /* OUT */void **data); - -/*----[ gras_multidict_remove ]----------------------------------------------*/ -/* Remove the entry associated with the given #key#. */ -/* Returns if ok. Removing a non-existant key is ok. */ -/*---------------------------------------------------------------------------*/ -gras_error_t gras_multidict_remove(gras_dict_t *head, - int keycount,const char **key); - -gras_error_t gras_multidict_remove_ext(gras_dict_t *head, - int keycount,const char **key,int *key_len); - -/*####[ Cache cursor functions ]#############################################*/ -/* To traverse (simple) caches */ -/* Don't add or remove entries to the cache while traversing !!! */ -/*###########################################################################*/ -typedef struct gras_dict_cursor_ gras_dict_cursor_t; -/* creator/destructor */ -gras_error_t gras_dict_cursor_new(const gras_dict_t *head, - /*OUT*/gras_dict_cursor_t **cursor); -void gras_dict_cursor_free(gras_dict_cursor_t *cursor); - -/* back to first element - it is not enough to reinit the cache after an add/remove in cache*/ -gras_error_t gras_dict_cursor_rewind(gras_dict_cursor_t *cursor); - - -gras_error_t gras_dict_cursor_get_key (gras_dict_cursor_t *cursor, - /*OUT*/char **key); -gras_error_t gras_dict_cursor_get_data (gras_dict_cursor_t *cursor, - /*OUT*/void **data); - - -void gras_dict_cursor_first (const gras_dict_t *dict, - gras_dict_cursor_t **cursor); -void gras_dict_cursor_step (gras_dict_cursor_t *cursor); -int gras_dict_cursor_get_or_free (gras_dict_cursor_t **cursor, - char **key, - void **data); -#define gras_dict_foreach(dict,cursor,key,data) \ - for (cursor=NULL, gras_dict_cursor_first((dict),&(cursor)) ; \ - gras_dict_cursor_get_or_free(&(cursor),&(key),(void**)(&data)); \ - gras_dict_cursor_step(cursor) ) - -#ifdef __cplusplus + * under the terms of the license (GNU LGPL) which comes with this package. */ + +#ifndef _XBT_DICT_H +#define _XBT_DICT_H + +#include "xbt/misc.h" /* SG_BEGIN_DECL */ +#include "xbt/dynar.h" /* void_f_pvoid_t */ +#include /* uintptr_t */ + +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. + * + * 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(); + char buff[512]; + + sprintf(buff,"some very precious data"); + xbt_dict_set(mydict,"my data", strdup(buff), free); + + sprintf(buff,"another good stuff"); + xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add +\endverbatim + */ + +/** @defgroup XBT_dict_cons Dict constructor and destructor + * @ingroup XBT_dict + * + * @{ + */ + + /** \brief Dictionary data type (opaque structure) */ +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); + +/** @} */ +/** @defgroup XBT_dict_basic Dictionaries basic usage + * @ingroup XBT_dict + * + * Careful, those functions assume that the key is null-terminated. + * + * @{ + */ + +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_elm_key(xbt_dictelm_t elem); +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(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); + + +/** @} */ +/** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys + * @ingroup XBT_dict + * + * Those functions work even with non-null terminated keys. + * + * @{ + */ +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. + * 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, 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 + + * + * \warning Do not add or remove entries to the cache while traversing !! + * + * @{ */ + +/** @brief Cursor on dictionaries (opaque type) */ +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_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_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 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); } -#endif +\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),(char**)&(key),(void**)(&data));\ + xbt_dict_cursor_step(cursor) ) + +/** @} */ + +SG_END_DECL() -#endif /* _GRAS_DICT_H */ +#endif /* _XBT_DICT_H */