include/xbt/misc.h

   1 /* xbt.h - Public interface to the xbt (gras's toolbox)                     */
   2
   3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   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. */
   8
   9 #ifndef XBT_MISC_H
  10 #define XBT_MISC_H
  11
  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
  25
  26 #else                           /* !__GNUC__ */
  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
  35
  36 #endif                          /* !__GNUC__ */
  37
  38 /* inline and __FUNCTION__ are only in GCC when -ansi is off */
  39
  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 */
  44 #else
  45 # define _XBT_FUNCTION "function"
  46 #endif
  47
  48 #ifdef DOXYGEN
  49 #  define XBT_INLINE
  50 #else
  51 #  ifndef __cplusplus
  52 #    if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
  53 #        define XBT_INLINE inline
  54 #    elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
  55 #        define XBT_INLINE inline
  56 #    elif defined(__BORLANDC__) && !defined(__STRICT_ANSI__)
  57 #        define XBT_INLINE __inline
  58 #    else
  59 #        define XBT_INLINE
  60 #    endif
  61 #  else
  62 #          if defined (__VISUALC__)
  63 #                  define XBT_INLINE __inline
  64 #          else
  65 #        define XBT_INLINE  inline
  66 #          endif
  67 #  endif /* __cplusplus */
  68 #endif
  69
  70 /* improvable on gcc (by evaluating arguments only once), but wouldn't be portable */
  71 #ifdef MIN
  72 # undef MIN
  73 #endif
  74 #define MIN(a,b) ((a)<(b)?(a):(b))
  75
  76 #ifdef MAX
  77 # undef MAX
  78 #endif
  79 #define MAX(a,b) ((a)>(b)?(a):(b))
  80
  81
  82 /*
  83  * Function calling convention (not used for now)
  84  */
  85
  86 #ifdef _XBT_WIN32
  87 #  ifndef _XBT_CALL
  88 #    define _XBT_CALL __cdecl
  89 #   endif
  90 #else
  91 #  define _XBT_CALL
  92 #endif
  93
  94 /* Handle import/export stuff
  95  *
  96  * Rational of XBT_PUBLIC:
  97  *   * This is for library symbols visible from the application-land.
  98  *     Basically, any symbols defined in the include/directory must be
  99  *     like this (plus some other globals).
 100  *
 101  *     UNIX coders should just think of it as a special way to say "extern".
 102  *
 103  *   * If you build the DLL, define the DLL_EXPORT symbol so that all symbols
 104  *     actually get exported by this file.
 105
 106  *   * If you do a static windows compilation, define DLL_STATIC, both when
 107  *     compiling the application files and when compiling the library.
 108  *
 109  *   * If you link your application against the DLL or if you do a UNIX build,
 110  *     don't do anything special. This file will do the right thing for you
 111  *     by default.
 112  *
 113  *
 114  * Rational of XBT_EXPORT_NO_IMPORT: (windows-only cruft)
 115  *   * Symbols which must be exported in the DLL, but not imported from it.
 116  *
 117  *   * This is obviously useful for initialized globals (which cannot be
 118  *     extern or similar).
 119  *   * This is also used in the log mecanism where a macro creates the
 120  *     variable automatically. When the macro is called from within SimGrid,
 121  *     the symbol must be exported, but when called  from within the client
 122  *     code, it must not try to retrieve the symbol from the DLL since it's
 123  *      not in there.
 124  *
 125  * Rational of XBT_IMPORT_NO_EXPORT: (windows-only cruft)
 126  *   * Symbols which must be imported from the DLL, but not explicitely
 127  *     exported from it.
 128  *
 129  *   * The root log category is already exported, but not imported explicitely
 130  *     when creating a subcategory since we cannot import the parent category
 131  *     to deal with the fact that the parent may be in application space, not
 132  *     DLL space.
 133  */
 134
 135
 136 /* Build the DLL */
 137 #if defined(DLL_EXPORT)
 138 #  define XBT_PUBLIC(type)            __declspec(dllexport) type
 139 #  define XBT_EXPORT_NO_IMPORT(type)  __declspec(dllexport) type
 140 #  define XBT_IMPORT_NO_EXPORT(type)  type
 141 #  define XBT_PUBLIC_DATA(type)       __declspec(dllexport) type
 142
 143 /* Pack everything up statically */
 144 #elif defined(DLL_STATIC)
 145 #  define XBT_PUBLIC(type)           extern type
 146 #  define XBT_EXPORT_NO_IMPORT(type)  type
 147 #  define XBT_IMPORT_NO_EXPORT(type)  type
 148 #  define XBT_PUBLIC_DATA(type)       extern type
 149
 150 /* Link against the DLL */
 151 #elif (defined(_XBT_WIN32) && !defined(DLL_EXPORT) && !defined(DLL_STATIC))
 152 #  define XBT_PUBLIC(type)              __declspec(dllimport) type
 153 #  define XBT_EXPORT_NO_IMPORT(type)    type
 154 #  define XBT_IMPORT_NO_EXPORT(type)    __declspec(dllimport) type
 155 #  define XBT_PUBLIC_DATA(type)         __declspec(dllimport) type
 156
 157 /* UNIX build */
 158 #else
 159 #  define XBT_PUBLIC(type)            extern type
 160 #  define XBT_EXPORT_NO_IMPORT(type)  type
 161 #  define XBT_IMPORT_NO_EXPORT(type)  type
 162 #  define XBT_PUBLIC_DATA(type)       extern type
 163 #endif
 164
 165 #if !defined (max) && !defined(__cplusplus)
 166 #  define max(a,b)      (((a) > (b)) ? (a) : (b))
 167 #endif
 168 #if !defined (min) && !defined(__cplusplus)
 169 #  define min(a,b)      (((a) < (b)) ? (a) : (b))
 170 #endif
 171
 172 #define TRUE  1
 173 #define FALSE 0
 174
 175 #define XBT_MAX_CHANNEL 10      /* FIXME: killme */
 176 /*! C++ users need love */
 177 #ifndef SG_BEGIN_DECL
 178 # ifdef __cplusplus
 179 #  define SG_BEGIN_DECL() extern "C" {
 180 # else
 181 #  define SG_BEGIN_DECL()
 182 # endif
 183 #endif
 184
 185 #ifndef SG_END_DECL
 186 # ifdef __cplusplus
 187 #  define SG_END_DECL() }
 188 # else
 189 #  define SG_END_DECL()
 190 # endif
 191 #endif
 192 /* End of cruft for C++ */
 193
 194 SG_BEGIN_DECL()
 195
 196 XBT_PUBLIC(const char *) xbt_procname(void);
 197
 198 #define XBT_BACKTRACE_SIZE 10   /* FIXME: better place? Do document */
 199
 200 SG_END_DECL()
 201 #endif                          /* XBT_MISC_H */