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
  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, void_f_pvoid_t free_ctn);
  61   XBT_PUBLIC(void*) xbt_dict_get(xbt_dict_t dict,const char *key);
  62   XBT_PUBLIC(void*) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
  63
  64   XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
  65   XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
  66   XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
  67   XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output)(void*));
  68   XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict);
  69
  70
  71 /** @} */
  72 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
  73  *  @ingroup XBT_dict
  74  *
  75  * Those functions work even with non-null terminated keys.
  76  *
  77  *  @{
  78  */
  79   XBT_PUBLIC(void)  xbt_dict_set_ext(xbt_dict_t     dict,
  80                          const char     *key, int  key_len,
  81                          void           *data,
  82                          void_f_pvoid_t free_ctn);
  83   XBT_PUBLIC(void*) xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len);
  84   XBT_PUBLIC(void*) xbt_dict_get_or_null_ext(xbt_dict_t dict, const char *key, int key_len);
  85   XBT_PUBLIC(void)  xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len);
  86
  87
  88 /** @} */
  89 /** @defgroup XBT_dict_curs Cursors on dictionaries
  90  *  @ingroup XBT_dict
  91  *
  92  *  Don't get impressed, there is a lot of functions here, but traversing a
  93  *  dictionary is immediate with the xbt_dict_foreach macro.
  94  *  You only need the other functions in rare cases (they are not used directly in SG itself).
  95  *
  96  *  Here is an example (assuming that the dictionary contains strings, ie
  97  *  that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
  98 \verbatim xbt_dict_cursor_t cursor=NULL;
  99  char *key,*data;
 100
 101  xbt_dict_foreach(dict,cursor,key,data) {
 102     printf("   - Seen:  %s->%s\n",key,data);
 103  }\endverbatim
 104
 105  *
 106  *  \warning Do not add or remove entries to the cache while traversing !!
 107  *
 108  *  @{ */
 109
 110   /** @brief Cursor on dictionaries (opaque type) */
 111   typedef struct xbt_dict_cursor_ *xbt_dict_cursor_t;
 112   XBT_PUBLIC(xbt_dict_cursor_t) xbt_dict_cursor_new(const xbt_dict_t dict);
 113   XBT_PUBLIC(void)               xbt_dict_cursor_free(xbt_dict_cursor_t *cursor);
 114
 115   XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
 116
 117
 118   XBT_PUBLIC(char *) xbt_dict_cursor_get_key     (xbt_dict_cursor_t cursor);
 119   XBT_PUBLIC(void *) xbt_dict_cursor_get_data    (xbt_dict_cursor_t cursor);
 120
 121   XBT_PUBLIC(void) xbt_dict_cursor_first (const xbt_dict_t   dict,
 122                              xbt_dict_cursor_t *cursor);
 123   XBT_PUBLIC(void)         xbt_dict_cursor_step        (xbt_dict_cursor_t  cursor);
 124   XBT_PUBLIC(int)          xbt_dict_cursor_get_or_free (xbt_dict_cursor_t *cursor,
 125                                             char              **key,
 126                                             void              **data);
 127   /** @def xbt_dict_foreach
 128       @hideinitializer */
 129 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
 130     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \
 131          xbt_dict_cursor_get_or_free(&(cursor),&(key),(void**)(&data));\
 132          xbt_dict_cursor_step(cursor) )
 133
 134 /** @} */
 135 /** @defgroup XBT_dict_multi Multi-level dictionaries
 136  *  @ingroup XBT_dict
 137  *
 138  * They can be seen as dictionary of multiple keys or as dictionary of
 139  * dictionary of ... of data. Most of the functions here work the same way
 140  * than their simple dictionary counterpart.
 141  *
 142  * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
 143  * Use xbt_dict_free() and xbt_dict_new() instead.
 144  *
 145  * @{
 146  */
 147
 148 /** \brief To dump multicache, this function dumps a cache                           */
 149 XBT_PUBLIC(void) xbt_dict_print(void *data);
 150 /** \brief To dump multicache, this one dumps a string                               */
 151 XBT_PUBLIC(void) xbt_dict_prints(void *data);
 152
 153
 154 /*----[ xbt_multidict_set ]--------------------------------------------------*/
 155 XBT_PUBLIC(void)
 156 xbt_multidict_set(xbt_dict_t mdict,
 157                   xbt_dynar_t keys,
 158                   void *data,void (*free_ctn)(void*));
 159 XBT_PUBLIC(void)
 160 xbt_multidict_set_ext(xbt_dict_t mdict,
 161                       xbt_dynar_t keys, xbt_dynar_t lens,
 162                       void *data,void_f_pvoid_t free_ctn);
 163
 164 /*----[ xbt_multidict_get ]--------------------------------------------------*/
 165 XBT_PUBLIC(void*) xbt_multidict_get    (xbt_dict_t mdict, xbt_dynar_t keys);
 166 XBT_PUBLIC(void*) xbt_multidict_get_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
 167
 168 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
 169 /*---------------------------------------------------------------------------*/
 170 XBT_PUBLIC(void) xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
 171 XBT_PUBLIC(void) xbt_multidict_remove_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
 172
 173 /** @} */
 174
 175 SG_END_DECL()
 176
 177 #endif /* _XBT_DICT_H */