Compiler.h

Go to the documentation of this file.

/*
* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
*
* This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
* and international copyright treaties.
*
* Access to and use of the software is governed by the terms of the applicable ONIXS Software
* Services Agreement (the Agreement) and Customer end user license agreements granting
* a non-assignable, non-transferable and non-exclusive license to use the software
* for it's own data processing purposes under the terms defined in the Agreement.
*
* Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
* of this source code or associated reference material to any other location for further reproduction
* or redistribution, and any amendments to this copyright notice, are expressly prohibited.
*
* Any reproduction or redistribution for sale or hiring of the Software not in accordance with
* the terms of the Agreement is a violation of copyright law.
*/
 
#pragma once
 
#if !(defined(ONIXS_ICEBOE_DOXYGEN) && ONIXS_ICEBOE_DOXYGEN)
 
#include <OnixS/ICE/BOE/CompilerDetection.h>
#include <OnixS/ICE/BOE/Export.h>
 
#if defined(_MSC_VER) && defined(_MSVC_LANG)
#  define ONIXS_CURRENT_CXX_STD _MSVC_LANG
#else
#  define ONIXS_CURRENT_CXX_STD __cplusplus
#endif
 
#if !defined(ONIXS_ICEBOE_CXX11)
#   error at least C++11 is required
#   define ONIXS_ICEBOE_TERMINATE_COMPILATION
# endif
 
# if defined(ONIXS_ICEBOE_CXX11)
#  if (ONIXS_CURRENT_CXX_STD < 201103L)
#   error C++11 was targeted during the OnixS SDK compilation but is not detected now
#   define ONIXS_ICEBOE_TERMINATE_COMPILATION
#  endif
# endif
 
# if defined(ONIXS_ICEBOE_CXX14)
#  if (ONIXS_CURRENT_CXX_STD < 201402L)
#   error C++14 was targeted during the OnixS SDK compilation but is not detected now
#   define ONIXS_ICEBOE_TERMINATE_COMPILATION
#  endif
# endif
 
# if defined(ONIXS_ICEBOE_CXX17)
#  if (ONIXS_CURRENT_CXX_STD < 201703L)
#   error C++17 was targeted during the OnixS SDK compilation but is not detected now
#   define ONIXS_ICEBOE_TERMINATE_COMPILATION
#  endif
# endif
 
# if defined(ONIXS_ICEBOE_CXX20)
#  if !(ONIXS_CURRENT_CXX_STD > 201703L)
#   error C++20 was targeted during the OnixS SDK compilation but is not detected now
#   define ONIXS_ICEBOE_TERMINATE_COMPILATION
#  endif
# endif
 
# if defined(ONIXS_ICEBOE_TERMINATE_COMPILATION)
#  include <terminate_compilation>
#endif
 
#define ONIXS_ICEBOE_TO_STR_IMPL(X) #X
#define ONIXS_ICEBOE_TO_STR(X) ONIXS_ICEBOE_TO_STR_IMPL(X)
 
#define ONIXS_ICEBOE_CONCATENATE_IMPL(X,Y) X##Y
#define ONIXS_ICEBOE_CONCATENATE(X,Y) ONIXS_ICEBOE_CONCATENATE_IMPL(X,Y)
#define ONIXS_ICEBOE_MAKE_UNIQUE_NAME(name) ONIXS_ICEBOE_CONCATENATE(___, ONIXS_ICEBOE_CONCATENATE(name, __LINE__))
 
# if defined(ONIXS_ICEBOE_COMPILER_IS_GNU) | defined(ONIXS_ICEBOE_COMPILER_IS_Clang)
#  define ONIXS_ICEBOE_COMPILER_IS_GNU_or_Clang
# endif
 
 
# if defined(ONIXS_ICEBOE_COMPILER_IS_GNU_or_Clang)
 
#if ((ONIXS_CURRENT_CXX_STD >= 201703L) && (!defined(ONIXS_ICEBOE_CXX17)))
# define _ONIXS_ICEBOE_DTS_BUILD 1
#else
# define _ONIXS_ICEBOE_DTS_BUILD 0
#endif
 
#if defined(ONIXS_ICEBOE_COMPILER_IS_GNU)
# if (__GNUC__ >= 9) && !_ONIXS_ICEBOE_DTS_BUILD
#   define ONIXS_ICEBOE_LIKELY(cond)   (__builtin_expect_with_probability((static_cast<bool>((cond))), true, 0.99999f))
#   define ONIXS_ICEBOE_UNLIKELY(cond) (__builtin_expect_with_probability((static_cast<bool>((cond))), false, 0.99999f))
# else
#   define ONIXS_ICEBOE_LIKELY(cond)   (__builtin_expect((static_cast<bool>((cond))), true))
#   define ONIXS_ICEBOE_UNLIKELY(cond) (__builtin_expect((static_cast<bool>((cond))), false))
# endif
#endif
 
#undef _ONIXS_ICEBOE_DTS_BUILD
 
#if defined(ONIXS_ICEBOE_COMPILER_IS_Clang)
# define ONIXS_ICEBOE_LIKELY(cond)   (__builtin_expect((static_cast<bool>((cond))), true))
# define ONIXS_ICEBOE_UNLIKELY(cond) (__builtin_expect((static_cast<bool>((cond))), false))
#endif
 
#  define ONIXS_ICEBOE_UNUSED __attribute__((__unused__))
#  define ONIXS_ICEBOE_HOTPATH __attribute__((hot))
#  define ONIXS_ICEBOE_COLDPATH __attribute__((noinline,cold))
#  define ONIXS_ICEBOE_NODISCARD __attribute__((warn_unused_result))
#  define ONIXS_ICEBOE_PURE
#  define ONIXS_ICEBOE_NONULL __attribute__((nonnull))
#  define ONIXS_ICEBOE_FORCEINLINE inline __attribute__ ((__always_inline__))
#  define ONIXS_ICEBOE_PRAGMA(x) _Pragma(#x)
 
// https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/p0012r1.html
#if defined(__cpp_noexcept_function_type) && __cpp_noexcept_function_type >= 201510L
#  define ONIXS_ICEBOE_CXX17_NOEXCEPT 1
#else
#  define ONIXS_ICEBOE_CXX17_NOEXCEPT 0
#endif
 
 
 
#elif defined(ONIXS_ICEBOE_COMPILER_IS_MSVC)
 
#  define ONIXS_ICEBOE_LIKELY(cond) ((cond))
#  define ONIXS_ICEBOE_UNLIKELY(cond) ((cond))
#  define ONIXS_ICEBOE_PURE
#  define ONIXS_ICEBOE_UNUSED
#  define ONIXS_ICEBOE_HOTPATH
#  define ONIXS_ICEBOE_COLDPATH
#  define ONIXS_ICEBOE_NODISCARD _Check_return_
#  define ONIXS_ICEBOE_NONULL
#  define ONIXS_ICEBOE_FORCEINLINE inline
#  define ONIXS_ICEBOE_PRAGMA(x) __pragma(x)
 
#else
#  error Unsupported compiler
#endif
 
#define ONIXS_ICEBOE_STATIC_ASSERT(...) static_assert(__VA_ARGS__, "")
#define ONIXS_ICEBOE_CHECK_NOTHROW(equation) ONIXS_ICEBOE_STATIC_ASSERT(noexcept((equation)))
 
 
#if defined NDEBUG
# define ONIXS_ICEBOE_ASSERT(CHECK) void(0)
#else
# define ONIXS_ICEBOE_ASSERT(CHECK) ((CHECK) ? void(0) : []() {assert(!#CHECK);}())
#endif
 
#define ONIXS_ICEBOE_HARDWARE_DESTRUCTIVE_INTERFACE_SIZE (64)
 
#else //#if !(defined(ONIXS_DOXYGEN) && ONIXS_DOXYGEN)
#define ONIXS_ICEBOE_EXPORTED
#define ONIXS_ICEBOE_NODISCARD
#define ONIXS_ICEBOE_HOTPATH
#define ONIXS_ICEBOE_COLDPATH
#define ONIXS_ICEBOE_PURE
#define ONIXS_ICEBOE_CXX11
#define ONIXS_ICEBOE_CXX14
#define ONIXS_ICEBOE_CXX17
#define ONIXS_ICEBOE_CXX20
#define ONIXS_ICEBOE_UNUSED
#define ONIXS_ICEBOE_CXX17_NOEXCEPT 0
#define ONIXS_ICEBOE_PRAGMA(x)
#endif
 
#define ONIXS_ICEBOE_DATA_PACKING_BEGIN(alignment) ONIXS_ICEBOE_PRAGMA(pack(push, alignment))
#define ONIXS_ICEBOE_DATA_PACKING_END ONIXS_ICEBOE_PRAGMA(pack(pop))