predicate_detail.hpp

Go to the documentation of this file.

// -----------------------------------------------------------------------------------------------------
// Copyright (c) 2006-2021, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2021, 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/seqan/seqan3/blob/master/LICENSE.md
// -----------------------------------------------------------------------------------------------------
 
#pragma once
 
#include <array>
#include <cctype>
#include <seqan3/std/concepts>
#include <stdexcept>
#include <string>
 
#include <seqan3/utility/detail/type_name_as_string.hpp>
#include <seqan3/utility/type_traits/basic.hpp>
 
#ifdef SEQAN3_DEPRECATED_310
#include <seqan3/alphabet/concept.hpp>
#endif // SEQAN3_DEPRECATED_310
 
namespace seqan3::detail
{
 
// ----------------------------------------------------------------------------
// constexpr_pseudo_bitset (could be replaced with constexpr std::bitset or github.com/ClaasBontus/bitset2)
// ----------------------------------------------------------------------------
 
template <size_t N>
class constexpr_pseudo_bitset : public std::array<bool, N>
{
private:
    using base_t = std::array<bool, N>;
public:
    using base_t::base_t;
 
    constexpr constexpr_pseudo_bitset operator|(constexpr_pseudo_bitset rhs) const noexcept
    {
        for (size_t i = 0; i < N; ++i)
            rhs[i] = rhs[i] || base_t::operator[](i);
 
        return rhs;
    }
    constexpr constexpr_pseudo_bitset operator~() const noexcept
    {
        constexpr_pseudo_bitset ret{};
        for (size_t i = 0; i < N; ++i)
            ret[i] = !base_t::operator[](i);
 
        return ret;
    }
};
 
// ----------------------------------------------------------------------------
// condition_message_v
// ----------------------------------------------------------------------------
 
template <char op, typename condition_head_t, typename ...condition_ts>
inline const std::string condition_message_v
{
    std::string{"("} +
    (condition_head_t::msg + ... +
        (std::string{" "} + std::string{{op, op}} + std::string{" "} + condition_ts::msg)) +
    std::string{")"}
};
 
// ----------------------------------------------------------------------------
// char_predicate
// ----------------------------------------------------------------------------
 
template <typename condition_t>
struct char_predicate_base;
 
template <typename condition_t>
SEQAN3_CONCEPT char_predicate = requires
{
    requires std::predicate<std::remove_reference_t<condition_t>, char>;
    requires std::is_base_of_v<char_predicate_base<std::remove_cvref_t<condition_t>>,
                               std::remove_cvref_t<condition_t>>;
 
    std::remove_reference_t<condition_t>::msg;
 
    //The msg type can be added with a std::string.
    SEQAN3_RETURN_TYPE_CONSTRAINT(std::string{} + std::remove_reference_t<condition_t>::msg,
                                  std::convertible_to, decltype(std::remove_reference_t<condition_t>::msg));
};
 
 
// ----------------------------------------------------------------------------
// char_predicate
// ----------------------------------------------------------------------------
 
template <char_predicate... condition_ts>
    requires (sizeof...(condition_ts) >= 2)
struct char_predicate_disjunction;
 
template <char_predicate condition_t>
struct char_predicate_negator;
 
template <typename derived_t>
struct char_predicate_base
{
    using data_t = constexpr_pseudo_bitset<257>; // sizeof(char) plus EOF
 
    template <char_predicate rhs_t>
    constexpr auto operator||(rhs_t const &) const
    {
        return char_predicate_disjunction<derived_t, rhs_t>{};
    }
 
    constexpr auto operator!() const
    {
        return char_predicate_negator<derived_t>{};
    }
 
    template <std::integral value_t>
    constexpr bool operator()(value_t const val) const noexcept
        requires (sizeof(value_t) == 1)
    {
        return derived_t::data[static_cast<unsigned char>(val)];
    }
 
    template <std::integral value_t>
    constexpr bool operator()(value_t const val) const noexcept
        requires (sizeof(value_t) != 1)
    {
        using char_trait = std::char_traits<value_t>;
        return (static_cast<std::make_unsigned_t<value_t>>(val) < 256) ? operator()(static_cast<uint8_t>(val)) :
               (char_trait::eq_int_type(val, char_trait::eof()))       ? derived_t::data[256]                  : false;
    }
 
    std::string message() const
    {
        return derived_t::msg;
    }
};
 
// ----------------------------------------------------------------------------
// char_predicate_disjunction
// ----------------------------------------------------------------------------
 
template <char_predicate... condition_ts>
    requires (sizeof...(condition_ts) >= 2)
struct char_predicate_disjunction : public char_predicate_base<char_predicate_disjunction<condition_ts...>>
{
    inline static const std::string msg = detail::condition_message_v<'|', condition_ts...>;
 
    using base_t = char_predicate_base<char_predicate_disjunction<condition_ts...>>;
 
    using typename base_t::data_t;
    static constexpr data_t data = (condition_ts::data | ...);
};
 
template <char_predicate condition_t>
struct char_predicate_negator : public char_predicate_base<char_predicate_negator<condition_t>>
{
    inline static const std::string msg = std::string{'!'} + condition_t::msg;
 
    using base_t = char_predicate_base<char_predicate_negator<condition_t>>;
 
    using typename base_t::data_t;
    static constexpr data_t data = ~condition_t::data;
};
 
// ----------------------------------------------------------------------------
// is_in_interval_type
// ----------------------------------------------------------------------------
 
template <uint8_t interval_first, uint8_t interval_last>
    requires (interval_first <= interval_last)
struct is_in_interval_type : public char_predicate_base<is_in_interval_type<interval_first, interval_last>>
{
    inline static const std::string msg = std::string{"is_in_interval<'"} +
                                          std::string{interval_first}     +
                                          std::string{"', '"}             +
                                          std::string{interval_last}      +
                                          std::string{"'>"};
 
    using base_t = char_predicate_base<is_in_interval_type<interval_first, interval_last>>;
 
    using typename base_t::data_t;
    static constexpr data_t data = [] () constexpr
    {
        data_t ret{};
 
        for (size_t i = interval_first; i <= static_cast<size_t>(interval_last); ++i)
            ret[i] = true;
 
        return ret;
    }();
};
 
#ifdef SEQAN3_DEPRECATED_310
// ----------------------------------------------------------------------------
// is_in_alphabet_type
// ----------------------------------------------------------------------------
 
template <detail::constexpr_alphabet alphabet_t>
struct is_in_alphabet_type : public char_predicate_base<is_in_alphabet_type<alphabet_t>>
{
public:
    inline static const std::string msg = std::string{"is_in_alphabet<"}          +
                                          detail::type_name_as_string<alphabet_t> +
                                          std::string{">"};
 
    using base_t = char_predicate_base<is_in_alphabet_type<alphabet_t>>;
 
    using typename base_t::data_t;
    static constexpr data_t data = [] () constexpr
    {
        data_t ret{};
 
        for (size_t i = 0; i < 256; ++i)
            ret[i] = char_is_valid_for<alphabet_t>(static_cast<uint8_t>(i));
 
        return ret;
    }();
};
#endif // SEQAN3_DEPRECATED_310
 
// ----------------------------------------------------------------------------
// is_char_type
// ----------------------------------------------------------------------------
 
template <int char_v>
struct is_char_type : public char_predicate_base<is_char_type<char_v>>
{
    static_assert(char_v == EOF || static_cast<uint64_t>(char_v) < 256, "TODO");
 
    inline static const std::string msg = std::string{"is_char<'"}                                     +
                                          ((char_v == EOF) ? std::string{"EOF"} : std::string{char_v}) +
                                          std::string{"'>"};
 
 
 
    using base_t = char_predicate_base<is_char_type<char_v>>;
 
    using typename base_t::data_t;
    static constexpr data_t data = [] () constexpr
    {
        data_t ret{};
 
        if (char_v == EOF)
            ret[256] = true;
        else
            ret[static_cast<uint8_t>(char_v)] = true;
 
        return ret;
    }();
};
 
} // namespace seqan3::detail