X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c46aba70aa4ccf22cc19fac31d451c7158e922dd..1f606358fff6ef994cd58570e7c77ee6259d6a4e:/include/xbt/dict.h

diff --git a/include/xbt/dict.h b/include/xbt/dict.h
index 61b2f14957..6a5e9126c5 100644
--- a/include/xbt/dict.h
+++ b/include/xbt/dict.h
@@ -18,9 +18,8 @@ SG_BEGIN_DECL()
 /** @addtogroup XBT_dict
  *  @brief The dictionary data structure (comparable to hash tables)
  *
- *  This section describes the API to a dictionary structure that
- *  associates as string to a void* key. It provides the same
- *  functionality than an hash table.
+ *  This section describes the API to a dictionary structure that  associates as string to a void* key. It provides the
+ *  same functionality than an hash table.
  *
  *  Here is a little example of use:
 
@@ -44,7 +43,6 @@ SG_BEGIN_DECL()
  */
 
   /** \brief Dictionary data type (opaque structure) */
-
 typedef struct s_xbt_dict *xbt_dict_t;
 typedef struct s_xbt_dictelm *xbt_dictelm_t;
 typedef struct s_xbt_dictelm {
@@ -71,8 +69,7 @@ XBT_PUBLIC(unsigned int) xbt_dict_size(xbt_dict_t dict);
  *  @{
  */
 
-XBT_PUBLIC(void) xbt_dict_set(xbt_dict_t dict, const char *key, void *data,
-                              void_f_pvoid_t free_ctn);
+XBT_PUBLIC(void) xbt_dict_set(xbt_dict_t dict, const char *key, void *data, void_f_pvoid_t free_ctn);
 XBT_PUBLIC(void *) xbt_dict_get(xbt_dict_t dict, const char *key);
 XBT_PUBLIC(void *) xbt_dict_get_or_null(xbt_dict_t dict, const char *key);
 XBT_PUBLIC(char *) xbt_dict_get_key(xbt_dict_t dict, const void *data);
@@ -97,15 +94,10 @@ XBT_PUBLIC(int) xbt_dict_is_empty(xbt_dict_t dict);
  *
  *  @{
  */
-XBT_PUBLIC(void) xbt_dict_set_ext(xbt_dict_t dict,
-                                  const char *key, int key_len,
-                                  void *data, void_f_pvoid_t free_ctn);
-XBT_PUBLIC(void *) xbt_dict_get_ext(xbt_dict_t dict, const char *key,
-                                    int key_len);
-XBT_PUBLIC(void *) xbt_dict_get_or_null_ext(xbt_dict_t dict,
-                                            const char *key, int key_len);
-XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key,
-                                     int key_len);
+XBT_PUBLIC(void) xbt_dict_set_ext(xbt_dict_t dict, const char *key, int key_len, void *data, void_f_pvoid_t free_ctn);
+XBT_PUBLIC(void *) xbt_dict_get_ext(xbt_dict_t dict, const char *key, int key_len);
+XBT_PUBLIC(void *) xbt_dict_get_or_null_ext(xbt_dict_t dict, const char *key, int key_len);
+XBT_PUBLIC(void) xbt_dict_remove_ext(xbt_dict_t dict, const char *key, int key_len);
 
 struct s_xbt_dict_cursor {
   xbt_dictelm_t current;
@@ -117,12 +109,12 @@ struct s_xbt_dict_cursor {
 /** @defgroup XBT_dict_curs Cursors on dictionaries
  *  @ingroup XBT_dict
  *
- *  Don't get impressed, there is a lot of functions here, but traversing a
- *  dictionary is immediate with the xbt_dict_foreach macro.
+ *  Don't get impressed, there is a lot of functions here, but traversing a dictionary is immediate with the
+ *  xbt_dict_foreach macro.
  *  You only need the other functions in rare cases (they are not used directly in SG itself).
  *
- *  Here is an example (assuming that the dictionary contains strings, ie
- *  that the <tt>data</tt> argument of xbt_dict_set was always a null-terminated char*):
+ *  Here is an example (assuming that the dictionary contains strings, i.e., that the <tt>data</tt> argument of
+ *  xbt_dict_set was always a null-terminated char*):
 \verbatim xbt_dict_cursor_t cursor=NULL;
  char *key,*data;
 
@@ -135,7 +127,7 @@ struct s_xbt_dict_cursor {
  *
  *  @{ */
 
-  /** @brief Cursor on dictionaries (opaque type) */
+/** @brief Cursor on dictionaries (opaque type) */
 typedef struct s_xbt_dict_cursor *xbt_dict_cursor_t;
 
 static inline xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor) {
@@ -150,15 +142,11 @@ XBT_PUBLIC(void) xbt_dict_cursor_rewind(xbt_dict_cursor_t cursor);
 xbt_dictelm_t xbt_dict_cursor_get_elm(xbt_dict_cursor_t cursor);
 XBT_PUBLIC(char *) xbt_dict_cursor_get_key(xbt_dict_cursor_t cursor);
 XBT_PUBLIC(void *) xbt_dict_cursor_get_data(xbt_dict_cursor_t cursor);
-XBT_PUBLIC(void) xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor,
-                                          void *data,
-                                          void_f_pvoid_t free_ctn);
+XBT_PUBLIC(void) xbt_dict_cursor_set_data(xbt_dict_cursor_t cursor, void *data, void_f_pvoid_t free_ctn);
 
-XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict,
-                                       xbt_dict_cursor_t * cursor);
+XBT_PUBLIC(void) xbt_dict_cursor_first(const xbt_dict_t dict, xbt_dict_cursor_t * cursor);
 XBT_PUBLIC(void) xbt_dict_cursor_step(xbt_dict_cursor_t cursor);
-XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor,
-                                            char **key, void **data);
+XBT_PUBLIC(int) xbt_dict_cursor_get_or_free(xbt_dict_cursor_t * cursor, char **key, void **data);
 /** @def xbt_dict_foreach
  *  @param dict a \ref xbt_dict_t iterator
  *  @param cursor an \ref xbt_dict_cursor_t used as cursor
@@ -185,4 +173,16 @@ xbt_dict_foreach(head, cursor, key, data) {
 /** @} */
 
 SG_END_DECL()
+
+#ifdef __cplusplus
+namespace simgrid {
+namespace xbt {
+  inline void destroy(xbt_dict_t d)
+  {
+    xbt_dict_free(&d);
+  }
+}
+}
+#endif
+
 #endif                          /* _XBT_DICT_H */