SG_BEGIN_DECL
-/** @addtogroup XBT_dynar
- * @brief DynArr are dynamically sized vector which may contain any type of variables.
+/** @brief Dynar data type (opaque type)
*
- * 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 dictionaries -- see the
- * @ref XBT_dict section). You thus have to provide the function which will be used to free the content at
+ * These are the SimGrid version of the DYNamically sized ARays, which all C programmer recode one day or another.
+ * For performance concerns, the content of dynars must be homogeneous (in contrary to @ref xbt_dict_t).
+ * You thus have to provide the function which will be used to free the content at
* structure creation (of type void_f_pvoid_t).
- *
- * @deprecated If you are using C++, you might want to use `std::vector` instead.
- *
- * @section XBT_dynar_exscal Example with scalar
- * @dontinclude dynar.cpp
- *
- * @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 test_dynar_string
- * @skip dynar_t
- * @until s2
- * @skip Populate_str
- * @skip dyn
- * @until }
- * @skip macro
- * @until dynar_free
- * @skip end_of_doxygen
- * @until }
- *
- * Note that if you use dynars to store pointed data, xbt_dynar_member() won't be for you. Instead of comparing your
- * pointed elements, it compares the pointer to them.
*/
-/** @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;
+/** constant dynar */
typedef const struct xbt_dynar_s* const_xbt_dynar_t;
+/* @warning DO NOT USE THIS STRUCTURE DIRECTLY! Use the public interface, even if it's public for sake of inlining */
+typedef struct xbt_dynar_s {
+ unsigned long size;
+ unsigned long used;
+ unsigned long elmsize;
+ void* data;
+ void_f_pvoid_t free_f;
+} s_xbt_dynar_t;
XBT_PUBLIC xbt_dynar_t xbt_dynar_new(const unsigned long elm_size, void_f_pvoid_t free_f);
XBT_PUBLIC void xbt_dynar_free(xbt_dynar_t* dynar);
XBT_PUBLIC void xbt_dynar_free_container(xbt_dynar_t* dynar);
XBT_PUBLIC void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
-/** @} */
-/** @defgroup XBT_dynar_array Dynar as a regular array
- * @ingroup XBT_dynar
- *
- * @{
- */
-
+/* Dynar as a regular array */
XBT_PUBLIC void xbt_dynar_get_cpy(const_xbt_dynar_t dynar, unsigned long idx, void* dst);
XBT_PUBLIC void xbt_dynar_insert_at(xbt_dynar_t dynar, int idx, const void* src);
XBT_PUBLIC void xbt_dynar_sort(const_xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn);
XBT_ATTRIB_DEPRECATED_v331("This function will be removed") XBT_PUBLIC void* xbt_dynar_to_array(xbt_dynar_t dynar);
-/** @} */
-/** @defgroup XBT_dynar_misc Dynar miscellaneous functions
- * @ingroup XBT_dynar
- *
- * @{
- */
-
+/* Dynar size */
+XBT_PUBLIC void xbt_dynar_reset(xbt_dynar_t dynar);
XBT_PUBLIC unsigned long xbt_dynar_length(const_xbt_dynar_t dynar);
XBT_PUBLIC int xbt_dynar_is_empty(const_xbt_dynar_t dynar);
-XBT_PUBLIC void xbt_dynar_reset(xbt_dynar_t dynar);
-
-/** @} */
-/** @defgroup XBT_dynar_perl Perl-like use of dynars
- * @ingroup XBT_dynar
- *
- * @{
- */
+/* Perl-like interface */
XBT_PUBLIC void xbt_dynar_push(xbt_dynar_t dynar, const void* src);
XBT_PUBLIC void xbt_dynar_pop(xbt_dynar_t dynar, void* 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* dst);
XBT_PUBLIC 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
- *
- * Those functions do not retrieve the content, but only their address.
- *
- * @{
- */
-
+/* Direct content manipulation*/
XBT_PUBLIC void* xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, unsigned long idx);
XBT_PUBLIC void* xbt_dynar_get_ptr(const_xbt_dynar_t dynar, unsigned long idx);
XBT_PUBLIC void* xbt_dynar_insert_at_ptr(xbt_dynar_t dynar, int idx);
XBT_PUBLIC void* xbt_dynar_push_ptr(xbt_dynar_t dynar);
XBT_PUBLIC 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 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.
- *
- * @{
- */
-
- /** @brief Quick retrieval of scalar content
- * @hideinitializer */
+/* Dynars of scalar */
+/** @brief Quick retrieval of scalar content
+ * @hideinitializer */
# define xbt_dynar_get_as(dynar,idx,type) \
(*(type*)xbt_dynar_get_ptr((dynar),(idx)))
/** @brief Quick setting of scalar content
# 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.
- *
- * @{
- */
-
-/*
- * @warning DO NOT USE THIS STRUCTURE DIRECTLY! Instead, use the public interface:
- * This was made public to allow:
- * - the inlining of the foreach elements
- * - sending such beasts over the network
- *
- * @see xbt_dynar_length()
- */
-typedef struct xbt_dynar_s {
- unsigned long size;
- unsigned long used;
- unsigned long elmsize;
- void *data;
- void_f_pvoid_t free_f;
-} s_xbt_dynar_t;
-
+/* Iterating over dynars */
static inline int _xbt_dynar_cursor_get(const_xbt_dynar_t dynar, unsigned int idx, void* dst)
{
if (!dynar) /* iterating over a NULL dynar is a no-op */
/** @brief Iterates over the whole dynar.
*
* @param _dynar what to iterate over
- * @param _cursor an integer used as cursor
- * @param _data
+ * @param _cursor an unsigned integer used as cursor
* @hideinitializer
*
* Here is an example of usage:
* @code
xbt_dynar_t dyn;
unsigned int cpt;
-string *str;
+char* str;
xbt_dynar_foreach (dyn,cpt,str) {
printf("Seen %s\n",str);
}
@endcode
*
* Note that underneath, that's a simple for loop with no real black magic involved. It's perfectly safe to interrupt
- * a foreach with a break or a return statement.
+ * a foreach with a break or a return statement, but inserting or removing elements during the traversal is probably a
+ * bad idea (even if you can fix side effects by manually changing the counter).
*/
#define xbt_dynar_foreach(_dynar, _cursor, _data) \
for ((_cursor) = 0; _xbt_dynar_cursor_get((_dynar), (_cursor), &(_data)); (_cursor)++)
-
-/** @} */
SG_END_DECL
#endif /* XBT_DYNAR_H */
