/* $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" /* BEGIN_DECL */
-/* pointer to a function freeing something */
-typedef void (void_f_ppvoid_t)(void**);
-typedef void (void_f_pvoid_t) (void*);
+BEGIN_DECL()
-gras_dynar_t *gras_dynar_new(unsigned long elm_size,
+/** \brief Dictionnary data type
+ \ingroup XBT_dynar
+*/
+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_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);
/* 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);
+void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void *const dst);
+void *xbt_dynar_get_ptr(const xbt_dynar_t dynar,
+ const int idx);
-#define gras_dynar_get_as(dynar,idx,type) *(type*)gras_dynar_get_ptr(dynar,idx)
+#define xbt_dynar_get_as(dynar,idx,type) *(type*)xbt_dynar_get_ptr(dynar,idx)
-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);
+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);
/* 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);
+
+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 *object);
+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 *operator);
+
+/* speed-optimized versions */
+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);
+
+#define xbt_dynar_insert_at_as(dynar,idx,type,value) *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
+#define xbt_dynar_push_as(dynar,type,value) *(type*)xbt_dynar_push_ptr(dynar)=value
+#define xbt_dynar_pop_as(dynar,type) *(type*)xbt_dynar_pop_ptr(dynar)
+
/* 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);
+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);
+
/**
- * gras_dynar_foreach:
- * @_dynar: what to iterate over
- * @_cursor: an integer used as cursor
- * @_data:
- *
- * Iterates over the whole dynar. Example:
+ \brief Dynar iterator
+ \ingroup XBT_dynar
+ * xbt_dynar_foreach:
+ * \param _dynar what to iterate over
+ * \param _cursor an integer used as cursor
+ * \param _data
*
- * <programlisting>
- * gras_dynar_t *dyn;
- * int cpt;
- * string *str;
- * gras_dynar_foreach (dyn,cpt,str) {
- * printf("Seen %s\n",str);
- * }</programlisting>
+ * Iterates over the whole dynar.
+ * \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 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)) )
+#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 (gras_dynar_length(_dynar) && (_gras_dynar_cursor_first(_dynar,&_cursor), \
+ for (xbt_dynar_length(_dynar) && (_xbt_dynar_cursor_first(_dynar,&_cursor), \
1); \
- gras_dynar_length(_dynar) && gras_dynar_cursor_get(_dynar,&_cursor,&_data); \
- gras_dynar_cursor_step(_dynar,&_cursor))
+ xbt_dynar_length(_dynar) && xbt_dynar_cursor_get(_dynar,&_cursor,&_data); \
+ xbt_dynar_cursor_step(_dynar,&_cursor))
*/
-void gras_dynar_cursor_rm(gras_dynar_t * dynar,
- int * const cursor);
+void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
+ int *const cursor);
-#endif /* _GRAS_DYNAR_H */
+END_DECL()
+#endif /* _XBT_DYNAR_H */