SeqAn3 3.3.0-rc.1
The Modern C++ library for sequence analysis.
sam_file/input_format_concept.hpp
Go to the documentation of this file.
1// -----------------------------------------------------------------------------------------------------
2// Copyright (c) 2006-2022, Knut Reinert & Freie Universität Berlin
3// Copyright (c) 2016-2022, Knut Reinert & MPI für molekulare Genetik
4// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
5// shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
6// -----------------------------------------------------------------------------------------------------
7
13#pragma once
14
15#include <fstream>
16#include <optional>
17#include <string>
18#include <vector>
19
20#include <seqan3/alphabet/cigar/cigar.hpp>
21#include <seqan3/alphabet/gap/gapped.hpp>
22#include <seqan3/alphabet/nucleotide/dna4.hpp>
23#include <seqan3/alphabet/nucleotide/dna5.hpp>
24#include <seqan3/alphabet/quality/aliases.hpp>
25#include <seqan3/alphabet/quality/phred42.hpp>
26#include <seqan3/io/sam_file/header.hpp>
27#include <seqan3/io/sam_file/input_options.hpp>
28#include <seqan3/io/sam_file/sam_flag.hpp>
29#include <seqan3/io/sam_file/sam_tag_dictionary.hpp>
30#include <seqan3/utility/type_list/type_list.hpp>
31
32namespace seqan3::detail
33{
34
45template <typename format_type>
46struct sam_file_input_format_exposer : public format_type
47{
48public:
49 // Can't use `using format_type::read_alignment_record` as it produces a hard failure in the format concept check
50 // for types that do not model the format concept, i.e. don't offer the proper read_alignment_record interface.
52 template <typename... ts>
53 void read_alignment_record(ts &&... args)
54 {
55 format_type::read_alignment_record(std::forward<ts>(args)...);
56 }
57};
58
59} // namespace seqan3::detail
60
61namespace seqan3
62{
63
77template <typename t>
78concept sam_file_input_format = requires (detail::sam_file_input_format_exposer<t> & v,
79 std::ifstream & stream,
80 sam_file_input_options<dna5> & options,
81 std::vector<dna5_vector> & ref_sequences,
82 sam_file_header<> & header,
83 std::streampos & position_buffer,
84 dna5_vector & seq,
85 std::vector<phred42> & qual,
86 std::string & id,
87 dna5_vector & ref_seq,
88 std::optional<int32_t> & ref_id,
89 std::optional<int32_t> & ref_offset,
90 std::vector<cigar> & cigar,
91 sam_flag & flag,
92 uint8_t & mapq,
93 std::tuple<std::optional<int32_t>, std::optional<int32_t>, int32_t> & mate,
94 sam_tag_dictionary & tag_dict,
95 double & e_value,
96 double & bit_score) {
97 t::file_extensions;
98 // std::same_as<decltype(t::file_extensions), std::vector<std::string>>;
99
100 {
101 v.read_alignment_record(stream,
102 options,
103 ref_sequences,
104 header,
105 position_buffer,
106 seq,
107 qual,
108 id,
109 ref_seq,
110 ref_id,
111 ref_offset,
112 cigar,
113 flag,
114 mapq,
115 mate,
116 tag_dict,
117 e_value,
118 bit_score)
119 };
120
121 {
122 v.read_alignment_record(stream,
123 options,
124 std::ignore,
125 header,
126 position_buffer,
127 std::ignore,
128 std::ignore,
129 std::ignore,
130 std::ignore,
131 std::ignore,
132 std::ignore,
133 std::ignore,
134 std::ignore,
135 std::ignore,
136 std::ignore,
137 std::ignore,
138 std::ignore,
139 std::ignore,
140 std::ignore)
141 };
142 };
144
145// Workaround for https://github.com/doxygen/doxygen/issues/9379
146#if SEQAN3_DOXYGEN_ONLY(1) 0
147template <typename t>
148class sam_file_input_format
149{};
150#endif
151
225
226} // namespace seqan3
227
228namespace seqan3::detail
229{
230
236template <typename t>
237constexpr bool is_type_list_of_sam_file_input_formats_v = false;
238
244template <typename... ts>
245constexpr bool is_type_list_of_sam_file_input_formats_v<type_list<ts...>> = (sam_file_input_format<ts> && ...);
246
252template <typename t>
253concept type_list_of_sam_file_input_formats = is_type_list_of_sam_file_input_formats_v<t>;
254
255} // namespace seqan3::detail
aliases.hpp
Provides aliases for qualified.
cigar.hpp
Provides the seqan3::cigar alphabet.
seqan3::sam_file_input_format
The generic concept for alignment file input formats.
Definition: sam_file/input_format_concept.hpp:149
seqan3::detail::type_list_of_sam_file_input_formats
Auxiliary concept that checks whether a type is a seqan3::type_list and all types meet seqan3::sam_fi...
Definition: sam_file/input_format_concept.hpp:253
dna4.hpp
Provides seqan3::dna4, container aliases and string literals.
dna5.hpp
Provides seqan3::dna5, container aliases and string literals.
gapped.hpp
Provides seqan3::gapped.
seqan3::sam_flag
sam_flag
An enum flag that describes the properties of an aligned read (given as a SAM record).
Definition: sam_flag.hpp:76
seqan3::detail::is_type_list_of_sam_file_input_formats_v
constexpr bool is_type_list_of_sam_file_input_formats_v
Auxiliary value metafuncton that checks whether a type is a seqan3::type_list and all types meet seqa...
Definition: sam_file/input_format_concept.hpp:237
header.hpp
Provides the seqan3::sam_file_header class.
seqan3::detail
The internal SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
seqan3
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
phred42.hpp
Provides seqan3::phred42 quality scores.
input_options.hpp
Provides seqan3::sam_file_input_options.
sam_flag.hpp
Provides helper data structures for the seqan3::sam_file_output.
sam_tag_dictionary.hpp
Provides the seqan3::sam_tag_dictionary class and auxiliaries.
seqan3::detail::sam_file_input_format_exposer
Internal class used to expose the actual format interface to read SAM records from the file.
Definition: sam_file/input_format_concept.hpp:47
seqan3::detail::sam_file_input_format_exposer::read_alignment_record
void read_alignment_record(ts &&... args)
Forwards to the seqan3::sam_file_input_format::read_alignment_record interface.
Definition: sam_file/input_format_concept.hpp:53
seqan3::type_list
Type that contains multiple types.
Definition: type_list.hpp:29
type_list.hpp
Provides seqan3::type_list.