libstdc++-v3/include/std/iosfwd

   1 // Forwarding declarations -*- C++ -*-
   2
   3 // Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
   4 // 2006, 2007
   5 // Free Software Foundation, Inc.
   6 //
   7 // This file is part of the GNU ISO C++ Library.  This library is free
   8 // software; you can redistribute it and/or modify it under the
   9 // terms of the GNU General Public License as published by the
  10 // Free Software Foundation; either version 2, or (at your option)
  11 // any later version.
  12
  13 // This library is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17
  18 // You should have received a copy of the GNU General Public License
  19 // along with this library; see the file COPYING.  If not, write to
  20 // the Free Software Foundation, 51 Franklin Street, Fifth Floor,
  21 // Boston, MA 02110-1301, USA.
  22
  23 // As a special exception, you may use this file as part of a free software
  24 // library without restriction.  Specifically, if other files instantiate
  25 // templates or use macros or inline functions from this file, or you compile
  26 // this file and link it with other files to produce an executable, this
  27 // file does not by itself cause the resulting executable to be covered by
  28 // the GNU General Public License.  This exception does not however
  29 // invalidate any other reasons why the executable file might be covered by
  30 // the GNU General Public License.
  31
  32 /** @file iosfwd
  33  *  This is a Standard C++ Library header.
  34  */
  35
  36 //
  37 // ISO C++ 14882: 27.2  Forward declarations
  38 //
  39
  40 #ifndef _GLIBCXX_IOSFWD
  41 #define _GLIBCXX_IOSFWD 1
  42
  43 #pragma GCC system_header
  44
  45 #include <bits/c++config.h>
  46 #include <bits/stringfwd.h>     // For string forward declarations.
  47 #include <bits/postypes.h>
  48
  49 _GLIBCXX_BEGIN_NAMESPACE(std)
  50
  51   template<typename _CharT, typename _Traits = char_traits<_CharT> >
  52     class basic_ios;
  53
  54   template<typename _CharT, typename _Traits = char_traits<_CharT> >
  55     class basic_streambuf;
  56
  57   template<typename _CharT, typename _Traits = char_traits<_CharT> >
  58     class basic_istream;
  59
  60   template<typename _CharT, typename _Traits = char_traits<_CharT> >
  61     class basic_ostream;
  62
  63   template<typename _CharT, typename _Traits = char_traits<_CharT> >
  64     class basic_iostream;
  65
  66   template<typename _CharT, typename _Traits = char_traits<_CharT>,
  67             typename _Alloc = allocator<_CharT> >
  68     class basic_stringbuf;
  69
  70   template<typename _CharT, typename _Traits = char_traits<_CharT>,
  71            typename _Alloc = allocator<_CharT> >
  72     class basic_istringstream;
  73
  74   template<typename _CharT, typename _Traits = char_traits<_CharT>,
  75            typename _Alloc = allocator<_CharT> >
  76     class basic_ostringstream;
  77
  78   template<typename _CharT, typename _Traits = char_traits<_CharT>,
  79            typename _Alloc = allocator<_CharT> >
  80     class basic_stringstream;
  81
  82   template<typename _CharT, typename _Traits = char_traits<_CharT> >
  83     class basic_filebuf;
  84
  85   template<typename _CharT, typename _Traits = char_traits<_CharT> >
  86     class basic_ifstream;
  87
  88   template<typename _CharT, typename _Traits = char_traits<_CharT> >
  89     class basic_ofstream;
  90
  91   template<typename _CharT, typename _Traits = char_traits<_CharT> >
  92     class basic_fstream;
  93
  94   template<typename _CharT, typename _Traits = char_traits<_CharT> >
  95     class istreambuf_iterator;
  96
  97   template<typename _CharT, typename _Traits = char_traits<_CharT> >
  98     class ostreambuf_iterator;
  99
 100   // _GLIBCXX_RESOLVE_LIB_DEFECTS
 101   // Not included.   (??? Apparently no LWG number?)
 102   class ios_base;
 103
 104   /**
 105    *  @defgroup io I/O
 106    *
 107    *  Nearly all of the I/O classes are parameterized on the type of
 108    *  characters they read and write.  (The major exception is ios_base at
 109    *  the top of the hierarchy.)  This is a change from pre-Standard
 110    *  streams, which were not templates.
 111    *
 112    *  For ease of use and compatibility, all of the basic_* I/O-related
 113    *  classes are given typedef names for both of the builtin character
 114    *  widths (wide and narrow).  The typedefs are the same as the
 115    *  pre-Standard names, for example:
 116    *
 117    *  @code
 118    *     typedef basic_ifstream<char>  ifstream;
 119    *  @endcode
 120    *
 121    *  Because properly forward-declaring these classes can be difficult, you
 122    *  should not do it yourself.  Instead, include the &lt;iosfwd&gt;
 123    *  header, which contains only declarations of all the I/O classes as
 124    *  well as the typedefs.  Trying to forward-declare the typedefs
 125    *  themselves (e.g., "class ostream;") is not valid ISO C++.
 126    *
 127    *  For more specific declarations, see
 128    *  http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch24.html
 129    *
 130    *  @{
 131   */
 132   typedef basic_ios<char>               ios;            ///< @isiosfwd
 133   typedef basic_streambuf<char>         streambuf;      ///< @isiosfwd
 134   typedef basic_istream<char>           istream;        ///< @isiosfwd
 135   typedef basic_ostream<char>           ostream;        ///< @isiosfwd
 136   typedef basic_iostream<char>          iostream;       ///< @isiosfwd
 137   typedef basic_stringbuf<char>         stringbuf;      ///< @isiosfwd
 138   typedef basic_istringstream<char>     istringstream;  ///< @isiosfwd
 139   typedef basic_ostringstream<char>     ostringstream;  ///< @isiosfwd
 140   typedef basic_stringstream<char>      stringstream;   ///< @isiosfwd
 141   typedef basic_filebuf<char>           filebuf;        ///< @isiosfwd
 142   typedef basic_ifstream<char>          ifstream;       ///< @isiosfwd
 143   typedef basic_ofstream<char>          ofstream;       ///< @isiosfwd
 144   typedef basic_fstream<char>           fstream;        ///< @isiosfwd
 145
 146 #ifdef _GLIBCXX_USE_WCHAR_T
 147   typedef basic_ios<wchar_t>            wios;           ///< @isiosfwd
 148   typedef basic_streambuf<wchar_t>      wstreambuf;     ///< @isiosfwd
 149   typedef basic_istream<wchar_t>        wistream;       ///< @isiosfwd
 150   typedef basic_ostream<wchar_t>        wostream;       ///< @isiosfwd
 151   typedef basic_iostream<wchar_t>       wiostream;      ///< @isiosfwd
 152   typedef basic_stringbuf<wchar_t>      wstringbuf;     ///< @isiosfwd
 153   typedef basic_istringstream<wchar_t>  wistringstream; ///< @isiosfwd
 154   typedef basic_ostringstream<wchar_t>  wostringstream; ///< @isiosfwd
 155   typedef basic_stringstream<wchar_t>   wstringstream;  ///< @isiosfwd
 156   typedef basic_filebuf<wchar_t>        wfilebuf;       ///< @isiosfwd
 157   typedef basic_ifstream<wchar_t>       wifstream;      ///< @isiosfwd
 158   typedef basic_ofstream<wchar_t>       wofstream;      ///< @isiosfwd
 159   typedef basic_fstream<wchar_t>        wfstream;       ///< @isiosfwd
 160 #endif
 161   /** @}  */
 162
 163 _GLIBCXX_END_NAMESPACE
 164
 165 #endif /* _GLIBCXX_IOSFWD */