Yeah, right. Comments within comments. Erm. No comments

[simgrid.git] / include / xbt / set.h

diff --git a/include/xbt/set.h b/include/xbt/set.h
index 726efad..ef0817e 100644 (file)
--- a/include/xbt/set.h
+++ b/include/xbt/set.h
@@ -10,18 +10,32 @@
 #ifndef _XBT_SET_H
 #define _XBT_SET_H
 
-#include "xbt/misc.h" /* BEGIN_DECL */
+#include "xbt/misc.h" /* SG_BEGIN_DECL */
+#include "xbt/function_types.h"
 
-BEGIN_DECL()
+SG_BEGIN_DECL()
 
 /** @addtogroup XBT_set
+ *  @brief A data container consisting in \ref XBT_dict and \ref XBT_dynar
  * 
  *  The elements stored in such a data structure can be retrieve both by
  *  name and by ID. For this to work, the first fields of the structures
- *  stored must begin with:
- *  \verbatim unsigned int ID;
+ *  stored must begin with the following fields:
+ *  \verbatim struct {
+ unsigned int ID;
  char        *name;
- unsigned int name_len;\endverbatim
+ unsigned int name_len;
+ // my other fields, constituting the payload 
+} my_element_type_t; \endverbatim
+ * 
+ *  Since we are casting elements around, no protection is ensured by the 
+ * compiler. It is thus safer to define the headers using the macro 
+ * defined to that extend:
+ *  \verbatim struct {
+ XBT_SET_HEADERS;
+
+ // my other fields, constituting the payload 
+} my_element_type_t; \endverbatim
  *
  *  It is impossible to remove an element from such a data structure.
  *
@@ -29,31 +43,36 @@ BEGIN_DECL()
  *  Such a datastructure was necessary/useful to store the GRAS type 
  *  descriptions, but it should be reworked to become generic.
  *
- * @{
-*/
+ */
 
 
-/** @name 1. Set and set elements, constructor/destructor
+/** @defgroup XBT_set_cons Set and set elements, constructor/destructor
+ *  @ingroup XBT_set
  *
  *  @{
  */
 /** \brief Opaque type representing a set */
-typedef struct xbt_set_ *xbt_set_t; 
+typedef struct xbt_set_ *xbt_set_t;
+
+#define XBT_SET_HEADERS \
+  unsigned int ID;      \
+  char        *name;    \
+  unsigned int name_len
+
 /** \brief It must be possible to cast set elements to this type */
-struct xbt_set_elm_ {
+typedef struct xbt_set_elm_ {
   unsigned int ID;      /**< Identificator (system assigned) */
   char        *name;    /**< Name (user assigned) */
   unsigned int name_len;/**< Length of the name */
-};
+} s_xbt_set_elm_t,*xbt_set_elm_t;
 
 /*####[ Functions ]##########################################################*/
 xbt_set_t xbt_set_new (void);
 void xbt_set_free(xbt_set_t *set);
 
 /** @} */
-typedef struct xbt_set_elm_  s_xbt_set_elm_t;
-typedef struct xbt_set_elm_ *  xbt_set_elm_t;
-/** @name 2. Main functions
+/** @defgroup XBT_set_basic Sets basic usage
+ *  @ingroup XBT_set
  *
  *  @{
  */
@@ -63,9 +82,13 @@ void xbt_set_add (xbt_set_t set, xbt_set_elm_t  elm, void_f_pvoid_t *free_func);
 xbt_set_elm_t xbt_set_get_by_name    (xbt_set_t set, const char *key);
 xbt_set_elm_t xbt_set_get_by_name_ext(xbt_set_t set, const char *key, int key_len);
 xbt_set_elm_t xbt_set_get_by_id      (xbt_set_t set, int         id);
-                                     
+
+unsigned long xbt_set_length (const xbt_set_t set);
+   
+
 /** @} */
-/** @name 3. Cursors
+/** @defgroup XBT_set_curs Sets cursors
+ *  @ingroup XBT_set
  *
  *  \warning Don't add or remove entries to the cache while traversing
  *
@@ -90,7 +113,6 @@ int          xbt_set_cursor_get_or_free (xbt_set_cursor_t *cursor,
        xbt_set_cursor_step(cursor) )
 
 /* @} */
-/* @} */
-END_DECL()
+SG_END_DECL()
 
 #endif /* _XBT_SET_H */