1 // Standard stream manipulators -*- C++ -*-
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 include/iomanip
26 * This is a Standard C++ Library header.
30 // ISO C++ 14882: 27.6.3 Standard manipulators
33 #ifndef _GLIBCXX_IOMANIP
34 #define _GLIBCXX_IOMANIP 1
36 #pragma GCC system_header
38 #include <bits/c++config.h>
40 #include <bits/ios_base.h>
42 #if __cplusplus >= 201103L
44 #if __cplusplus > 201103L
45 #include <sstream> // used in quoted.
49 namespace std _GLIBCXX_VISIBILITY(default)
51 _GLIBCXX_BEGIN_NAMESPACE_VERSION
53 // [27.6.3] standard manipulators
56 struct _Resetiosflags { ios_base::fmtflags _M_mask; };
59 * @brief Manipulator for @c setf.
60 * @param __mask A format flags mask.
62 * Sent to a stream object, this manipulator resets the specified flags,
63 * via @e stream.setf(0,__mask).
66 resetiosflags(ios_base::fmtflags __mask)
67 { return { __mask }; }
69 template<typename _CharT, typename _Traits>
70 inline basic_istream<_CharT, _Traits>&
71 operator>>(basic_istream<_CharT, _Traits>& __is, _Resetiosflags __f)
73 __is.setf(ios_base::fmtflags(0), __f._M_mask);
77 template<typename _CharT, typename _Traits>
78 inline basic_ostream<_CharT, _Traits>&
79 operator<<(basic_ostream<_CharT, _Traits>& __os, _Resetiosflags __f)
81 __os.setf(ios_base::fmtflags(0), __f._M_mask);
86 struct _Setiosflags { ios_base::fmtflags _M_mask; };
89 * @brief Manipulator for @c setf.
90 * @param __mask A format flags mask.
92 * Sent to a stream object, this manipulator sets the format flags
96 setiosflags(ios_base::fmtflags __mask)
97 { return { __mask }; }
99 template<typename _CharT, typename _Traits>
100 inline basic_istream<_CharT, _Traits>&
101 operator>>(basic_istream<_CharT, _Traits>& __is, _Setiosflags __f)
103 __is.setf(__f._M_mask);
107 template<typename _CharT, typename _Traits>
108 inline basic_ostream<_CharT, _Traits>&
109 operator<<(basic_ostream<_CharT, _Traits>& __os, _Setiosflags __f)
111 __os.setf(__f._M_mask);
116 struct _Setbase { int _M_base; };
119 * @brief Manipulator for @c setf.
120 * @param __base A numeric base.
122 * Sent to a stream object, this manipulator changes the
123 * @c ios_base::basefield flags to @c oct, @c dec, or @c hex when @a base
124 * is 8, 10, or 16, accordingly, and to 0 if @a __base is any other value.
128 { return { __base }; }
130 template<typename _CharT, typename _Traits>
131 inline basic_istream<_CharT, _Traits>&
132 operator>>(basic_istream<_CharT, _Traits>& __is, _Setbase __f)
134 __is.setf(__f._M_base == 8 ? ios_base::oct :
135 __f._M_base == 10 ? ios_base::dec :
136 __f._M_base == 16 ? ios_base::hex :
137 ios_base::fmtflags(0), ios_base::basefield);
141 template<typename _CharT, typename _Traits>
142 inline basic_ostream<_CharT, _Traits>&
143 operator<<(basic_ostream<_CharT, _Traits>& __os, _Setbase __f)
145 __os.setf(__f._M_base == 8 ? ios_base::oct :
146 __f._M_base == 10 ? ios_base::dec :
147 __f._M_base == 16 ? ios_base::hex :
148 ios_base::fmtflags(0), ios_base::basefield);
153 template<typename _CharT>
154 struct _Setfill { _CharT _M_c; };
157 * @brief Manipulator for @c fill.
158 * @param __c The new fill character.
160 * Sent to a stream object, this manipulator calls @c fill(__c) for that
163 template<typename _CharT>
164 inline _Setfill<_CharT>
168 template<typename _CharT, typename _Traits>
169 inline basic_istream<_CharT, _Traits>&
170 operator>>(basic_istream<_CharT, _Traits>& __is, _Setfill<_CharT> __f)
176 template<typename _CharT, typename _Traits>
177 inline basic_ostream<_CharT, _Traits>&
178 operator<<(basic_ostream<_CharT, _Traits>& __os, _Setfill<_CharT> __f)
185 struct _Setprecision { int _M_n; };
188 * @brief Manipulator for @c precision.
189 * @param __n The new precision.
191 * Sent to a stream object, this manipulator calls @c precision(__n) for
195 setprecision(int __n)
198 template<typename _CharT, typename _Traits>
199 inline basic_istream<_CharT, _Traits>&
200 operator>>(basic_istream<_CharT, _Traits>& __is, _Setprecision __f)
202 __is.precision(__f._M_n);
206 template<typename _CharT, typename _Traits>
207 inline basic_ostream<_CharT, _Traits>&
208 operator<<(basic_ostream<_CharT, _Traits>& __os, _Setprecision __f)
210 __os.precision(__f._M_n);
215 struct _Setw { int _M_n; };
218 * @brief Manipulator for @c width.
219 * @param __n The new width.
221 * Sent to a stream object, this manipulator calls @c width(__n) for
228 template<typename _CharT, typename _Traits>
229 inline basic_istream<_CharT, _Traits>&
230 operator>>(basic_istream<_CharT, _Traits>& __is, _Setw __f)
232 __is.width(__f._M_n);
236 template<typename _CharT, typename _Traits>
237 inline basic_ostream<_CharT, _Traits>&
238 operator<<(basic_ostream<_CharT, _Traits>& __os, _Setw __f)
240 __os.width(__f._M_n);
244 #if __cplusplus >= 201103L
246 template<typename _MoneyT>
247 struct _Get_money { _MoneyT& _M_mon; bool _M_intl; };
250 * @brief Extended manipulator for extracting money.
251 * @param __mon Either long double or a specialization of @c basic_string.
252 * @param __intl A bool indicating whether international format
255 * Sent to a stream object, this manipulator extracts @a __mon.
257 template<typename _MoneyT>
258 inline _Get_money<_MoneyT>
259 get_money(_MoneyT& __mon, bool __intl = false)
260 { return { __mon, __intl }; }
262 template<typename _CharT, typename _Traits, typename _MoneyT>
263 basic_istream<_CharT, _Traits>&
264 operator>>(basic_istream<_CharT, _Traits>& __is, _Get_money<_MoneyT> __f)
266 typename basic_istream<_CharT, _Traits>::sentry __cerb(__is, false);
269 ios_base::iostate __err = ios_base::goodbit;
272 typedef istreambuf_iterator<_CharT, _Traits> _Iter;
273 typedef money_get<_CharT, _Iter> _MoneyGet;
275 const _MoneyGet& __mg = use_facet<_MoneyGet>(__is.getloc());
276 __mg.get(_Iter(__is.rdbuf()), _Iter(), __f._M_intl,
277 __is, __err, __f._M_mon);
279 __catch(__cxxabiv1::__forced_unwind&)
281 __is._M_setstate(ios_base::badbit);
282 __throw_exception_again;
285 { __is._M_setstate(ios_base::badbit); }
287 __is.setstate(__err);
293 template<typename _MoneyT>
294 struct _Put_money { const _MoneyT& _M_mon; bool _M_intl; };
297 * @brief Extended manipulator for inserting money.
298 * @param __mon Either long double or a specialization of @c basic_string.
299 * @param __intl A bool indicating whether international format
302 * Sent to a stream object, this manipulator inserts @a __mon.
304 template<typename _MoneyT>
305 inline _Put_money<_MoneyT>
306 put_money(const _MoneyT& __mon, bool __intl = false)
307 { return { __mon, __intl }; }
309 template<typename _CharT, typename _Traits, typename _MoneyT>
310 basic_ostream<_CharT, _Traits>&
311 operator<<(basic_ostream<_CharT, _Traits>& __os, _Put_money<_MoneyT> __f)
313 typename basic_ostream<_CharT, _Traits>::sentry __cerb(__os);
316 ios_base::iostate __err = ios_base::goodbit;
319 typedef ostreambuf_iterator<_CharT, _Traits> _Iter;
320 typedef money_put<_CharT, _Iter> _MoneyPut;
322 const _MoneyPut& __mp = use_facet<_MoneyPut>(__os.getloc());
323 if (__mp.put(_Iter(__os.rdbuf()), __f._M_intl, __os,
324 __os.fill(), __f._M_mon).failed())
325 __err |= ios_base::badbit;
327 __catch(__cxxabiv1::__forced_unwind&)
329 __os._M_setstate(ios_base::badbit);
330 __throw_exception_again;
333 { __os._M_setstate(ios_base::badbit); }
335 __os.setstate(__err);
340 template<typename _CharT>
343 const std::tm* _M_tmb;
344 const _CharT* _M_fmt;
348 * @brief Extended manipulator for formatting time.
350 * This manipulator uses time_put::put to format time.
353 * @param __tmb struct tm time data to format.
354 * @param __fmt format string.
356 template<typename _CharT>
357 inline _Put_time<_CharT>
358 put_time(const std::tm* __tmb, const _CharT* __fmt)
359 { return { __tmb, __fmt }; }
361 template<typename _CharT, typename _Traits>
362 basic_ostream<_CharT, _Traits>&
363 operator<<(basic_ostream<_CharT, _Traits>& __os, _Put_time<_CharT> __f)
365 typename basic_ostream<_CharT, _Traits>::sentry __cerb(__os);
368 ios_base::iostate __err = ios_base::goodbit;
371 typedef ostreambuf_iterator<_CharT, _Traits> _Iter;
372 typedef time_put<_CharT, _Iter> _TimePut;
374 const _CharT* const __fmt_end = __f._M_fmt +
375 _Traits::length(__f._M_fmt);
377 const _TimePut& __mp = use_facet<_TimePut>(__os.getloc());
378 if (__mp.put(_Iter(__os.rdbuf()), __os, __os.fill(),
379 __f._M_tmb, __f._M_fmt, __fmt_end).failed())
380 __err |= ios_base::badbit;
382 __catch(__cxxabiv1::__forced_unwind&)
384 __os._M_setstate(ios_base::badbit);
385 __throw_exception_again;
388 { __os._M_setstate(ios_base::badbit); }
390 __os.setstate(__err);
395 template<typename _CharT>
399 const _CharT* _M_fmt;
403 * @brief Extended manipulator for extracting time.
405 * This manipulator uses time_get::get to extract time.
408 * @param __tmb struct to extract the time data to.
409 * @param __fmt format string.
411 template<typename _CharT>
412 inline _Get_time<_CharT>
413 get_time(std::tm* __tmb, const _CharT* __fmt)
414 { return { __tmb, __fmt }; }
416 template<typename _CharT, typename _Traits>
417 basic_istream<_CharT, _Traits>&
418 operator>>(basic_istream<_CharT, _Traits>& __is, _Get_time<_CharT> __f)
420 typename basic_istream<_CharT, _Traits>::sentry __cerb(__is, false);
423 ios_base::iostate __err = ios_base::goodbit;
426 typedef istreambuf_iterator<_CharT, _Traits> _Iter;
427 typedef time_get<_CharT, _Iter> _TimeGet;
429 const _CharT* const __fmt_end = __f._M_fmt +
430 _Traits::length(__f._M_fmt);
432 const _TimeGet& __mg = use_facet<_TimeGet>(__is.getloc());
433 __mg.get(_Iter(__is.rdbuf()), _Iter(), __is,
434 __err, __f._M_tmb, __f._M_fmt, __fmt_end);
436 __catch(__cxxabiv1::__forced_unwind&)
438 __is._M_setstate(ios_base::badbit);
439 __throw_exception_again;
442 { __is._M_setstate(ios_base::badbit); }
444 __is.setstate(__err);
449 #if __cplusplus > 201103L
451 #define __cpp_lib_quoted_string_io 201304
453 _GLIBCXX_END_NAMESPACE_VERSION
455 _GLIBCXX_BEGIN_NAMESPACE_VERSION
458 * @brief Struct for delimited strings.
460 template<typename _String, typename _CharT>
461 struct _Quoted_string
463 static_assert(is_reference<_String>::value
464 || is_pointer<_String>::value,
465 "String type must be pointer or reference");
467 _Quoted_string(_String __str, _CharT __del, _CharT __esc)
468 : _M_string(__str), _M_delim{__del}, _M_escape{__esc}
472 operator=(_Quoted_string&) = delete;
480 * @brief Inserter for quoted strings.
482 * _GLIBCXX_RESOLVE_LIB_DEFECTS
483 * DR 2344 quoted()'s interaction with padding is unclear
485 template<typename _CharT, typename _Traits>
487 operator<<(std::basic_ostream<_CharT, _Traits>& __os,
488 const _Quoted_string<const _CharT*, _CharT>& __str)
490 std::basic_ostringstream<_CharT, _Traits> __ostr;
491 __ostr << __str._M_delim;
492 for (const _CharT* __c = __str._M_string; *__c; ++__c)
494 if (*__c == __str._M_delim || *__c == __str._M_escape)
495 __ostr << __str._M_escape;
498 __ostr << __str._M_delim;
500 return __os << __ostr.str();
504 * @brief Inserter for quoted strings.
506 * _GLIBCXX_RESOLVE_LIB_DEFECTS
507 * DR 2344 quoted()'s interaction with padding is unclear
509 template<typename _CharT, typename _Traits, typename _String>
511 operator<<(std::basic_ostream<_CharT, _Traits>& __os,
512 const _Quoted_string<_String, _CharT>& __str)
514 std::basic_ostringstream<_CharT, _Traits> __ostr;
515 __ostr << __str._M_delim;
516 for (auto& __c : __str._M_string)
518 if (__c == __str._M_delim || __c == __str._M_escape)
519 __ostr << __str._M_escape;
522 __ostr << __str._M_delim;
524 return __os << __ostr.str();
528 * @brief Extractor for delimited strings.
529 * The left and right delimiters can be different.
531 template<typename _CharT, typename _Traits, typename _Alloc>
533 operator>>(std::basic_istream<_CharT, _Traits>& __is,
534 const _Quoted_string<basic_string<_CharT, _Traits, _Alloc>&,
541 if (__c != __str._M_delim)
544 __is >> __str._M_string;
547 __str._M_string.clear();
548 std::ios_base::fmtflags __flags
549 = __is.flags(__is.flags() & ~std::ios_base::skipws);
555 if (__c == __str._M_escape)
561 else if (__c == __str._M_delim)
563 __str._M_string += __c;
570 _GLIBCXX_END_NAMESPACE_VERSION
571 } // namespace __detail
572 _GLIBCXX_BEGIN_NAMESPACE_VERSION
575 * @brief Manipulator for quoted strings.
576 * @param __string String to quote.
577 * @param __delim Character to quote string with.
578 * @param __escape Escape character to escape itself or quote character.
580 template<typename _CharT>
582 quoted(const _CharT* __string,
583 _CharT __delim = _CharT('"'), _CharT __escape = _CharT('\\'))
585 return __detail::_Quoted_string<const _CharT*, _CharT>(__string, __delim,
589 template<typename _CharT, typename _Traits, typename _Alloc>
591 quoted(const basic_string<_CharT, _Traits, _Alloc>& __string,
592 _CharT __delim = _CharT('"'), _CharT __escape = _CharT('\\'))
594 return __detail::_Quoted_string<
595 const basic_string<_CharT, _Traits, _Alloc>&, _CharT>(
596 __string, __delim, __escape);
599 template<typename _CharT, typename _Traits, typename _Alloc>
601 quoted(basic_string<_CharT, _Traits, _Alloc>& __string,
602 _CharT __delim = _CharT('"'), _CharT __escape = _CharT('\\'))
604 return __detail::_Quoted_string<
605 basic_string<_CharT, _Traits, _Alloc>&, _CharT>(
606 __string, __delim, __escape);
609 #endif // __cplusplus > 201103L
611 #endif // __cplusplus >= 201103L
613 // Inhibit implicit instantiations for required instantiations,
614 // which are defined via explicit instantiations elsewhere.
615 // NB: This syntax is a GNU extension.
616 #if _GLIBCXX_EXTERN_TEMPLATE
617 extern template ostream& operator<<(ostream&, _Setfill<char>);
618 extern template ostream& operator<<(ostream&, _Setiosflags);
619 extern template ostream& operator<<(ostream&, _Resetiosflags);
620 extern template ostream& operator<<(ostream&, _Setbase);
621 extern template ostream& operator<<(ostream&, _Setprecision);
622 extern template ostream& operator<<(ostream&, _Setw);
623 extern template istream& operator>>(istream&, _Setfill<char>);
624 extern template istream& operator>>(istream&, _Setiosflags);
625 extern template istream& operator>>(istream&, _Resetiosflags);
626 extern template istream& operator>>(istream&, _Setbase);
627 extern template istream& operator>>(istream&, _Setprecision);
628 extern template istream& operator>>(istream&, _Setw);
630 #ifdef _GLIBCXX_USE_WCHAR_T
631 extern template wostream& operator<<(wostream&, _Setfill<wchar_t>);
632 extern template wostream& operator<<(wostream&, _Setiosflags);
633 extern template wostream& operator<<(wostream&, _Resetiosflags);
634 extern template wostream& operator<<(wostream&, _Setbase);
635 extern template wostream& operator<<(wostream&, _Setprecision);
636 extern template wostream& operator<<(wostream&, _Setw);
637 extern template wistream& operator>>(wistream&, _Setfill<wchar_t>);
638 extern template wistream& operator>>(wistream&, _Setiosflags);
639 extern template wistream& operator>>(wistream&, _Resetiosflags);
640 extern template wistream& operator>>(wistream&, _Setbase);
641 extern template wistream& operator>>(wistream&, _Setprecision);
642 extern template wistream& operator>>(wistream&, _Setw);
646 _GLIBCXX_END_NAMESPACE_VERSION
649 #endif /* _GLIBCXX_IOMANIP */