record.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 <limits>
#include <tuple>
 
#include <seqan3/core/detail/template_inspection.hpp>
 
namespace seqan3
{
 
// ----------------------------------------------------------------------------
// enum field
// ----------------------------------------------------------------------------
 
enum class field
{
    // Fields used in multiple contexts ........................................
    seq,  
    id,   
    qual, 
 
    offset, 
 
    // Fields unique to structure io ...........................................
    bpp,            
    structure,      
    structured_seq, 
    energy,         
    react,          
    react_err,      
    comment,        
 
    // Fields unique to alignment io ...........................................
    alignment,  
    ref_id,     
    ref_seq,    
    ref_offset, 
    header_ptr, 
 
    flag,  
    mate,  
    mapq,  
    cigar, 
    tags,  
 
    bit_score, 
    evalue,    
 
    // User defined field aliases .. ...........................................
    user_defined_0, 
    user_defined_1, 
    user_defined_2, 
    user_defined_3, 
    user_defined_4, 
    user_defined_5, 
    user_defined_6, 
    user_defined_7, 
    user_defined_8, 
    user_defined_9  
};
 
// ----------------------------------------------------------------------------
// fields
// ----------------------------------------------------------------------------
 
template <field... fs>
struct fields
{
    static constexpr std::array<field, sizeof...(fs)> as_array{fs...};
 
    static constexpr size_t npos = std::numeric_limits<size_t>::max();
 
    static constexpr size_t size = sizeof...(fs);
 
    static constexpr size_t index_of(field f)
    {
        for (size_t i = 0; i < sizeof...(fs); ++i)
            if (as_array[i] == f)
                return i;
        return npos;
    }
 
    static constexpr bool contains(field f)
    {
        return index_of(f) != npos;
    }
 
    static_assert(
        []() constexpr
        {
            for (size_t i = 0; i < as_array.size(); ++i)
                for (size_t j = i + 1; j < as_array.size(); ++j)
                    if (as_array[i] == as_array[j])
                        return false;
 
            return true;
        }(),
        "You may not include a field twice into fields<>.");
};
 
// ----------------------------------------------------------------------------
// record
// ----------------------------------------------------------------------------
 
template <typename field_types, typename field_ids>
struct record : detail::transfer_template_args_onto_t<field_types, std::tuple>
{
public:
    using base_type = detail::transfer_template_args_onto_t<field_types, std::tuple>;
 
private:
    template <typename t>
        requires requires (t & v) { v.clear(); }
    static constexpr void clear_element(t & v) noexcept(noexcept(v.clear()))
    {
        v.clear();
    }
 
    template <typename t>
    static constexpr void clear_element(t & v) noexcept(noexcept(std::declval<t &>() = t{}))
    {
        v = {};
    }
 
    static constexpr auto expander = [](auto &... args)
    {
        (clear_element(args), ...);
    };
 
    base_type & as_base() noexcept
    {
        return *this;
    }
 
public:
    record() = default;                           
    record(record const &) = default;             
    record & operator=(record const &) = default; 
    record(record &&) = default;                  
    record & operator=(record &&) = default;      
    ~record() = default;                          
 
    using base_type::base_type;
 
    static_assert(field_types::size() == field_ids::as_array.size(),
                  "You must give as many IDs as types to seqan3::record.");
 
    void clear() noexcept(noexcept(std::apply(expander, std::declval<record &>().as_base())))
    {
        // PR2165 / __cpp_lib_tuple_like (C++23): std::apply requires tuple-like.
        // In C++23, this means std::array, std::pair, std::tuple, and std::ranges::subranges. Nothing else.
        // https://en.cppreference.com/w/cpp/utility/tuple/tuple-like
        std::apply(expander, as_base());
    }
 
protected:
 
    template <field f>
    using field_constant = std::integral_constant<field, f>;
 
    template <field f, typename tuple_t>
    static decltype(auto) get_impl(field_constant<f>, tuple_t && record_as_tuple)
    {
        static_assert(field_ids::contains(f), "The record does not contain the field you wish to retrieve.");
        return std::get<field_ids::index_of(f)>(std::forward<tuple_t>(record_as_tuple));
    }
};
 
} // namespace seqan3
 
namespace std
{
 
template <typename field_types, typename field_ids>
struct tuple_size<seqan3::record<field_types, field_ids>> :
    tuple_size<typename seqan3::record<field_types, field_ids>::base_type>
{};
 
template <size_t elem_no, typename field_types, typename field_ids>
struct tuple_element<elem_no, seqan3::record<field_types, field_ids>> :
    tuple_element<elem_no, typename seqan3::record<field_types, field_ids>::base_type>
{};
 
} // namespace std