3 // Copyright (C) 1997-2015 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
25 /** @file bits/streambuf_iterator.h
26 * This is an internal header file, included by other library headers.
27 * Do not attempt to use it directly. @headername{iterator}
30 #ifndef _STREAMBUF_ITERATOR_H
31 #define _STREAMBUF_ITERATOR_H 1
33 #pragma GCC system_header
36 #include <debug/debug.h>
38 namespace std
_GLIBCXX_VISIBILITY(default)
40 _GLIBCXX_BEGIN_NAMESPACE_VERSION
43 * @addtogroup iterators
47 // 24.5.3 Template class istreambuf_iterator
48 /// Provides input iterator semantics for streambufs.
49 template<typename _CharT
, typename _Traits
>
50 class istreambuf_iterator
51 : public iterator
<input_iterator_tag
, _CharT
, typename
_Traits::off_type
,
53 #if __cplusplus >= 201103L
64 typedef _CharT char_type
;
65 typedef _Traits traits_type
;
66 typedef typename
_Traits::int_type int_type
;
67 typedef basic_streambuf
<_CharT
, _Traits
> streambuf_type
;
68 typedef basic_istream
<_CharT
, _Traits
> istream_type
;
71 template<typename _CharT2
>
72 friend typename
__gnu_cxx::__enable_if
<__is_char
<_CharT2
>::__value
,
73 ostreambuf_iterator
<_CharT2
> >::__type
74 copy(istreambuf_iterator
<_CharT2
>, istreambuf_iterator
<_CharT2
>,
75 ostreambuf_iterator
<_CharT2
>);
77 template<bool _IsMove
, typename _CharT2
>
78 friend typename
__gnu_cxx::__enable_if
<__is_char
<_CharT2
>::__value
,
80 __copy_move_a2(istreambuf_iterator
<_CharT2
>,
81 istreambuf_iterator
<_CharT2
>, _CharT2
*);
83 template<typename _CharT2
>
84 friend typename
__gnu_cxx::__enable_if
<__is_char
<_CharT2
>::__value
,
85 istreambuf_iterator
<_CharT2
> >::__type
86 find(istreambuf_iterator
<_CharT2
>, istreambuf_iterator
<_CharT2
>,
90 // 24.5.3 istreambuf_iterator
92 // If the end of stream is reached (streambuf_type::sgetc()
93 // returns traits_type::eof()), the iterator becomes equal to
94 // the "end of stream" iterator value.
95 // NB: This implementation assumes the "end of stream" value
97 mutable streambuf_type
* _M_sbuf
;
98 mutable int_type _M_c
;
101 /// Construct end of input stream iterator.
102 _GLIBCXX_CONSTEXPR
istreambuf_iterator() _GLIBCXX_USE_NOEXCEPT
103 : _M_sbuf(0), _M_c(traits_type::eof()) { }
105 #if __cplusplus >= 201103L
106 istreambuf_iterator(const istreambuf_iterator
&) noexcept
= default;
108 ~istreambuf_iterator() = default;
111 /// Construct start of input stream iterator.
112 istreambuf_iterator(istream_type
& __s
) _GLIBCXX_USE_NOEXCEPT
113 : _M_sbuf(__s
.rdbuf()), _M_c(traits_type::eof()) { }
115 /// Construct start of streambuf iterator.
116 istreambuf_iterator(streambuf_type
* __s
) _GLIBCXX_USE_NOEXCEPT
117 : _M_sbuf(__s
), _M_c(traits_type::eof()) { }
119 /// Return the current character pointed to by iterator. This returns
120 /// streambuf.sgetc(). It cannot be assigned. NB: The result of
121 /// operator*() on an end of stream is undefined.
125 #ifdef _GLIBCXX_DEBUG_PEDANTIC
126 // Dereferencing a past-the-end istreambuf_iterator is a
127 // libstdc++ extension
128 __glibcxx_requires_cond(!_M_at_eof(),
129 _M_message(__gnu_debug::__msg_deref_istreambuf
)
130 ._M_iterator(*this));
132 return traits_type::to_char_type(_M_get());
135 /// Advance the iterator. Calls streambuf.sbumpc().
139 __glibcxx_requires_cond(!_M_at_eof(),
140 _M_message(__gnu_debug::__msg_inc_istreambuf
)
141 ._M_iterator(*this));
145 _M_c
= traits_type::eof();
150 /// Advance the iterator. Calls streambuf.sbumpc().
154 __glibcxx_requires_cond(!_M_at_eof(),
155 _M_message(__gnu_debug::__msg_inc_istreambuf
)
156 ._M_iterator(*this));
158 istreambuf_iterator __old
= *this;
161 __old
._M_c
= _M_sbuf
->sbumpc();
162 _M_c
= traits_type::eof();
167 // _GLIBCXX_RESOLVE_LIB_DEFECTS
168 // 110 istreambuf_iterator::equal not const
169 // NB: there is also number 111 (NAD, Future) pending on this function.
170 /// Return true both iterators are end or both are not end.
172 equal(const istreambuf_iterator
& __b
) const
173 { return _M_at_eof() == __b
._M_at_eof(); }
179 const int_type __eof
= traits_type::eof();
180 int_type __ret
= __eof
;
183 if (!traits_type::eq_int_type(_M_c
, __eof
))
185 else if (!traits_type::eq_int_type((__ret
= _M_sbuf
->sgetc()),
197 const int_type __eof
= traits_type::eof();
198 return traits_type::eq_int_type(_M_get(), __eof
);
202 template<typename _CharT
, typename _Traits
>
204 operator==(const istreambuf_iterator
<_CharT
, _Traits
>& __a
,
205 const istreambuf_iterator
<_CharT
, _Traits
>& __b
)
206 { return __a
.equal(__b
); }
208 template<typename _CharT
, typename _Traits
>
210 operator!=(const istreambuf_iterator
<_CharT
, _Traits
>& __a
,
211 const istreambuf_iterator
<_CharT
, _Traits
>& __b
)
212 { return !__a
.equal(__b
); }
214 /// Provides output iterator semantics for streambufs.
215 template<typename _CharT
, typename _Traits
>
216 class ostreambuf_iterator
217 : public iterator
<output_iterator_tag
, void, void, void, void>
223 typedef _CharT char_type
;
224 typedef _Traits traits_type
;
225 typedef basic_streambuf
<_CharT
, _Traits
> streambuf_type
;
226 typedef basic_ostream
<_CharT
, _Traits
> ostream_type
;
229 template<typename _CharT2
>
230 friend typename
__gnu_cxx::__enable_if
<__is_char
<_CharT2
>::__value
,
231 ostreambuf_iterator
<_CharT2
> >::__type
232 copy(istreambuf_iterator
<_CharT2
>, istreambuf_iterator
<_CharT2
>,
233 ostreambuf_iterator
<_CharT2
>);
236 streambuf_type
* _M_sbuf
;
240 /// Construct output iterator from ostream.
241 ostreambuf_iterator(ostream_type
& __s
) _GLIBCXX_USE_NOEXCEPT
242 : _M_sbuf(__s
.rdbuf()), _M_failed(!_M_sbuf
) { }
244 /// Construct output iterator from streambuf.
245 ostreambuf_iterator(streambuf_type
* __s
) _GLIBCXX_USE_NOEXCEPT
246 : _M_sbuf(__s
), _M_failed(!_M_sbuf
) { }
248 /// Write character to streambuf. Calls streambuf.sputc().
250 operator=(_CharT __c
)
253 _Traits::eq_int_type(_M_sbuf
->sputc(__c
), _Traits::eof()))
273 /// Return true if previous operator=() failed.
275 failed() const _GLIBCXX_USE_NOEXCEPT
276 { return _M_failed
; }
279 _M_put(const _CharT
* __ws
, streamsize __len
)
281 if (__builtin_expect(!_M_failed
, true)
282 && __builtin_expect(this->_M_sbuf
->sputn(__ws
, __len
) != __len
,
289 // Overloads for streambuf iterators.
290 template<typename _CharT
>
291 typename
__gnu_cxx::__enable_if
<__is_char
<_CharT
>::__value
,
292 ostreambuf_iterator
<_CharT
> >::__type
293 copy(istreambuf_iterator
<_CharT
> __first
,
294 istreambuf_iterator
<_CharT
> __last
,
295 ostreambuf_iterator
<_CharT
> __result
)
297 if (__first
._M_sbuf
&& !__last
._M_sbuf
&& !__result
._M_failed
)
300 __copy_streambufs_eof(__first
._M_sbuf
, __result
._M_sbuf
, __ineof
);
302 __result
._M_failed
= true;
307 template<bool _IsMove
, typename _CharT
>
308 typename
__gnu_cxx::__enable_if
<__is_char
<_CharT
>::__value
,
309 ostreambuf_iterator
<_CharT
> >::__type
310 __copy_move_a2(_CharT
* __first
, _CharT
* __last
,
311 ostreambuf_iterator
<_CharT
> __result
)
313 const streamsize __num
= __last
- __first
;
315 __result
._M_put(__first
, __num
);
319 template<bool _IsMove
, typename _CharT
>
320 typename
__gnu_cxx::__enable_if
<__is_char
<_CharT
>::__value
,
321 ostreambuf_iterator
<_CharT
> >::__type
322 __copy_move_a2(const _CharT
* __first
, const _CharT
* __last
,
323 ostreambuf_iterator
<_CharT
> __result
)
325 const streamsize __num
= __last
- __first
;
327 __result
._M_put(__first
, __num
);
331 template<bool _IsMove
, typename _CharT
>
332 typename
__gnu_cxx::__enable_if
<__is_char
<_CharT
>::__value
,
334 __copy_move_a2(istreambuf_iterator
<_CharT
> __first
,
335 istreambuf_iterator
<_CharT
> __last
, _CharT
* __result
)
337 typedef istreambuf_iterator
<_CharT
> __is_iterator_type
;
338 typedef typename
__is_iterator_type::traits_type traits_type
;
339 typedef typename
__is_iterator_type::streambuf_type streambuf_type
;
340 typedef typename
traits_type::int_type int_type
;
342 if (__first
._M_sbuf
&& !__last
._M_sbuf
)
344 streambuf_type
* __sb
= __first
._M_sbuf
;
345 int_type __c
= __sb
->sgetc();
346 while (!traits_type::eq_int_type(__c
, traits_type::eof()))
348 const streamsize __n
= __sb
->egptr() - __sb
->gptr();
351 traits_type::copy(__result
, __sb
->gptr(), __n
);
352 __sb
->__safe_gbump(__n
);
354 __c
= __sb
->underflow();
358 *__result
++ = traits_type::to_char_type(__c
);
359 __c
= __sb
->snextc();
366 template<typename _CharT
>
367 typename
__gnu_cxx::__enable_if
<__is_char
<_CharT
>::__value
,
368 istreambuf_iterator
<_CharT
> >::__type
369 find(istreambuf_iterator
<_CharT
> __first
,
370 istreambuf_iterator
<_CharT
> __last
, const _CharT
& __val
)
372 typedef istreambuf_iterator
<_CharT
> __is_iterator_type
;
373 typedef typename
__is_iterator_type::traits_type traits_type
;
374 typedef typename
__is_iterator_type::streambuf_type streambuf_type
;
375 typedef typename
traits_type::int_type int_type
;
377 if (__first
._M_sbuf
&& !__last
._M_sbuf
)
379 const int_type __ival
= traits_type::to_int_type(__val
);
380 streambuf_type
* __sb
= __first
._M_sbuf
;
381 int_type __c
= __sb
->sgetc();
382 while (!traits_type::eq_int_type(__c
, traits_type::eof())
383 && !traits_type::eq_int_type(__c
, __ival
))
385 streamsize __n
= __sb
->egptr() - __sb
->gptr();
388 const _CharT
* __p
= traits_type::find(__sb
->gptr(),
391 __n
= __p
- __sb
->gptr();
392 __sb
->__safe_gbump(__n
);
396 __c
= __sb
->snextc();
399 if (!traits_type::eq_int_type(__c
, traits_type::eof()))
407 // @} group iterators
409 _GLIBCXX_END_NAMESPACE_VERSION