libstdc++
iosfwd
Go to the documentation of this file.
00001 // <iosfwd> Forward declarations -*- C++ -*-
00002 
00003 // Copyright (C) 1997-2015 Free Software Foundation, Inc.
00004 //
00005 // This file is part of the GNU ISO C++ Library.  This library is free
00006 // software; you can redistribute it and/or modify it under the
00007 // terms of the GNU General Public License as published by the
00008 // Free Software Foundation; either version 3, or (at your option)
00009 // any later version.
00010 
00011 // This library is distributed in the hope that it will be useful,
00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014 // GNU General Public License for more details.
00015 
00016 // Under Section 7 of GPL version 3, you are granted additional
00017 // permissions described in the GCC Runtime Library Exception, version
00018 // 3.1, as published by the Free Software Foundation.
00019 
00020 // You should have received a copy of the GNU General Public License and
00021 // a copy of the GCC Runtime Library Exception along with this program;
00022 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
00023 // <http://www.gnu.org/licenses/>.
00024 
00025 /** @file include/iosfwd
00026  *  This is a Standard C++ Library header.
00027  */
00028 
00029 //
00030 // ISO C++ 14882: 27.2  Forward declarations
00031 //
00032 
00033 #ifndef _GLIBCXX_IOSFWD
00034 #define _GLIBCXX_IOSFWD 1
00035 
00036 #pragma GCC system_header
00037 
00038 #include <bits/c++config.h>
00039 #include <bits/stringfwd.h>     // For string forward declarations.
00040 #include <bits/postypes.h>
00041 
00042 namespace std _GLIBCXX_VISIBILITY(default)
00043 {
00044 _GLIBCXX_BEGIN_NAMESPACE_VERSION
00045 
00046   /**
00047    *  @defgroup io I/O
00048    *
00049    *  Nearly all of the I/O classes are parameterized on the type of
00050    *  characters they read and write.  (The major exception is ios_base at
00051    *  the top of the hierarchy.)  This is a change from pre-Standard
00052    *  streams, which were not templates.
00053    *
00054    *  For ease of use and compatibility, all of the basic_* I/O-related
00055    *  classes are given typedef names for both of the builtin character
00056    *  widths (wide and narrow).  The typedefs are the same as the
00057    *  pre-Standard names, for example:
00058    *
00059    *  @code
00060    *     typedef basic_ifstream<char>  ifstream;
00061    *  @endcode
00062    *
00063    *  Because properly forward-declaring these classes can be difficult, you
00064    *  should not do it yourself.  Instead, include the &lt;iosfwd&gt;
00065    *  header, which contains only declarations of all the I/O classes as
00066    *  well as the typedefs.  Trying to forward-declare the typedefs
00067    *  themselves (e.g., <code>class ostream;</code>) is not valid ISO C++.
00068    *
00069    *  For more specific declarations, see
00070    *  https://gcc.gnu.org/onlinedocs/libstdc++/manual/io.html#std.io.objects
00071    *
00072    *  @{
00073   */
00074   class ios_base;
00075 
00076   template<typename _CharT, typename _Traits = char_traits<_CharT> >
00077     class basic_ios;
00078 
00079   template<typename _CharT, typename _Traits = char_traits<_CharT> >
00080     class basic_streambuf;
00081 
00082   template<typename _CharT, typename _Traits = char_traits<_CharT> >
00083     class basic_istream;
00084 
00085   template<typename _CharT, typename _Traits = char_traits<_CharT> >
00086     class basic_ostream;
00087 
00088   template<typename _CharT, typename _Traits = char_traits<_CharT> >
00089     class basic_iostream;
00090 
00091 
00092 _GLIBCXX_BEGIN_NAMESPACE_CXX11
00093 
00094   template<typename _CharT, typename _Traits = char_traits<_CharT>,
00095             typename _Alloc = allocator<_CharT> >
00096     class basic_stringbuf;
00097 
00098   template<typename _CharT, typename _Traits = char_traits<_CharT>,
00099            typename _Alloc = allocator<_CharT> >
00100     class basic_istringstream;
00101 
00102   template<typename _CharT, typename _Traits = char_traits<_CharT>,
00103            typename _Alloc = allocator<_CharT> >
00104     class basic_ostringstream;
00105 
00106   template<typename _CharT, typename _Traits = char_traits<_CharT>,
00107            typename _Alloc = allocator<_CharT> >
00108     class basic_stringstream;
00109 
00110 _GLIBCXX_END_NAMESPACE_CXX11
00111 
00112   template<typename _CharT, typename _Traits = char_traits<_CharT> >
00113     class basic_filebuf;
00114 
00115   template<typename _CharT, typename _Traits = char_traits<_CharT> >
00116     class basic_ifstream;
00117 
00118   template<typename _CharT, typename _Traits = char_traits<_CharT> >
00119     class basic_ofstream;
00120 
00121   template<typename _CharT, typename _Traits = char_traits<_CharT> >
00122     class basic_fstream;
00123 
00124   template<typename _CharT, typename _Traits = char_traits<_CharT> >
00125     class istreambuf_iterator;
00126 
00127   template<typename _CharT, typename _Traits = char_traits<_CharT> >
00128     class ostreambuf_iterator;
00129 
00130 
00131   /// Base class for @c char streams.
00132   typedef basic_ios<char>               ios; 
00133 
00134   /// Base class for @c char buffers.
00135   typedef basic_streambuf<char>         streambuf;
00136 
00137   /// Base class for @c char input streams.
00138   typedef basic_istream<char>           istream;
00139 
00140   /// Base class for @c char output streams.
00141   typedef basic_ostream<char>           ostream;
00142 
00143   /// Base class for @c char mixed input and output streams.
00144   typedef basic_iostream<char>          iostream;
00145 
00146   /// Class for @c char memory buffers.
00147   typedef basic_stringbuf<char>         stringbuf;
00148 
00149   /// Class for @c char input memory streams.
00150   typedef basic_istringstream<char>     istringstream;
00151 
00152   /// Class for @c char output memory streams.
00153   typedef basic_ostringstream<char>     ostringstream;
00154 
00155   /// Class for @c char mixed input and output memory streams.
00156   typedef basic_stringstream<char>      stringstream;
00157 
00158   /// Class for @c char file buffers.
00159   typedef basic_filebuf<char>           filebuf;
00160 
00161   /// Class for @c char input file streams.
00162   typedef basic_ifstream<char>          ifstream;
00163 
00164   /// Class for @c char output file streams.
00165   typedef basic_ofstream<char>          ofstream;
00166 
00167   /// Class for @c char mixed input and output file streams.
00168   typedef basic_fstream<char>           fstream;
00169 
00170 #ifdef _GLIBCXX_USE_WCHAR_T
00171   /// Base class for @c wchar_t streams.
00172   typedef basic_ios<wchar_t>            wios;
00173 
00174   /// Base class for @c wchar_t buffers.
00175   typedef basic_streambuf<wchar_t>      wstreambuf;
00176 
00177   /// Base class for @c wchar_t input streams.
00178   typedef basic_istream<wchar_t>        wistream;
00179 
00180   /// Base class for @c wchar_t output streams.
00181   typedef basic_ostream<wchar_t>        wostream;
00182 
00183   /// Base class for @c wchar_t mixed input and output streams.
00184   typedef basic_iostream<wchar_t>       wiostream;
00185 
00186   /// Class for @c wchar_t memory buffers.
00187   typedef basic_stringbuf<wchar_t>      wstringbuf;
00188 
00189   /// Class for @c wchar_t input memory streams.
00190   typedef basic_istringstream<wchar_t>  wistringstream;
00191 
00192   /// Class for @c wchar_t output memory streams.
00193   typedef basic_ostringstream<wchar_t>  wostringstream;
00194 
00195   /// Class for @c wchar_t mixed input and output memory streams.
00196   typedef basic_stringstream<wchar_t>   wstringstream;
00197 
00198   /// Class for @c wchar_t file buffers.
00199   typedef basic_filebuf<wchar_t>        wfilebuf;
00200 
00201   /// Class for @c wchar_t input file streams.
00202   typedef basic_ifstream<wchar_t>       wifstream;
00203 
00204   /// Class for @c wchar_t output file streams.
00205   typedef basic_ofstream<wchar_t>       wofstream;
00206 
00207   /// Class for @c wchar_t mixed input and output file streams.
00208   typedef basic_fstream<wchar_t>        wfstream;
00209 #endif
00210   /** @}  */
00211 
00212 _GLIBCXX_END_NAMESPACE_VERSION
00213 } // namespace
00214 
00215 #endif /* _GLIBCXX_IOSFWD */