platform.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
// macro cruft
#define HIBF_STR_HELPER(x) #x
#define HIBF_STR(x) HIBF_STR_HELPER(x)
 
// ============================================================================
//  Documentation
// ============================================================================
 
// Doxygen related
// this macro is a NO-OP unless doxygen parses it, in which case it resolves to the argument
#ifndef HIBF_DOXYGEN_ONLY
#    define HIBF_DOXYGEN_ONLY(x)
#endif
 
// ============================================================================
//  Compiler support general
// ============================================================================
 
#if defined(__GNUC__) && !defined(__llvm__) && !defined(__INTEL_COMPILER)
#    define HIBF_COMPILER_IS_GCC 1
#else
#    define HIBF_COMPILER_IS_GCC 0
#endif
 
#if HIBF_DOXYGEN_ONLY(1) 0
#    define HIBF_DISABLE_COMPILER_CHECK
#endif // HIBF_DOXYGEN_ONLY(1)0
 
#ifndef HIBF_HAS_AVX512
#    if __AVX512F__ && __AVX512BW__
#        define HIBF_HAS_AVX512 1
#    else
#        define HIBF_HAS_AVX512 0
#    endif
#endif
 
// ============================================================================
//  Compiler support GCC
// ============================================================================
 
#if HIBF_COMPILER_IS_GCC
#    if (__GNUC__ < 12)
#        error "At least GCC 12 is needed."
#    endif // (__GNUC__ < 12)
 
#    if (__GNUC__ == 12 && __GNUC_MINOR__ <= 2)
#        pragma warning "Be aware that GCC < 12.3 might have bugs that cause compile failure."
#    endif // (__GNUC__ == 12 && __GNUC_MINOR__ <= 2)
 
#    if HIBF_DOXYGEN_ONLY(1) 0
#        define HIBF_DISABLE_NEWER_COMPILER_DIAGNOSTIC
#    endif // HIBF_DOXYGEN_ONLY(1)0
 
#    ifndef HIBF_DISABLE_NEWER_COMPILER_DIAGNOSTIC
#        if (__GNUC__ > 14)
#            pragma message                                                                                            \
                "Your compiler is newer than the latest supported compiler version (gcc-14). It might be that compiling fails. You can disable this warning by setting -DHIBF_DISABLE_NEWER_COMPILER_DIAGNOSTIC."
#        endif // (__GNUC__ > 14)
#    endif     // HIBF_DISABLE_NEWER_COMPILER_DIAGNOSTIC
#endif
 
// ============================================================================
//  C++ standard and features
// ============================================================================
 
#if __has_include(<version>)
#    include <version> // for __cpp_lib_constexpr_vector
#endif
 
// C++ standard [required]
#ifdef __cplusplus
#    if (__cplusplus < 202100)
#        error "C++23 is required, make sure that you have set -std=c++23."
#    endif
#else
#    error "This is not a C++ compiler."
#endif
 
// ============================================================================
//  Dependencies
// ============================================================================
 
// HIBF [required]
#if __has_include(<hibf/version.hpp>)
#    include <hibf/version.hpp>
#else
#    error "HIBF include directory not set correctly. Forgot to add -I ${INSTALLDIR}/include to your CXXFLAGS?"
#endif
 
// ============================================================================
//  Deprecation Messages
// ============================================================================
 
#ifndef HIBF_PRAGMA
#    define HIBF_PRAGMA(non_string_literal) _Pragma(#non_string_literal)
#endif
 
#ifndef HIBF_DEPRECATED_HEADER
#    ifndef HIBF_DISABLE_DEPRECATED_WARNINGS
#        define HIBF_DEPRECATED_HEADER(message) HIBF_PRAGMA(GCC warning message)
#    else
#        define HIBF_DEPRECATED_HEADER(message) 
#    endif
#endif
 
#ifndef HIBF_REMOVE_DEPRECATED_100
#    ifndef HIBF_DEPRECATED_100
#        ifndef HIBF_DISABLE_DEPRECATED_WARNINGS
#            define HIBF_DEPRECATED_100                                                                                \
                [[deprecated("This will be removed in version 1.0.0; please see the documentation.")]]
#        else
#            define HIBF_DEPRECATED_100 
#        endif
#    endif
#endif
 
// ============================================================================
//  Workarounds
// ============================================================================
 
#if defined(__cpp_lib_constexpr_vector)
#    define HIBF_CONSTEXPR_VECTOR constexpr
#else
#    define HIBF_CONSTEXPR_VECTOR
#endif
 
#ifndef HIBF_WORKAROUND_GCC_BOGUS_MEMCPY
#    if HIBF_COMPILER_IS_GCC && (__GNUC__ == 12)
#        define HIBF_WORKAROUND_GCC_BOGUS_MEMCPY 1
#    else
#        define HIBF_WORKAROUND_GCC_BOGUS_MEMCPY 0
#    endif
#endif
 
#ifndef HIBF_WORKAROUND_GCC_NO_CXX11_ABI
#    if defined(_GLIBCXX_USE_CXX11_ABI) && _GLIBCXX_USE_CXX11_ABI == 0
#        define HIBF_WORKAROUND_GCC_NO_CXX11_ABI 1
#    else
#        define HIBF_WORKAROUND_GCC_NO_CXX11_ABI 0
#    endif
#endif
 
#if defined(__cpp_lib_constexpr_vector) && __cpp_lib_constexpr_vector >= 201907L
#    define HIBF_WORKAROUND_LITERAL constexpr
#else
#    define HIBF_WORKAROUND_LITERAL inline
#endif
 
#if HIBF_DOXYGEN_ONLY(1) 0
#    define HIBF_DISABLE_LEGACY_STD_DIAGNOSTIC
#endif // HIBF_DOXYGEN_ONLY(1)0
 
#if defined(_GLIBCXX_USE_CXX11_ABI) && _GLIBCXX_USE_CXX11_ABI == 0
#    ifndef HIBF_DISABLE_LEGACY_STD_DIAGNOSTIC
#        pragma message                                                                                                \
            "We do not actively support compiler that have -D_GLIBCXX_USE_CXX11_ABI=0 set, and it might be that compiling fails. It is known that all compilers of CentOS 7 / RHEL 7 set this flag by default (and that it cannot be overridden!). Note that these versions of the OSes are community-supported. You can disable this warning by setting -DHIBF_DISABLE_LEGACY_STD_DIAGNOSTIC."
#    endif // HIBF_DISABLE_LEGACY_STD_DIAGNOSTIC
#endif     // _GLIBCXX_USE_CXX11_ABI == 0
 
// ============================================================================
//  Backmatter
// ============================================================================
 
// macro cruft undefine
#undef HIBF_STR
#undef HIBF_STR_HELPER