libstdc++-v3/include/bits/basic_ios.h

   1 // Iostreams base classes -*- 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 /** @file basic_ios.h
  31  *  This is an internal header file, included by other library headers.
  32  *  You should not attempt to use it directly.
  33  */
  34
  35 #ifndef _CPP_BITS_BASICIOS_H
  36 #define _CPP_BITS_BASICIOS_H 1
  37
  38 #pragma GCC system_header
  39
  40 #include <bits/streambuf_iterator.h>
  41 #include <bits/locale_facets.h>
  42
  43 namespace std
  44 {
  45   // 27.4.5  Template class basic_ios
  46   template<typename _CharT, typename _Traits>
  47     class basic_ios : public ios_base
  48     {
  49     public:
  50       // Types:
  51       typedef _CharT                            char_type;
  52       typedef typename _Traits::int_type        int_type;
  53       typedef typename _Traits::pos_type        pos_type;
  54       typedef typename _Traits::off_type        off_type;
  55       typedef _Traits                           traits_type;
  56
  57       // Non-standard Types:
  58       typedef ctype<_CharT>                             __ctype_type;
  59       typedef ostreambuf_iterator<_CharT, _Traits>      __ostreambuf_iter;
  60       typedef num_put<_CharT, __ostreambuf_iter>        __numput_type;
  61       typedef istreambuf_iterator<_CharT, _Traits>      __istreambuf_iter;
  62       typedef num_get<_CharT, __istreambuf_iter>        __numget_type;
  63
  64       // Data members:
  65     protected:
  66       basic_ostream<_CharT, _Traits>*   _M_tie;
  67       char_type                         _M_fill;
  68       iostate                           _M_exception;
  69
  70       basic_streambuf<_CharT, _Traits>* _M_streambuf;
  71       iostate                           _M_streambuf_state;
  72
  73       // Cached use_facet<ctype>, which is based on the current locale info.
  74       const __ctype_type*               _M_ios_fctype;
  75       // From ostream.
  76       const __numput_type*              _M_fnumput;
  77       // From istream.
  78       const __numget_type*              _M_fnumget;
  79
  80     public:
  81       inline const __ctype_type*
  82       _M_get_fctype_ios(void)
  83       { return _M_ios_fctype; }
  84
  85       operator void*() const
  86       { return this->fail() ? 0 : const_cast<basic_ios*>(this); }
  87
  88       inline bool
  89       operator!() const
  90       { return this->fail(); }
  91
  92       inline iostate
  93       rdstate() const
  94       { return _M_streambuf_state; }
  95
  96       inline void
  97       clear(iostate __state = goodbit)
  98       {
  99         if (this->rdbuf())
 100           _M_streambuf_state = __state;
 101         else
 102           _M_streambuf_state = __state | badbit;
 103         if ((this->rdstate() & this->exceptions()))
 104           __throw_ios_failure("basic_ios::clear(iostate) caused exception");
 105       }
 106
 107       inline void
 108       setstate(iostate __state)
 109       { this->clear(this->rdstate() | __state); }
 110
 111       inline bool
 112       good() const
 113       { return this->rdstate() == 0; }
 114
 115       inline bool
 116       eof() const
 117       { return (this->rdstate() & eofbit) != 0; }
 118
 119       inline bool
 120       fail() const
 121       { return (this->rdstate() & (badbit | failbit)) != 0; }
 122
 123       inline bool
 124       bad() const
 125       { return (this->rdstate() & badbit) != 0; }
 126
 127       inline iostate
 128       exceptions() const
 129       { return _M_exception; }
 130
 131       inline void
 132       exceptions(iostate __except)
 133       {
 134         _M_exception = __except;
 135         this->clear(_M_streambuf_state);
 136       }
 137
 138       // Constructor/destructor:
 139       explicit
 140       basic_ios(basic_streambuf<_CharT, _Traits>* __sb) : ios_base()
 141       { this->init(__sb); }
 142
 143       virtual
 144       ~basic_ios() { }
 145
 146       // Members:
 147       inline basic_ostream<_CharT, _Traits>*
 148       tie() const
 149       { return _M_tie; }
 150
 151       inline basic_ostream<_CharT, _Traits>*
 152       tie(basic_ostream<_CharT, _Traits>* __tiestr)
 153       {
 154         basic_ostream<_CharT, _Traits>* __old = _M_tie;
 155         _M_tie = __tiestr;
 156         return __old;
 157       }
 158
 159       inline basic_streambuf<_CharT, _Traits>*
 160       rdbuf() const
 161       { return _M_streambuf; }
 162
 163       basic_streambuf<_CharT, _Traits>*
 164       rdbuf(basic_streambuf<_CharT, _Traits>* __sb);
 165
 166       basic_ios&
 167       copyfmt(const basic_ios& __rhs);
 168
 169       inline char_type
 170       fill() const
 171       { return _M_fill; }
 172
 173       inline char_type
 174       fill(char_type __ch)
 175       {
 176         char_type __old = this->fill();
 177         _M_fill = __ch;
 178         return __old;
 179       }
 180
 181       // Locales:
 182       locale
 183       imbue(const locale& __loc);
 184
 185       char
 186       narrow(char_type __c, char __dfault) const;
 187
 188       char_type
 189       widen(char __c) const;
 190
 191     protected:
 192       // 27.4.5.1  basic_ios constructors
 193       basic_ios() : ios_base()
 194       { }
 195
 196       void
 197       init(basic_streambuf<_CharT, _Traits>* __sb);
 198
 199       bool
 200       _M_check_facet(const locale::facet* __f) const
 201       {
 202         if (!__f)
 203           __throw_bad_cast();
 204         return true;
 205       }
 206
 207       void
 208       _M_cache_facets(const locale& __loc);
 209     };
 210 } // namespace std
 211
 212 #ifdef _GLIBCPP_NO_TEMPLATE_EXPORT
 213 # define export
 214 #include <bits/basic_ios.tcc>
 215 #endif
 216
 217 #endif /* _CPP_BITS_BASICIOS_H */
 218
 219