Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Continue documenting my changes
[simgrid.git] / include / xbt / set.h
1 /* $Id$ */
2
3 /* xbt/set.h -- api to a generic dictionary                                 */
4
5 /* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
6
7 /* This program is free software; you can redistribute it and/or modify it
8  * under the terms of the license (GNU LGPL) which comes with this package. */
9
10 #ifndef _XBT_SET_H
11 #define _XBT_SET_H
12
13 #include "xbt/misc.h" /* SG_BEGIN_DECL */
14 #include "xbt/function_types.h"
15
16 SG_BEGIN_DECL()
17
18 /** @addtogroup XBT_set
19  *  @brief A data container consisting in \ref XBT_dict and \ref XBT_dynar
20  * 
21  *  The elements stored in such a data structure can be retrieve both by
22  *  name and by ID. For this to work, the first fields of the structures
23  *  stored must begin with the following fields:
24  *  \verbatim struct {
25  unsigned int ID;
26  char        *name;
27  unsigned int name_len;
28  // my other fields, constituting the payload 
29 } my_element_type_t; \endverbatim
30  * 
31  *  Since we are casting elements around, no protection is ensured by the 
32  * compiler. It is thus safer to define the headers using the macro 
33  * defined to that extend:
34  *  \verbatim struct {
35  XBT_SET_HEADERS;
36
37  // my other fields, constituting the payload 
38 } my_element_type_t; \endverbatim
39  *
40  *  It is now possible to remove an element from such a data structure.
41  *
42  *  @todo
43  *  Such a datastructure was necessary/useful to store the GRAS type 
44  *  descriptions, but it should be reworked to become generic.
45  *
46  */
47
48
49 /** @defgroup XBT_set_cons Set and set elements, constructor/destructor
50  *  @ingroup XBT_set
51  *
52  *  @{
53  */
54 /** \brief Opaque type representing a set */
55 typedef struct xbt_set_ *xbt_set_t;
56
57 #define XBT_SET_HEADERS \
58   unsigned int ID;      \
59   char        *name;    \
60   unsigned int name_len
61
62 /** \brief It must be possible to cast set elements to this type */
63 typedef struct xbt_set_elm_ {
64   unsigned int ID;      /**< Identificator (system assigned) */
65   char        *name;    /**< Name (user assigned) */
66   unsigned int name_len;/**< Length of the name */
67 } s_xbt_set_elm_t,*xbt_set_elm_t;
68
69 /*####[ Functions ]##########################################################*/
70 XBT_PUBLIC(xbt_set_t) xbt_set_new (void);
71 XBT_PUBLIC(void) xbt_set_free(xbt_set_t *set);
72
73 /** @} */
74 /** @defgroup XBT_set_basic Sets basic usage
75  *  @ingroup XBT_set
76  *
77  *  @{
78  */
79
80 XBT_PUBLIC(void) xbt_set_add (xbt_set_t set, xbt_set_elm_t  elm, void_f_pvoid_t *free_func);
81 XBT_PUBLIC(void) xbt_set_remove (xbt_set_t set, xbt_set_elm_t elm);
82 XBT_PUBLIC(void) xbt_set_remove_by_name (xbt_set_t set, const char *key);
83 XBT_PUBLIC(void) xbt_set_remove_by_name_ext (xbt_set_t set, const char *key, int key_len);
84 XBT_PUBLIC(void) xbt_set_remove_by_id (xbt_set_t set, int id);
85
86 XBT_PUBLIC(xbt_set_elm_t) xbt_set_get_by_name    (xbt_set_t set, const char *key);
87 XBT_PUBLIC(xbt_set_elm_t) xbt_set_get_by_name_ext(xbt_set_t set, const char *key, int key_len);
88 XBT_PUBLIC(xbt_set_elm_t) xbt_set_get_by_id      (xbt_set_t set, int         id);
89
90 XBT_PUBLIC(unsigned long) xbt_set_length (const xbt_set_t set);
91    
92
93 /** @} */
94 /** @defgroup XBT_set_curs Sets cursors
95  *  @ingroup XBT_set
96  *
97  *  \warning Don't add or remove entries to the cache while traversing
98  *
99  *  @{
100  */
101
102 /** @brief Cursor type */
103 typedef struct xbt_set_cursor_ *xbt_set_cursor_t;
104
105 XBT_PUBLIC(void)         xbt_set_cursor_first       (xbt_set_t         set,
106                                           xbt_set_cursor_t *cursor);
107 XBT_PUBLIC(void)         xbt_set_cursor_step        (xbt_set_cursor_t  cursor);
108 XBT_PUBLIC(int)          xbt_set_cursor_get_or_free (xbt_set_cursor_t *cursor,
109                                           xbt_set_elm_t    *elm);
110
111 /** @brief Iterates over the whole set
112  *  @hideinitializer
113  */
114 #define xbt_set_foreach(set,cursor,elm)                       \
115   for ((cursor) = NULL, xbt_set_cursor_first((set),&(cursor)) ;   \
116        xbt_set_cursor_get_or_free(&(cursor),(xbt_set_elm_t*)&(elm));          \
117        xbt_set_cursor_step(cursor) )
118
119 /* @} */
120 SG_END_DECL()
121
122 #endif /* _XBT_SET_H */