Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
use extern keyword when you link with the static library on Windows
[simgrid.git] / include / xbt / misc.h
index 0ec724c..cfa461e 100644 (file)
 #ifndef XBT_MISC_H
 #define XBT_MISC_H
 
-#ifndef max
-#  define max(a, b) (((a) > (b))?(a):(b))
+/* Attributes are only in recent versions of GCC */
+#if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
+# define _XBT_GNUC_PRINTF( format_idx, arg_idx )    \
+          __attribute__((__format__ (__printf__, format_idx, arg_idx)))
+# define _XBT_GNUC_SCANF( format_idx, arg_idx )     \
+              __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
+# define _XBT_GNUC_FORMAT( arg_idx )                \
+                  __attribute__((__format_arg__ (arg_idx)))
+# define _XBT_GNUC_NORETURN __attribute__((__noreturn__))
+# define _XBT_GNUC_UNUSED  __attribute__((unused))
+
+#else   /* !__GNUC__ */
+# define _XBT_GNUC_PRINTF( format_idx, arg_idx )
+# define _XBT_GNUC_SCANF( format_idx, arg_idx )
+# define _XBT_GNUC_FORMAT( arg_idx )
+# define _XBT_GNUC_NORETURN
+# define _XBT_GNUC_UNUSED
+
+#endif  /* !__GNUC__ */
+
+/* inline and __FUNCTION__ are only in GCC when -ansi is off */
+
+#if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
+# define _XBT_FUNCTION __FUNCTION__
+#elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
+# define _XBT_FUNC__ __func__      /* ISO-C99 compliant */
+#else
+# define _XBT_FUNCTION "function"
+#endif
+
+#ifndef __cplusplus
+#    if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
+#        define XBT_INLINE inline
+#    elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
+#        define XBT_INLINE inline
+#    elif defined(__BORLANDC__) && !defined(__STRICT_ANSI__)
+#        define XBT_INLINE __inline
+#    else
+#        define XBT_INLINE
+#    endif
+# else
+#    define XBT_INLINE  inline
 #endif
-#ifndef min
-#  define min(a, b) (((a) < (b))?(a):(b))
+
+/* improvable on gcc (by evaluating arguments only once), but wouldn't be portable */
+#ifdef MIN
+# undef MIN
+#endif
+#define MIN(a,b) ((a)<(b)?(a):(b))
+
+#ifdef MAX
+# undef MAX
+#endif
+#define MAX(a,b) ((a)>(b)?(a):(b))
+
+
+/* 
+ * Function calling convention (not used for now) 
+ */
+#ifdef _WIN32
+#  ifndef _XBT_CALL
+#    define _XBT_CALL __cdecl
+#   endif
+#else 
+#  define _XBT_CALL
+#endif
+
+/* Handle import/export stuff
+ * 
+ * Rational of XBT_PUBLIC: 
+ *   * This is for library symbols visible from the application-land.
+ *     Basically, any symbols defined in the include/directory must be 
+ *     like this (plus some other globals). 
+ *
+ *     UNIX coders should just think of it as a special way to say "extern".
+ *
+ *   * If you build the DLL, define the DLL_EXPORT symbol so that all symbols
+ *     actually get exported by this file.
+
+ *   * If you do a static windows compilation, define DLL_STATIC, both when
+ *     compiling the application files and when compiling the library.
+ *
+ *   * If you link your application against the DLL or if you do a UNIX build,
+ *     don't do anything special. This file will do the right thing for you 
+ *     by default.
+ *
+ * 
+ * Rational of XBT_EXPORT_NO_IMPORT: (windows-only cruft)
+ *   * Symbols which must be exported in the DLL, but not imported from it.
+ * 
+ *   * This is obviously useful for initialized globals (which cannot be 
+ *     extern or similar).
+ *   * This is also used in the log mecanism where a macro creates the 
+ *     variable automatically. When the macro is called from within SimGrid,
+ *     the symbol must be exported, but when called  from within the client
+ *     code, it must not try to retrieve the symbol from the DLL since it's
+ *      not in there.
+ * 
+ * Rational of XBT_IMPORT_NO_EXPORT: (windows-only cruft)
+ *   * Symbols which must be imported from the DLL, but not explicitely 
+ *     exported from it.
+ * 
+ *   * The root log category is already exported, but not imported explicitely 
+ *     when creating a subcategory since we cannot import the parent category 
+ *     to deal with the fact that the parent may be in application space, not 
+ *     DLL space.
+ */
+
+
+/* Build the DLL */
+#if defined(DLL_EXPORT)
+#  define XBT_PUBLIC(type)            __declspec(dllexport) type
+#  define XBT_EXPORT_NO_IMPORT(type)  __declspec(dllexport) type
+#  define XBT_IMPORT_NO_EXPORT(type)  type 
+#  define XBT_PUBLIC_DATA(type)              __declspec(dllexport) type
+
+/* Pack everything up statically */
+#elif defined(DLL_STATIC)
+#  define XBT_PUBLIC(type)           extern type
+#  define XBT_EXPORT_NO_IMPORT(type)  type
+#  define XBT_IMPORT_NO_EXPORT(type)  type
+#  define XBT_PUBLIC_DATA(type)       extern type
+     
+
+/* Link against the DLL */
+#elif (defined(_WIN32) && !defined(DLL_EXPORT) && !defined(DLL_STATIC))
+#  define XBT_PUBLIC(type)             __declspec(dllimport) type
+#  define XBT_EXPORT_NO_IMPORT(type)   type
+#  define XBT_IMPORT_NO_EXPORT(type)   __declspec(dllimport) type
+#  define XBT_PUBLIC_DATA(type)                __declspec(dllimport) type
+
+/* UNIX build. Let's keep sain here ;) */
+#else
+#  define XBT_PUBLIC(type)            extern type
+#  define XBT_EXPORT_NO_IMPORT(type)  type
+#  define XBT_IMPORT_NO_EXPORT(type)  type
+#  define XBT_PUBLIC_DATA(type)       extern type
+#endif
+   
+#if !defined (max) && !defined(__cplusplus)
+#  define max(a,b)     (((a) > (b)) ? (a) : (b))
+#endif
+#if !defined (min) && !defined(__cplusplus)
+#  define min(a,b)     (((a) < (b)) ? (a) : (b))
 #endif
 
 #define TRUE  1
 
 #define XBT_MAX_CHANNEL 10 /* FIXME: killme */
 /*! C++ users need love */
-#ifndef BEGIN_DECL
+#ifndef SG_BEGIN_DECL
 # ifdef __cplusplus
-#  define BEGIN_DECL extern "C" {
+#  define SG_BEGIN_DECL() extern "C" {
 # else
-#  define BEGIN_DECL 
+#  define SG_BEGIN_DECL() 
 # endif
 #endif
 
-/*! C++ users need love */
-#ifndef END_DECL
+#ifndef SG_END_DECL
 # ifdef __cplusplus
-#  define END_DECL }
+#  define SG_END_DECL() }
 # else
-#  define END_DECL 
+#  define SG_END_DECL() 
 # endif
 #endif
 /* End of cruft for C++ */
 
-BEGIN_DECL
-/* Dunno where to place this: needed by config and amok */
-typedef struct {  
-   char *name;
-   int port;
-} xbt_host_t;
+SG_BEGIN_DECL()
 
-/* pointer to a function freeing something */
-typedef   void (void_f_ppvoid_t)(void**);
-typedef   void (void_f_pvoid_t) (void*);
+XBT_PUBLIC(const char *)xbt_procname(void);
 
-/* The following two definitions concern the type of the keys used for
-   the heaps. That should be handled via configure (FIXME). */
-typedef long double xbt_heap_float_t;
-#define XBT_HEAP_FLOAT_T "%Lg" /* for printing purposes */
+#define XBT_BACKTRACE_SIZE 10 /* FIXME: better place? Do document */
+   
+SG_END_DECL()
+
+#endif /* XBT_MISC_H */
 
-typedef long double xbt_maxmin_float_t;
-#define XBT_MAXMIN_FLOAT_T "%Lg"       /* for printing purposes */
 
 
-END_DECL
 
-#endif /* XBT_MISC_H */