structure_file/output_format_concept.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2006-2025 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2025 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause

 
#pragma once
 
#include <fstream>
#include <set>
#include <string>
#include <vector>
 
#include <seqan3/alphabet/nucleotide/rna5.hpp>
#include <seqan3/alphabet/structure/structured_rna.hpp>
#include <seqan3/alphabet/structure/wuss.hpp>
#include <seqan3/io/structure_file/output_options.hpp>
#include <seqan3/utility/type_list/type_list.hpp>
 
namespace seqan3::detail
{

template <typename format_type>
struct structure_file_output_format_exposer : public format_type
{
public:
    // Can't use `using format_type::write_structure_record` as it produces a hard failure in the format concept check
    // for types that do not model the format concept, i.e. don't offer the proper write_structure_record interface.
    template <typename... ts>
    void write_structure_record(ts &&... args)
    {
        format_type::write_structure_record(std::forward<ts>(args)...);
    }
};
 
} // namespace seqan3::detail
 
namespace seqan3
{

template <typename t>
concept structure_file_output_format = requires (detail::structure_file_output_format_exposer<t> & v,
                                                 std::ofstream & f,
                                                 structure_file_output_options & options,
                                                 rna5_vector & seq,
                                                 std::string & id,
                                                 std::vector<std::set<std::pair<double, size_t>>> & bpp,
                                                 std::vector<wuss51> & structure,
                                                 std::vector<structured_rna<rna5, wuss51>> & structured_seq,
                                                 double energy,
                                                 double react,
                                                 double react_err,
                                                 std::string & comment,
                                                 size_t offset) {
    t::file_extensions;
 
    {
        v.write_structure_record(f, options, seq, id, bpp, structure, energy, react, react_err, comment, offset)
    } -> std::same_as<void>;
 
    {
        v.write_structure_record(f,
                                 options,
                                 seq,
                                 id,
                                 bpp,
                                 std::ignore,
                                 std::ignore,
                                 std::ignore,
                                 std::ignore,
                                 std::ignore,
                                 std::ignore)
    } -> std::same_as<void>;
 
    {
        v.write_structure_record(f,
                                 options,
                                 structured_seq,
                                 id,
                                 std::ignore,
                                 structured_seq,
                                 energy,
                                 std::ignore,
                                 std::ignore,
                                 std::ignore,
                                 std::ignore)
    } -> std::same_as<void>;
 
    {
        v.write_structure_record(f,
                                 options,
                                 std::ignore,
                                 std::ignore,
                                 std::ignore,
                                 std::ignore,
                                 std::ignore,
                                 std::ignore,
                                 std::ignore,
                                 std::ignore,
                                 std::ignore)
    } -> std::same_as<void>;
    // the last is required to be compile time valid, but should always throw at run-time.
};
 
// Workaround for https://github.com/doxygen/doxygen/issues/9379
#if SEQAN3_DOXYGEN_ONLY(1) 0
template <typename t>
class structure_file_output_format
{};
#endif



 
} // namespace seqan3
 
namespace seqan3::detail
{

template <typename t>
constexpr bool is_type_list_of_structure_file_output_formats_v = false;

template <typename... ts>
constexpr bool is_type_list_of_structure_file_output_formats_v<type_list<ts...>> =
    (structure_file_output_format<ts> && ...);

template <typename t>
concept type_list_of_structure_file_output_formats = is_type_list_of_structure_file_output_formats_v<t>;
} // namespace seqan3::detail