include/xbt/dict.h

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