SeqAn3
misc.hpp
Go to the documentation of this file.
1 // ============================================================================
2 // SeqAn - The Library for Sequence Analysis
3 // ============================================================================
4 //
5 // Copyright (c) 2006-2018, Knut Reinert & Freie Universitaet Berlin
6 // Copyright (c) 2016-2018, Knut Reinert & MPI Molekulare Genetik
7 // All rights reserved.
8 //
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions are met:
11 //
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // * Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // * Neither the name of Knut Reinert or the FU Berlin nor the names of
18 // its contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 // ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
25 // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 // OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
31 // DAMAGE.
32 //
33 // ============================================================================
34 
40 #pragma once
41 
42 #include <range/v3/algorithm/equal.hpp>
43 
46 #include <seqan3/io/exception.hpp>
47 #include <seqan3/io/filesystem.hpp>
48 #include <seqan3/std/iterator>
49 
50 namespace seqan3::detail
51 {
52 
59 template <std::OutputIterator<char> it_t>
60 constexpr void write_eol(it_t & it, bool const add_cr)
61 {
62  if (add_cr)
63  it = '\r';
64 
65  it = '\n';
66 }
67 
78 template <typename format_variant_type>
79 void set_format(format_variant_type & format,
80  filesystem::path const & file_name)
81 {
82  using valid_formats = detail::transfer_template_args_onto_t<format_variant_type, type_list>;
83 
84  bool format_found = false;
85  std::string extension = file_name.extension().string();
86  if (extension.size() > 1)
87  {
88  extension = extension.substr(1); // drop leading "."
89  meta::for_each(valid_formats{}, [&] (auto && fmt)
90  {
91  using fmt_type = remove_cvref_t<decltype(fmt)>;
92 
93  for (auto const & ext : fmt_type::file_extensions)
94  {
95  if (std::ranges::equal(ext, extension))
96  {
97  format = fmt_type{};
98  format_found = true;
99  return;
100  }
101  }
102  });
103  }
104 
105  if (!format_found)
106  throw unhandled_extension_error("No valid format found for this extension.");
107 }
108 
109 } // namespace seqan3::detail
Provides exceptions used in the I/O module.
Provides C++20 additions to the <iterator> header.
Provides seqan3::type_list and auxiliary metafunctions.
Provides seqan3::type_list and auxiliary metafunctions.
Definition: aligned_sequence_concept.hpp:288
This header includes C++17 filesystem support and imports it into namespace seqan3::filesystem (indep...
::ranges::equal equal
Alias for ranges::equal. Determines if two sets of elements are the same.
Definition: ranges:210