1 /** @addtogroup XBT_API
3 The XBT functionalities fall into several categories:
25 /** @defgroup XBT_grounding Grounding features */
26 /** @defgroup XBT_adt Usual data structures */
27 /** @defgroup XBT_misc Miscellaneous */
31 ########################################################################
34 /** @addtogroup XBT_grounding
36 Grounding features are the basement of SimGrid. You'll find portable (and
37 secure) wrappers to the malloc-like functions, logging support, error
38 reporting features, etc.
42 /** @defgroup XBT_syscall Malloc and friends */
43 /** @defgroup XBT_str String related functions */
44 /** @defgroup XBT_ex Exception support (C++) */
45 /** @defgroup XBT_ex_c Exception support (C) */
46 /** @defgroup XBT_log Logging support */
47 /** @defgroup XBT_error Assert macro familly */
48 /** @defgroup XBT_config Configuration support */
49 /** @defgroup XBT_mallocator Mallocators */
50 /** @defgroup XBT_cunit Unit testing support */
56 ########################################################################
58 /** @addtogroup XBT_adt
60 Here are the basic data containers that every C programmer rewrites one day.
61 You won't need to do so yourself, you lucky one, because we did it for you.
62 However, if you are programming in C++ you might want to use C++ containers
66 /** @defgroup XBT_dynar Dynar: generic dynamic array */
67 /** @defgroup XBT_dict Dict: generic dictionnary */
68 /** @defgroup XBT_swag Swag: O(1) set datatype */
69 /** @defgroup XBT_heap Heap: generic heap data structure */
73 ########################################################################
75 /** @addtogroup XBT_misc
77 Here are several general purposes library components designed specially
78 for you, you lucky one.
82 /** @defgroup XBT_graph General purpose graph library */
83 /** @defgroup XBT_parmap Parallel map */
84 /** @defgroup XBT_synchro Simulated Synchronization */
85 /** @defgroup XBT_thread Thread stuff */
86 /** @defgroup XBT_context Portable context implementation */
87 /** @defgroup XBT_replay Replay */
90 /* ************************* *
91 * * PORTABILITY-INTERNALS * * (not included in documentation)
92 * ************************* */
94 /** \addtogroup XBT_context Portable context implementation
95 * \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
96 * for non-preemptible threads.
98 * You shouldn't use it directly since it is merely intended to ease the
99 * implementation of the several programmation environment of the
100 * SimGrid toolkit (namely, \ref MSG_API and \ref SMPI_API).
102 * You should use those environments instead.