/* xbt.h - Public interface to the xbt (simgrid's toolbox) */
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2004-2023. 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. */
# define _GNU_SOURCE
#endif
-// Teach the compiler that some code path is unreacheable:
-#if defined(__has_builtin)
-# if __has_builtin(__builtin_unreachable)
-# define XBT_UNREACHABLE() __builtin_unreachable()
-# else
-# include <stdlib.h>
-# define XBT_UNREACHABLE() abort()
-# endif
-#elif (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
-# define XBT_UNREACHABLE() __builtin_unreachable()
-#else
-# include <stdlib.h>
-# define XBT_UNREACHABLE() abort()
-#endif
-
-/* On MinGW, stdio.h defines __MINGW_PRINTF_FORMAT and __MINGW_SCANF_FORMAT
- which are the suitable format style (either gnu_printf or ms_printf)
- depending on which version is available (__USE_MINGW_ANSI_STDIO): */
-#ifdef __MINGW32__
-# include <stdio.h>
-
-#define XBT_ATTRIB_PRINTF(format_idx, arg_idx) \
- __attribute__((__format__(__MINGW_PRINTF_FORMAT, (format_idx), (arg_idx))))
-#define XBT_ATTRIB_SCANF(format_idx, arg_idx) __attribute__((__MINGW_SCANF_FORMAT(__scanf__, (format_idx), (arg_idx))))
-#else
#define XBT_ATTRIB_PRINTF(format_idx, arg_idx) __attribute__((__format__(__printf__, (format_idx), (arg_idx))))
#define XBT_ATTRIB_SCANF(format_idx, arg_idx) __attribute__((__format__(__scanf__, (format_idx), (arg_idx))))
-#endif
#if defined(__cplusplus)
#if __cplusplus >= 201103L
#define XBT_ATTRIB_DEPRECATED(mesg) __attribute__((deprecated(mesg)))
#endif
-#define XBT_ATTRIB_DEPRECATED_v325(mesg) \
- XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.25)") /* Will be dropped in v3.25 */
-#define XBT_ATTRIB_DEPRECATED_v327(mesg) \
- XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.27)") /* Will be dropped in v3.27 */
-#define XBT_ATTRIB_DEPRECATED_v328(mesg) \
- XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.28)") /* Will be dropped in v3.28 */
+#define XBT_ATTRIB_DEPRECATED_v334(mesg) \
+ XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.33)")
+#define XBT_ATTRIB_DEPRECATED_v335(mesg) \
+ XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.34)")
+#define XBT_ATTRIB_DEPRECATED_v336(mesg) \
+ XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.35)")
+#define XBT_ATTRIB_DEPRECATED_v337(mesg) \
+ XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.36)")
+
+/* Work around https://github.com/microsoft/vscode-cpptools/issues/4503 */
+#ifdef __INTELLISENSE__
+#pragma diag_suppress 1094
+#endif
#if !defined(__APPLE__)
# define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__(prio)))
/* Concatenate arguments. _XBT_CONCAT2 adds a level of indirection over _XBT_CONCAT. */
#define _XBT_CONCAT(a, b) a##b
#define _XBT_CONCAT2(a, b) _XBT_CONCAT(a, b)
-#define _XBT_CONCAT3(a, b, c) _XBT_CONCAT2(_XBT_CONCAT(a, b), c)
+#define _XBT_CONCAT3(a, b, c) _XBT_CONCAT2(_XBT_CONCAT2(a, b), c)
#define _XBT_CONCAT4(a, b, c, d) _XBT_CONCAT2(_XBT_CONCAT3(a, b, c), d)
/*
a16, a15, a14, a13, a12, a11, a10, a9, \
a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
+/* Expands to number of arguments. */
+#define _XBT_COUNT_ARGS(...) _XBT_IF_ONE_ARG_(__VA_ARGS__, \
+ 64, 63, 62, 61, 60, 59, 58, 57, 56, 55, 54, 53, 52, 51, 50, 49, \
+ 48, 47, 46, 45, 44, 43, 42, 41, 40, 39, 38, 37, 36, 35, 34, 33, \
+ 32, 31, 30, 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, 19, 18, 17, \
+ 16, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1)
+
+/* Expands to list with each argument rendered as string. Add more cases if needed. */
+#define _XBT_STRINGIFY_ARGS(...) _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_02_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_02_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_03_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_03_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_04_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_04_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_05_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_05_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_06_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_06_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_07_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_07_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_08_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_08_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_09_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_09_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_10_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_10_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_11_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_11_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_12_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_12_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_13_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_13_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_14_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_14_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_15_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_15_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_16_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_16_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_17_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_17_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_18_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_18_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_19_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_19_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_20_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_20_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_21_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_21_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_22_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_22_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_23_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_23_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_24_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_24_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_25_, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_STRINGIFY_A_25_(...) error_maximum_size_of_XBT_STRINGIFY_ARGS_reached
+
/* Handle import/export stuff
*
* Rationale of XBT_PUBLIC:
*
* * 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.
- *
- * 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).
- * * This is also used in the log mechanism 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.
- *
- * 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
- * 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 __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 __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 __attribute__((visibility("default")))
-# define XBT_EXPORT_NO_IMPORT __attribute__((visibility("default")))
-# define XBT_IMPORT_NO_EXPORT __attribute__((visibility("default")))
+#if defined(__ELF__)
+#define XBT_PUBLIC __attribute__((visibility("default")))
# define XBT_PUBLIC_DATA extern __attribute__((visibility("default")))
# define XBT_PRIVATE __attribute__((visibility("hidden")))
#else
-# define XBT_PUBLIC /* public */
-# define XBT_EXPORT_NO_IMPORT
-# define XBT_IMPORT_NO_EXPORT
+#define XBT_PUBLIC /* public */
# define XBT_PUBLIC_DATA extern
# define XBT_PRIVATE /** @private */
/* C++ users need love */
#ifndef SG_BEGIN_DECL
# ifdef __cplusplus
-# define SG_BEGIN_DECL() extern "C" {
+# define SG_BEGIN_DECL extern "C" {
# else
-# define SG_BEGIN_DECL()
+# define SG_BEGIN_DECL
# endif
#endif
#ifndef SG_END_DECL
# ifdef __cplusplus
-# define SG_END_DECL() }
+# define SG_END_DECL }
# else
-# define SG_END_DECL()
+# define SG_END_DECL
# endif
#endif
/* End of cruft for C++ */
