X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ce6136d5f1a9ce68cfa6c968c257bd6c00c531d7..8ffb62089250c85576933a6eb1bb3be501712840:/include/xbt/dynar.h diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h index 7dfff27998..52a99e05b9 100644 --- a/include/xbt/dynar.h +++ b/include/xbt/dynar.h @@ -1,18 +1,17 @@ /* dynar - a generic dynamic array */ -/* Copyright (c) 2004-2007, 2009-2015. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2004-2018. 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. */ -#ifndef _XBT_DYNAR_H -#define _XBT_DYNAR_H +#ifndef XBT_DYNAR_H +#define XBT_DYNAR_H #include /* memcpy */ -#include "xbt/base.h" /* SG_BEGIN_DECL */ -#include "xbt/function_types.h" +#include /* SG_BEGIN_DECL */ +#include SG_BEGIN_DECL() @@ -20,14 +19,15 @@ SG_BEGIN_DECL() * @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). + * + * 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_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.c + * \dontinclude dynar.cpp * * \skip Vars_decl * \skip dyn @@ -40,7 +40,7 @@ SG_BEGIN_DECL() * \until xbt_dynar_free * * \section XBT_dynar_exptr Example with pointed data - * + * * \skip test_dynar_string * \skip dynar_t * \until s2 @@ -52,12 +52,9 @@ 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, 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. */ /** @defgroup XBT_dynar_cons Dynar constructor and destructor * @ingroup XBT_dynar @@ -67,14 +64,14 @@ SG_BEGIN_DECL() /** \brief Dynar data type (opaque type) */ typedef struct xbt_dynar_s *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_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_shrink(xbt_dynar_t dynar, int empty_slots); -XBT_PUBLIC(void) xbt_dynar_dump(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 void xbt_dynar_init(xbt_dynar_t dynar, const unsigned long elmsize, 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 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 @@ -83,34 +80,21 @@ 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, 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_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 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(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(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar, - int_f_pvoid_t color); -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 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); /** @} */ /** @defgroup XBT_dynar_misc Dynar miscellaneous functions @@ -119,10 +103,10 @@ 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 const dynar); +XBT_PUBLIC void xbt_dynar_merge(xbt_dynar_t* d1, xbt_dynar_t* d2); /** @} */ /** @defgroup XBT_dynar_perl Perl-like use of dynars @@ -131,13 +115,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 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 @@ -148,27 +130,23 @@ XBT_PUBLIC(void) xbt_dynar_map(const xbt_dynar_t dynar, * @{ */ -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, 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); /** @} */ /** @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. + * 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 + /** @brief Quick retrieval of scalar content * @hideinitializer */ # define xbt_dynar_get_as(dynar,idx,type) \ (*(type*)xbt_dynar_get_ptr((dynar),(idx))) @@ -176,19 +154,19 @@ XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar); * @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 + /** @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 + /** @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 + /** @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 + /** @brief Quick insertion of scalar content * @hideinitializer */ # define xbt_dynar_push_as(dynar,type,value) \ *(type*)xbt_dynar_push_ptr(dynar)=value @@ -201,25 +179,24 @@ 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. + * 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. + * Do not call these function directly, but only within the xbt_dynar_foreach macro. * * @{ */ -XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar, - unsigned int *const cursor); +XBT_PUBLIC void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int* const cursor); -/* do not use this structure internals directly, but use the public interface - * This was made public to allow: - * - the inlining of the foreach elements - * - sending such beasts over the network +/* + * \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; @@ -228,29 +205,24 @@ typedef struct xbt_dynar_s { void_f_pvoid_t free_f; } s_xbt_dynar_t; -static XBT_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* const dst) { if (!dynar) /* iterating over a NULL dynar is a no-op */ - return FALSE; + return 0; if (idx >= dynar->used) { //XBT_DEBUG("Cursor on %p already on last elem", (void *) dynar); - return FALSE; + return 0; } // XBT_DEBUG("Cash out cursor on %p at %u", (void *) dynar, *idx); - memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize, - dynar->elmsize); + memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize, dynar->elmsize); - return TRUE; + return 1; } - - -/** @brief Iterates over the whole dynar. - * +/** @brief Iterates over the whole dynar. + * * @param _dynar what to iterate over * @param _cursor an integer used as cursor * @param _data @@ -265,10 +237,9 @@ 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. + * + * 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 ; \ @@ -287,6 +258,6 @@ xbt_dynar_foreach (dyn,cpt,str) { (_cursor)++ ) #endif /** @} */ - SG_END_DECL() -#endif /* _XBT_DYNAR_H */ + +#endif /* XBT_DYNAR_H */