1 /** @addtogroup XBT_API
3 * The XBT functionalities fall into several categories:
4 * - Portability support
15 * 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 */
35 /** @addtogroup XBT_grounding
37 * Grounding features are the basement of SimGrid. You'll find portable (and
38 * secure) wrappers to the malloc-like functions, logging support, error
39 * reporting features, etc.
43 /** @defgroup XBT_syscall Malloc and friends */
44 /** @defgroup XBT_ex Exception support */
45 /** @defgroup XBT_log Logging support */
46 /** @defgroup XBT_error Assert macro familly */
47 /** @defgroup XBT_config Configuration support */
57 /** @addtogroup XBT_adt
59 * Here are the basic data containers that every C programmer rewrites one day.
60 * You won't need to do so yourself, you lucky one, because we did it for you.
64 /** @defgroup XBT_dynar Dynar: generic dynamic array */
65 /** @defgroup XBT_dict Dict: generic dictionnary */
66 /** @defgroup XBT_set Set: generic set datatype */
67 /** @defgroup XBT_fifo Fifo: generic workqueue */
68 /** @defgroup XBT_swag Swag: O(1) set datatype */
69 /** @defgroup XBT_heap Heap: generic heap data structure */
71 /** @} */ End of XBT_adt
79 /** @addtogroup XBT_misc
81 * Here are several general purposes library components designed specially
82 * for you, you lucky one.
85 /** @defgroup XBT_graph General purpose graph library */
87 /** @} */ End of XBT_misc
89 /* ************************* *
90 * * PORTABILITY-INTERNALS * * (not included in documentation)
91 * ************************* */
93 /** \defgroup XBT_context Portable context implementation
94 * \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
95 * for non-preemptible threads.
97 * You shouldn't use it directly since it is merely intended to ease the
98 * implementation of the several programmation environment of the
99 * SimGrid toolkit (namely, \ref MSG_API, \ref GRAS_API and \ref SMPI_API).
101 * You should use those environments instead.