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" /* BEGIN_DECL */
  15 #include "xbt/dynar.h" /* void_f_pvoid_t */
  16 #include "xbt/error.h"
  17
  18 BEGIN_DECL()
  19
  20 /** @addtogroup XBT_dict
  21  *
  22  *  This section describes the API to a dictionnary structure that
  23  *  associates as string to a void* key. Even if it provides the same
  24  *  functionnality than an hash table, the implementation differs and the
  25  *  internal data-structure rather looks like a tree.
  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 \endverbatim
  36
  37  *
  38  * \warning This section also gets bitten by the doxygen bug reordering the name sections.
  39  * Make sure to read in this order:
  40  *  -# Constructor/destructor
  41  *  -# Dictionnaries basic usage
  42  *  -# Non-null terminated keys
  43  *  -# Traversing dictionnaries with cursors
  44  *
  45  * @{
  46 */
  47
  48 /**  @name 1. Constructor/destructor
  49  *   @{
  50  */
  51
  52   /** \brief Dictionnary data type (opaque structure) */
  53   typedef struct xbt_dict_ *xbt_dict_t;
  54   xbt_dict_t xbt_dict_new(void);
  55   void xbt_dict_free(xbt_dict_t *dict);
  56
  57 /** @} */
  58 /** @name 2. Dictionnaries basic usage
  59  *
  60  * Careful, those functions assume that the key is null-terminated.
  61  *
  62  *  @{ */
  63
  64   void  xbt_dict_set(xbt_dict_t head, const char *key, void *data, void_f_pvoid_t *free_ctn);
  65   void *xbt_dict_get(xbt_dict_t head,const char *key);
  66   void *xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
  67
  68   void xbt_dict_remove(xbt_dict_t head, const char *key);
  69   void xbt_dict_dump(xbt_dict_t head,void (*output)(void*));
  70
  71 /** @} */
  72 /** @name 3. Non-null terminated keys
  73  *
  74  * Those functions work even with non-null terminated keys.
  75  *
  76  *  @{
  77  */
  78   void  xbt_dict_set_ext(xbt_dict_t     head,
  79                          const char     *key, int  key_len,
  80                          void           *data,
  81                          void_f_pvoid_t *free_ctn);
  82   void *xbt_dict_get_ext(xbt_dict_t head,const char *key, int key_len);
  83   void xbt_dict_remove_ext(xbt_dict_t head, const char *key, int key_len);
  84
  85
  86 /** @} */
  87 /** @name 4. Cursors on dictionnaries
  88  *
  89  *  Don't get impressed, there is a lot of functions here, but traversing a
  90  *  dictionnary is imediate with the xbt_dict_foreach macro.
  91  *  You only need the other functions in rare cases (they are not used directly in SG itself).
  92  *
  93  *  Here is an example (assuming that the dictionnary contains strings, ie
  94  *  that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
  95 \verbatim xbt_dict_cursor_t cursor=NULL;
  96  char *key,*data;
  97
  98  xbt_dict_foreach(head,cursor,key,data) {
  99     printf("   - Seen:  %s->%s\n",key,data);
 100  }\endverbatim
 101
 102  *
 103  *  \warning Do not add or remove entries to the cache while traversing !!
 104  *
 105  *  @{ */
 106
 107   /** @brief Cursor on dictionnaries (opaque type) */
 108   typedef struct xbt_dict_cursor_ *xbt_dict_cursor_t;
 109   xbt_dict_cursor_t xbt_dict_cursor_new(const xbt_dict_t head);
 110   void               xbt_dict_cursor_free(xbt_dict_cursor_t *cursor);
 111
 112   void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
 113
 114
 115   char * xbt_dict_cursor_get_key     (xbt_dict_cursor_t cursor);
 116   void * xbt_dict_cursor_get_data    (xbt_dict_cursor_t cursor);
 117
 118   void xbt_dict_cursor_first (const xbt_dict_t   dict,
 119                              xbt_dict_cursor_t *cursor);
 120   void         xbt_dict_cursor_step        (xbt_dict_cursor_t  cursor);
 121   int          xbt_dict_cursor_get_or_free (xbt_dict_cursor_t *cursor,
 122                                             char              **key,
 123                                             void              **data);
 124   /** @def xbt_dict_foreach
 125       @hideinitializer */
 126 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
 127     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \
 128          xbt_dict_cursor_get_or_free(&(cursor),&(key),(void**)(&data));\
 129          xbt_dict_cursor_step(cursor) )
 130
 131 /** @} */
 132 /** @name 5. Multi-dictionnary
 133  *
 134  * They can be seen as dictionnary of multiple keys or as dictionnary of
 135  * dictionnary of ... of data. Most of the functions here work the same way
 136  * than their simple dictionnary counterpart.
 137  *
 138  * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
 139  * Use xbt_dict_free() and xbt_dict_new() instead.
 140  *
 141  * @{
 142  */
 143
 144 /** \brief To dump multicache, this function dumps a cache                           */
 145 void xbt_dict_print(void *data);
 146 /** \brief To dump multicache, this one dumps a string                               */
 147 void xbt_dict_prints(void *data);
 148
 149
 150 /*----[ xbt_multidict_set ]--------------------------------------------------*/
 151 void
 152 xbt_multidict_set(xbt_dict_t mdict,
 153                   xbt_dynar_t keys,
 154                   void *data,void (*free_ctn)(void*));
 155 void
 156 xbt_multidict_set_ext(xbt_dict_t mdict,
 157                       xbt_dynar_t keys, xbt_dynar_t lens,
 158                       void *data,void_f_pvoid_t *free_ctn);
 159
 160 /*----[ xbt_multidict_get ]--------------------------------------------------*/
 161 void *xbt_multidict_get    (xbt_dict_t mdict, xbt_dynar_t keys);
 162 void *xbt_multidict_get_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
 163
 164 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
 165 /*---------------------------------------------------------------------------*/
 166 void xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
 167 void xbt_multidict_remove_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
 168
 169 /** @} */
 170 /** @} */
 171
 172 END_DECL()
 173
 174 #endif /* _XBT_DICT_H */