-/* $Id$ */
-
-/* Copyright (c) 2004 Arnaud Legrand. All rights reserved. */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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. */
#define _XBT_SWAG_H
#include "xbt/misc.h"
-#include "xbt/sysdep.h"
+#include "xbt/sysdep.h" /* size_t */
-/* This type should be added to a type that is to be used in such a swag */
-/* Whenever a new object with this struct is created, all fields have
- to be set to NULL */
+SG_BEGIN_DECL()
/**
- * \addtogroup XBT_swag
+ * @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 avoid using it unless you really know
- * what you are doing. It is basically a fifo but with restrictions so that
+ * 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) is O(1) and
* no call to malloc/free is done.
*
- * @{
*/
-
-/** \name Swag types
+/** @defgroup XBT_swag_type Swag types
+ @ingroup XBT_swag
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.
typedef struct xbt_swag_hookup {
void *next;
void *prev;
-} s_xbt_swag_hookup_t;
+} s_xbt_swag_hookup_t;
/**< This type should be added to a type that is to be used in a swag.
- * For example like that :
+ *
+ * Whenever a new object with this struct is created, all fields have
+ * to be set to NULL
+ *
+ * Here is an example like that :
\code
typedef struct foo {
}
\endcode
*/
-typedef s_xbt_swag_hookup_t *xbt_swag_hookup_t;
+typedef s_xbt_swag_hookup_t *xbt_swag_hookup_t;
typedef struct xbt_swag {
/**< A typical swag */
/* @} */
-/** \name Functions
+/** @defgroup XBT_swag_func SWAG functions
+ * @ingroup XBT_swag
+
+ * @{
*/
-/* @{ */
-xbt_swag_t xbt_swag_new(size_t offset);
-void xbt_swag_free(xbt_swag_t swag);
-void xbt_swag_init(xbt_swag_t swag, size_t offset);
-void xbt_swag_insert(void *obj, xbt_swag_t swag);
-void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag);
-void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag);
-void *xbt_swag_remove(void *obj, xbt_swag_t swag);
-void *xbt_swag_extract(xbt_swag_t swag);
-int xbt_swag_size(xbt_swag_t swag);
-int xbt_swag_belongs(void *obj, xbt_swag_t swag);
-
-static _XBT_INLINE void *xbt_swag_getFirst(xbt_swag_t swag)
+XBT_PUBLIC(xbt_swag_t) xbt_swag_new(size_t offset);
+XBT_PUBLIC(void) xbt_swag_free(xbt_swag_t swag);
+XBT_INLINE XBT_PUBLIC(void) xbt_swag_init(xbt_swag_t swag, size_t offset);
+
+/**
+ * \param obj the objet to insert in the swag
+ * \param swag a swag
+ * @hideinitializer
+ *
+ * insert \a obj in \a swag
+ */
+#define xbt_swag_insert(obj, swag) xbt_swag_insert_at_tail(obj, swag)
+
+XBT_PUBLIC(void) xbt_swag_insert_at_head(void *obj, xbt_swag_t 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);
+
+#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)
+
+static XBT_INLINE int xbt_swag_belongs(void *obj, xbt_swag_t swag)
+{
+ return ((xbt_swag_getNext(obj, swag->offset))
+ || (xbt_swag_getPrev(obj, swag->offset))
+ || (swag->head == obj));
+}
+
+static XBT_INLINE void *xbt_swag_getFirst(xbt_swag_t swag)
{
return (swag->head);
}
-#define xbt_swag_getNext(obj,offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->prev)
-#define xbt_swag_getPrev(obj,offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->next)
/**
* \brief Offset computation
* \arg var a variable of type <tt>struct</tt> something
* \arg field a field of <tt>struct</tt> something
* \return the offset of \a field in <tt>struct</tt> something.
+ * @hideinitializer
*
* It is very similar to offsetof except that is done at runtime and that
* you have to declare a variable. Why defining such a macro then ?
/* @} */
/**
- * \name Swag iterator
- *
+ * \defgroup XBT_swag_curs Swag cursor
+ * @ingroup XBT_swag
+
* Iterates over the whole swag.
*
* @{ */
((obj)?(obj_next=xbt_swag_getNext((obj),(swag)->offset)): \
(obj_next=NULL)) )
/* @} */
-/* @} */
-#endif /* _XBT_SWAG_H */
+SG_END_DECL()
+#endif /* _XBT_SWAG_H */
