1 /** @addtogroup XBT_API
3 The XBT functionalities fall into several categories:
24 /** @defgroup XBT_grounding Grounding features */
25 /** @defgroup XBT_adt Usual data structures */
26 /** @defgroup XBT_misc Miscellaneous */
30 ########################################################################
33 /** @addtogroup XBT_grounding
35 Grounding features are the basement of SimGrid. You'll find portable (and
36 secure) wrappers to the malloc-like functions, logging support, error
37 reporting features, etc.
41 /** @defgroup XBT_syscall Malloc and friends */
42 /** @defgroup XBT_str String related functions */
43 /** @defgroup XBT_ex Exception support (C++) */
44 /** @defgroup XBT_ex_c Exception support (C) */
45 /** @defgroup XBT_log Logging support */
46 /** @defgroup XBT_error Assert macro familly */
47 /** @defgroup XBT_config Configuration support */
48 /** @defgroup XBT_mallocator Mallocators */
49 /** @defgroup XBT_cunit Unit testing support */
55 ########################################################################
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.
61 However, if you are programming in C++ you might want to use C++ containers
65 /** @defgroup XBT_dynar Dynar: generic dynamic array */
66 /** @defgroup XBT_dict Dict: generic dictionnary */
67 /** @defgroup XBT_swag Swag: O(1) set datatype */
71 ########################################################################
73 /** @addtogroup XBT_misc
75 Here are several general purposes library components designed specially
76 for you, you lucky one.
80 /** @defgroup XBT_graph General purpose graph library */
81 /** @defgroup XBT_parmap Parallel map */
82 /** @defgroup XBT_synchro Simulated Synchronization */
83 /** @defgroup XBT_thread Thread stuff */
84 /** @defgroup XBT_context Portable context implementation */
85 /** @defgroup XBT_replay Replay */
88 /* ************************* *
89 * * PORTABILITY-INTERNALS * * (not included in documentation)
90 * ************************* */
92 /** \addtogroup XBT_context Portable context implementation
93 * \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
94 * for non-preemptible threads.
96 * You shouldn't use it directly since it is merely intended to ease the
97 * implementation of the several programmation environment of the
98 * SimGrid toolkit (namely, \ref MSG_API and \ref SMPI_API).
100 * You should use those environments instead.