Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove features marked with DEPRECATED_v321.
[simgrid.git] / include / xbt / base.h
index 108003c..53f71a3 100644 (file)
@@ -1,6 +1,6 @@
 /* xbt.h - Public interface to the xbt (simgrid's toolbox)                  */
 
-/* Copyright (c) 2004-2015. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
 
 /* 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. */
      __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
 #endif
 
+#if defined(__cplusplus)
+#if __cplusplus >= 201103L
+#define XBT_ATTRIB_NORETURN [[noreturn]]
+#endif
+#if __cplusplus >= 201703L
+#define XBT_ATTRIB_UNUSED [[maybe_unused]]
+#endif
+#if __cplusplus >= 201402L
+#define XBT_ATTRIB_DEPRECATED(mesg) [[deprecated(mesg)]]
+#endif
+#elif defined(__STDC_VERSION__)
+#if __STDC_VERSION__ >= 201112L
+#define XBT_ATTRIB_NORETURN _Noreturn
+#endif
+#endif
+
+#ifndef XBT_ATTRIB_NORETURN
 #define XBT_ATTRIB_NORETURN __attribute__((noreturn))
+#endif
+#ifndef XBT_ATTRIB_UNUSED
 #define XBT_ATTRIB_UNUSED  __attribute__((unused))
-#define XBT_ATTRIB_DEPRECATED(m)  __attribute__((deprecated(m)))
+#endif
+#ifndef XBT_ATTRIB_DEPRECATED
+#define XBT_ATTRIB_DEPRECATED(mesg) __attribute__((deprecated(mesg)))
+#endif
+
+#define XBT_ATTRIB_DEPRECATED_v322(mesg) XBT_ATTRIB_DEPRECATED(mesg) /* Will be dropped in v3.22 */
+#define XBT_ATTRIB_DEPRECATED_v323(mesg)                                                                               \
+  XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.23)") /* Will be dropped in v3.23 */
 
-/* Constructor priorities exist since gcc 4.3.  Apparently, they are however not
- * supported on Macs. */
-#if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && !defined(__APPLE__)
-#  define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__ (prio)))
-#  define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__ (prio)))
+#if !defined(__APPLE__)
+#  define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__(prio)))
+#  define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__(prio)))
 #else
-#  define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__))
-#  define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__))
+#  define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__))
+#  define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__))
 #endif
 
 #if defined(__GNUC__)
 #  define XBT_THREAD_LOCAL No thread local on this architecture
 #endif
 
-/* 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))
-
 /*
  * Expands to `one' if there is only one argument for the variadic part.
  * Otherwise, expands to `more'.
 
 /* Handle import/export stuff
  *
- * Rational of XBT_PUBLIC:
+ * Rationale 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).
  *
  *   * 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)
+ * Rationale of XBT_EXPORT_NO_IMPORT: (windows-only)
  *   * 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).
  *     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)
+ * Rationale of XBT_IMPORT_NO_EXPORT: (windows-only)
  *   * Symbols which must be imported from the DLL, but not explicitly  exported from it.
  *
  *   * The root log category is already exported, but not imported explicitly when creating a subcategory since we
 
 /* 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)       extern __declspec(dllexport) type
-#  define XBT_PUBLIC_CLASS            class __declspec(dllexport)
+#  define XBT_PUBLIC            __declspec(dllexport)
+#  define XBT_EXPORT_NO_IMPORT  __declspec(dllexport)
+#  define XBT_IMPORT_NO_EXPORT
+#  define XBT_PUBLIC_DATA       extern __declspec(dllexport)
 #  define XBT_PRIVATE
 
 /* Link against the DLL */
 #elif (defined(_WIN32) && !defined(DLL_EXPORT))
-#  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)       extern __declspec(dllimport) type
-#  define XBT_PUBLIC_CLASS            class __declspec(dllimport)
+#  define XBT_PUBLIC            __declspec(dllimport)
+#  define XBT_EXPORT_NO_IMPORT
+#  define XBT_IMPORT_NO_EXPORT  __declspec(dllimport)
+#  define XBT_PUBLIC_DATA       extern __declspec(dllimport)
 #  define XBT_PRIVATE
 
-#elif defined(__ELF__) 
-#  define XBT_PUBLIC(type)            __attribute__((visibility("default"))) type
-#  define XBT_EXPORT_NO_IMPORT(type)  __attribute__((visibility("default"))) type
-#  define XBT_IMPORT_NO_EXPORT(type)  __attribute__((visibility("default"))) type
-#  define XBT_PUBLIC_DATA(type)       extern __attribute__((visibility("default"))) type
-#  define XBT_PUBLIC_CLASS            class __attribute__((visibility("default")))
-#  define XBT_PRIVATE                 __attribute__((visibility("hidden")))
+#elif defined(__ELF__)
+#  define XBT_PUBLIC            __attribute__((visibility("default")))
+#  define XBT_EXPORT_NO_IMPORT  __attribute__((visibility("default")))
+#  define XBT_IMPORT_NO_EXPORT  __attribute__((visibility("default")))
+#  define XBT_PUBLIC_DATA       extern __attribute__((visibility("default")))
+#  define XBT_PRIVATE           __attribute__((visibility("hidden")))
 
 #else
-#  define XBT_PUBLIC(type)            type
-#  define XBT_EXPORT_NO_IMPORT(type)  type
-#  define XBT_IMPORT_NO_EXPORT(type)  type
-#  define XBT_PUBLIC_DATA(type)       extern type
-#  define XBT_PUBLIC_CLASS            class
-#  define XBT_PRIVATE                 /** @private */
+#  define XBT_PUBLIC            /* public */
+#  define XBT_EXPORT_NO_IMPORT
+#  define XBT_IMPORT_NO_EXPORT
+#  define XBT_PUBLIC_DATA       extern
+#  define XBT_PRIVATE           /** @private */
 
 #endif
 
-#define TRUE  1
-#define FALSE 0
-
 /* C++ users need love */
 #ifndef SG_BEGIN_DECL
 # ifdef __cplusplus