X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b8df87e176f27b25534f27d7e240defa32ca35bc..e71a2a302d28430dc1bfee906f842f5f3d0fa3ce:/include/xbt/dynar.h diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h index 5384cfbfec..7f59f2892d 100644 --- a/include/xbt/dynar.h +++ b/include/xbt/dynar.h @@ -1,6 +1,6 @@ /* dynar - a generic dynamic array */ -/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2021. The SimGrid Team. 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. */ @@ -13,14 +13,14 @@ #include /* SG_BEGIN_DECL */ #include -SG_BEGIN_DECL() +SG_BEGIN_DECL /** @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 + * 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 * structure creation (of type void_f_pvoid_t). * @@ -52,9 +52,8 @@ SG_BEGIN_DECL() * @skip end_of_doxygen * @until } * - * Note that if you use dynars to store pointed data, the xbt_dynar_search(), xbt_dynar_search_or_negative() and - * xbt_dynar_member() won't be for you. Instead of comparing your pointed elements, they compare the pointer to them. - * See the documentation of xbt_dynar_search() for more info. + * 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 @@ -63,15 +62,12 @@ SG_BEGIN_DECL() */ /** @brief Dynar data type (opaque type) */ typedef struct xbt_dynar_s *xbt_dynar_t; +typedef const struct xbt_dynar_s* const_xbt_dynar_t; -XBT_PUBLIC xbt_dynar_t xbt_dynar_new(const unsigned long elm_size, void_f_pvoid_t const free_f); -XBT_PUBLIC void xbt_dynar_init(xbt_dynar_t dynar, const unsigned long elmsize, void_f_pvoid_t const free_f); +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_voidp(void* dynar); XBT_PUBLIC void xbt_dynar_free_container(xbt_dynar_t* dynar); -XBT_PUBLIC void xbt_dynar_free_data(xbt_dynar_t dynar); XBT_PUBLIC void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots); -XBT_PUBLIC void xbt_dynar_dump(xbt_dynar_t dynar); /** @} */ /** @defgroup XBT_dynar_array Dynar as a regular array @@ -80,21 +76,14 @@ XBT_PUBLIC void xbt_dynar_dump(xbt_dynar_t dynar); * @{ */ -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, 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_get_cpy(const_xbt_dynar_t dynar, unsigned long idx, void* 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 void xbt_dynar_remove_n_at(xbt_dynar_t const dynar, const unsigned int n, const int idx); +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* dst); -XBT_PUBLIC unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void* elem); -XBT_PUBLIC signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void* const elem); -XBT_PUBLIC int xbt_dynar_member(xbt_dynar_t const dynar, void* elem); -XBT_PUBLIC void xbt_dynar_sort(xbt_dynar_t const dynar, int_f_cpvoid_cpvoid_t compar_fn); -XBT_PUBLIC xbt_dynar_t xbt_dynar_sort_strings(xbt_dynar_t dynar); -XBT_PUBLIC int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, int (*compar)(const void*, const void*)); -XBT_PUBLIC void* xbt_dynar_to_array(xbt_dynar_t dynar); +XBT_PUBLIC int xbt_dynar_member(const_xbt_dynar_t dynar, const void* elem); +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 @@ -103,10 +92,9 @@ XBT_PUBLIC void* xbt_dynar_to_array(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 const dynar); -XBT_PUBLIC void xbt_dynar_merge(xbt_dynar_t* d1, xbt_dynar_t* d2); +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 @@ -115,11 +103,11 @@ XBT_PUBLIC void xbt_dynar_merge(xbt_dynar_t* d1, xbt_dynar_t* d2); * @{ */ -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); +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 @@ -130,11 +118,11 @@ XBT_PUBLIC void xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op); * @{ */ -XBT_PUBLIC void* xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, const unsigned long idx); -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); +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 @@ -152,26 +140,20 @@ XBT_PUBLIC void* xbt_dynar_pop_ptr(xbt_dynar_t const dynar); (*(type*)xbt_dynar_get_ptr((dynar),(idx))) /** @brief Quick setting of scalar content * @hideinitializer */ -# define xbt_dynar_set_as(dynar,idx,type,val) \ - (*(type*)xbt_dynar_set_at_ptr((dynar),(idx))) = val - /** @brief Quick retrieval of scalar content - * @hideinitializer */ +#define xbt_dynar_set_as(dynar, idx, type, val) (*(type*)xbt_dynar_set_at_ptr((dynar), (idx))) = (val) +/** @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 */ +/** @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 removal of scalar content - * @hideinitializer */ +/** @brief Quick insertion of scalar content + * @hideinitializer */ +#define xbt_dynar_push_as(dynar, type, value) *(type*)xbt_dynar_push_ptr(dynar) = (value) +/** @brief Quick removal of scalar content + * @hideinitializer */ # define xbt_dynar_pop_as(dynar,type) \ (*(type*)xbt_dynar_pop_ptr(dynar)) @@ -179,16 +161,11 @@ XBT_PUBLIC void* xbt_dynar_pop_ptr(xbt_dynar_t const 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. - * - * Do not call these function directly, but only within the xbt_dynar_foreach macro. + * Cursors are used to iterate over the structure. Never add elements to the DynArr during the traversal. * * @{ */ -XBT_PUBLIC void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int* const cursor); - /* * @warning DO NOT USE THIS STRUCTURE DIRECTLY! Instead, use the public interface: * This was made public to allow: @@ -205,16 +182,13 @@ typedef struct xbt_dynar_s { void_f_pvoid_t free_f; } s_xbt_dynar_t; -static inline int _xbt_dynar_cursor_get(const xbt_dynar_t dynar, unsigned int idx, void* const dst) +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 */ return 0; - if (idx >= dynar->used) { - //XBT_DEBUG("Cursor on %p already on last elem", (void *) dynar); + if (idx >= dynar->used) return 0; - } - // XBT_DEBUG("Cash out cursor on %p at %u", (void *) dynar, *idx); memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize, dynar->elmsize); @@ -241,35 +215,10 @@ xbt_dynar_foreach (dyn,cpt,str) { * 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. */ -#define xbt_dynar_foreach(_dynar,_cursor,_data) \ - for ( (_cursor) = 0 ; \ - _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \ - (_cursor)++ ) +#define xbt_dynar_foreach(_dynar, _cursor, _data) \ + for ((_cursor) = 0; _xbt_dynar_cursor_get((_dynar), (_cursor), &(_data)); (_cursor)++) -#ifndef __cplusplus -#define xbt_dynar_foreach_ptr(_dynar,_cursor,_ptr) \ - for ((_cursor) = 0 ; \ - (_ptr = _cursor < _dynar->used ? xbt_dynar_get_ptr(_dynar,_cursor) : NULL) ; \ - (_cursor)++ ) -#else -#define xbt_dynar_foreach_ptr(_dynar,_cursor,_ptr) \ - for ((_cursor) = 0 ; \ - (_ptr = _cursor < _dynar->used ? (decltype(_ptr)) xbt_dynar_get_ptr(_dynar,_cursor) : NULL) ; \ - (_cursor)++ ) -#endif /** @} */ -SG_END_DECL() - -#ifdef __cplusplus -namespace simgrid { -namespace xbt { -/** Dynar of `T*` which `delete` its values */ -template inline xbt_dynar_t newDeleteDynar() -{ - return xbt_dynar_new(sizeof(T*), [](void* p) { delete *(T**)p; }); -} -} -} -#endif +SG_END_DECL #endif /* XBT_DYNAR_H */