xref: /freebsd/contrib/llvm-project/libcxx/include/iosfwd (revision 7ef62cebc2f965b0f640263e179276928885e33d)
1// -*- C++ -*-
2//===----------------------------------------------------------------------===//
3//
4// 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
7//
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;
20template<>            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
26template<class T>     class allocator;
27
28class ios_base;
29template <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;
87using 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>;
92
93}  // std
94
95*/
96
97#include <__assert> // all public C++ headers provide the assertion handler
98#include <__config>
99#include <__fwd/string.h>
100#include <__mbstate_t.h>
101#include <version>
102
103#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
104#  pragma GCC system_header
105#endif
106
107_LIBCPP_BEGIN_NAMESPACE_STD
108
109class _LIBCPP_TYPE_VIS ios_base;
110
111template <class _CharT, class _Traits = char_traits<_CharT> >
112    class _LIBCPP_TEMPLATE_VIS basic_ios;
113
114template <class _CharT, class _Traits = char_traits<_CharT> >
115    class _LIBCPP_TEMPLATE_VIS basic_streambuf;
116template <class _CharT, class _Traits = char_traits<_CharT> >
117    class _LIBCPP_TEMPLATE_VIS basic_istream;
118template <class _CharT, class _Traits = char_traits<_CharT> >
119    class _LIBCPP_TEMPLATE_VIS basic_ostream;
120template <class _CharT, class _Traits = char_traits<_CharT> >
121    class _LIBCPP_TEMPLATE_VIS basic_iostream;
122
123template <class _CharT, class _Traits = char_traits<_CharT>,
124          class _Allocator = allocator<_CharT> >
125    class _LIBCPP_TEMPLATE_VIS basic_stringbuf;
126template <class _CharT, class _Traits = char_traits<_CharT>,
127          class _Allocator = allocator<_CharT> >
128    class _LIBCPP_TEMPLATE_VIS basic_istringstream;
129template <class _CharT, class _Traits = char_traits<_CharT>,
130          class _Allocator = allocator<_CharT> >
131    class _LIBCPP_TEMPLATE_VIS basic_ostringstream;
132template <class _CharT, class _Traits = char_traits<_CharT>,
133          class _Allocator = allocator<_CharT> >
134    class _LIBCPP_TEMPLATE_VIS basic_stringstream;
135
136template <class _CharT, class _Traits = char_traits<_CharT> >
137    class _LIBCPP_TEMPLATE_VIS basic_filebuf;
138template <class _CharT, class _Traits = char_traits<_CharT> >
139    class _LIBCPP_TEMPLATE_VIS basic_ifstream;
140template <class _CharT, class _Traits = char_traits<_CharT> >
141    class _LIBCPP_TEMPLATE_VIS basic_ofstream;
142template <class _CharT, class _Traits = char_traits<_CharT> >
143    class _LIBCPP_TEMPLATE_VIS basic_fstream;
144
145template <class _CharT, class _Traits = char_traits<_CharT> >
146    class _LIBCPP_TEMPLATE_VIS istreambuf_iterator;
147template <class _CharT, class _Traits = char_traits<_CharT> >
148    class _LIBCPP_TEMPLATE_VIS ostreambuf_iterator;
149
150typedef basic_ios<char>              ios;
151#ifndef _LIBCPP_HAS_NO_WIDE_CHARACTERS
152typedef basic_ios<wchar_t>           wios;
153#endif
154
155typedef basic_streambuf<char>        streambuf;
156typedef basic_istream<char>          istream;
157typedef basic_ostream<char>          ostream;
158typedef basic_iostream<char>         iostream;
159
160typedef basic_stringbuf<char>        stringbuf;
161typedef basic_istringstream<char>    istringstream;
162typedef basic_ostringstream<char>    ostringstream;
163typedef basic_stringstream<char>     stringstream;
164
165typedef basic_filebuf<char>          filebuf;
166typedef basic_ifstream<char>         ifstream;
167typedef basic_ofstream<char>         ofstream;
168typedef basic_fstream<char>          fstream;
169
170#ifndef _LIBCPP_HAS_NO_WIDE_CHARACTERS
171typedef basic_streambuf<wchar_t>     wstreambuf;
172typedef basic_istream<wchar_t>       wistream;
173typedef basic_ostream<wchar_t>       wostream;
174typedef basic_iostream<wchar_t>      wiostream;
175
176typedef basic_stringbuf<wchar_t>     wstringbuf;
177typedef basic_istringstream<wchar_t> wistringstream;
178typedef basic_ostringstream<wchar_t> wostringstream;
179typedef basic_stringstream<wchar_t>  wstringstream;
180
181typedef basic_filebuf<wchar_t>       wfilebuf;
182typedef basic_ifstream<wchar_t>      wifstream;
183typedef basic_ofstream<wchar_t>      wofstream;
184typedef basic_fstream<wchar_t>       wfstream;
185#endif
186
187template <class _CharT, class _Traits>
188    class _LIBCPP_PREFERRED_NAME(ios) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wios)) basic_ios;
189
190template <class _CharT, class _Traits>
191    class _LIBCPP_PREFERRED_NAME(streambuf) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wstreambuf)) basic_streambuf;
192template <class _CharT, class _Traits>
193    class _LIBCPP_PREFERRED_NAME(istream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wistream)) basic_istream;
194template <class _CharT, class _Traits>
195    class _LIBCPP_PREFERRED_NAME(ostream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wostream)) basic_ostream;
196template <class _CharT, class _Traits>
197    class _LIBCPP_PREFERRED_NAME(iostream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wiostream)) basic_iostream;
198
199template <class _CharT, class _Traits, class _Allocator>
200    class _LIBCPP_PREFERRED_NAME(stringbuf) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wstringbuf)) basic_stringbuf;
201template <class _CharT, class _Traits, class _Allocator>
202    class _LIBCPP_PREFERRED_NAME(istringstream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wistringstream)) basic_istringstream;
203template <class _CharT, class _Traits, class _Allocator>
204    class _LIBCPP_PREFERRED_NAME(ostringstream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wostringstream)) basic_ostringstream;
205template <class _CharT, class _Traits, class _Allocator>
206    class _LIBCPP_PREFERRED_NAME(stringstream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wstringstream)) basic_stringstream;
207
208template <class _CharT, class _Traits>
209    class _LIBCPP_PREFERRED_NAME(filebuf) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wfilebuf)) basic_filebuf;
210template <class _CharT, class _Traits>
211    class _LIBCPP_PREFERRED_NAME(ifstream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wifstream)) basic_ifstream;
212template <class _CharT, class _Traits>
213    class _LIBCPP_PREFERRED_NAME(ofstream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wofstream)) basic_ofstream;
214template <class _CharT, class _Traits>
215    class _LIBCPP_PREFERRED_NAME(fstream) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wfstream)) basic_fstream;
216
217template <class _State>             class _LIBCPP_TEMPLATE_VIS fpos;
218typedef fpos<mbstate_t>    streampos;
219typedef fpos<mbstate_t>    wstreampos;
220#ifndef _LIBCPP_HAS_NO_CHAR8_T
221typedef fpos<mbstate_t>    u8streampos;
222#endif
223typedef fpos<mbstate_t>    u16streampos;
224typedef fpos<mbstate_t>    u32streampos;
225
226#if defined(_NEWLIB_VERSION)
227// On newlib, off_t is 'long int'
228typedef long int streamoff;         // for char_traits in <string>
229#else
230typedef long long streamoff;        // for char_traits in <string>
231#endif
232
233// Include other forward declarations here
234template <class _Tp, class _Alloc = allocator<_Tp> >
235class _LIBCPP_TEMPLATE_VIS vector;
236
237template <class _CharT, class _Traits>
238class __save_flags
239{
240    typedef basic_ios<_CharT, _Traits> __stream_type;
241    typedef typename __stream_type::fmtflags fmtflags;
242
243    __stream_type& __stream_;
244    fmtflags       __fmtflags_;
245    _CharT         __fill_;
246
247    __save_flags(const __save_flags&);
248    __save_flags& operator=(const __save_flags&);
249public:
250    _LIBCPP_INLINE_VISIBILITY
251    explicit __save_flags(__stream_type& __stream)
252        : __stream_(__stream),
253          __fmtflags_(__stream.flags()),
254          __fill_(__stream.fill())
255        {}
256    _LIBCPP_INLINE_VISIBILITY
257    ~__save_flags()
258    {
259        __stream_.flags(__fmtflags_);
260        __stream_.fill(__fill_);
261    }
262};
263
264_LIBCPP_END_NAMESPACE_STD
265
266#endif // _LIBCPP_IOSFWD
267