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