output_format_concept.hpp

Go to the documentation of this file.

// -----------------------------------------------------------------------------------------------------
// Copyright (c) 2006-2019, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2019, 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 <fstream>
#include <string>
#include <vector>

#include <seqan3/alphabet/nucleotide/dna5.hpp>
#include <seqan3/alphabet/quality/aliases.hpp>
#include <seqan3/alphabet/quality/phred42.hpp>
#include <seqan3/core/type_list.hpp>
#include <seqan3/io/sequence_file/output_options.hpp>

namespace seqan3::detail
{

template <typename t>
class sequence_file_output_format
{};

} // namespace seqan3::detail

namespace seqan3
{

template <typename t>
SEQAN3_CONCEPT SequenceFileOutputFormat = requires (detail::sequence_file_output_format<t> & v,
                                                    std::ofstream                  & f,
                                                    sequence_file_output_options   & options,
                                                    dna5_vector                    & seq,
                                                    std::string                    & id,
                                                    std::vector<phred42>           & qual,
                                                    std::vector<dna5q>             & seq_qual)
{
    t::file_extensions;

    { v.write(f, options, seq,         id,          qual)        } -> void;
    { v.write(f, options, std::ignore, id,          std::ignore) } -> void;
    { v.write(f, options, std::ignore, std::ignore, std::ignore) } -> void;
    // the last is required to be compile time valid, but should always throw at run-time.
};


} // namespace seqan3

namespace seqan3::detail
{

template <typename t>
constexpr bool is_type_list_of_sequence_file_output_formats_v = false;

template <typename ... ts>
constexpr bool is_type_list_of_sequence_file_output_formats_v<type_list<ts...>> =
    (SequenceFileOutputFormat<ts> && ...);

template <typename t>
SEQAN3_CONCEPT TypeListOfSequenceFileOutputFormats = is_type_list_of_sequence_file_output_formats_v<t>;
} // namespace seqan3::detail