3 /* xbt.h - Public interface to the xbt (gras's toolbox) */
5 /* Copyright (c) 2004 Martin Quinson. */
6 /* Copyright (c) 2004 Arnaud Legrand. */
7 /* All rights reserved. */
9 /* This program is free software; you can redistribute it and/or modify it
10 * under the terms of the license (GNU LGPL) which comes with this package. */
15 /* Attributes are only in recent versions of GCC */
16 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
17 # define _XBT_GNUC_PRINTF( format_idx, arg_idx ) \
18 __attribute__((__format__ (__printf__, format_idx, arg_idx)))
19 # define _XBT_GNUC_SCANF( format_idx, arg_idx ) \
20 __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
21 # define _XBT_GNUC_FORMAT( arg_idx ) \
22 __attribute__((__format_arg__ (arg_idx)))
23 # define _XBT_GNUC_NORETURN __attribute__((__noreturn__))
24 # define _XBT_GNUC_UNUSED __attribute__((unused))
27 # define _XBT_GNUC_PRINTF( format_idx, arg_idx )
28 # define _XBT_GNUC_SCANF( format_idx, arg_idx )
29 # define _XBT_GNUC_FORMAT( arg_idx )
30 # define _XBT_GNUC_NORETURN
31 # define _XBT_GNUC_UNUSED
33 #endif /* !__GNUC__ */
35 /* inline and __FUNCTION__ are only in GCC when -ansi is off */
37 #if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
38 # define _XBT_FUNCTION __FUNCTION__
39 #elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
40 # define _XBT_FUNC__ __func__ /* ISO-C99 compliant */
42 # define _XBT_FUNCTION "function"
46 # if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
47 # define XBT_INLINE inline
48 # elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
49 # define XBT_INLINE inline
50 # elif defined(__BORLANDC__) && !defined(__STRICT_ANSI__)
51 # define XBT_INLINE __inline
56 # define XBT_INLINE inline
59 /* improvable on gcc (by evaluating arguments only once), but wouldn't be portable */
63 #define MIN(a,b) ((a)<(b)?(a):(b))
68 #define MAX(a,b) ((a)>(b)?(a):(b))
72 * Function calling convention (not used for now)
77 # define _XBT_CALL __cdecl
83 /* Handle import/export stuff
85 * Rational of XBT_PUBLIC:
86 * * This is for library symbols visible from the application-land.
87 * Basically, any symbols defined in the include/directory must be
88 * like this (plus some other globals).
90 * UNIX coders should just think of it as a special way to say "extern".
92 * * If you build the DLL, define the DLL_EXPORT symbol so that all symbols
93 * actually get exported by this file.
95 * * If you do a static windows compilation, define DLL_STATIC, both when
96 * compiling the application files and when compiling the library.
98 * * If you link your application against the DLL or if you do a UNIX build,
99 * don't do anything special. This file will do the right thing for you
103 * Rational of XBT_EXPORT_NO_IMPORT: (windows-only cruft)
104 * * Symbols which must be exported in the DLL, but not imported from it.
106 * * This is obviously useful for initialized globals (which cannot be
107 * extern or similar).
108 * * This is also used in the log mecanism where a macro creates the
109 * variable automatically. When the macro is called from within SimGrid,
110 * the symbol must be exported, but when called from within the client
111 * code, it must not try to retrieve the symbol from the DLL since it's
114 * Rational of XBT_IMPORT_NO_EXPORT: (windows-only cruft)
115 * * Symbols which must be imported from the DLL, but not explicitely
118 * * The root log category is already exported, but not imported explicitely
119 * when creating a subcategory since we cannot import the parent category
120 * to deal with the fact that the parent may be in application space, not
126 #if defined(DLL_EXPORT)
127 # define XBT_PUBLIC(type) __declspec(dllexport) type
128 # define XBT_EXPORT_NO_IMPORT(type) __declspec(dllexport) type
129 # define XBT_IMPORT_NO_EXPORT(type) type
130 # define XBT_PUBLIC_DATA(type) __declspec(dllexport) type
132 /* Pack everything up statically */
133 #elif defined(DLL_STATIC)
134 # define XBT_PUBLIC(type) type
135 # define XBT_EXPORT_NO_IMPORT(type) type
136 # define XBT_IMPORT_NO_EXPORT(type) type
137 # define XBT_PUBLIC_DATA(type) type
140 /* Link against the DLL */
141 #elif (defined(_WIN32) && !defined(DLL_EXPORT))
142 # define XBT_PUBLIC(type) __declspec(dllimport) type
143 # define XBT_EXPORT_NO_IMPORT(type) type
144 # define XBT_IMPORT_NO_EXPORT(type) __declspec(dllimport) type
145 # define XBT_PUBLIC_DATA(type) __declspec(dllimport) type
147 /* UNIX build. Let's keep sain here ;) */
149 # define XBT_PUBLIC(type) extern type
150 # define XBT_EXPORT_NO_IMPORT(type) type
151 # define XBT_IMPORT_NO_EXPORT(type) type
152 # define XBT_PUBLIC_DATA(type) extern type
155 #if !defined (max) && !defined(__cplusplus)
156 # define max(a,b) (((a) > (b)) ? (a) : (b))
158 #if !defined (min) && !defined(__cplusplus)
159 # define min(a,b) (((a) < (b)) ? (a) : (b))
165 #define XBT_MAX_CHANNEL 10 /* FIXME: killme */
166 /*! C++ users need love */
167 #ifndef SG_BEGIN_DECL
169 # define SG_BEGIN_DECL() extern "C" {
171 # define SG_BEGIN_DECL()
177 # define SG_END_DECL() }
179 # define SG_END_DECL()
182 /* End of cruft for C++ */
186 XBT_PUBLIC(const char *)xbt_procname(void);
188 #define XBT_BACKTRACE_SIZE 10 /* FIXME: better place? Do document */
192 #endif /* XBT_MISC_H */