1 /** @addtogroup XBT_API
3 The XBT functionalities fall into several categories:
17 Data are associated to both an ID (0(1) search) and a name
23 /** @defgroup XBT_grounding Grounding features */
24 /** @defgroup XBT_adt Usual data structures */
25 /** @defgroup XBT_misc Misc general purposes library components */
29 ########################################################################
32 /** @addtogroup XBT_grounding
34 Grounding features are the basement of SimGrid. You'll find portable (and
35 secure) wrappers to the malloc-like functions, logging support, error
36 reporting features, etc.
40 /** @defgroup XBT_syscall Malloc and friends */
41 /** @defgroup XBT_str String related functions */
42 /** @defgroup XBT_ex Exception support */
43 /** @defgroup XBT_log Logging support */
44 /** @defgroup XBT_error Assert macro familly */
45 /** @defgroup XBT_config Configuration support */
46 /** @defgroup XBT_mallocator Mallocators */
50 ########################################################################
52 /** @addtogroup XBT_adt
54 Here are the basic data containers that every C programmer rewrites one day.
55 You won't need to do so yourself, you lucky one, because we did it for you.
58 /** @defgroup XBT_dynar Dynar: generic dynamic array */
59 /** @defgroup XBT_dict Dict: generic dictionnary */
60 /** @defgroup XBT_set Set: generic set datatype */
61 /** @defgroup XBT_fifo Fifo: generic workqueue */
62 /** @defgroup XBT_swag Swag: O(1) set datatype */
63 /** @defgroup XBT_heap Heap: generic heap data structure */
67 ########################################################################
69 /** @addtogroup XBT_misc
71 Here are several general purposes library components designed specially
72 for you, you lucky one.
76 /** @defgroup XBT_graph General purpose graph library */
77 /** @} */ End of XBT_misc
79 /* ************************* *
80 * * PORTABILITY-INTERNALS * * (not included in documentation)
81 * ************************* */
83 /** \defgroup XBT_context Portable context implementation
84 * \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
85 * for non-preemptible threads.
87 * You shouldn't use it directly since it is merely intended to ease the
88 * implementation of the several programmation environment of the
89 * SimGrid toolkit (namely, \ref MSG_API, \ref GRAS_API and \ref SMPI_API).
91 * You should use those environments instead.