X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/66eeb4028730b704a90c79edc202e18a159b3eda..09f286c26a7cabb1d5d5cfda4ecd26e06cd23080:/include/xbt/dynar.h

diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h
index ff1085d8b6..d3b131c189 100644
--- a/include/xbt/dynar.h
+++ b/include/xbt/dynar.h
@@ -1,85 +1,199 @@
 /* $Id$ */
 
-/* dynar - a generic dynamic array                                         */
+/* dynar - a generic dynamic array                                          */
 
-/* Authors: Martin Quinson                                                  */
-/* Copyright (C) 2003 the OURAGAN project.                                  */
+/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
 
 /* This program is free software; you can redistribute it and/or modify it
-   under the terms of the license (GNU LGPL) which comes with this package. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#ifndef _GRAS_DYNAR_H
-#define _GRAS_DYNAR_H
+#ifndef _XBT_DYNAR_H
+#define _XBT_DYNAR_H
 
-typedef struct gras_dynar_s gras_dynar_t;
+#include "xbt/misc.h" /* SG_BEGIN_DECL */
+#include "xbt/function_types.h"
 
-/* pointer to a function freeing something */
-typedef   void (void_f_ppvoid_t)(void**);
-typedef   void (void_f_pvoid_t) (void*);
+SG_BEGIN_DECL()
 
-gras_dynar_t *gras_dynar_new(unsigned long elm_size, 
+/** @addtogroup XBT_dynar
+  * @brief DynArr are dynamically sized vector which may contain any type of variables.
+  *
+  * 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
+  * contrary to dictionnaries -- see the \ref XBT_dict section). You thus
+  * have to provide the function which will be used to free the content at
+  * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
+  *
+  * \section XBT_dynar_exscal Example with scalar
+  * \dontinclude dynar.c
+  *
+  * \skip Vars_decl
+  * \skip dyn
+  * \until iptr
+  * \skip Populate_ints
+  * \skip dyn
+  * \until end_of_traversal
+  * \skip shifting
+  * \skip val
+  * \until xbt_dynar_free
+  *
+  * \section XBT_dynar_exptr Example with pointed data
+  * 
+  * \skip doxygen_string_cruft
+  * \skip function
+  * \until s2
+  * \skip Populate_str
+  * \skip dyn
+  * \until }
+  * \skip macro
+  * \until dynar_free
+  * \skip end_of_doxygen
+  * \until }
+  *
+  */
+
+/** @defgroup XBT_dynar_cons Dynar constructor and destructor
+ *  @ingroup XBT_dynar
+ *
+ *  @{
+ */
+   /** \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          gras_dynar_free(gras_dynar_t *dynar);
-void          gras_dynar_free_container(gras_dynar_t *dynar);
+  void          xbt_dynar_free(xbt_dynar_t *dynar);
+  void          xbt_dynar_free_voidp(void *dynar);
+  void          xbt_dynar_free_container(xbt_dynar_t *dynar);
 
-unsigned long gras_dynar_length(const gras_dynar_t *dynar);
-void          gras_dynar_reset(gras_dynar_t *dynar);
+  unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
+  void          xbt_dynar_reset(xbt_dynar_t dynar);
 
+  void          xbt_dynar_dump(xbt_dynar_t dynar);
 
-/* regular array functions */
-void gras_dynar_get_cpy(const gras_dynar_t *dynar, int idx, void *const dst);
-void *gras_dynar_get_ptr(const gras_dynar_t * const dynar,
-			 const int                  idx);
+/** @} */
+/** @defgroup XBT_dynar_array Dynar as a regular array
+ *  @ingroup XBT_dynar
+ *
+ *  @{
+ */
 
-#define gras_dynar_get_as(dynar,idx,type) *(type*)gras_dynar_get_ptr(dynar,idx)
+  void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void * const dst);
   
-void gras_dynar_set(gras_dynar_t *dynar, int  idx, const void *src);
-void gras_dynar_remplace(gras_dynar_t *dynar,
-			 int idx, const void *object);
-
-/* perl array function */
-void gras_dynar_insert_at(gras_dynar_t *dynar,
-			   int  idx, const void *src);
-void gras_dynar_remove_at(gras_dynar_t *dynar,
-			   int  idx, void *object);
-void gras_dynar_push     (gras_dynar_t *dynar, const void *src);
-void gras_dynar_pop      (gras_dynar_t *dynar, void *const dst);
-void gras_dynar_unshift  (gras_dynar_t *dynar, const void *src);
-void gras_dynar_shift    (gras_dynar_t *dynar, void *const dst);
-void gras_dynar_map      (const gras_dynar_t *dynar, void_f_pvoid_t *operator);
-
-/* cursor functions */
-void gras_dynar_cursor_first (const gras_dynar_t *dynar, int *cursor);
-void gras_dynar_cursor_step  (const gras_dynar_t *dynar, int *cursor);
-int  gras_dynar_cursor_get   (const gras_dynar_t *dynar, int *cursor, void *whereto);
-
-/**
- * gras_dynar_foreach:
- * @_dynar: what to iterate over
- * @_cursor: an integer used as cursor
- * @_data:
+  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);
+
+  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);
+
+/** @} */
+/** @defgroup XBT_dynar_perl Perl-like use of dynars
+ *  @ingroup XBT_dynar
+ *
+ *  @{
+ */
+
+  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);
+
+/** @} */
+/** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
+ *  @ingroup XBT_dynar
  *
- * Iterates over the whole dynar. Example:
+ *  Those functions do not retrive the content, but only their address.
  *
- * <programlisting>
- * gras_dynar_t *dyn;
- * int cpt;
- * string *str;
- * gras_dynar_foreach (dyn,cpt,str) {
- *   printf("Seen %s\n",str);
- * }</programlisting>
+ *  @{
  */
-#define gras_dynar_foreach(_dynar,_cursor,_data) \
-       for (gras_dynar_cursor_first(_dynar,&(_cursor))      ; \
-	    gras_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
-            gras_dynar_cursor_step(_dynar,&(_cursor))         )
-/*
-       for (gras_dynar_length(_dynar) && (_gras_dynar_cursor_first(_dynar,&_cursor),      \
-					  1);     \
-	    gras_dynar_length(_dynar) && gras_dynar_cursor_get(_dynar,&_cursor,&_data); \
-            gras_dynar_cursor_step(_dynar,&_cursor))
-*/
-void gras_dynar_cursor_rm(gras_dynar_t * dynar,
-			  int          * const cursor);
-
-#endif /* _GRAS_DYNAR_H */
+
+  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);
+
+/** @} */
+/** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
+ *  @ingroup XBT_dynar
+ *
+ *  While the other functions use a memcpy to retrive 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.
+ *
+ *  @{
+ */
+
+  /** @brief Quick retrieval of scalar content 
+   *  @hideinitializer */
+#  define xbt_dynar_get_as(dynar,idx,type) \
+          (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
+  /** @brief Quick retrieval of scalar content 
+   *  @hideinitializer */
+#  define xbt_dynar_getlast_as(dynar,type) \
+          (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
+  /** @brief Quick retrieval of scalar content 
+   *  @hideinitializer */
+#  define xbt_dynar_getfirst_as(dynar,type) \
+          (*(type*)xbt_dynar_get_ptr((dynar),0))
+  /** @brief Quick insertion of scalar content 
+   *  @hideinitializer */
+#  define xbt_dynar_insert_at_as(dynar,idx,type,value) \
+          *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
+  /** @brief Quick insertion of scalar content 
+   *  @hideinitializer */
+#  define xbt_dynar_push_as(dynar,type,value) \
+          *(type*)xbt_dynar_push_ptr(dynar)=value
+  /** @brief Quick insertion of scalar content 
+   *  @hideinitializer */
+#  define xbt_dynar_pop_as(dynar,type) \
+           (*(type*)xbt_dynar_pop_ptr(dynar))
+
+/** @} */
+/** @defgroup XBT_dynar_cursor Cursors on dynar
+ *  @ingroup XBT_dynar
+ *
+ * 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
+ *
+ *  @{
+ */
+
+  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);
+
+
+/** @brief Iterates over the whole dynar. 
+ * 
+ *  @param _dynar what to iterate over
+ *  @param _cursor an integer used as cursor
+ *  @param _data
+ *  @hideinitializer
+ *
+ * \note An example of usage:
+ * \code
+xbt_dynar_t dyn;
+int cpt;
+string *str;
+xbt_dynar_foreach (dyn,cpt,str) {
+  printf("Seen %s\n",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))         )
+
+/** @} */
+
+SG_END_DECL()
+
+#endif /* _XBT_DYNAR_H */