X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/8be7ea3f9e71cd563e91b6aba63f5c70f043fbd5..76ddf2528f029c970be3fd1d08659452b1842ae8:/include/xbt/lib.h

diff --git a/include/xbt/lib.h b/include/xbt/lib.h
index 5139ff8264..404ed253c0 100644
--- a/include/xbt/lib.h
+++ b/include/xbt/lib.h
@@ -1,6 +1,6 @@
 /* xbt/lib.h - api to a generic library                                     */
 
-/* Copyright (c) 2011, 2013. The SimGrid Team.
+/* Copyright (c) 2011, 2013-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -13,6 +13,41 @@
 
 SG_BEGIN_DECL()
 
+/** Container for all the objects of a given type
+ *
+ *  * each item is identified by a string name/identifier;
+ *
+ *  * the lib itself is a dictionary from the element id to the element;
+ *
+ *  * the element itself is represented aby the xbt_dictelm_t;
+ *
+ *  * the element can store any number of associated facets/data structures (corresponding to the different layers of
+ *    SimGrid or its extensions) in ((void**)dictelt->content)[level];
+ *
+ *  * each level is allocated in the lib with `xbt_lib_add_level`.
+ *
+ *  <pre>
+ *  // Define a collection for the foo objects and two associated facets:
+ *  typedef xbt_dictelm_t foo_t;
+ *  xbt_lib_t foo_lib = xbt_lib_new();
+ *  int BAR_FOO_LEVEL  = xbt_lib_add_level(foo_lib, free_bar);
+ *  int AUTH_FOO_LEVEL = xbt_lib_add_level(foo_lib, free_auth);
+ *
+ *  // Store a bar:
+ *  bar_t bar = bar_new();
+ *  char* id = bar_name(bar);
+ *  xbt_lib_set(id, id, BAR_FOO_LEVEL, bar);
+ *
+ *  // Find the corresponding foo and the facet again:
+ *  foo_t foo = xbt_lib_get_elm_or_null(foo_lib, id);
+ *  bar_t bar2 = (bar_t) xbt_lib_get_level(foo, BAR_FOO_LEVEL);
+ *  assert(bar == bar2);
+ *
+ *  // Add authentication facet for the previous object:
+ *  auth_t auth = auth_new();
+ *  xbt_lib_set(foo_lib, id, AUTH_FOO_LEVEL, auth);
+ *  </pre>
+ */
 typedef struct s_xbt_lib {
   xbt_dict_t dict;
   int levels;
@@ -24,12 +59,12 @@ typedef struct s_xbt_lib {
 XBT_PUBLIC(xbt_lib_t) xbt_lib_new(void);
 XBT_PUBLIC(void) xbt_lib_free(xbt_lib_t * lib);
 XBT_PUBLIC(int) xbt_lib_add_level(xbt_lib_t lib, void_f_pvoid_t free_f);
-XBT_PUBLIC(void) xbt_lib_set(xbt_lib_t lib, const char *name, int level,
-                             void *obj);
-XBT_PUBLIC(void *) xbt_lib_get_or_null(xbt_lib_t lib, const char *name,
-                                       int level);
+XBT_PUBLIC(void) xbt_lib_set(xbt_lib_t lib, const char *name, int level, void *obj);
+XBT_PUBLIC(void) xbt_lib_unset(xbt_lib_t lib, const char *key, int level, int invoke_callback);
+XBT_PUBLIC(void *) xbt_lib_get_or_null(xbt_lib_t lib, const char *name, int level);
 XBT_PUBLIC(xbt_dictelm_t) xbt_lib_get_elm_or_null(xbt_lib_t lib, const char *key);
 XBT_PUBLIC(void *) xbt_lib_get_level(xbt_dictelm_t elm, int level);
+XBT_PUBLIC(void) xbt_lib_remove(xbt_lib_t lib, const char *key);
 
 #define xbt_lib_length(lib) xbt_dict_length((lib)->dict)
 
@@ -39,4 +74,16 @@ XBT_PUBLIC(void *) xbt_lib_get_level(xbt_dictelm_t elm, int level);
   xbt_dict_foreach((lib)->dict, cursor, key, data)
 
 SG_END_DECL()
+
+#ifdef __cplusplus
+namespace simgrid {
+namespace xbt {
+  inline void destroy(xbt_lib_t l)
+  {
+    xbt_lib_free(&l);
+  }
+}
+}
+#endif
+
 #endif                          /* _XBT_LIB_H */