SG_BEGIN_DECL()
-/**
+/**
* @addtogroup XBT_swag
* @brief a O(1) set based on linked lists
- *
+ *
* Warning, this module is done to be efficient and performs tons of cast and dirty things. So make sure you know what
* you are doing while using it.
* It is basically a fifo but with restrictions so that it can be used as a set. Any operation (add, remove, belongs)
/** @defgroup XBT_swag_type Swag types
@ingroup XBT_swag
- Specific set.
+ Specific set.
These typedefs are public so that the compiler can do his job but believe me, you don't want to try to play with
those structs directly. Use them as an abstract datatype.
void *next;
void *prev;
} s_xbt_swag_hookup_t;
-/**< This type should be added to a type that is to be used in a swag.
+/**< This type should be added to a type that is to be used in a swag.
*
* Whenever a new object with this struct is created, all fields have to be set to NULL
*
};
typedef struct xbt_swag s_xbt_swag_t;
typedef struct xbt_swag* xbt_swag_t;
+typedef const struct xbt_swag* const_xbt_swag_t;
/**< A typical swag */
/* @} */
-/** @defgroup XBT_swag_func SWAG functions
+/** @defgroup XBT_swag_func SWAG functions
* @ingroup XBT_swag
-
+
* @{
*/
XBT_PUBLIC(void) xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag);
XBT_PUBLIC(void *) xbt_swag_remove(void *obj, xbt_swag_t swag);
XBT_PUBLIC(void *) xbt_swag_extract(xbt_swag_t swag);
-XBT_PUBLIC(int) xbt_swag_size(xbt_swag_t swag);
+XBT_PUBLIC(int) xbt_swag_size(const_xbt_swag_t swag);
#define xbt_swag_getPrev(obj, offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->prev)
#define xbt_swag_getNext(obj, offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->next)
#define xbt_swag_belongs(obj, swag) (xbt_swag_getNext((obj), (swag)->offset) || (swag)->tail == (obj))
-static inline void *xbt_swag_getFirst(xbt_swag_t swag)
+static inline void *xbt_swag_getFirst(const_xbt_swag_t swag)
{
return (swag->head);
}
* \defgroup XBT_swag_curs Swag cursor
* @ingroup XBT_swag
- * Iterates over the whole swag.
+ * Iterates over the whole swag.
*
* @{ */
(obj)=(decltype(obj)) xbt_swag_getNext((obj),(swag)->offset))
#endif
/**
- * @brief A safe swag iterator
+ * @brief A safe swag iterator
* @param obj the indice of the loop
* @param obj_next the object that is right after (if any) \a obj in the swag
* @param swag what to iterate over
* @hideinitializer
- You can safely modify the \a swag while using this loop.
+ You can safely modify the \a swag while using this loop.
Well, safely... Err. You can remove \a obj without having any trouble at least. */
#ifndef __cplusplus
