Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
help doxygen to stop complaining about documentation for unknown define
[simgrid.git] / include / xbt / dict.h
index e9fdb4c..38aab19 100644 (file)
@@ -29,7 +29,7 @@ BEGIN_DECL()
  char buff[512];
 
  sprintf(buff,"some very precious data");
- xbt_dict_set(mydict,"my data", strdump(buff), free); 
+ xbt_dict_set(mydict,"my data", strdup(buff), free); 
 
  sprintf(buff,"another good stuff");
  xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add \endverbatim
@@ -104,7 +104,7 @@ BEGIN_DECL()
  *
  *  @{ */
 
-  /** \brief Cursor on dictionnaries (opaque type) */
+  /** @brief Cursor on dictionnaries (opaque type) */
   typedef struct xbt_dict_cursor_ *xbt_dict_cursor_t;
   xbt_dict_cursor_t xbt_dict_cursor_new(const xbt_dict_t head);
   void               xbt_dict_cursor_free(xbt_dict_cursor_t *cursor);
@@ -123,69 +123,62 @@ BEGIN_DECL()
   int          xbt_dict_cursor_get_or_free (xbt_dict_cursor_t *cursor,
                                            char              **key,
                                            void              **data);
-  /** \brief toto 
-      \hideinitializer */
+  /** @def xbt_dict_foreach
+      @hideinitializer */
 #  define xbt_dict_foreach(dict,cursor,key,data)                       \
     for (cursor=NULL, xbt_dict_cursor_first((dict),&(cursor)) ;        \
          xbt_dict_cursor_get_or_free(&(cursor),&(key),(void**)(&data));\
          xbt_dict_cursor_step(cursor) )
 
 /** @} */
-/** @} */
-
-#if 0
-
-                         MULTI-DICTS ARE BROKEN
-
+/** @name 5. Multi-dictionnary
+ *
+ * They can be seen as dictionnary of multiple keys or as dictionnary of 
+ * dictionnary of ... of data. Most of the functions here work the same way 
+ * than their simple dictionnary counterpart.
+ *
+ * Note that there is no xbt_multidict_free neither xbt_multi_dict_new functions.
+ * Use xbt_dict_free() and xbt_dict_new() instead.
+ *
+ * @{
+ */
 
-/*####[ Multi cache functions ]##############################################*/
-/* The are cache of cache of data. Any function there works the same way     */
-/*  than their simple cache counterpart.                                     */
-/*###############################"###########################################*/
-/* To dump multicache, this function dumps a cache                           */
+/** \brief To dump multicache, this function dumps a cache                           */
 void xbt_dict_print(void *data);
-/* To dump multicache, this one dumps a string                               */
+/** \brief To dump multicache, this one dumps a string                               */
 void xbt_dict_prints(void *data);
 
-/*----[ xbt_multidict_free ]------------------------------------------------*/
-/* This function does not exist. Use xbt_dict_free instead.                 */
-/*---------------------------------------------------------------------------*/
 
-/*----[ xbt_multidict_set ]-------------------------------------------------*/
-/* Insert the data in the structure under the #keycount# #key#s.             */
-/* The key are destroyed in the process. Think to strdup it before.          */
-/* Returns if it was ok or not                                               */
+/*----[ xbt_multidict_set ]--------------------------------------------------*/
+xbt_error_t 
+xbt_multidict_set(xbt_dict_t mdict,
+                  xbt_dynar_t keys,
+                  void *data,void (*free_ctn)(void*));
+xbt_error_t
+xbt_multidict_set_ext(xbt_dict_t mdict,
+                      xbt_dynar_t keys, xbt_dynar_t lens,
+                      void *data,void_f_pvoid_t *free_ctn);
+
+/*----[ xbt_multidict_get ]--------------------------------------------------*/
+xbt_error_t 
+xbt_multidict_get(xbt_dict_t mdict,
+                  xbt_dynar_t keys,
+                 /*OUT*/void **data);
+xbt_error_t 
+xbt_multidict_get_ext(xbt_dict_t mdict,
+                      xbt_dynar_t keys, xbt_dynar_t lens,
+                      /*OUT*/void **data);
+
+/*----[ xbt_multidict_remove ]-----------------------------------------------*/
 /*---------------------------------------------------------------------------*/
-xbt_error_t xbt_multidict_set(xbt_dict_t *head,
-                               int keycount,char **key,
-                               void *data,void (*free_ctn)(void*));
-
-xbt_error_t xbt_multidict_set_ext(xbt_dict_t *head,
-                                   int keycount,char **key,int *key_len,
-                                   void *data,void_f_pvoid_t *free_ctn);
-
-/*----[ xbt_multidict_get ]-------------------------------------------------*/
-/* Search the given #key#. data=NULL when not found.                         */
-/* Returns true if anything went ok, and false on internal error.            */
-/*---------------------------------------------------------------------------*/
-xbt_error_t xbt_multidict_get(xbt_dict_t head,
-                               int keycount,const char **key,
-                               /* OUT */void **data);
-
-xbt_error_t xbt_multidict_get_ext(xbt_dict_t head,
-                                   int keycount,const char **key,int *key_len,
-                                   /* OUT */void **data);
+xbt_error_t 
+xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
+xbt_error_t 
+xbt_multidict_remove_ext(xbt_dict_t mdict, 
+                         xbt_dynar_t keys, xbt_dynar_t lens);
 
-/*----[ xbt_multidict_remove ]----------------------------------------------*/
-/* Remove the entry associated with the given #key#.                         */
-/* Returns if ok. Removing a non-existant key is ok.                         */
-/*---------------------------------------------------------------------------*/
-xbt_error_t xbt_multidict_remove(xbt_dict_t head,
-                                  int keycount,const char **key);
-
-xbt_error_t xbt_multidict_remove_ext(xbt_dict_t head,
-                                       int keycount,const char **key,int *key_len);
-#endif
+/** @} */
+/** @} */
 
 END_DECL()