core.hpp

Go to the documentation of this file.

// -----------------------------------------------------------------------------------------------------
// Copyright (c) 2022 deCODE Genetics
// Copyright (c) 2006-2020, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2020, Knut Reinert & MPI für molekulare Genetik
// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
// shipped with this file and also available at: https://github.com/biocpp/biocpp-core/blob/main/LICENSE.md
// -----------------------------------------------------------------------------------------------------
 
#pragma once
 
#include <cinttypes>
#include <ciso646> // makes _LIBCPP_VERSION available
#include <cstddef> // makes __GLIBCXX__ available
 
// ============================================================================
//  C++ standard and features
// ============================================================================
 
// C++ standard [required]
#ifdef __cplusplus
static_assert(__cplusplus >= 201709, "BioCpp-Core requires C++20, make sure that you have set -std=c++20.");
#else
#    error "This is not a C++ compiler."
#endif
 
#if __has_include(<version>)
#    include <version>
#endif
 
// ============================================================================
//  Dependencies
// ============================================================================
 
// Self [required]
#if !__has_include(<bio/core.hpp>)
#    error BioC++ include directory not set correctly. Forgot to add -I ${INSTALLDIR}/include to your CXXFLAGS?
#endif
 
// ============================================================================
//  Documentation
// ============================================================================
 
// Doxygen related
// this macro is a NO-OP unless doxygen parses it, in which case it resolves to the argument
#ifndef BIOCPP_DOXYGEN_ONLY
#    define BIOCPP_DOXYGEN_ONLY(x)
#endif
 
// ============================================================================
//  Compiler Workarounds
// ============================================================================
 
#if defined(__GNUC__) && (__GNUC__ == 10 && __GNUC_MINOR__ <= 1)
#    pragma GCC warning                                                                                                \
      "Be aware that gcc 10.0 and 10.1 are known to have several bugs that might make BioC++ fail to compile. Please use gcc >= 10.2."
#endif // defined(__GNUC__) && (__GNUC__ == 10 && __GNUC_MINOR__ <= 1)
 
#ifndef BIOCPP_WORKAROUND_GCC_96070 // fixed since gcc10.4
#    if (defined(__GNUC__) && (__GNUC__ == 10 && __GNUC_MINOR__ < 4)) || defined(__clang__)
#        define BIOCPP_WORKAROUND_GCC_96070 1
#    else
#        define BIOCPP_WORKAROUND_GCC_96070 0
#    endif
#endif
 
#if BIOCPP_DOXYGEN_ONLY(1) 0
#    define BIOCPP_DISABLE_LEGACY_STD_DIAGNOSTIC
#endif // BIOCPP_DOXYGEN_ONLY(1)0
 
#if defined(_GLIBCXX_USE_CXX11_ABI) && _GLIBCXX_USE_CXX11_ABI == 0
#    ifndef BIOCPP_DISABLE_LEGACY_STD_DIAGNOSTIC
#        pragma GCC warning                                                                                            \
          "Your compiler has set -D_GLIBCXX_USE_CXX11_ABI=0. Please switch to a compiler that does not. You can disable this warning by setting -DBIOCPP_DISABLE_LEGACY_STD_DIAGNOSTIC."
#    endif // BIOCPP_DISABLE_LEGACY_STD_DIAGNOSTIC
#endif     // _GLIBCXX_USE_CXX11_ABI == 0
 
#ifndef BIOCPP_WORKAROUND_CLANG_58078
#    if defined(__clang__)
#        define BIOCPP_WORKAROUND_CLANG_58078 1
#    else
#        define BIOCPP_WORKAROUND_CLANG_58078 0
#    endif
#endif
 
#ifndef BIOCPP_WORKAROUND_CLANG_59501
#    if defined(__clang__)
#        define BIOCPP_WORKAROUND_CLANG_59501 1
#    else
#        define BIOCPP_WORKAROUND_CLANG_59501 0
#    endif
#endif
 
// ============================================================================
//  Define our version
// ============================================================================
 
#define BIOCPP_CORE_VERSION_MAJOR 0
#define BIOCPP_CORE_VERSION_MINOR 7
#define BIOCPP_CORE_VERSION_PATCH 0
 
#define BIOCPP_CORE_VERSION                                                                                            \
    (BIOCPP_CORE_VERSION_MAJOR * 10000 + BIOCPP_CORE_VERSION_MINOR * 100 + BIOCPP_CORE_VERSION_PATCH)
 
#define BIOCPP_CORE_VERSION_CSTRING_HELPER_STR(str) #str
 
#define BIOCPP_CORE_VERSION_CSTRING_HELPER_FUNC(MAJOR, MINOR, PATCH)                                                   \
    BIOCPP_CORE_VERSION_CSTRING_HELPER_STR(MAJOR)                                                                      \
    "." BIOCPP_CORE_VERSION_CSTRING_HELPER_STR(MINOR) "." BIOCPP_CORE_VERSION_CSTRING_HELPER_STR(PATCH)
 
#define BIOCPP_CORE_VERSION_CSTRING                                                                                    \
    BIOCPP_CORE_VERSION_CSTRING_HELPER_FUNC(BIOCPP_CORE_VERSION_MAJOR,                                                 \
                                            BIOCPP_CORE_VERSION_MINOR,                                                 \
                                            BIOCPP_CORE_VERSION_PATCH)
 
#include <string_view>
 
namespace bio
{
 
inline constexpr size_t biocpp_core_version_major = BIOCPP_CORE_VERSION_MAJOR;
inline constexpr size_t biocpp_core_version_minor = BIOCPP_CORE_VERSION_MINOR;
inline constexpr size_t biocpp_core_version_patch = BIOCPP_CORE_VERSION_PATCH;
 
inline constexpr std::string_view biocpp_core_version = BIOCPP_CORE_VERSION_CSTRING;
 
} // namespace bio
 
#undef BIOCPP_CORE_VERSION_CSTRING_HELPER_STR
#undef BIOCPP_CORE_VERSION_CSTRING_HELPER_FUNC
 
// ============================================================================
//  Macros for general use within libraries
// ============================================================================
 
#if defined(__clang__)
#    define BIOCPP_IS_SAME(...) __is_same(__VA_ARGS__)
#elif defined(__GNUC__)
#    define BIOCPP_IS_SAME(...) __is_same_as(__VA_ARGS__)
#else
#    define BIOCPP_IS_SAME(...) std::is_same_v<__VA_ARGS__>
#endif
 
#define BIOCPP_IS_CONSTEXPR(...) std::integral_constant<bool, __builtin_constant_p((__VA_ARGS__, 0))>::value
 
#define BIOCPP_UNREACHABLE __builtin_unreachable(); /* GCOVR_EXCL_LINE */
 
// ============================================================================
//  Alphabet namespaces
// ============================================================================
 
namespace bio::alphabet
{}
 
namespace bio::alphabet::custom
{}
 
namespace bio::alphabet
{
inline namespace literals
{}
} // namespace bio::alphabet
 
namespace bio::alphabet::detail
{}
 
// ============================================================================
//  Meta namespaces
// ============================================================================
 
namespace bio::meta
{}
 
namespace bio::meta
{
inline namespace literals
{}
} // namespace bio::meta
 
namespace bio::meta::detail
{}
 
// ============================================================================
//  Ranges namespaces
// ============================================================================
 
namespace bio::ranges
{}
 
namespace bio::ranges::views
{}
 
#ifndef BIOCPP_NO_NAMESPACE_ALIASES
namespace bio
{
namespace views = ranges::views;
} // namespace bio
#endif
 
namespace bio::ranges::detail
{}