blob: 263a66771fb3c5a661ab8b73ee16a29db0130c80 [file] [log] [blame]
Howard Hinnantc51e1022010-05-11 19:42:16 +00001// -*- C++ -*-
Louis Dionne9bd93882021-11-17 16:25:01 -05002//===----------------------------------------------------------------------===//
Howard Hinnantc51e1022010-05-11 19:42:16 +00003//
Chandler Carruthd2012102019-01-19 10:56:40 +00004// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Howard Hinnantc51e1022010-05-11 19:42:16 +00007//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP_IOSFWD
11#define _LIBCPP_IOSFWD
12
13/*
14 iosfwd synopsis
15
16namespace std
17{
18
19template<class charT> struct char_traits;
Marshall Clow8732fed2018-12-11 04:35:44 +000020template<> struct char_traits<char>;
21template<> struct char_traits<char8_t>; // C++20
22template<> struct char_traits<char16_t>;
23template<> struct char_traits<char32_t>;
24template<> struct char_traits<wchar_t>;
25
Howard Hinnantc51e1022010-05-11 19:42:16 +000026template<class T> class allocator;
27
Howard Hinnantc8827ba2011-05-13 21:52:40 +000028class ios_base;
Howard Hinnantc51e1022010-05-11 19:42:16 +000029template <class charT, class traits = char_traits<charT> > class basic_ios;
30
31template <class charT, class traits = char_traits<charT> > class basic_streambuf;
32template <class charT, class traits = char_traits<charT> > class basic_istream;
33template <class charT, class traits = char_traits<charT> > class basic_ostream;
34template <class charT, class traits = char_traits<charT> > class basic_iostream;
35
36template <class charT, class traits = char_traits<charT>, class Allocator = allocator<charT> >
37 class basic_stringbuf;
38template <class charT, class traits = char_traits<charT>, class Allocator = allocator<charT> >
39 class basic_istringstream;
40template <class charT, class traits = char_traits<charT>, class Allocator = allocator<charT> >
41 class basic_ostringstream;
42template <class charT, class traits = char_traits<charT>, class Allocator = allocator<charT> >
43 class basic_stringstream;
44
45template <class charT, class traits = char_traits<charT> > class basic_filebuf;
46template <class charT, class traits = char_traits<charT> > class basic_ifstream;
47template <class charT, class traits = char_traits<charT> > class basic_ofstream;
48template <class charT, class traits = char_traits<charT> > class basic_fstream;
49
50template <class charT, class traits = char_traits<charT> > class istreambuf_iterator;
51template <class charT, class traits = char_traits<charT> > class ostreambuf_iterator;
52
53typedef basic_ios<char> ios;
54typedef basic_ios<wchar_t> wios;
55
56typedef basic_streambuf<char> streambuf;
57typedef basic_istream<char> istream;
58typedef basic_ostream<char> ostream;
59typedef basic_iostream<char> iostream;
60
61typedef basic_stringbuf<char> stringbuf;
62typedef basic_istringstream<char> istringstream;
63typedef basic_ostringstream<char> ostringstream;
64typedef basic_stringstream<char> stringstream;
65
66typedef basic_filebuf<char> filebuf;
67typedef basic_ifstream<char> ifstream;
68typedef basic_ofstream<char> ofstream;
69typedef basic_fstream<char> fstream;
70
71typedef basic_streambuf<wchar_t> wstreambuf;
72typedef basic_istream<wchar_t> wistream;
73typedef basic_ostream<wchar_t> wostream;
74typedef basic_iostream<wchar_t> wiostream;
75
76typedef basic_stringbuf<wchar_t> wstringbuf;
77typedef basic_istringstream<wchar_t> wistringstream;
78typedef basic_ostringstream<wchar_t> wostringstream;
79typedef basic_stringstream<wchar_t> wstringstream;
80
81typedef basic_filebuf<wchar_t> wfilebuf;
82typedef basic_ifstream<wchar_t> wifstream;
83typedef basic_ofstream<wchar_t> wofstream;
84typedef basic_fstream<wchar_t> wfstream;
85
86template <class state> class fpos;
Marek Kurdeje3ac4e22021-03-23 17:15:07 +010087using streampos = fpos<char_traits<char>::state_type>;
88using wstreampos = fpos<char_traits<wchar_t>::state_type>;
89using u8streampos = fpos<char_traits<char8_t>::state_type>; // C++20
90using u16streampos = fpos<char_traits<char16_t>::state_type>;
91using u32streampos = fpos<char_traits<char32_t>::state_type>;
Howard Hinnantc51e1022010-05-11 19:42:16 +000092
93} // std
94
95*/
96
97#include <__config>
Louis Dionne89258142021-08-23 15:32:36 -040098#include <__mbstate_t.h>
Mark de Weverce8f12c2021-12-22 18:14:14 +010099#include <version>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000100
Howard Hinnantaaaa52b2011-10-17 20:05:10 +0000101#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Arthur O'Dwyer6eeaa002022-02-01 20:16:40 -0500102# pragma GCC system_header
Howard Hinnantaaaa52b2011-10-17 20:05:10 +0000103#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000104
105_LIBCPP_BEGIN_NAMESPACE_STD
106
Howard Hinnant8331b762013-03-06 23:30:19 +0000107class _LIBCPP_TYPE_VIS ios_base;
Howard Hinnantd4335272011-01-08 20:00:48 +0000108
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000109template<class _CharT> struct _LIBCPP_TEMPLATE_VIS char_traits;
Marshall Clow8732fed2018-12-11 04:35:44 +0000110template<> struct char_traits<char>;
Arthur O'Dwyerafa5d5f2021-04-18 21:47:08 -0400111#ifndef _LIBCPP_HAS_NO_CHAR8_T
Marshall Clow8732fed2018-12-11 04:35:44 +0000112template<> struct char_traits<char8_t>;
113#endif
114template<> struct char_traits<char16_t>;
115template<> struct char_traits<char32_t>;
Louis Dionne89258142021-08-23 15:32:36 -0400116#ifndef _LIBCPP_HAS_NO_WIDE_CHARACTERS
Marshall Clow8732fed2018-12-11 04:35:44 +0000117template<> struct char_traits<wchar_t>;
Louis Dionne89258142021-08-23 15:32:36 -0400118#endif
Marshall Clow8732fed2018-12-11 04:35:44 +0000119
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000120template<class _Tp> class _LIBCPP_TEMPLATE_VIS allocator;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000121
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000122template <class _CharT, class _Traits = char_traits<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000123 class _LIBCPP_TEMPLATE_VIS basic_ios;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000124
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000125template <class _CharT, class _Traits = char_traits<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000126 class _LIBCPP_TEMPLATE_VIS basic_streambuf;
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000127template <class _CharT, class _Traits = char_traits<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000128 class _LIBCPP_TEMPLATE_VIS basic_istream;
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000129template <class _CharT, class _Traits = char_traits<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000130 class _LIBCPP_TEMPLATE_VIS basic_ostream;
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000131template <class _CharT, class _Traits = char_traits<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000132 class _LIBCPP_TEMPLATE_VIS basic_iostream;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000133
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000134template <class _CharT, class _Traits = char_traits<_CharT>,
135 class _Allocator = allocator<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000136 class _LIBCPP_TEMPLATE_VIS basic_stringbuf;
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000137template <class _CharT, class _Traits = char_traits<_CharT>,
138 class _Allocator = allocator<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000139 class _LIBCPP_TEMPLATE_VIS basic_istringstream;
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000140template <class _CharT, class _Traits = char_traits<_CharT>,
141 class _Allocator = allocator<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000142 class _LIBCPP_TEMPLATE_VIS basic_ostringstream;
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000143template <class _CharT, class _Traits = char_traits<_CharT>,
144 class _Allocator = allocator<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000145 class _LIBCPP_TEMPLATE_VIS basic_stringstream;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000146
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000147template <class _CharT, class _Traits = char_traits<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000148 class _LIBCPP_TEMPLATE_VIS basic_filebuf;
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000149template <class _CharT, class _Traits = char_traits<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000150 class _LIBCPP_TEMPLATE_VIS basic_ifstream;
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000151template <class _CharT, class _Traits = char_traits<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000152 class _LIBCPP_TEMPLATE_VIS basic_ofstream;
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000153template <class _CharT, class _Traits = char_traits<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000154 class _LIBCPP_TEMPLATE_VIS basic_fstream;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000155
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000156template <class _CharT, class _Traits = char_traits<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000157 class _LIBCPP_TEMPLATE_VIS istreambuf_iterator;
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000158template <class _CharT, class _Traits = char_traits<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000159 class _LIBCPP_TEMPLATE_VIS ostreambuf_iterator;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000160
161typedef basic_ios<char> ios;
Louis Dionne89258142021-08-23 15:32:36 -0400162#ifndef _LIBCPP_HAS_NO_WIDE_CHARACTERS
Howard Hinnantc51e1022010-05-11 19:42:16 +0000163typedef basic_ios<wchar_t> wios;
Louis Dionne89258142021-08-23 15:32:36 -0400164#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000165
166typedef basic_streambuf<char> streambuf;
167typedef basic_istream<char> istream;
168typedef basic_ostream<char> ostream;
169typedef basic_iostream<char> iostream;
170
171typedef basic_stringbuf<char> stringbuf;
172typedef basic_istringstream<char> istringstream;
173typedef basic_ostringstream<char> ostringstream;
174typedef basic_stringstream<char> stringstream;
175
176typedef basic_filebuf<char> filebuf;
177typedef basic_ifstream<char> ifstream;
178typedef basic_ofstream<char> ofstream;
179typedef basic_fstream<char> fstream;
180
Louis Dionne89258142021-08-23 15:32:36 -0400181#ifndef _LIBCPP_HAS_NO_WIDE_CHARACTERS
Howard Hinnantc51e1022010-05-11 19:42:16 +0000182typedef basic_streambuf<wchar_t> wstreambuf;
183typedef basic_istream<wchar_t> wistream;
184typedef basic_ostream<wchar_t> wostream;
185typedef basic_iostream<wchar_t> wiostream;
186
187typedef basic_stringbuf<wchar_t> wstringbuf;
188typedef basic_istringstream<wchar_t> wistringstream;
189typedef basic_ostringstream<wchar_t> wostringstream;
190typedef basic_stringstream<wchar_t> wstringstream;
191
192typedef basic_filebuf<wchar_t> wfilebuf;
193typedef basic_ifstream<wchar_t> wifstream;
194typedef basic_ofstream<wchar_t> wofstream;
195typedef basic_fstream<wchar_t> wfstream;
Louis Dionne89258142021-08-23 15:32:36 -0400196#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000197
Richard Smith256954d2020-11-11 17:12:18 -0800198template <class _CharT, class _Traits>
Louis Dionne89258142021-08-23 15:32:36 -0400199 class _LIBCPP_PREFERRED_NAME(ios) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wios)) basic_ios;
Richard Smith256954d2020-11-11 17:12:18 -0800200
201template <class _CharT, class _Traits>
Louis Dionne89258142021-08-23 15:32:36 -0400202 class _LIBCPP_PREFERRED_NAME(streambuf) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wstreambuf)) basic_streambuf;
Richard Smith256954d2020-11-11 17:12:18 -0800203template <class _CharT, class _Traits>
Louis Dionne89258142021-08-23 15:32:36 -0400204 class _LIBCPP_PREFERRED_NAME(istream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wistream)) basic_istream;
Richard Smith256954d2020-11-11 17:12:18 -0800205template <class _CharT, class _Traits>
Louis Dionne89258142021-08-23 15:32:36 -0400206 class _LIBCPP_PREFERRED_NAME(ostream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wostream)) basic_ostream;
Richard Smith256954d2020-11-11 17:12:18 -0800207template <class _CharT, class _Traits>
Louis Dionne89258142021-08-23 15:32:36 -0400208 class _LIBCPP_PREFERRED_NAME(iostream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wiostream)) basic_iostream;
Richard Smith256954d2020-11-11 17:12:18 -0800209
210template <class _CharT, class _Traits, class _Allocator>
Louis Dionne89258142021-08-23 15:32:36 -0400211 class _LIBCPP_PREFERRED_NAME(stringbuf) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wstringbuf)) basic_stringbuf;
Richard Smith256954d2020-11-11 17:12:18 -0800212template <class _CharT, class _Traits, class _Allocator>
Louis Dionne89258142021-08-23 15:32:36 -0400213 class _LIBCPP_PREFERRED_NAME(istringstream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wistringstream)) basic_istringstream;
Richard Smith256954d2020-11-11 17:12:18 -0800214template <class _CharT, class _Traits, class _Allocator>
Louis Dionne89258142021-08-23 15:32:36 -0400215 class _LIBCPP_PREFERRED_NAME(ostringstream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wostringstream)) basic_ostringstream;
Richard Smith256954d2020-11-11 17:12:18 -0800216template <class _CharT, class _Traits, class _Allocator>
Louis Dionne89258142021-08-23 15:32:36 -0400217 class _LIBCPP_PREFERRED_NAME(stringstream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wstringstream)) basic_stringstream;
Richard Smith256954d2020-11-11 17:12:18 -0800218
219template <class _CharT, class _Traits>
Louis Dionne89258142021-08-23 15:32:36 -0400220 class _LIBCPP_PREFERRED_NAME(filebuf) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wfilebuf)) basic_filebuf;
Richard Smith256954d2020-11-11 17:12:18 -0800221template <class _CharT, class _Traits>
Louis Dionne89258142021-08-23 15:32:36 -0400222 class _LIBCPP_PREFERRED_NAME(ifstream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wifstream)) basic_ifstream;
Richard Smith256954d2020-11-11 17:12:18 -0800223template <class _CharT, class _Traits>
Louis Dionne89258142021-08-23 15:32:36 -0400224 class _LIBCPP_PREFERRED_NAME(ofstream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wofstream)) basic_ofstream;
Richard Smith256954d2020-11-11 17:12:18 -0800225template <class _CharT, class _Traits>
Louis Dionne89258142021-08-23 15:32:36 -0400226 class _LIBCPP_PREFERRED_NAME(fstream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wfstream)) basic_fstream;
Richard Smith256954d2020-11-11 17:12:18 -0800227
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000228template <class _State> class _LIBCPP_TEMPLATE_VIS fpos;
Howard Hinnant155c2af2010-05-24 17:49:41 +0000229typedef fpos<mbstate_t> streampos;
230typedef fpos<mbstate_t> wstreampos;
Arthur O'Dwyerafa5d5f2021-04-18 21:47:08 -0400231#ifndef _LIBCPP_HAS_NO_CHAR8_T
Marshall Clow8732fed2018-12-11 04:35:44 +0000232typedef fpos<mbstate_t> u8streampos;
233#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000234#ifndef _LIBCPP_HAS_NO_UNICODE_CHARS
Howard Hinnant155c2af2010-05-24 17:49:41 +0000235typedef fpos<mbstate_t> u16streampos;
236typedef fpos<mbstate_t> u32streampos;
Louis Dionne96fc5f52021-09-09 11:25:10 -0400237#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000238
Jonathan Roelofsd3c81f42015-02-03 15:34:17 +0000239#if defined(_NEWLIB_VERSION)
240// On newlib, off_t is 'long int'
241typedef long int streamoff; // for char_traits in <string>
242#else
Howard Hinnantc51e1022010-05-11 19:42:16 +0000243typedef long long streamoff; // for char_traits in <string>
Jonathan Roelofsd3c81f42015-02-03 15:34:17 +0000244#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000245
246template <class _CharT, // for <stdexcept>
247 class _Traits = char_traits<_CharT>,
Howard Hinnant5e9669f2010-09-21 16:04:28 +0000248 class _Allocator = allocator<_CharT> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000249 class _LIBCPP_TEMPLATE_VIS basic_string;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000250typedef basic_string<char, char_traits<char>, allocator<char> > string;
Louis Dionne89258142021-08-23 15:32:36 -0400251#ifndef _LIBCPP_HAS_NO_WIDE_CHARACTERS
Howard Hinnantc51e1022010-05-11 19:42:16 +0000252typedef basic_string<wchar_t, char_traits<wchar_t>, allocator<wchar_t> > wstring;
Louis Dionne89258142021-08-23 15:32:36 -0400253#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000254
Richard Smith256954d2020-11-11 17:12:18 -0800255template <class _CharT, class _Traits, class _Allocator>
Louis Dionne89258142021-08-23 15:32:36 -0400256 class _LIBCPP_PREFERRED_NAME(string) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wstring)) basic_string;
Eric Fiselier876c6862016-02-20 00:19:45 +0000257
258// Include other forward declarations here
259template <class _Tp, class _Alloc = allocator<_Tp> >
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000260class _LIBCPP_TEMPLATE_VIS vector;
Eric Fiselier876c6862016-02-20 00:19:45 +0000261
Louis Dionne3df65ce2020-10-15 13:27:27 -0400262template <class _CharT, class _Traits>
263class __save_flags
264{
265 typedef basic_ios<_CharT, _Traits> __stream_type;
266 typedef typename __stream_type::fmtflags fmtflags;
267
268 __stream_type& __stream_;
269 fmtflags __fmtflags_;
270 _CharT __fill_;
271
272 __save_flags(const __save_flags&);
273 __save_flags& operator=(const __save_flags&);
274public:
275 _LIBCPP_INLINE_VISIBILITY
276 explicit __save_flags(__stream_type& __stream)
277 : __stream_(__stream),
278 __fmtflags_(__stream.flags()),
279 __fill_(__stream.fill())
280 {}
281 _LIBCPP_INLINE_VISIBILITY
282 ~__save_flags()
283 {
284 __stream_.flags(__fmtflags_);
285 __stream_.fill(__fill_);
286 }
287};
288
Howard Hinnantc51e1022010-05-11 19:42:16 +0000289_LIBCPP_END_NAMESPACE_STD
290
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400291#endif // _LIBCPP_IOSFWD