Move the definition of XBT_PUBLIC from portable.h (which is a private header) to...

[simgrid.git] / include / xbt / misc.h

diff --git a/include/xbt/misc.h b/include/xbt/misc.h
index af16b98..a49fbf0 100644 (file)
--- a/include/xbt/misc.h
+++ b/include/xbt/misc.h
@@ -1,62 +1,141 @@
 /* $Id$ */
 
 /* $Id$ */
 

-/* xbt.h - Public interface to the xbt (gras's toolbox)                   */
+/* xbt.h - Public interface to the xbt (gras's toolbox)                     */

 
 

-/* Authors: Martin Quinson                                                  */
-/* Copyright (C) 2004 the OURAGAN project.                                  */
+/* Copyright (c) 2004 Martin Quinson.                                       */
+/* Copyright (c) 2004 Arnaud Legrand.                                       */
+/* All rights reserved.                                                     */

 
 /* This program is free software; you can redistribute it and/or modify it
 
 /* This program is free software; you can redistribute it and/or modify it

-   under the terms of the license (GNU LGPL) which comes with this package. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */

 
 #ifndef XBT_MISC_H
 #define XBT_MISC_H
 
 
 #ifndef XBT_MISC_H
 #define XBT_MISC_H
 

-#define max(a, b) (((a) > (b))?(a):(b))
-#define min(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
+
+/* Windows __declspec(). */
+#if defined(_WIN32) && defined(__BORLANDC__)
+#  if(__BORLANDC__ < 0x540)
+#    if (defined (__DLL) || defined (_DLL) || defined (_WINDLL) || defined (_RTLDLL) || defined (_XBT_USE_DYNAMIC_LIB) ) && ! defined (_XBT_USE_STAT
+#      undef  _XBT_USE_DECLSPEC
+#      define _XBT_USE_DECLSPEC
+#    endif
+#  else
+#  if ( defined (__DLL) || defined (_DLL) || defined (_WINDLL) || defined (_RTLDLL) || defined(_AFXDLL) || defined (_XBT_USE_DYNAMIC_LIB) )
+#    undef  _XBT_USE_DECLSPEC
+#    define _XBT_USE_DECLSPEC 1
+#  endif
+#  endif
+#endif
+
+#if defined (_XBT_USE_DECLSPEC) /* using export/import technique */
+
+#    ifndef _XBT_EXPORT_DECLSPEC
+#        define _XBT_EXPORT_DECLSPEC
+#    endif
+
+#    ifndef _XBT_IMPORT_DECLSPEC
+#        define _XBT_IMPORT_DECLSPEC
+#    endif
+
+#    if defined (_XBT_DESIGNATED_DLL) /* this is a lib which will contain xbt exports */
+#        define  XBT_PUBLIC        _XBT_EXPORT_DECLSPEC
+#    else
+#        define  XBT_PUBLIC        _XBT_IMPORT_DECLSPEC   /* other modules, importing xbt exports */
+#    endif
+
+#else /* not using DLL export/import specifications */
+
+#    define XBT_PUBLIC
+
+#endif /* #if defined (_XBT_USE_DECLSPEC) */
+
+/* Function calling convention (not used for now) */
+#if !defined (_XBT_CALL)
+#define _XBT_CALL
+#endif
+
+
+
+#ifndef max
+#  define max(a, b) (((a) > (b))?(a):(b))
+#endif
+#ifndef min
+#  define min(a, b) (((a) < (b))?(a):(b))
+#endif

 
 #define TRUE  1
 #define FALSE 0
 
 #define XBT_MAX_CHANNEL 10 /* FIXME: killme */
 /*! C++ users need love */
 
 #define TRUE  1
 #define FALSE 0
 
 #define XBT_MAX_CHANNEL 10 /* FIXME: killme */
 /*! C++ users need love */

-#ifndef BEGIN_DECL
+#ifndef SG_BEGIN_DECL

 # ifdef __cplusplus
 # ifdef __cplusplus

-#  define BEGIN_DECL extern "C" {
+#  define SG_BEGIN_DECL() extern "C" {

 # else
 # else

-#  define BEGIN_DECL 
+#  define SG_BEGIN_DECL() 

 # endif
 #endif
 
 /*! C++ users need love */
 # endif
 #endif
 
 /*! C++ users need love */

-#ifndef END_DECL
+#ifndef SG_END_DECL

 # ifdef __cplusplus
 # ifdef __cplusplus

-#  define END_DECL }
+#  define SG_END_DECL() }

 # else
 # else

-#  define END_DECL 
+#  define SG_END_DECL() 

 # endif
 #endif
 /* End of cruft for C++ */
 
 # 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;
-
-/* pointer to a function freeing something */
-typedef   void (void_f_ppvoid_t)(void**);
-typedef   void (void_f_pvoid_t) (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 */
-
-typedef long double xbt_maxmin_float_t;
-#define XBT_MAXMIN_FLOAT_T "%Lg"       /* for printing purposes */
+SG_BEGIN_DECL()

 
 

+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 */
 
 #endif /* XBT_MISC_H */