libstdc++-v3/include/std/std_iostream.h

   1 // Standard iostream objects -*- C++ -*-
   2
   3 // Copyright (C) 1997, 1998, 1999, 2001, 2002 Free Software Foundation, Inc.
   4 //
   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 2, or (at your option)
   9 // any later version.
  10
  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.
  15
  16 // You should have received a copy of the GNU General Public License along
  17 // with this library; see the file COPYING.  If not, write to the Free
  18 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19 // USA.
  20
  21 // As a special exception, you may use this file as part of a free software
  22 // library without restriction.  Specifically, if other files instantiate
  23 // templates or use macros or inline functions from this file, or you compile
  24 // this file and link it with other files to produce an executable, this
  25 // file does not by itself cause the resulting executable to be covered by
  26 // the GNU General Public License.  This exception does not however
  27 // invalidate any other reasons why the executable file might be covered by
  28 // the GNU General Public License.
  29
  30 //
  31 // ISO C++ 14882: 27.3  Standard iostream objects
  32 //
  33
  34 /** @file iostream
  35  *  This is a Standard C++ Library header.  You should @c #include this header
  36  *  in your programs, rather than any of the "st[dl]_*.h" implementation files.
  37  */
  38
  39 #ifndef _IOSTREAM
  40 #define _IOSTREAM 1
  41
  42 #pragma GCC system_header
  43
  44 #include <bits/c++config.h>
  45 #include <ostream>
  46 #include <istream>
  47
  48 namespace std
  49 {
  50   /**
  51    *  @name Standard Stream Objects
  52    *
  53    *  The &lt;iostream&gt; header declares the eight <em>standard stream
  54    *  objects</em>.  For other declarations, see
  55    *  http://gcc.gnu.org/onlinedocs/libstdc++/27_io/howto.html#10 and the
  56    *  @link s27_2_iosfwd I/O forward declarations @endlink
  57    *
  58    *  They are required by default to cooperate with the global C library's
  59    *  @c FILE streams, and to be available during program startup and
  60    *  termination.  For more information, see the HOWTO linked to above.
  61   */
  62   //@{
  63   extern istream cin;           ///< Linked to standard input
  64   extern ostream cout;          ///< Linked to standard output
  65   extern ostream cerr;          ///< Linked to standard error (unbuffered)
  66   extern ostream clog;          ///< Linked to standard error (buffered)
  67
  68 #ifdef _GLIBCXX_USE_WCHAR_T
  69   extern wistream wcin;         ///< Linked to standard input
  70   extern wostream wcout;        ///< Linked to standard output
  71   extern wostream wcerr;        ///< Linked to standard error (unbuffered)
  72   extern wostream wclog;        ///< Linked to standard error (buffered)
  73 #endif
  74   //@}
  75
  76   // For construction of filebuffers for cout, cin, cerr, clog et. al.
  77   static ios_base::Init __ioinit;
  78 } // namespace std
  79
  80 #endif