SeqAn3
out_file_iterator.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 <cassert>
43 
44 #include <range/v3/range_fwd.hpp>
45 
46 #include <seqan3/core/platform.hpp>
47 
48 #include <seqan3/std/ranges>
49 
50 namespace seqan3::detail
51 {
52 
75 template <typename file_type>
76 class out_file_iterator
77 {
78  static_assert(!std::is_const_v<file_type>,
79  "You cannot iterate over const files, because the iterator changes the file.");
80 public:
85  using value_type = void;
86  using reference = void;
87  using const_reference = void;
88  using size_type = void;
89  using difference_type = std::ptrdiff_t;
90  using pointer = void *;
92  using iterator_category = std::output_iterator_tag;
94 
98  constexpr out_file_iterator() = default;
101  constexpr out_file_iterator(out_file_iterator const &) = default;
103  constexpr out_file_iterator & operator=(out_file_iterator const &) = default;
105  constexpr out_file_iterator (out_file_iterator &&) = default;
107  constexpr out_file_iterator & operator=(out_file_iterator &&) = default;
109  ~out_file_iterator() = default;
110 
112  constexpr out_file_iterator(file_type & _host) noexcept :
113  host{&_host}
114  {}
116 
120  out_file_iterator & operator++()
122  {
123  return *this;
124  }
125 
127  out_file_iterator operator++(int)
128  {
129  return *this;
130  }
131 
133 
134  out_file_iterator & operator*() noexcept
135  {
136  return *this;
137  }
138 
143  template <typename arg_t>
144  out_file_iterator & operator=(arg_t && arg)
145  {
146  assert(host != nullptr);
147  host->push_back(std::forward<arg_t>(arg));
148  return *this;
149  }
151 
156  constexpr bool operator==(std::ranges::default_sentinel const &) const noexcept
157  {
158  return false;
159  }
160 
161  constexpr bool operator!=(std::ranges::default_sentinel const &) const noexcept
162  {
163  return true;
164  }
165 
166  constexpr friend bool operator==(std::ranges::default_sentinel const &,
167  out_file_iterator const & it) noexcept
168  {
169  return (it == std::ranges::default_sentinel{});
170  }
171 
172  constexpr friend bool operator!=(std::ranges::default_sentinel const &,
173  out_file_iterator const & it) noexcept
174  {
175  return (it != std::ranges::default_sentinel{});
176  }
178 
179 private:
181  file_type * host{};
182 };
183 
184 } // namespace seqan3::detail
Contains platform and dependency checks.
Adaptations of concepts from the Ranges TS.
Definition: aligned_sequence_concept.hpp:288
::ranges::default_sentinel default_sentinel
Alias for ranges::default_sentinel. Empty sentinel type for use with iterator types that know the bou...
Definition: ranges:215