include/xbt/dict.h

   1 /* xbt/dict.h -- api to a generic dictionary                                */
   2
   3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9
  10 #ifndef _XBT_DICT_H
  11 #define _XBT_DICT_H
  12
  13 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
  14 #include "xbt/dynar.h"          /* void_f_pvoid_t */
  15 #include <stdint.h> /* uintptr_t */
  16
  17 SG_BEGIN_DECL();
  18
  19 /** @addtogroup XBT_dict
  20  *  @brief The dictionary data structure (comparable to hash tables)
  21  *
  22  *  This section describes the API to a dictionary structure that
  23  *  associates as string to a void* key. It provides the same
  24  *  functionality than an hash table.
  25  *
  26  *  Here is a little example of use:
  27  *  \verbatim xbt_dict_t mydict = xbt_dict_new();
  28  char buff[512];
  29
  30  sprintf(buff,"some very precious data");
  31  xbt_dict_set(mydict,"my data", strdup(buff), free);
  32
  33  sprintf(buff,"another good stuff");
  34  xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add
  35 \endverbatim
  36  *
  37  */
  38
  39 /** @defgroup XBT_dict_cons Dict constructor and destructor
  40  *  @ingroup XBT_dict
  41  *
  42  *  @{
  43  */
  44
  45   /** \brief Dictionary data type (opaque structure) */
  46 typedef struct xbt_dict_ *xbt_dict_t;
  47 XBT_PUBLIC(xbt_dict_t) xbt_dict_new(void);
  48 XBT_PUBLIC(void) xbt_dict_free(xbt_dict_t * dict);
  49 XBT_PUBLIC(unsigned int) xbt_dict_size(xbt_dict_t dict);
  50
  51 /** @} */
  52 /** @defgroup XBT_dict_basic Dictionaries basic usage
  53  *  @ingroup XBT_dict
  54  *
  55  * Careful, those functions assume that the key is null-terminated.
  56  *
  57  *  @{
  58  */
  59
  60 XBT_PUBLIC(void) xbt_dict_set(xbt_dict_t dict, const char *key, void *data,
  61                               void_f_pvoid_t free_ctn);
  62 XBT_PUBLIC(void *) xbt_dict_get(xbt_dict_t dict, const char *key);
  63 XBT_PUBLIC(void *) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
  64 XBT_PUBLIC(char *) xbt_dict_get_key(xbt_dict_t dict, const void*data);
  65
  66 XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
  67 XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
  68 XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
  69 XBT_PUBLIC(void) xbt_dict_dump_output_string(void *s);
  70 XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output) (void *));
  71 XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict);
  72
  73
  74 /** @} */
  75 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
  76  *  @ingroup XBT_dict
  77  *
  78  * Those functions work even with non-null terminated keys.
  79  *
  80  *  @{
  81  */
  82 XBT_PUBLIC(void) xbt_dict_set_ext(xbt_dict_t dict,
  83                                   const char *key, int key_len,
  84                                   void *data, void_f_pvoid_t free_ctn);
  85 XBT_PUBLIC(void *) xbt_dict_get_ext(xbt_dict_t dict, const char *key,
  86                                     int key_len);
  87 XBT_PUBLIC(void *) xbt_dict_get_or_null_ext(xbt_dict_t dict, const char *key,
  88                                             int key_len);
  89 XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key,
  90                                      int key_len);
  91
  92
  93 XBT_PUBLIC(void) xbt_dicti_set(xbt_dict_t dict, uintptr_t key, uintptr_t data);
  94 XBT_PUBLIC(uintptr_t) xbt_dicti_get(xbt_dict_t dict, uintptr_t key);
  95 XBT_PUBLIC(void) xbt_dicti_remove(xbt_dict_t dict, uintptr_t key);
  96
  97
  98 /** @} */
  99 /** @defgroup XBT_dict_curs Cursors on dictionaries
 100  *  @ingroup XBT_dict
 101  *
 102  *  Don't get impressed, there is a lot of functions here, but traversing a
 103  *  dictionary is immediate with the xbt_dict_foreach macro.
 104  *  You only need the other functions in rare cases (they are not used directly in SG itself).
 105  *
 106  *  Here is an example (assuming that the dictionary contains strings, ie
 107  *  that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
 108 \verbatim xbt_dict_cursor_t cursor=NULL;
 109  char *key,*data;
 110
 111  xbt_dict_foreach(dict,cursor,key,data) {
 112     printf("   - Seen:  %s->%s\n",key,data);
 113  }\endverbatim
 114
 115  *
 116  *  \warning Do not add or remove entries to the cache while traversing !!
 117  *
 118  *  @{ */
 119
 120   /** @brief Cursor on dictionaries (opaque type) */
 121      typedef struct xbt_dict_cursor_ *xbt_dict_cursor_t;
 122 XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
 123 XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t * cursor);
 124
 125 XBT_INLINE XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
 126
 127
 128 XBT_PUBLIC(char *) xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor);
 129 XBT_PUBLIC(void *) xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor);
 130
 131 XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict,
 132                                        xbt_dict_cursor_t * cursor);
 133 XBT_INLINE XBT_PUBLIC(void) xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
 134 XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor,
 135                                             char **key, void **data);
 136   /** @def xbt_dict_foreach
 137       @hideinitializer */
 138 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
 139     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \
 140          xbt_dict_cursor_get_or_free(&(cursor),(char**)&(key),(void**)(&data));\
 141          xbt_dict_cursor_step(cursor) )
 142
 143 /** @} */
 144 /** @defgroup XBT_dict_multi Multi-level dictionaries
 145  *  @ingroup XBT_dict
 146  *
 147  * They can be seen as dictionary of multiple keys or as dictionary of
 148  * dictionary of ... of data. Most of the functions here work the same way
 149  * than their simple dictionary counterpart.
 150  *
 151  * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
 152  * Use xbt_dict_free() and xbt_dict_new() instead.
 153  *
 154  * @{
 155  */
 156
 157 /** \brief To dump multicache, this function dumps a cache                           */
 158 XBT_PUBLIC(void) xbt_dict_print(void *data);
 159 /** \brief To dump multicache, this one dumps a string                               */
 160 XBT_PUBLIC(void) xbt_dict_prints(void *data);
 161
 162
 163 /*----[ xbt_multidict_set ]--------------------------------------------------*/
 164 XBT_PUBLIC(void)
 165 xbt_multidict_set(xbt_dict_t mdict,
 166                   xbt_dynar_t keys, void *data, void (*free_ctn) (void *));
 167 XBT_PUBLIC(void)
 168 xbt_multidict_set_ext(xbt_dict_t mdict,
 169                       xbt_dynar_t keys, xbt_dynar_t lens,
 170                       void *data, void_f_pvoid_t free_ctn);
 171
 172 /*----[ xbt_multidict_get ]--------------------------------------------------*/
 173 XBT_PUBLIC(void *) xbt_multidict_get(xbt_dict_t mdict, xbt_dynar_t keys);
 174 XBT_PUBLIC(void *) xbt_multidict_get_ext(xbt_dict_t mdict, xbt_dynar_t keys,
 175                                          xbt_dynar_t lens);
 176
 177 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
 178 /*---------------------------------------------------------------------------*/
 179 XBT_PUBLIC(void) xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
 180 XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict, xbt_dynar_t keys,
 181                                           xbt_dynar_t lens);
 182
 183 /** @} */
 184
 185 SG_END_DECL()
 186 #endif /* _XBT_DICT_H */