X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a5fa0e26004ac8dafe1c9d50c1c14e6d7190f16f..5b3677b425b9cc6949c1573d59ac772540cbf4b2:/include/xbt/set.h

diff --git a/include/xbt/set.h b/include/xbt/set.h
index ef0817e14f..1d87320332 100644
--- a/include/xbt/set.h
+++ b/include/xbt/set.h
@@ -1,8 +1,7 @@
-/* $Id$ */
-
 /* xbt/set.h -- api to a generic dictionary                                 */
 
-/* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
+/* Copyright (c) 2004-2007, 2009-2010, 2012-2014. 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. */
@@ -10,42 +9,45 @@
 #ifndef _XBT_SET_H
 #define _XBT_SET_H
 
-#include "xbt/misc.h" /* SG_BEGIN_DECL */
+#include "xbt/misc.h"           /* SG_BEGIN_DECL */
 #include "xbt/function_types.h"
 
 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 the following fields:
- *  \verbatim struct {
- unsigned int ID;
- char        *name;
- 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 
+\verbatim
+ struct {
+   unsigned int ID;
+   char        *name;
+   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 {
+ *
+\verbatim
+struct {
  XBT_SET_HEADERS;
 
- // my other fields, constituting the payload 
-} my_element_type_t; \endverbatim
+ // my other fields, constituting the payload
+} my_element_type_t;
+\endverbatim
  *
- *  It is impossible to remove an element from such a data structure.
+ *  It is now possible to remove an element from such a data structure.
  *
  *  @todo
- *  Such a datastructure was necessary/useful to store the GRAS type 
+ *  Such a datastructure was necessary/useful to store the GRAS type
  *  descriptions, but it should be reworked to become generic.
  *
  */
-
-
 /** @defgroup XBT_set_cons Set and set elements, constructor/destructor
  *  @ingroup XBT_set
  *
@@ -62,13 +64,14 @@ typedef struct xbt_set_ *xbt_set_t;
 /** \brief It must be possible to cast set elements to this type */
 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;
+  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);
+XBT_PUBLIC(xbt_set_t) xbt_set_new(void);
+XBT_PUBLIC(void) xbt_set_free(xbt_set_t * set);
 
 /** @} */
 /** @defgroup XBT_set_basic Sets basic usage
@@ -77,14 +80,25 @@ void xbt_set_free(xbt_set_t *set);
  *  @{
  */
 
-void xbt_set_add (xbt_set_t set, xbt_set_elm_t  elm, void_f_pvoid_t *free_func);
+XBT_PUBLIC(void) xbt_set_add(xbt_set_t set, xbt_set_elm_t elm,
+                             void_f_pvoid_t free_func);
+XBT_PUBLIC(void) xbt_set_remove(xbt_set_t set, xbt_set_elm_t elm);
+XBT_PUBLIC(void) xbt_set_remove_by_name(xbt_set_t set, const char *key);
+XBT_PUBLIC(xbt_set_elm_t) xbt_set_get_by_name_or_null(xbt_set_t set,
+                                                      const char *key);
+XBT_PUBLIC(void) xbt_set_remove_by_name_ext(xbt_set_t set, const char *key,
+                                            int key_len);
+XBT_PUBLIC(void) xbt_set_remove_by_id(xbt_set_t set, int id);
 
-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);
+XBT_PUBLIC(xbt_set_elm_t) xbt_set_get_by_name(xbt_set_t set,
+                                              const char *key);
+XBT_PUBLIC(xbt_set_elm_t) xbt_set_get_by_name_ext(xbt_set_t set,
+                                                  const char *key,
+                                                  int key_len);
+XBT_PUBLIC(xbt_set_elm_t) xbt_set_get_by_id(xbt_set_t set, int id);
+
+XBT_PUBLIC(unsigned long) xbt_set_length(const xbt_set_t set);
 
-unsigned long xbt_set_length (const xbt_set_t set);
-   
 
 /** @} */
 /** @defgroup XBT_set_curs Sets cursors
@@ -98,11 +112,11 @@ unsigned long xbt_set_length (const xbt_set_t set);
 /** @brief Cursor type */
 typedef struct xbt_set_cursor_ *xbt_set_cursor_t;
 
-void         xbt_set_cursor_first       (xbt_set_t         set,
-					  xbt_set_cursor_t *cursor);
-void         xbt_set_cursor_step        (xbt_set_cursor_t  cursor);
-int          xbt_set_cursor_get_or_free (xbt_set_cursor_t *cursor,
-					  xbt_set_elm_t    *elm);
+XBT_PUBLIC(void) xbt_set_cursor_first(xbt_set_t set,
+                                      xbt_set_cursor_t * cursor);
+XBT_PUBLIC(void) xbt_set_cursor_step(xbt_set_cursor_t cursor);
+XBT_PUBLIC(int) xbt_set_cursor_get_or_free(xbt_set_cursor_t * cursor,
+                                           xbt_set_elm_t * elm);
 
 /** @brief Iterates over the whole set
  *  @hideinitializer
@@ -114,5 +128,4 @@ int          xbt_set_cursor_get_or_free (xbt_set_cursor_t *cursor,
 
 /* @} */
 SG_END_DECL()
-
-#endif /* _XBT_SET_H */
+#endif                          /* _XBT_SET_H */