1 // File based streams -*- C++ -*-
 
    3 // Copyright (C) 1997-2014 Free Software Foundation, Inc.
 
    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 3, or (at your option)
 
   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.
 
   16 // Under Section 7 of GPL version 3, you are granted additional
 
   17 // permissions described in the GCC Runtime Library Exception, version
 
   18 // 3.1, as published by the Free Software Foundation.
 
   20 // You should have received a copy of the GNU General Public License and
 
   21 // a copy of the GCC Runtime Library Exception along with this program;
 
   22 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
 
   23 // <http://www.gnu.org/licenses/>.
 
   25 /** @file include/fstream
 
   26  *  This is a Standard C++ Library header.
 
   30 // ISO C++ 14882: 27.8  File-based streams
 
   33 #ifndef _GLIBCXX_FSTREAM
 
   34 #define _GLIBCXX_FSTREAM 1
 
   36 #pragma GCC system_header
 
   40 #include <bits/codecvt.h>
 
   41 #include <cstdio>             // For BUFSIZ
 
   42 #include <bits/basic_file.h>  // For __basic_file, __c_lock
 
   43 #if __cplusplus >= 201103L
 
   44 #include <string>             // For std::string overloads.
 
   47 namespace std _GLIBCXX_VISIBILITY(default)
 
   49 _GLIBCXX_BEGIN_NAMESPACE_VERSION
 
   51   // [27.8.1.1] template class basic_filebuf
 
   53    *  @brief  The actual work of input and output (for files).
 
   56    *  @tparam _CharT  Type of character stream.
 
   57    *  @tparam _Traits  Traits for character type, defaults to
 
   58    *                   char_traits<_CharT>.
 
   60    *  This class associates both its input and output sequence with an
 
   61    *  external disk file, and maintains a joint file position for both
 
   62    *  sequences.  Many of its semantics are described in terms of similar
 
   63    *  behavior in the Standard C Library's @c FILE streams.
 
   65    *  Requirements on traits_type, specific to this class:
 
   66    *  - traits_type::pos_type must be fpos<traits_type::state_type>
 
   67    *  - traits_type::off_type must be streamoff
 
   68    *  - traits_type::state_type must be Assignable and DefaultConstructible,
 
   69    *  - traits_type::state_type() must be the initial state for codecvt.
 
   71   template<typename _CharT, typename _Traits>
 
   72     class basic_filebuf : public basic_streambuf<_CharT, _Traits>
 
   76       typedef _CharT                               char_type;
 
   77       typedef _Traits                              traits_type;
 
   78       typedef typename traits_type::int_type       int_type;
 
   79       typedef typename traits_type::pos_type       pos_type;
 
   80       typedef typename traits_type::off_type       off_type;
 
   82       typedef basic_streambuf<char_type, traits_type>      __streambuf_type;
 
   83       typedef basic_filebuf<char_type, traits_type>     __filebuf_type;
 
   84       typedef __basic_file<char>               __file_type;
 
   85       typedef typename traits_type::state_type          __state_type;
 
   86       typedef codecvt<char_type, char, __state_type>    __codecvt_type;
 
   88       friend class ios_base; // For sync_with_stdio.
 
   92       // MT lock inherited from libio or other low-level io library.
 
   98       /// Place to stash in || out || in | out settings for current filebuf.
 
   99       ios_base::openmode   _M_mode;
 
  101       // Beginning state type for codecvt.
 
  102       __state_type         _M_state_beg;
 
  104       // During output, the state that corresponds to pptr(),
 
  105       // during input, the state that corresponds to egptr() and
 
  107       __state_type     _M_state_cur;
 
  109       // Not used for output. During input, the state that corresponds
 
  110       // to eback() and _M_ext_buf.
 
  111       __state_type     _M_state_last;
 
  113       /// Pointer to the beginning of internal buffer.
 
  117        *  Actual size of internal buffer. This number is equal to the size
 
  118        *  of the put area + 1 position, reserved for the overflow char of
 
  123       // Set iff _M_buf is allocated memory from _M_allocate_internal_buffer.
 
  124       bool         _M_buf_allocated;
 
  127        *  _M_reading == false && _M_writing == false for @b uncommitted mode;
 
  128        *  _M_reading == true for @b read mode;
 
  129        *  _M_writing == true for @b write mode;
 
  131        *  NB: _M_reading == true && _M_writing == true is unused.
 
  138        *  Necessary bits for putback buffer management.
 
  140        *  @note pbacks of over one character are not currently supported.
 
  143       char_type*       _M_pback_cur_save;
 
  144       char_type*       _M_pback_end_save;
 
  148       // Cached codecvt facet.
 
  149       const __codecvt_type*    _M_codecvt;
 
  152        *  Buffer for external characters. Used for input when
 
  153        *  codecvt::always_noconv() == false. When valid, this corresponds
 
  159        *  Size of buffer held by _M_ext_buf.
 
  161       streamsize       _M_ext_buf_size;
 
  164        *  Pointers into the buffer held by _M_ext_buf that delimit a
 
  165        *  subsequence of bytes that have been read but not yet converted.
 
  166        *  When valid, _M_ext_next corresponds to egptr().
 
  168       const char*      _M_ext_next;
 
  172        *  Initializes pback buffers, and moves normal buffers to safety.
 
  174        *  _M_in_cur has already been moved back
 
  181        _M_pback_cur_save = this->gptr();
 
  182        _M_pback_end_save = this->egptr();
 
  183        this->setg(&_M_pback, &_M_pback, &_M_pback + 1);
 
  184        _M_pback_init = true;
 
  189        *  Deactivates pback buffer contents, and restores normal buffer.
 
  191        *  The pback buffer has only moved forward.
 
  194       _M_destroy_pback() throw()
 
  198        // Length _M_in_cur moved in the pback buffer.
 
  199        _M_pback_cur_save += this->gptr() != this->eback();
 
  200        this->setg(_M_buf, _M_pback_cur_save, _M_pback_end_save);
 
  201        _M_pback_init = false;
 
  206       // Constructors/destructor:
 
  208        *  @brief  Does not open any files.
 
  210        *  The default constructor initializes the parent class using its
 
  216        *  @brief  The destructor closes the file first.
 
  224        *  @brief  Returns true if the external file is open.
 
  227       is_open() const throw()
 
  228       { return _M_file.is_open(); }
 
  231        *  @brief  Opens an external file.
 
  232        *  @param  __s  The name of the file.
 
  233        *  @param  __mode  The open mode flags.
 
  234        *  @return  @c this on success, NULL on failure
 
  236        *  If a file is already open, this function immediately fails.
 
  237        *  Otherwise it tries to open the file named @a __s using the flags
 
  238        *  given in @a __mode.
 
  240        *  Table 92, adapted here, gives the relation between openmode
 
  241        *  combinations and the equivalent @c fopen() flags.
 
  242        *  (NB: lines app, in|out|app, in|app, binary|app, binary|in|out|app,
 
  243        *  and binary|in|app per DR 596)
 
  245        *  +---------------------------------------------------------+
 
  246        *  | ios_base Flag combination            stdio equivalent   |
 
  247        *  |binary  in  out  trunc  app                              |
 
  248        *  +---------------------------------------------------------+
 
  258        *  +---------------------------------------------------------+
 
  268        *  +---------------------------------------------------------+
 
  272       open(const char* __s, ios_base::openmode __mode);
 
  274 #if __cplusplus >= 201103L
 
  276        *  @brief  Opens an external file.
 
  277        *  @param  __s  The name of the file.
 
  278        *  @param  __mode  The open mode flags.
 
  279        *  @return  @c this on success, NULL on failure
 
  282       open(const std::string& __s, ios_base::openmode __mode)
 
  283       { return open(__s.c_str(), __mode); }
 
  287        *  @brief  Closes the currently associated file.
 
  288        *  @return  @c this on success, NULL on failure
 
  290        *  If no file is currently open, this function immediately fails.
 
  292        *  If a <em>put buffer area</em> exists, @c overflow(eof) is
 
  293        *  called to flush all the characters.  The file is then
 
  296        *  If any operations fail, this function also fails.
 
  303       _M_allocate_internal_buffer();
 
  306       _M_destroy_internal_buffer() throw();
 
  308       // [27.8.1.4] overridden virtual functions
 
  312       // Stroustrup, 1998, p. 628
 
  313       // underflow() and uflow() functions are called to get the next
 
  314       // character from the real input source when the buffer is empty.
 
  315       // Buffered input uses underflow()
 
  321       pbackfail(int_type __c = _Traits::eof());
 
  323       // Stroustrup, 1998, p 648
 
  324       // The overflow() function is called to transfer characters to the
 
  325       // real output destination when the buffer is full. A call to
 
  326       // overflow(c) outputs the contents of the buffer plus the
 
  329       // Consume some sequence of the characters in the pending sequence.
 
  331       overflow(int_type __c = _Traits::eof());
 
  333       // Convert internal byte sequence to external, char-based
 
  334       // sequence via codecvt.
 
  336       _M_convert_to_external(char_type*, streamsize);
 
  339        *  @brief  Manipulates the buffer.
 
  340        *  @param  __s  Pointer to a buffer area.
 
  341        *  @param  __n  Size of @a __s.
 
  344        *  If no file has been opened, and both @a __s and @a __n are zero, then
 
  345        *  the stream becomes unbuffered.  Otherwise, @c __s is used as a
 
  347        *  http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch25s02.html
 
  350       virtual __streambuf_type*
 
  351       setbuf(char_type* __s, streamsize __n);
 
  354       seekoff(off_type __off, ios_base::seekdir __way,
 
  355          ios_base::openmode __mode = ios_base::in | ios_base::out);
 
  358       seekpos(pos_type __pos,
 
  359          ios_base::openmode __mode = ios_base::in | ios_base::out);
 
  361       // Common code for seekoff, seekpos, and overflow
 
  363       _M_seek(off_type __off, ios_base::seekdir __way, __state_type __state);
 
  366       _M_get_ext_pos(__state_type &__state);
 
  372       imbue(const locale& __loc);
 
  375       xsgetn(char_type* __s, streamsize __n);
 
  378       xsputn(const char_type* __s, streamsize __n);
 
  380       // Flushes output buffer, then writes unshift sequence.
 
  382       _M_terminate_output();
 
  385        *  This function sets the pointers of the internal buffer, both get
 
  386        *  and put areas. Typically:
 
  388        *   __off == egptr() - eback() upon underflow/uflow (@b read mode);
 
  389        *   __off == 0 upon overflow (@b write mode);
 
  390        *   __off == -1 upon open, setbuf, seekoff/pos (@b uncommitted mode).
 
  392        *  NB: epptr() - pbase() == _M_buf_size - 1, since _M_buf_size
 
  393        *  reflects the actual allocated memory and the last cell is reserved
 
  394        *  for the overflow char of a full put area.
 
  397       _M_set_buffer(streamsize __off)
 
  399    const bool __testin = _M_mode & ios_base::in;
 
  400    const bool __testout = (_M_mode & ios_base::out
 
  401                || _M_mode & ios_base::app);
 
  403    if (__testin && __off > 0)
 
  404      this->setg(_M_buf, _M_buf, _M_buf + __off);
 
  406      this->setg(_M_buf, _M_buf, _M_buf);
 
  408    if (__testout && __off == 0 && _M_buf_size > 1 )
 
  409      this->setp(_M_buf, _M_buf + _M_buf_size - 1);
 
  415   // [27.8.1.5] Template class basic_ifstream
 
  417    *  @brief  Controlling input for files.
 
  420    *  @tparam _CharT  Type of character stream.
 
  421    *  @tparam _Traits  Traits for character type, defaults to
 
  422    *                   char_traits<_CharT>.
 
  424    *  This class supports reading from named files, using the inherited
 
  425    *  functions from std::basic_istream.  To control the associated
 
  426    *  sequence, an instance of std::basic_filebuf is used, which this page
 
  427    *  refers to as @c sb.
 
  429   template<typename _CharT, typename _Traits>
 
  430     class basic_ifstream : public basic_istream<_CharT, _Traits>
 
  434       typedef _CharT                   char_type;
 
  435       typedef _Traits                  traits_type;
 
  436       typedef typename traits_type::int_type       int_type;
 
  437       typedef typename traits_type::pos_type       pos_type;
 
  438       typedef typename traits_type::off_type       off_type;
 
  440       // Non-standard types:
 
  441       typedef basic_filebuf<char_type, traits_type>    __filebuf_type;
 
  442       typedef basic_istream<char_type, traits_type>    __istream_type;
 
  445       __filebuf_type   _M_filebuf;
 
  448       // Constructors/Destructors:
 
  450        *  @brief  Default constructor.
 
  452        *  Initializes @c sb using its default constructor, and passes
 
  453        *  @c &sb to the base class initializer.  Does not open any files
 
  454        *  (you haven't given it a filename to open).
 
  456       basic_ifstream() : __istream_type(), _M_filebuf()
 
  457       { this->init(&_M_filebuf); }
 
  460        *  @brief  Create an input file stream.
 
  461        *  @param  __s  Null terminated string specifying the filename.
 
  462        *  @param  __mode  Open file in specified mode (see std::ios_base).
 
  464        *  @c ios_base::in is automatically included in @a __mode.
 
  466        *  Tip:  When using std::string to hold the filename, you must use
 
  467        *  .c_str() before passing it to this constructor.
 
  470       basic_ifstream(const char* __s, ios_base::openmode __mode = ios_base::in)
 
  471       : __istream_type(), _M_filebuf()
 
  473    this->init(&_M_filebuf);
 
  474    this->open(__s, __mode);
 
  477 #if __cplusplus >= 201103L
 
  479        *  @brief  Create an input file stream.
 
  480        *  @param  __s  std::string specifying the filename.
 
  481        *  @param  __mode  Open file in specified mode (see std::ios_base).
 
  483        *  @c ios_base::in is automatically included in @a __mode.
 
  486       basic_ifstream(const std::string& __s,
 
  487             ios_base::openmode __mode = ios_base::in)
 
  488       : __istream_type(), _M_filebuf()
 
  490    this->init(&_M_filebuf);
 
  491    this->open(__s, __mode);
 
  496        *  @brief  The destructor does nothing.
 
  498        *  The file is closed by the filebuf object, not the formatting
 
  506        *  @brief  Accessing the underlying buffer.
 
  507        *  @return  The current basic_filebuf buffer.
 
  509        *  This hides both signatures of std::basic_ios::rdbuf().
 
  513       { return const_cast<__filebuf_type*>(&_M_filebuf); }
 
  516        *  @brief  Wrapper to test for an open file.
 
  517        *  @return  @c rdbuf()->is_open()
 
  521       { return _M_filebuf.is_open(); }
 
  523       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 
  524       // 365. Lack of const-qualification in clause 27
 
  527       { return _M_filebuf.is_open(); }
 
  530        *  @brief  Opens an external file.
 
  531        *  @param  __s  The name of the file.
 
  532        *  @param  __mode  The open mode flags.
 
  534        *  Calls @c std::basic_filebuf::open(s,__mode|in).  If that function
 
  535        *  fails, @c failbit is set in the stream's error state.
 
  537        *  Tip:  When using std::string to hold the filename, you must use
 
  538        *  .c_str() before passing it to this constructor.
 
  541       open(const char* __s, ios_base::openmode __mode = ios_base::in)
 
  543    if (!_M_filebuf.open(__s, __mode | ios_base::in))
 
  544      this->setstate(ios_base::failbit);
 
  546      // _GLIBCXX_RESOLVE_LIB_DEFECTS
 
  547      // 409. Closing an fstream should clear error state
 
  551 #if __cplusplus >= 201103L
 
  553        *  @brief  Opens an external file.
 
  554        *  @param  __s  The name of the file.
 
  555        *  @param  __mode  The open mode flags.
 
  557        *  Calls @c std::basic_filebuf::open(__s,__mode|in).  If that function
 
  558        *  fails, @c failbit is set in the stream's error state.
 
  561       open(const std::string& __s, ios_base::openmode __mode = ios_base::in)
 
  563    if (!_M_filebuf.open(__s, __mode | ios_base::in))
 
  564      this->setstate(ios_base::failbit);
 
  566      // _GLIBCXX_RESOLVE_LIB_DEFECTS
 
  567      // 409. Closing an fstream should clear error state
 
  573        *  @brief  Close the file.
 
  575        *  Calls @c std::basic_filebuf::close().  If that function
 
  576        *  fails, @c failbit is set in the stream's error state.
 
  581    if (!_M_filebuf.close())
 
  582      this->setstate(ios_base::failbit);
 
  587   // [27.8.1.8] Template class basic_ofstream
 
  589    *  @brief  Controlling output for files.
 
  592    *  @tparam _CharT  Type of character stream.
 
  593    *  @tparam _Traits  Traits for character type, defaults to
 
  594    *                   char_traits<_CharT>.
 
  596    *  This class supports reading from named files, using the inherited
 
  597    *  functions from std::basic_ostream.  To control the associated
 
  598    *  sequence, an instance of std::basic_filebuf is used, which this page
 
  599    *  refers to as @c sb.
 
  601   template<typename _CharT, typename _Traits>
 
  602     class basic_ofstream : public basic_ostream<_CharT,_Traits>
 
  606       typedef _CharT                   char_type;
 
  607       typedef _Traits                  traits_type;
 
  608       typedef typename traits_type::int_type       int_type;
 
  609       typedef typename traits_type::pos_type       pos_type;
 
  610       typedef typename traits_type::off_type       off_type;
 
  612       // Non-standard types:
 
  613       typedef basic_filebuf<char_type, traits_type>    __filebuf_type;
 
  614       typedef basic_ostream<char_type, traits_type>    __ostream_type;
 
  617       __filebuf_type   _M_filebuf;
 
  622        *  @brief  Default constructor.
 
  624        *  Initializes @c sb using its default constructor, and passes
 
  625        *  @c &sb to the base class initializer.  Does not open any files
 
  626        *  (you haven't given it a filename to open).
 
  628       basic_ofstream(): __ostream_type(), _M_filebuf()
 
  629       { this->init(&_M_filebuf); }
 
  632        *  @brief  Create an output file stream.
 
  633        *  @param  __s  Null terminated string specifying the filename.
 
  634        *  @param  __mode  Open file in specified mode (see std::ios_base).
 
  636        *  @c ios_base::out | @c ios_base::trunc is automatically included in
 
  639        *  Tip:  When using std::string to hold the filename, you must use
 
  640        *  .c_str() before passing it to this constructor.
 
  643       basic_ofstream(const char* __s,
 
  644             ios_base::openmode __mode = ios_base::out|ios_base::trunc)
 
  645       : __ostream_type(), _M_filebuf()
 
  647    this->init(&_M_filebuf);
 
  648    this->open(__s, __mode);
 
  651 #if __cplusplus >= 201103L
 
  653        *  @brief  Create an output file stream.
 
  654        *  @param  __s  std::string specifying the filename.
 
  655        *  @param  __mode  Open file in specified mode (see std::ios_base).
 
  657        *  @c ios_base::out | @c ios_base::trunc is automatically included in
 
  661       basic_ofstream(const std::string& __s,
 
  662             ios_base::openmode __mode = ios_base::out|ios_base::trunc)
 
  663       : __ostream_type(), _M_filebuf()
 
  665    this->init(&_M_filebuf);
 
  666    this->open(__s, __mode);
 
  671        *  @brief  The destructor does nothing.
 
  673        *  The file is closed by the filebuf object, not the formatting
 
  681        *  @brief  Accessing the underlying buffer.
 
  682        *  @return  The current basic_filebuf buffer.
 
  684        *  This hides both signatures of std::basic_ios::rdbuf().
 
  688       { return const_cast<__filebuf_type*>(&_M_filebuf); }
 
  691        *  @brief  Wrapper to test for an open file.
 
  692        *  @return  @c rdbuf()->is_open()
 
  696       { return _M_filebuf.is_open(); }
 
  698       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 
  699       // 365. Lack of const-qualification in clause 27
 
  702       { return _M_filebuf.is_open(); }
 
  705        *  @brief  Opens an external file.
 
  706        *  @param  __s  The name of the file.
 
  707        *  @param  __mode  The open mode flags.
 
  709        *  Calls @c std::basic_filebuf::open(__s,__mode|out|trunc).  If that
 
  710        *  function fails, @c failbit is set in the stream's error state.
 
  712        *  Tip:  When using std::string to hold the filename, you must use
 
  713        *  .c_str() before passing it to this constructor.
 
  716       open(const char* __s,
 
  717       ios_base::openmode __mode = ios_base::out | ios_base::trunc)
 
  719    if (!_M_filebuf.open(__s, __mode | ios_base::out))
 
  720      this->setstate(ios_base::failbit);
 
  722      // _GLIBCXX_RESOLVE_LIB_DEFECTS
 
  723      // 409. Closing an fstream should clear error state
 
  727 #if __cplusplus >= 201103L
 
  729        *  @brief  Opens an external file.
 
  730        *  @param  __s  The name of the file.
 
  731        *  @param  __mode  The open mode flags.
 
  733        *  Calls @c std::basic_filebuf::open(s,mode|out|trunc).  If that
 
  734        *  function fails, @c failbit is set in the stream's error state.
 
  737       open(const std::string& __s,
 
  738       ios_base::openmode __mode = ios_base::out | ios_base::trunc)
 
  740    if (!_M_filebuf.open(__s, __mode | ios_base::out))
 
  741      this->setstate(ios_base::failbit);
 
  743      // _GLIBCXX_RESOLVE_LIB_DEFECTS
 
  744      // 409. Closing an fstream should clear error state
 
  750        *  @brief  Close the file.
 
  752        *  Calls @c std::basic_filebuf::close().  If that function
 
  753        *  fails, @c failbit is set in the stream's error state.
 
  758    if (!_M_filebuf.close())
 
  759      this->setstate(ios_base::failbit);
 
  764   // [27.8.1.11] Template class basic_fstream
 
  766    *  @brief  Controlling input and output for files.
 
  769    *  @tparam _CharT  Type of character stream.
 
  770    *  @tparam _Traits  Traits for character type, defaults to
 
  771    *                   char_traits<_CharT>.
 
  773    *  This class supports reading from and writing to named files, using
 
  774    *  the inherited functions from std::basic_iostream.  To control the
 
  775    *  associated sequence, an instance of std::basic_filebuf is used, which
 
  776    *  this page refers to as @c sb.
 
  778   template<typename _CharT, typename _Traits>
 
  779     class basic_fstream : public basic_iostream<_CharT, _Traits>
 
  783       typedef _CharT                   char_type;
 
  784       typedef _Traits                  traits_type;
 
  785       typedef typename traits_type::int_type       int_type;
 
  786       typedef typename traits_type::pos_type       pos_type;
 
  787       typedef typename traits_type::off_type       off_type;
 
  789       // Non-standard types:
 
  790       typedef basic_filebuf<char_type, traits_type>    __filebuf_type;
 
  791       typedef basic_ios<char_type, traits_type>        __ios_type;
 
  792       typedef basic_iostream<char_type, traits_type>   __iostream_type;
 
  795       __filebuf_type   _M_filebuf;
 
  798       // Constructors/destructor:
 
  800        *  @brief  Default constructor.
 
  802        *  Initializes @c sb using its default constructor, and passes
 
  803        *  @c &sb to the base class initializer.  Does not open any files
 
  804        *  (you haven't given it a filename to open).
 
  807       : __iostream_type(), _M_filebuf()
 
  808       { this->init(&_M_filebuf); }
 
  811        *  @brief  Create an input/output file stream.
 
  812        *  @param  __s  Null terminated string specifying the filename.
 
  813        *  @param  __mode  Open file in specified mode (see std::ios_base).
 
  815        *  Tip:  When using std::string to hold the filename, you must use
 
  816        *  .c_str() before passing it to this constructor.
 
  819       basic_fstream(const char* __s,
 
  820            ios_base::openmode __mode = ios_base::in | ios_base::out)
 
  821       : __iostream_type(0), _M_filebuf()
 
  823    this->init(&_M_filebuf);
 
  824    this->open(__s, __mode);
 
  827 #if __cplusplus >= 201103L
 
  829        *  @brief  Create an input/output file stream.
 
  830        *  @param  __s  Null terminated string specifying the filename.
 
  831        *  @param  __mode  Open file in specified mode (see std::ios_base).
 
  834       basic_fstream(const std::string& __s,
 
  835            ios_base::openmode __mode = ios_base::in | ios_base::out)
 
  836       : __iostream_type(0), _M_filebuf()
 
  838    this->init(&_M_filebuf);
 
  839    this->open(__s, __mode);
 
  844        *  @brief  The destructor does nothing.
 
  846        *  The file is closed by the filebuf object, not the formatting
 
  854        *  @brief  Accessing the underlying buffer.
 
  855        *  @return  The current basic_filebuf buffer.
 
  857        *  This hides both signatures of std::basic_ios::rdbuf().
 
  861       { return const_cast<__filebuf_type*>(&_M_filebuf); }
 
  864        *  @brief  Wrapper to test for an open file.
 
  865        *  @return  @c rdbuf()->is_open()
 
  869       { return _M_filebuf.is_open(); }
 
  871       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 
  872       // 365. Lack of const-qualification in clause 27
 
  875       { return _M_filebuf.is_open(); }
 
  878        *  @brief  Opens an external file.
 
  879        *  @param  __s  The name of the file.
 
  880        *  @param  __mode  The open mode flags.
 
  882        *  Calls @c std::basic_filebuf::open(__s,__mode).  If that
 
  883        *  function fails, @c failbit is set in the stream's error state.
 
  885        *  Tip:  When using std::string to hold the filename, you must use
 
  886        *  .c_str() before passing it to this constructor.
 
  889       open(const char* __s,
 
  890       ios_base::openmode __mode = ios_base::in | ios_base::out)
 
  892    if (!_M_filebuf.open(__s, __mode))
 
  893      this->setstate(ios_base::failbit);
 
  895      // _GLIBCXX_RESOLVE_LIB_DEFECTS
 
  896      // 409. Closing an fstream should clear error state
 
  900 #if __cplusplus >= 201103L
 
  902        *  @brief  Opens an external file.
 
  903        *  @param  __s  The name of the file.
 
  904        *  @param  __mode  The open mode flags.
 
  906        *  Calls @c std::basic_filebuf::open(__s,__mode).  If that
 
  907        *  function fails, @c failbit is set in the stream's error state.
 
  910       open(const std::string& __s,
 
  911       ios_base::openmode __mode = ios_base::in | ios_base::out)
 
  913    if (!_M_filebuf.open(__s, __mode))
 
  914      this->setstate(ios_base::failbit);
 
  916      // _GLIBCXX_RESOLVE_LIB_DEFECTS
 
  917      // 409. Closing an fstream should clear error state
 
  923        *  @brief  Close the file.
 
  925        *  Calls @c std::basic_filebuf::close().  If that function
 
  926        *  fails, @c failbit is set in the stream's error state.
 
  931    if (!_M_filebuf.close())
 
  932      this->setstate(ios_base::failbit);
 
  936 _GLIBCXX_END_NAMESPACE_VERSION
 
  939 #include <bits/fstream.tcc>
 
  941 #endif /* _GLIBCXX_FSTREAM */