X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/85897b1307bb68f05f31385803f1b3a5b806a73f..4f4314c39e129ca194f757e4e068866e286736f6:/include/xbt/dynar.h?ds=sidebyside

diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h
index ab156bbb58..7b9b53f33b 100644
--- a/include/xbt/dynar.h
+++ b/include/xbt/dynar.h
@@ -11,18 +11,13 @@
 #define _XBT_DYNAR_H
 
 #include "xbt/misc.h" /* SG_BEGIN_DECL */
+#include "xbt/function_types.h"
 
 SG_BEGIN_DECL()
 
 /** @addtogroup XBT_dynar
   * @brief DynArr are dynamically sized vector which may contain any type of variables.
   *
-  * <center><table><tr><td><b>Up </b>    <td> [\ref index]::[\ref XBT_API]
-  *                <tr><td><b>Prev</b>   <td> [\ref XBT_config]
-  *                <tr><td><b>Next</b>   <td> [\ref XBT_dict]
-  *                <tr><td><b>Down</b>   <td> \ref XBT_dynar_cons\n\ref XBT_dynar_array\n\ref XBT_dynar_perl\n\ref XBT_dynar_ctn\n\ref XBT_dynar_speed\n\ref XBT_dynar_cursor 
-  * </table></center>
-  *
   * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
   *  
   * For performance concerns, the content of DynArr must be homogeneous (in
@@ -61,89 +56,75 @@ SG_BEGIN_DECL()
 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
  *  @ingroup XBT_dynar
  *
- * <center><table><tr><td><b>Up </b>       <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
- *                <tr><td><b>Jump to</b><td> --\>\ref XBT_dynar_cons\<--\n\ref XBT_dynar_array\n\ref XBT_dynar_perl\n\ref XBT_dynar_ctn\n\ref XBT_dynar_speed\n\ref XBT_dynar_cursor
- * </table></center>
- *
  *  @{
  */
    /** \brief Dynar data type (opaque type) */
    typedef struct xbt_dynar_s *xbt_dynar_t;
 
 
-  xbt_dynar_t   xbt_dynar_new(unsigned long elm_size, 
-			     void_f_pvoid_t *free_func);
-  void          xbt_dynar_free(xbt_dynar_t *dynar);
-  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);
 
-  unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
-  void          xbt_dynar_reset(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 const dynar);
+  XBT_PUBLIC(void)          xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
 
-  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
  *  @ingroup XBT_dynar
  *
- * <center><table><tr><td><b>Up </b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
- *                <tr><td><b>Jump to</b><td> \ref XBT_dynar_cons\n--\>\ref XBT_dynar_array\<--\n\ref XBT_dynar_perl\n\ref XBT_dynar_ctn\n\ref XBT_dynar_speed\n\ref XBT_dynar_cursor
- * </table></center>
- *
  *  @{
  */
 
-  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);
   
-  void xbt_dynar_set(xbt_dynar_t dynar, int idx, const void *src);
-  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);
 
-  void xbt_dynar_insert_at(xbt_dynar_t dynar, int  idx, const void *src);
-  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  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
  *
- * <center><table><tr><td><b>Up </b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
- *                <tr><td><b>Jump to</b><td> \ref XBT_dynar_cons\n\ref XBT_dynar_array\n--\>\ref XBT_dynar_perl\<--\n\ref XBT_dynar_ctn\n\ref XBT_dynar_speed\n\ref XBT_dynar_cursor
- * </table></center>
- *
  *  @{
  */
 
-  void xbt_dynar_push    (xbt_dynar_t dynar, const void *src);
-  void xbt_dynar_pop     (xbt_dynar_t dynar, void *const dst);
-  void xbt_dynar_unshift (xbt_dynar_t dynar, const void *src);
-  void xbt_dynar_shift   (xbt_dynar_t dynar, void *const dst);
-  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
  *  @ingroup XBT_dynar
  *
- * <center><table><tr><td><b>Up </b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
- *                <tr><td><b>Jump to</b><td> \ref XBT_dynar_cons\n\ref XBT_dynar_array\n\ref XBT_dynar_perl\n--\>\ref XBT_dynar_ctn\<--\n\ref XBT_dynar_speed\n\ref XBT_dynar_cursor
- * </table></center>
- *
- *  Those functions do not retrive the content, but only their address.
+ *  Those functions do not retrieve the content, but only their address.
  *
  *  @{
  */
 
-  void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const int idx);
-  void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
-  void *xbt_dynar_push_ptr(xbt_dynar_t dynar);
-  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
  *  @ingroup XBT_dynar
  *
- * <center><table><tr><td><b>Up </b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
- *                <tr><td><b>Jump to</b><td> \ref XBT_dynar_cons\n\ref XBT_dynar_array\n\ref XBT_dynar_perl\n\ref XBT_dynar_ctn\n--\>\ref XBT_dynar_speed\<--\n\ref XBT_dynar_cursor
- * </table></center>
- *
- *  While the other functions use a memcpy to retrive the content into the
+ *  While the other functions use a memcpy to retrieve the content into the
  *  user provided area, those ones use a regular affectation. It only works
  *  for scalar values, but should be a little faster.
  *
@@ -179,24 +160,27 @@ SG_BEGIN_DECL()
 /** @defgroup XBT_dynar_cursor Cursors on dynar
  *  @ingroup XBT_dynar
  *
- * <center><table><tr><td><b>Up </b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
- *                <tr><td><b>Jump to</b><td> \ref XBT_dynar_cons\n\ref XBT_dynar_array\n\ref XBT_dynar_perl\n\ref XBT_dynar_ctn\n\ref XBT_dynar_speed\n--\>\ref XBT_dynar_cursor\<--
- * </table></center>
- *
  * 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>
  *
  *  @{
  */
 
-  void xbt_dynar_cursor_first (const xbt_dynar_t dynar, int *cursor);
-  void xbt_dynar_cursor_step  (const xbt_dynar_t dynar, int *cursor);
-  int  xbt_dynar_cursor_get   (const xbt_dynar_t dynar, int *cursor, 
-			       void *whereto);
-  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. 
  * 
@@ -208,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);
@@ -216,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))         )
 
 /** @} */