Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove the old crufty navigation bars
[simgrid.git] / include / xbt / dict.h
index 38aab19..686f396 100644 (file)
 #ifndef _XBT_DICT_H
 #define _XBT_DICT_H
 
-#include "xbt/misc.h" /* BEGIN_DECL */
-#include "xbt/error.h"
+#include "xbt/misc.h" /* SG_BEGIN_DECL */
 #include "xbt/dynar.h" /* void_f_pvoid_t */
 
-BEGIN_DECL()
+SG_BEGIN_DECL()
 
 /** @addtogroup XBT_dict
+ *  @brief The dictionnary data structure (comparable to hash tables)
  * 
  *  This section describes the API to a dictionnary structure that
  *  associates as string to a void* key. Even if it provides the same
@@ -35,18 +35,12 @@ BEGIN_DECL()
  xbt_dict_set(mydict,"my data", strdup(buff), free); // previous data gets erased (and freed) by second add \endverbatim
 
  *
- * \warning This section also gets bitten by the doxygen bug reordering the name sections. 
- * Make sure to read in this order:
- *  -# Constructor/destructor
- *  -# Dictionnaries basic usage
- *  -# Non-null terminated keys
- *  -# Traversing dictionnaries with cursors
- *
- * @{
-*/
+ */
 
-/**  @name 1. Constructor/destructor
- *   @{
+/** @defgroup XBT_dict_cons Dict constructor and destructor
+ *  @ingroup XBT_dict
+ *
+ *  @{
  */
 
   /** \brief Dictionnary data type (opaque structure) */
@@ -55,36 +49,40 @@ BEGIN_DECL()
   void xbt_dict_free(xbt_dict_t *dict);
 
 /** @} */
-/** @name 2. Dictionnaries basic usage
+/** @defgroup XBT_dict_basic Dictionnaries basic usage
+ *  @ingroup XBT_dict
  *
  * Careful, those functions assume that the key is null-terminated.
  *
- *  @{ */
+ *  @{
+ */
+
+  void  xbt_dict_set(xbt_dict_t head, const char *key, void *data, void_f_pvoid_t *free_ctn);
+  void *xbt_dict_get(xbt_dict_t head,const char *key);
+  void *xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
 
-  void xbt_dict_set(xbt_dict_t head, const char *key, void *data, void_f_pvoid_t *free_ctn);
-  xbt_error_t xbt_dict_get(xbt_dict_t head,const char *key, /* OUT */void **data);
-  xbt_error_t xbt_dict_remove(xbt_dict_t head,const char *key);
+  void xbt_dict_remove(xbt_dict_t head, const char *key);
   void xbt_dict_dump(xbt_dict_t head,void (*output)(void*));
   
 /** @} */
-/** @name 3. Non-null terminated keys
+/** @defgroup XBT_dict_nnul Dictionnaries with non-nul terminated keys
+ *  @ingroup XBT_dict
  *
  * Those functions work even with non-null terminated keys.
  *
  *  @{
  */
-  void xbt_dict_set_ext(xbt_dict_t     head,
-                       const char     *key, int  key_len,
-                       void           *data,
-                       void_f_pvoid_t *free_ctn);
-  xbt_error_t xbt_dict_get_ext(xbt_dict_t head,const char *key, int key_len,
-                              /* OUT */void **data);
-  xbt_error_t xbt_dict_remove_ext(xbt_dict_t head,
-                                 const char *key, int key_len);
+  void  xbt_dict_set_ext(xbt_dict_t     head,
+                        const char     *key, int  key_len,
+                        void           *data,
+                        void_f_pvoid_t *free_ctn);
+  void *xbt_dict_get_ext(xbt_dict_t head,const char *key, int key_len);
+  void xbt_dict_remove_ext(xbt_dict_t head, const char *key, int key_len);
 
 
 /** @} */
-/** @name 4. Cursors on dictionnaries 
+/** @defgroup XBT_dict_curs Cursors on dictionnaries 
+ *  @ingroup XBT_dict
  *
  *  Don't get impressed, there is a lot of functions here, but traversing a 
  *  dictionnary is imediate with the xbt_dict_foreach macro.
@@ -112,10 +110,8 @@ BEGIN_DECL()
   void xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
 
 
-  xbt_error_t xbt_dict_cursor_get_key     (xbt_dict_cursor_t cursor,
-                                          /*OUT*/char **key);
-  xbt_error_t xbt_dict_cursor_get_data    (xbt_dict_cursor_t cursor,
-                                          /*OUT*/void **data);
+  char * xbt_dict_cursor_get_key     (xbt_dict_cursor_t cursor);
+  void * xbt_dict_cursor_get_data    (xbt_dict_cursor_t cursor);
 
   void xbt_dict_cursor_first (const xbt_dict_t   dict,
                             xbt_dict_cursor_t *cursor);
@@ -131,7 +127,8 @@ BEGIN_DECL()
          xbt_dict_cursor_step(cursor) )
 
 /** @} */
-/** @name 5. Multi-dictionnary
+/** @defgroup XBT_dict_multi Multi-level dictionnaries
+ *  @ingroup XBT_dict
  *
  * 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 
@@ -150,36 +147,26 @@ void xbt_dict_prints(void *data);
 
 
 /*----[ xbt_multidict_set ]--------------------------------------------------*/
-xbt_error_t 
+void
 xbt_multidict_set(xbt_dict_t mdict,
                   xbt_dynar_t keys,
                   void *data,void (*free_ctn)(void*));
-xbt_error_t
+void
 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);
+void *xbt_multidict_get    (xbt_dict_t mdict, xbt_dynar_t keys);
+void *xbt_multidict_get_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
 
 /*----[ xbt_multidict_remove ]-----------------------------------------------*/
 /*---------------------------------------------------------------------------*/
-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);
+void xbt_multidict_remove(xbt_dict_t mdict, xbt_dynar_t keys);
+void xbt_multidict_remove_ext(xbt_dict_t mdict, xbt_dynar_t keys, xbt_dynar_t lens);
 
 /** @} */
-/** @} */
 
-END_DECL()
+SG_END_DECL()
 
 #endif /* _XBT_DICT_H */