Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
726efad138627d9ecb61fd5f529dfc9fd922de4c
[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" /* BEGIN_DECL */
14
15 BEGIN_DECL()
16
17 /** @addtogroup XBT_set
18  * 
19  *  The elements stored in such a data structure can be retrieve both by
20  *  name and by ID. For this to work, the first fields of the structures
21  *  stored must begin with:
22  *  \verbatim unsigned int ID;
23  char        *name;
24  unsigned int name_len;\endverbatim
25  *
26  *  It is impossible to remove an element from such a data structure.
27  *
28  *  @todo
29  *  Such a datastructure was necessary/useful to store the GRAS type 
30  *  descriptions, but it should be reworked to become generic.
31  *
32  * @{
33 */
34
35
36 /** @name 1. Set and set elements, constructor/destructor
37  *
38  *  @{
39  */
40 /** \brief Opaque type representing a set */
41 typedef struct xbt_set_ *xbt_set_t; 
42 /** \brief It must be possible to cast set elements to this type */
43 struct xbt_set_elm_ {
44   unsigned int ID;      /**< Identificator (system assigned) */
45   char        *name;    /**< Name (user assigned) */
46   unsigned int name_len;/**< Length of the name */
47 };
48
49 /*####[ Functions ]##########################################################*/
50 xbt_set_t xbt_set_new (void);
51 void xbt_set_free(xbt_set_t *set);
52
53 /** @} */
54 typedef struct xbt_set_elm_  s_xbt_set_elm_t;
55 typedef struct xbt_set_elm_ *  xbt_set_elm_t;
56 /** @name 2. Main functions
57  *
58  *  @{
59  */
60
61 void xbt_set_add (xbt_set_t set, xbt_set_elm_t  elm, void_f_pvoid_t *free_func);
62
63 xbt_set_elm_t xbt_set_get_by_name    (xbt_set_t set, const char *key);
64 xbt_set_elm_t xbt_set_get_by_name_ext(xbt_set_t set, const char *key, int key_len);
65 xbt_set_elm_t xbt_set_get_by_id      (xbt_set_t set, int         id);
66                                       
67 /** @} */
68 /** @name 3. Cursors
69  *
70  *  \warning Don't add or remove entries to the cache while traversing
71  *
72  *  @{
73  */
74
75 /** @brief Cursor type */
76 typedef struct xbt_set_cursor_ *xbt_set_cursor_t;
77
78 void         xbt_set_cursor_first       (xbt_set_t         set,
79                                           xbt_set_cursor_t *cursor);
80 void         xbt_set_cursor_step        (xbt_set_cursor_t  cursor);
81 int          xbt_set_cursor_get_or_free (xbt_set_cursor_t *cursor,
82                                           xbt_set_elm_t    *elm);
83
84 /** @brief Iterates over the whole set
85  *  @hideinitializer
86  */
87 #define xbt_set_foreach(set,cursor,elm)                       \
88   for ((cursor) = NULL, xbt_set_cursor_first((set),&(cursor)) ;   \
89        xbt_set_cursor_get_or_free(&(cursor),(xbt_set_elm_t*)&(elm));          \
90        xbt_set_cursor_step(cursor) )
91
92 /* @} */
93 /* @} */
94 END_DECL()
95
96 #endif /* _XBT_SET_H */