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
 
#include <cinttypes>
#include <ciso646> // makes _LIBCPP_VERSION available
#include <cstddef> // makes __GLIBCXX__ available
 
// macro cruft
#define SEQAN3_STR_HELPER(x) #x
#define SEQAN3_STR(x) SEQAN3_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 SEQAN3_DOXYGEN_ONLY
#    define SEQAN3_DOXYGEN_ONLY(x)
#endif
 
// ============================================================================
//  Compiler support general
// ============================================================================
 
#if defined(__GNUC__) && !defined(__llvm__) && !defined(__INTEL_COMPILER)
#    define SEQAN3_COMPILER_IS_GCC 1
#else
#    define SEQAN3_COMPILER_IS_GCC 0
#endif
 
#if SEQAN3_DOXYGEN_ONLY(1) 0
#    define SEQAN3_DISABLE_COMPILER_CHECK
#endif // SEQAN3_DOXYGEN_ONLY(1)0
 
// ============================================================================
//  Compiler support GCC
// ============================================================================
 
#if SEQAN3_COMPILER_IS_GCC
#    if (__GNUC__ < 11)
#        error                                                                                                         \
            "SeqAn 3.1.x is the last version that supports GCC 7, 8, and 9. SeqAn 3.2.x is the latest version that support GCC 10. Please upgrade your compiler or use 3.1.x./3.2.x."
#    endif // (__GNUC__ < 11)
 
#    if (__GNUC__ == 11 && __GNUC_MINOR__ <= 3)
#        pragma GCC warning "Be aware that GCC < 11.4 might have bugs that cause SeqAn3 fail to compile."
#    endif // (__GNUC__ == 11 && __GNUC_MINOR__ <= 2)
 
#    if (__GNUC__ == 12 && __GNUC_MINOR__ <= 2)
#        pragma GCC warning "Be aware that GCC < 12.3 might have bugs that cause SeqAn3 fail to compile."
#    endif // (__GNUC__ == 12 && __GNUC_MINOR__ <= 1)
 
#    if SEQAN3_DOXYGEN_ONLY(1) 0
#        define SEQAN3_DISABLE_NEWER_COMPILER_DIAGNOSTIC
#    endif // SEQAN3_DOXYGEN_ONLY(1)0
 
#    ifndef SEQAN3_DISABLE_NEWER_COMPILER_DIAGNOSTIC
#        if (__GNUC__ > 13)
#            pragma message                                                                                            \
                "Your compiler is newer than the latest supported compiler of this SeqAn version (gcc-13). It might be that SeqAn does not compile due to this. You can disable this warning by setting -DSEQAN3_DISABLE_NEWER_COMPILER_DIAGNOSTIC."
#        endif // (__GNUC__ > 13)
#    endif     // SEQAN3_DISABLE_NEWER_COMPILER_DIAGNOSTIC
 
// ============================================================================
//  Compiler support Clang
// ============================================================================
 
#elif defined(__clang__)
#    if __clang_major__ < 17
#        error "Only Clang >= 17 is supported."
#    endif
 
// ============================================================================
//  Compiler support other
// ============================================================================
 
#elif !defined(SEQAN3_DISABLE_COMPILER_CHECK)
#    error "Your compiler is not supported. You can disable this error by setting -DSEQAN3_DISABLE_COMPILER_CHECK."
#endif // SEQAN3_COMPILER_IS_GCC
 
// ============================================================================
//  C++ standard and features
// ============================================================================
 
#if __has_include(<version>)
#    include <version>
#endif
 
// C++ standard [required]
#ifdef __cplusplus
#    if (__cplusplus < 202002L)
#        error "SeqAn3 requires C++20, make sure that you have set -std=c++20."
#    endif
#else
#    error "This is not a C++ compiler."
#endif
 
// ============================================================================
//  Dependencies
// ============================================================================
 
// SeqAn [required]
#if __has_include(<seqan3/version.hpp>)
#    include <seqan3/version.hpp>
#else
#    error SeqAn3 include directory not set correctly. Forgot to add -I ${INSTALLDIR}/include to your CXXFLAGS?
#endif
 
// SDSL [required]
#if __has_include(<sdsl/version.hpp>)
#    include <sdsl/version.hpp>
static_assert(sdsl::sdsl_version_major == 3, "Only version 3 of the SDSL is supported by SeqAn3.");
#else
#    error The sdsl library was not included correctly. Forgot to add -I ${INSTALLDIR}/include to your CXXFLAGS?
#endif
 
// Cereal [optional]
#ifndef SEQAN3_WITH_CEREAL
#    if __has_include(<cereal/cereal.hpp>)
#        define SEQAN3_WITH_CEREAL 1
#    else
#        define SEQAN3_WITH_CEREAL 0
#    endif
#elif SEQAN3_WITH_CEREAL != 0
#    if !__has_include(<cereal/cereal.hpp>)
#        error Cereal was marked as required, but not found!
#    endif
#endif
 
#if !SEQAN3_WITH_CEREAL
#    define CEREAL_SERIALIZE_FUNCTION_NAME serialize       
#    define CEREAL_LOAD_FUNCTION_NAME load                 
#    define CEREAL_SAVE_FUNCTION_NAME save                 
#    define CEREAL_LOAD_MINIMAL_FUNCTION_NAME load_minimal 
#    define CEREAL_SAVE_MINIMAL_FUNCTION_NAME save_minimal 
#endif
 
// ============================================================================
//  Deprecation Messages
// ============================================================================
 
#ifndef SEQAN3_PRAGMA
#    define SEQAN3_PRAGMA(non_string_literal) _Pragma(#non_string_literal)
#endif
 
#ifndef SEQAN3_DEPRECATED_HEADER
#    ifndef SEQAN3_DISABLE_DEPRECATED_WARNINGS
#        define SEQAN3_DEPRECATED_HEADER(message) SEQAN3_PRAGMA(GCC warning message)
#    else
#        define SEQAN3_DEPRECATED_HEADER(message) 
#    endif
#endif
 
#ifndef SEQAN3_REMOVE_DEPRECATED_340
#    ifndef SEQAN3_DEPRECATED_340
#        ifndef SEQAN3_DISABLE_DEPRECATED_WARNINGS
#            define SEQAN3_DEPRECATED_340                                                                              \
                [[deprecated("This will be removed in SeqAn-3.4.0; please see the documentation.")]]
#        else
#            define SEQAN3_DEPRECATED_340 
#        endif
#    endif
#endif
 
// ============================================================================
//  Workarounds
// ============================================================================
 
#ifndef SEQAN3_WORKAROUND_VIEW_PERFORMANCE
#    define SEQAN3_WORKAROUND_VIEW_PERFORMANCE 1
#endif
 
#ifndef SEQAN3_WORKAROUND_DEFAULT_CONSTRUCTIBLE_VIEW
#    if SEQAN3_COMPILER_IS_GCC && (__GNUC__ < 12)
#        define SEQAN3_WORKAROUND_DEFAULT_CONSTRUCTIBLE_VIEW 1
#    else
#        define SEQAN3_WORKAROUND_DEFAULT_CONSTRUCTIBLE_VIEW 0
#    endif
#endif
 
#ifndef SEQAN3_WORKAROUND_GCC_100139
#    if SEQAN3_COMPILER_IS_GCC && (__GNUC__ < 12)
#        define SEQAN3_WORKAROUND_GCC_100139 1
#    else
#        define SEQAN3_WORKAROUND_GCC_100139 0
#    endif
#endif
 
#ifndef SEQAN3_WORKAROUND_GCC_BOGUS_MEMCPY
#    if SEQAN3_COMPILER_IS_GCC && (__GNUC__ == 12 || __GNUC__ == 13)
#        define SEQAN3_WORKAROUND_GCC_BOGUS_MEMCPY 1
#    else
#        define SEQAN3_WORKAROUND_GCC_BOGUS_MEMCPY 0
#    endif
#endif
 
#ifndef SEQAN3_WORKAROUND_GCC_NO_CXX11_ABI
#    if defined(_GLIBCXX_USE_CXX11_ABI) && _GLIBCXX_USE_CXX11_ABI == 0
#        define SEQAN3_WORKAROUND_GCC_NO_CXX11_ABI 1
#    else
#        define SEQAN3_WORKAROUND_GCC_NO_CXX11_ABI 0
#    endif
#endif
 
#if __cpp_lib_constexpr_vector >= 201907L && (defined(_LIBCPP_VERSION) || !defined(_GLIBCXX_DEBUG))
#    define SEQAN3_WORKAROUND_LITERAL constexpr
#else
#    define SEQAN3_WORKAROUND_LITERAL inline
#endif
 
#if SEQAN3_DOXYGEN_ONLY(1) 0
#    define SEQAN3_DISABLE_LEGACY_STD_DIAGNOSTIC
#endif // SEQAN3_DOXYGEN_ONLY(1)0
 
#if defined(_GLIBCXX_USE_CXX11_ABI) && _GLIBCXX_USE_CXX11_ABI == 0
#    ifndef SEQAN3_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 SeqAn does not compile due to this. It is known that all compiler 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 (see https://docs.seqan.de/seqan3/main_user/about_api.html#platform_stability for more details). You can disable this warning by setting -DSEQAN3_DISABLE_LEGACY_STD_DIAGNOSTIC."
#    endif // SEQAN3_DISABLE_LEGACY_STD_DIAGNOSTIC
#endif     // _GLIBCXX_USE_CXX11_ABI == 0
 
// ============================================================================
//  Backmatter
// ============================================================================
 
// macro cruft undefine
#undef SEQAN3_STR
#undef SEQAN3_STR_HELPER