1 /** @addtogroup XBT_API
3 The XBT functionalities fall into several categories:
21 /** @defgroup XBT_grounding Grounding features */
22 /** @defgroup XBT_adt Usual data structures */
23 /** @defgroup XBT_misc Miscellaneous */
27 ########################################################################
30 /** @addtogroup XBT_grounding
32 Grounding features are the basement of SimGrid. You'll find portable (and
33 secure) wrappers to the malloc-like functions, logging support, error
34 reporting features, etc.
38 /** @defgroup XBT_syscall Malloc and friends */
39 /** @defgroup XBT_str String related functions */
40 /** @defgroup XBT_ex Exception support (C++) */
41 /** @defgroup XBT_ex_c Exception support (C) */
42 /** @defgroup XBT_log Logging support */
43 /** @defgroup XBT_error Assert macro familly */
44 /** @defgroup XBT_config Configuration support */
45 /** @defgroup XBT_mallocator Mallocators */
51 ########################################################################
53 /** @addtogroup XBT_adt
55 Here are the basic data containers that every C programmer rewrites one day.
56 You won't need to do so yourself, you lucky one, because we did it for you.
57 However, if you are programming in C++ you might want to use C++ containers
61 /** @defgroup XBT_dynar Dynar: generic dynamic array */
62 /** @defgroup XBT_dict Dict: generic dictionnary */
66 ########################################################################
68 /** @addtogroup XBT_misc
70 Here are several general purposes library components designed specially
71 for you, you lucky one.
75 /** @defgroup XBT_graph General purpose graph library */
76 /** @defgroup XBT_parmap Parallel map */
77 /** @defgroup XBT_synchro Simulated Synchronization */
78 /** @defgroup XBT_context Portable context implementation */
79 /** @defgroup XBT_replay Replay */
82 /* ************************* *
83 * * PORTABILITY-INTERNALS * * (not included in documentation)
84 * ************************* */
86 /** @addtogroup XBT_context Portable context implementation
87 * @brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
88 * for non-preemptible threads.
90 * You shouldn't use it directly since it is merely intended to ease the
91 * implementation of the several programmation environment of the
92 * SimGrid toolkit (namely, @ref MSG_API and @ref SMPI_API).
94 * You should use those environments instead.