Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
define the XBT_IMPORT_NO_PUBLIC macro for imported but not exported type
[simgrid.git] / include / xbt / misc.h
index 0a97552..256f4ec 100644 (file)
 # 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__ */
 
 
 #if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
 # define _XBT_FUNCTION __FUNCTION__
-# define _XBT_INLINE inline
 #elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
 # define _XBT_FUNC__ __func__      /* ISO-C99 compliant */
-# define _XBT_INLINE inline
 #else
 # define _XBT_FUNCTION "function"
-# define _XBT_INLINE 
 #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
+
+/* 
+ * 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: 
+ *   * If you build the DLL you must pass the right value of XBT_PUBLIC in the project : to do this you must define the DLL_EXPORT macro
+ *   * If you do a static compilation, you must define the macro DLL_STATIC
+ *   * If you link your code against the DLL, this file defines the macro to '__declspec(dllimport)' for you
+ *   * If you compile under unix, this file defines the macro to 'extern', even if it's not mandatory with modern compilers
+ * 
+ * Rational of XBT_PUBLIC_NO_IMPORT:
+ *   * This is for 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.
+ */
+
+
+#ifdef DLL_EXPORT
+#  define XBT_PUBLIC(type)                       __declspec(dllexport) type
+#  define XBT_PUBLIC_NO_IMPORT(type)  __declspec(dllexport) type
+#  define XBT_IMPORT_NO_PUBLIC(type)  type 
+#else
+#  ifdef DLL_STATIC
+#    define XBT_PUBLIC(type)              type
+#    define XBT_PUBLIC_NO_IMPORT(type) type
+#   define XBT_IMPORT_NO_PUBLIC(type)  type 
+#  else
+#    ifdef _WIN32
+#      define XBT_PUBLIC(type)              __declspec(dllimport) type
+#      define XBT_PUBLIC_NO_IMPORT(type) type
+#      define XBT_IMPORT_NO_PUBLIC(type) __declspec(dllimport) type
+#       else
+#      define XBT_PUBLIC(type)              extern type
+#      define XBT_PUBLIC_NO_IMPORT(type) type
+#      define XBT_IMPORT_NO_PUBLIC(type) type
+#    endif
+#  endif
+#endif
+   
+
 
 
 #ifndef max
 
 #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()
 
-const char *xbt_procname(void);
+XBT_PUBLIC(const char *)xbt_procname(void);
 
-END_DECL()
+#define XBT_BACKTRACE_SIZE 10 /* FIXME: better place? Do document */
+   
+SG_END_DECL()
 
 #endif /* XBT_MISC_H */
+
+
+
+