// File based streams -*- C++ -*-

// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library.  This library is free
// software; you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the
// Free Software Foundation; either version 2, or (at your option)
// any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License along
// with this library; see the file COPYING.  If not, write to the Free
// Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
// USA.

// As a special exception, you may use this file as part of a free software
// library without restriction.  Specifically, if other files instantiate
// templates or use macros or inline functions from this file, or you compile
// this file and link it with other files to produce an executable, this
// file does not by itself cause the resulting executable to be covered by
// the GNU General Public License.  This exception does not however
// invalidate any other reasons why the executable file might be covered by
// the GNU General Public License.

//
// ISO C++ 14882: 27.8  File-based streams
//

/** @file fstream
 *  This is a Standard C++ Library header.  You should @c #include this header
 *  in your programs, rather than any of the "st[dl]_*.h" implementation files.
 */

#ifndef _CPP_FSTREAM
#define _CPP_FSTREAM	1

#pragma GCC system_header

#include <istream>
#include <ostream>
#include <locale>	// For codecvt
#include <bits/basic_file.h>
#include <bits/gthr.h>

namespace std
{
  // [27.8.1.1] template class basic_filebuf
  /**
   *  @brief  The actual work of input and output (for files).
   *
   *  This class associates both its input and output sequence with an
   *  external disk file, and maintains a joint file position for both
   *  sequences.  Many of its sematics are described in terms of similar
   *  behavior in the Standard C Library's @c FILE streams.
  */
  template<typename _CharT, typename _Traits>
    class basic_filebuf : public basic_streambuf<_CharT, _Traits>
    {
    public:
      // Types:
      typedef _CharT                     	        char_type;
      typedef _Traits                    	        traits_type;
      typedef typename traits_type::int_type 		int_type;
      typedef typename traits_type::pos_type 		pos_type;
      typedef typename traits_type::off_type 		off_type;

      //@{
      /**
       *  @if maint
       *  @doctodo
       *  @endif
      */
      typedef basic_streambuf<char_type, traits_type>  	__streambuf_type;
      typedef basic_filebuf<char_type, traits_type>     __filebuf_type;
      typedef __basic_file<char>		        __file_type;
      typedef typename traits_type::state_type          __state_type;
      typedef codecvt<char_type, char, __state_type>    __codecvt_type;
      typedef ctype<char_type>                          __ctype_type;
      //@}

      friend class ios_base; // For sync_with_stdio.

    protected:
      // Data Members:
      // MT lock inherited from libio or other low-level io library.
      /**
       *  @if maint
       *  @doctodo
       *  @endif
      */
      __c_lock          	_M_lock;

      // External buffer.
      /**
       *  @if maint
       *  @doctodo
       *  @endif
      */
      __file_type 		_M_file;

      // Current and beginning state type for codecvt.
      /**
       *  @if maint
       *  @doctodo
       *  @endif
      */
      __state_type		_M_state_cur;
      __state_type 		_M_state_beg;

      // Set iff _M_buf is allocated memory from _M_allocate_internal_buffer.
      /**
       *  @if maint
       *  @doctodo
       *  @endif
      */
      bool			_M_buf_allocated;
      
      // XXX Needed?
      bool			_M_last_overflowed;

      // The position in the buffer corresponding to the external file
      // pointer.
      /**
       *  @if maint
       *  @doctodo
       *  @endif
      */
      char_type*		_M_filepos;

    public:
      // Constructors/destructor:
      /**
       *  @brief  Does not open any files.
       *
       *  The default constructor initializes the parent class using its
       *  own default ctor.
      */
      basic_filebuf();

      /**
       *  @brief  The destructor closes the file first.
      */
      virtual
      ~basic_filebuf()
      {
	this->close();
	_M_last_overflowed = false;
      }

      // Members:
      /**
       *  @brief  Returns true if the external file is open.
      */
      bool
      is_open() const throw() { return _M_file.is_open(); }

      /**
       *  @brief  Opens an external file.
       *  @param  s  The name of the file.
       *  @param  mode  The open mode flags.
       *  @return  @c this on success, NULL on failure
       *
       *  If a file is already open, this function immediately fails.
       *  Otherwise it tries to open the file named @a s using the flags
       *  given in @a mode.
       *
       *  [Table 92 gives the relation between openmode combinations and the
       *  equivalent fopen() flags, but the table has not been copied yet.]
      */
      __filebuf_type*
      open(const char* __s, ios_base::openmode __mode);

      /**
       *  @brief  Closes the currently associated file.
       *  @return  @c this on success, NULL on failure
       *
       *  If no file is currently open, this function immediately fails.
       *
       *  If a "put buffer area" exists, @c overflow(eof) is called to flush
       *  all the characters.  The file is then closed.
       *
       *  If any operations fail, this function also fails.
      */
      __filebuf_type*
      close() throw();

    protected:
      /**
       *  @if maint
       *  @doctodo
       *  @endif
      */
      void
      _M_allocate_internal_buffer();

      /**
       *  @if maint
       *  @doctodo
       *  @endif
      */
      void
      _M_destroy_internal_buffer() throw();

      // [27.8.1.4] overridden virtual functions
      // [documentation is inherited]
      virtual streamsize
      showmanyc();

      // Stroustrup, 1998, p. 628
      // underflow() and uflow() functions are called to get the next
      // charater from the real input source when the buffer is empty.
      // Buffered input uses underflow()

      // The only difference between underflow() and uflow() is that the
      // latter bumps _M_in_cur after the read.  In the sync_with_stdio
      // case, this is important, as we need to unget the read character in
      // the underflow() case in order to maintain synchronization.  So
      // instead of calling underflow() from uflow(), we create a common
      // subroutine to do the real work.
      /**
       *  @if maint
       *  @doctodo
       *  @endif
      */
      int_type
      _M_underflow_common(bool __bump);

      // [documentation is inherited]
      virtual int_type
      underflow();

      // [documentation is inherited]
      virtual int_type
      uflow();

      // [documentation is inherited]
      virtual int_type
      pbackfail(int_type __c = _Traits::eof());

      // NB: For what the standard expects of the overflow function,
      // see _M_really_overflow(), below. Because basic_streambuf's
      // sputc/sputn call overflow directly, and the complications of
      // this implementation's setting of the initial pointers all
      // equal to _M_buf when initializing, it seems essential to have
      // this in actuality be a helper function that checks for the
      // eccentricities of this implementation, and then call
      // overflow() if indeed the buffer is full.

      // [documentation is inherited]
      virtual int_type
      overflow(int_type __c = _Traits::eof());

      // Stroustrup, 1998, p 648
      // The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer charactersNULL on/ The overflow() function is called to transfer characters