X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9361ad5f13f67578120a74bbbfba718292084cdb..ab632dac1251c5a02ac8ce554e98a6d791cebd72:/include/xbt/dynar.h

diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h
index b34da648b8..e8bf02c01b 100644
--- a/include/xbt/dynar.h
+++ b/include/xbt/dynar.h
@@ -40,8 +40,8 @@ SG_BEGIN_DECL()
   *
   * \section XBT_dynar_exptr Example with pointed data
   * 
-  * \skip doxygen_string_cruft
-  * \skip function
+  * \skip test_dynar_string
+  * \skip dynar_t
   * \until s2
   * \skip Populate_str
   * \skip dyn
@@ -62,17 +62,19 @@ SG_BEGIN_DECL()
    typedef struct xbt_dynar_s *xbt_dynar_t;
 
 
-  XBT_PUBLIC xbt_dynar_t   xbt_dynar_new(unsigned long elm_size, 
-			     void_f_pvoid_t *free_func);
-  XBT_PUBLIC void          xbt_dynar_free(xbt_dynar_t *dynar);
-  XBT_PUBLIC void          xbt_dynar_free_voidp(void *dynar);
-  XBT_PUBLIC void          xbt_dynar_free_container(xbt_dynar_t *dynar);
+  XBT_PUBLIC(xbt_dynar_t)   xbt_dynar_new(const unsigned long elm_size, 
+					  void_f_pvoid_t const free_f);
+  XBT_PUBLIC(xbt_dynar_t)   xbt_dynar_new_sync(const unsigned long elm_size, 
+					       void_f_pvoid_t const free_f);
+  XBT_PUBLIC(void)          xbt_dynar_free(xbt_dynar_t *dynar);
+  XBT_PUBLIC(void)          xbt_dynar_free_voidp(void *dynar);
+  XBT_PUBLIC(void)          xbt_dynar_free_container(xbt_dynar_t *dynar);
 
-  XBT_PUBLIC unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
-  XBT_PUBLIC void          xbt_dynar_reset(xbt_dynar_t dynar);
-  XBT_PUBLIC void          xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
+  XBT_PUBLIC(unsigned long) xbt_dynar_length(const xbt_dynar_t dynar);
+  XBT_PUBLIC(void)          xbt_dynar_reset(xbt_dynar_t const dynar);
+  XBT_PUBLIC(void)          xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
 
-  XBT_PUBLIC void          xbt_dynar_dump(xbt_dynar_t dynar);
+  XBT_PUBLIC(void)          xbt_dynar_dump(xbt_dynar_t dynar);
 
 /** @} */
 /** @defgroup XBT_dynar_array Dynar as a regular array
@@ -81,16 +83,16 @@ SG_BEGIN_DECL()
  *  @{
  */
 
-  XBT_PUBLIC void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void * const dst);
+  XBT_PUBLIC(void) xbt_dynar_get_cpy(const xbt_dynar_t dynar, const unsigned long idx, void * const dst);
   
-  XBT_PUBLIC void xbt_dynar_set(xbt_dynar_t dynar, int idx, const void *src);
-  XBT_PUBLIC void xbt_dynar_replace(xbt_dynar_t dynar, int idx, const void *object);
+  XBT_PUBLIC(void) xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void *src);
+  XBT_PUBLIC(void) xbt_dynar_replace(xbt_dynar_t dynar, const unsigned long idx, const void *object);
 
-  XBT_PUBLIC void xbt_dynar_insert_at(xbt_dynar_t dynar, int  idx, const void *src);
-  XBT_PUBLIC void xbt_dynar_remove_at(xbt_dynar_t dynar, int  idx, void * const dst);
+  XBT_PUBLIC(void) xbt_dynar_insert_at(xbt_dynar_t  const dynar, const int  idx, const void *src);
+  XBT_PUBLIC(void) xbt_dynar_remove_at(xbt_dynar_t  const dynar, const int  idx, void * const dst);
 
-  XBT_PUBLIC int  xbt_dynar_search(xbt_dynar_t dynar, void *elem);
-  XBT_PUBLIC int  xbt_dynar_member(xbt_dynar_t dynar, void *elem);
+  XBT_PUBLIC(int)  xbt_dynar_search(xbt_dynar_t  const dynar, void *elem);
+  XBT_PUBLIC(int)  xbt_dynar_member(xbt_dynar_t  const dynar, void *elem);
 /** @} */
 /** @defgroup XBT_dynar_perl Perl-like use of dynars
  *  @ingroup XBT_dynar
@@ -98,11 +100,11 @@ SG_BEGIN_DECL()
  *  @{
  */
 
-  XBT_PUBLIC void xbt_dynar_push    (xbt_dynar_t dynar, const void *src);
-  XBT_PUBLIC void xbt_dynar_pop     (xbt_dynar_t dynar, void *const dst);
-  XBT_PUBLIC void xbt_dynar_unshift (xbt_dynar_t dynar, const void *src);
-  XBT_PUBLIC void xbt_dynar_shift   (xbt_dynar_t dynar, void *const dst);
-  XBT_PUBLIC void xbt_dynar_map     (const xbt_dynar_t dynar, void_f_pvoid_t *op);
+  XBT_PUBLIC(void) xbt_dynar_push    (xbt_dynar_t  const dynar, const void *src);
+  XBT_PUBLIC(void) xbt_dynar_pop     (xbt_dynar_t  const dynar, void *const dst);
+  XBT_PUBLIC(void) xbt_dynar_unshift (xbt_dynar_t  const dynar, const void *src);
+  XBT_PUBLIC(void) xbt_dynar_shift   (xbt_dynar_t  const dynar, void *const dst);
+  XBT_PUBLIC(void) xbt_dynar_map     (const xbt_dynar_t dynar, void_f_pvoid_t const op);
 
 /** @} */
 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
@@ -113,10 +115,10 @@ SG_BEGIN_DECL()
  *  @{
  */
 
-  XBT_PUBLIC void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const int idx);
-  XBT_PUBLIC void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
-  XBT_PUBLIC void *xbt_dynar_push_ptr(xbt_dynar_t dynar);
-  XBT_PUBLIC void *xbt_dynar_pop_ptr(xbt_dynar_t dynar);
+  XBT_PUBLIC(void*) xbt_dynar_get_ptr(const xbt_dynar_t dynar, const unsigned long idx);
+  XBT_PUBLIC(void*) xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
+  XBT_PUBLIC(void*) xbt_dynar_push_ptr(xbt_dynar_t  const dynar);
+  XBT_PUBLIC(void*) xbt_dynar_pop_ptr(xbt_dynar_t  const dynar);
 
 /** @} */
 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
@@ -160,18 +162,25 @@ SG_BEGIN_DECL()
  *
  * Cursors are used to iterate over the structure. Never add elements to the 
  * DynArr during the traversal. To remove elements, use the
- * xbt_dynar_cursor_rm() function
+ * xbt_dynar_cursor_rm() function.
+ *
+ * Do not call these functions directly, but only the xbt_dynar_foreach macro.
+ * 
+ * For synchronized dynars, the dynar will be locked during the whole
+ * loop and it will get unlocked automatically if you traverse all
+ * elements. If you want to break the loop before the end, make sure
+ * to call xbt_dynar_cursor_unlock() before the <tt>break;</tt>
  *
  *  @{
  */
 
-  XBT_PUBLIC void xbt_dynar_cursor_first (const xbt_dynar_t dynar, int *cursor);
-  XBT_PUBLIC void xbt_dynar_cursor_step  (const xbt_dynar_t dynar, int *cursor);
-  XBT_PUBLIC int  xbt_dynar_cursor_get   (const xbt_dynar_t dynar, int *cursor, 
-			       void *whereto);
-  XBT_PUBLIC void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
-			   int          *const cursor);
-
+  XBT_PUBLIC(void) _xbt_dynar_cursor_first (const xbt_dynar_t dynar, unsigned int * const cursor);
+  XBT_PUBLIC(void) _xbt_dynar_cursor_step  (const xbt_dynar_t dynar, unsigned int * const cursor);
+  XBT_PUBLIC(int)  _xbt_dynar_cursor_get   (const xbt_dynar_t dynar, unsigned int * const cursor, 
+					    void *whereto);
+  XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar,
+				       unsigned int *const cursor);
+  XBT_PUBLIC(void) xbt_dynar_cursor_unlock(xbt_dynar_t dynar);
 
 /** @brief Iterates over the whole dynar. 
  * 
@@ -183,7 +192,7 @@ SG_BEGIN_DECL()
  * \note An example of usage:
  * \code
 xbt_dynar_t dyn;
-int cpt;
+unsigned int cpt;
 string *str;
 xbt_dynar_foreach (dyn,cpt,str) {
   printf("Seen %s\n",str);
@@ -191,9 +200,9 @@ xbt_dynar_foreach (dyn,cpt,str) {
 \endcode
  */
 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
-       for (xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
-	    xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
-            xbt_dynar_cursor_step(_dynar,&(_cursor))         )
+       for (_xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
+	    _xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
+            _xbt_dynar_cursor_step(_dynar,&(_cursor))         )
 
 /** @} */