1 /* xbt.h - Public interface to the xbt (gras's toolbox) */
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
12 /* Attributes are only in recent versions of GCC */
13 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4))
14 # define _XBT_GNUC_PRINTF( format_idx, arg_idx ) \
15 __attribute__((__format__ (__printf__, format_idx, arg_idx)))
16 # define _XBT_GNUC_SCANF( format_idx, arg_idx ) \
17 __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
18 # define _XBT_GNUC_FORMAT( arg_idx ) \
19 __attribute__((__format_arg__ (arg_idx)))
20 # define _XBT_GNUC_NORETURN __attribute__((__noreturn__))
21 # define _XBT_GNUC_UNUSED __attribute__((__unused__))
22 # define _XBT_GNUC_CONSTRUCTOR __attribute__((__constructor__))
23 # define _XBT_GNUC_DESTRUCTOR __attribute__((__destructor__))
24 # undef _XBT_NEED_INIT_PRAGMA
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
32 # define _XBT_GNUC_CONSTRUCTOR
33 # define _XBT_GNUC_DESTRUCTOR
34 # define _XBT_NEED_INIT_PRAGMA 1
36 #endif /* !__GNUC__ */
38 /* inline and __FUNCTION__ are only in GCC when -ansi is off */
40 #if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
41 # define _XBT_FUNCTION __FUNCTION__
42 #elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
43 # define _XBT_FUNCTION __func__ /* ISO-C99 compliant */
45 # define _XBT_FUNCTION "function"
49 # if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
50 # define XBT_INLINE inline
51 # elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
52 # define XBT_INLINE inline
53 # elif defined(__BORLANDC__) && !defined(__STRICT_ANSI__)
54 # define XBT_INLINE __inline
59 # if defined (__VISUALC__)
60 # define XBT_INLINE __inline
62 # define XBT_INLINE inline
66 /* improvable on gcc (by evaluating arguments only once), but wouldn't be portable */
70 #define MIN(a,b) ((a)<(b)?(a):(b))
75 #define MAX(a,b) ((a)>(b)?(a):(b))
79 * Function calling convention (not used for now)
84 # define _XBT_CALL __cdecl
90 /* Handle import/export stuff
92 * Rational of XBT_PUBLIC:
93 * * This is for library symbols visible from the application-land.
94 * Basically, any symbols defined in the include/directory must be
95 * like this (plus some other globals).
97 * UNIX coders should just think of it as a special way to say "extern".
99 * * If you build the DLL, define the DLL_EXPORT symbol so that all symbols
100 * actually get exported by this file.
102 * * If you do a static windows compilation, define DLL_STATIC, both when
103 * compiling the application files and when compiling the library.
105 * * If you link your application against the DLL or if you do a UNIX build,
106 * don't do anything special. This file will do the right thing for you
110 * Rational of XBT_EXPORT_NO_IMPORT: (windows-only cruft)
111 * * Symbols which must be exported in the DLL, but not imported from it.
113 * * This is obviously useful for initialized globals (which cannot be
114 * extern or similar).
115 * * This is also used in the log mecanism where a macro creates the
116 * variable automatically. When the macro is called from within SimGrid,
117 * the symbol must be exported, but when called from within the client
118 * code, it must not try to retrieve the symbol from the DLL since it's
121 * Rational of XBT_IMPORT_NO_EXPORT: (windows-only cruft)
122 * * Symbols which must be imported from the DLL, but not explicitely
125 * * The root log category is already exported, but not imported explicitely
126 * when creating a subcategory since we cannot import the parent category
127 * to deal with the fact that the parent may be in application space, not
133 #if defined(DLL_EXPORT)
134 # define XBT_PUBLIC(type) __declspec(dllexport) type
135 # define XBT_EXPORT_NO_IMPORT(type) __declspec(dllexport) type
136 # define XBT_IMPORT_NO_EXPORT(type) type
137 # define XBT_PUBLIC_DATA(type) __declspec(dllexport) type
139 /* Pack everything up statically */
140 #elif defined(DLL_STATIC)
141 # define XBT_PUBLIC(type) extern type
142 # define XBT_EXPORT_NO_IMPORT(type) type
143 # define XBT_IMPORT_NO_EXPORT(type) type
144 # define XBT_PUBLIC_DATA(type) extern type
146 /* Link against the DLL */
147 #elif (defined(_XBT_WIN32) && !defined(DLL_EXPORT) && !defined(DLL_STATIC))
148 # define XBT_PUBLIC(type) __declspec(dllimport) type
149 # define XBT_EXPORT_NO_IMPORT(type) type
150 # define XBT_IMPORT_NO_EXPORT(type) __declspec(dllimport) type
151 # define XBT_PUBLIC_DATA(type) __declspec(dllimport) type
155 # define XBT_PUBLIC(type) extern type
156 # define XBT_EXPORT_NO_IMPORT(type) type
157 # define XBT_IMPORT_NO_EXPORT(type) type
158 # define XBT_PUBLIC_DATA(type) extern type
161 #if !defined (max) && !defined(__cplusplus)
162 # define max(a,b) (((a) > (b)) ? (a) : (b))
164 #if !defined (min) && !defined(__cplusplus)
165 # define min(a,b) (((a) < (b)) ? (a) : (b))
171 #define XBT_MAX_CHANNEL 10 /* FIXME: killme */
172 /*! C++ users need love */
173 #ifndef SG_BEGIN_DECL
175 # define SG_BEGIN_DECL() extern "C" {
177 # define SG_BEGIN_DECL()
183 # define SG_END_DECL() }
185 # define SG_END_DECL()
188 /* End of cruft for C++ */
192 XBT_PUBLIC(const char *) xbt_procname(void);
194 #define XBT_BACKTRACE_SIZE 10 /* FIXME: better place? Do document */
197 #endif /* XBT_MISC_H */