From: Frederic Suter <frederic.suter@cc.in2p3.fr>
Date: Tue, 17 Oct 2017 13:41:55 +0000 (+0200)
Subject: start deprecating xbt_dict
X-Git-Tag: v3.18~425
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/403bb1aa90176fd55b53734f5a1b230476284602

start deprecating xbt_dict
---

diff --git a/include/xbt/dict.h b/include/xbt/dict.h
index fd6edf573e..20100b8da5 100644
--- a/include/xbt/dict.h
+++ b/include/xbt/dict.h
@@ -74,20 +74,27 @@ 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_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);
-XBT_PUBLIC(char *) xbt_dict_get_elm_key(xbt_dictelm_t elem);
+XBT_PUBLIC(char*)
+XBT_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.")
+    xbt_dict_get_key(xbt_dict_t dict, const void* data);
+XBT_PUBLIC(char*)
+XBT_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.")
+    xbt_dict_get_elm_key(xbt_dictelm_t elem);
 XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm(xbt_dict_t dict, const char *key);
 XBT_PUBLIC(xbt_dictelm_t) xbt_dict_get_elm_or_null(xbt_dict_t dict, const char *key);
 
 XBT_PUBLIC(void) xbt_dict_remove(xbt_dict_t dict, const char *key);
 XBT_PUBLIC(void) xbt_dict_reset(xbt_dict_t dict);
 XBT_PUBLIC(int) xbt_dict_length(xbt_dict_t dict);
-XBT_PUBLIC(void) xbt_dict_dump_output_string(void *s);
+XBT_PUBLIC(void)
+XBT_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.")
+    xbt_dict_dump_output_string(void* s);
 XBT_PUBLIC(void) xbt_dict_dump(xbt_dict_t dict, void (*output) (void *));
-XBT_PUBLIC(void) xbt_dict_dump_sizes(xbt_dict_t dict);
+XBT_PUBLIC(void)
+XBT_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.")
+    xbt_dict_dump_sizes(xbt_dict_t dict);
 XBT_PUBLIC(int) xbt_dict_is_empty(xbt_dict_t dict);
 
-
 /** @} */
 /** @defgroup XBT_dict_nnul Dictionaries with non-nul terminated keys
  *  @ingroup XBT_dict
@@ -97,8 +104,12 @@ 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_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.")
+    xbt_dict_get_ext(xbt_dict_t dict, const char* key, int key_len);
+XBT_PUBLIC(void*)
+XBT_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.")
+    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 {
@@ -141,10 +152,11 @@ XBT_PUBLIC(void) xbt_dict_cursor_free(xbt_dict_cursor_t * cursor);
 
 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_ATTRIB_DEPRECATED_v321("xbt_dict is dying. v3.21 will turn this warning into an error.")
+    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_step(xbt_dict_cursor_t cursor);
diff --git a/include/xbt/str.h b/include/xbt/str.h
index 86ab084c12..f9d96e97c8 100644
--- a/include/xbt/str.h
+++ b/include/xbt/str.h
@@ -9,8 +9,9 @@
 #ifndef XBT_STR_H
 #define XBT_STR_H
 
-#include "xbt/misc.h"
+#include "xbt/dict.h"
 #include "xbt/dynar.h"
+#include "xbt/misc.h"
 
 #include <stdarg.h>             /* va_* */
 #include <stdio.h>  /* FILE */