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
27 /** @defgroup XBT_grounding Grounding features */
28 /** @defgroup XBT_adt Usual data structures */
29 /** @defgroup XBT_misc Misc general purposes library components */
33 ########################################################################
36 /** @addtogroup XBT_grounding
38 Grounding features are the basement of SimGrid. You'll find portable (and
39 secure) wrappers to the malloc-like functions, logging support, error
40 reporting features, etc.
44 /** @defgroup XBT_syscall Malloc and friends */
45 /** @defgroup XBT_str String related functions */
46 /** @defgroup XBT_ex Exception support */
47 /** @defgroup XBT_log Logging support */
48 /** @defgroup XBT_error Assert macro familly */
49 /** @defgroup XBT_config Configuration support */
50 /** @defgroup XBT_mallocator Mallocators */
54 ########################################################################
56 /** @addtogroup XBT_adt
58 Here are the basic data containers that every C programmer rewrites one day.
59 You won't need to do so yourself, you lucky one, because we did it for you.
62 /** @defgroup XBT_dynar Dynar: generic dynamic array */
63 /** @defgroup XBT_dict Dict: generic dictionnary */
64 /** @defgroup XBT_set Set: generic set datatype */
65 /** @defgroup XBT_fifo Fifo: generic workqueue */
66 /** @defgroup XBT_swag Swag: O(1) set datatype */
67 /** @defgroup XBT_heap Heap: generic heap data structure */
68 /** @defgroup XBT_dd Data description */
72 ########################################################################
74 /** @addtogroup XBT_misc
76 Here are several general purposes library components designed specially
77 for you, you lucky one.
81 /** @defgroup XBT_graph General purpose graph library */
82 /** @defgroup XBT_parmap Parallel map */
83 /** @defgroup XBT_peer Peer */
84 /** @defgroup XBT_queue Queue */
85 /** @defgroup XBT_sock Sock */
86 /** @defgroup XBT_synchro Synchro stuff */
87 /** @defgroup XBT_thread Thread stuff */
88 /** @defgroup XBT_context Portable context implementation */
89 /** @defgroup XBT_replay Replay */
92 /* ************************* *
93 * * PORTABILITY-INTERNALS * * (not included in documentation)
94 * ************************* */
96 /** \addtogroup XBT_context Portable context implementation
97 * \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
98 * for non-preemptible threads.
100 * You shouldn't use it directly since it is merely intended to ease the
101 * implementation of the several programmation environment of the
102 * SimGrid toolkit (namely, \ref MSG_API, \ref GRAS_API and \ref SMPI_API).
104 * You should use those environments instead.