sl@0: // (C) Copyright Jonathan Turkanis 2003.
sl@0: // Distributed under the Boost Software License, Version 1.0. (See accompanying
sl@0: // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt.)
sl@0: 
sl@0: // See http://www.boost.org/libs/iostreams for documentation.
sl@0: 
sl@0: //
sl@0: // Contains wrappers for standard file buffers, together
sl@0: // with convenience typedefs:
sl@0: //      - basic_file_source
sl@0: //      - basic_file_sink
sl@0: //      - basic_file
sl@0: //
sl@0: 
sl@0: #ifndef BOOST_IOSTREAMS_FILE_HPP_INCLUDED
sl@0: #define BOOST_IOSTREAMS_FILE_HPP_INCLUDED
sl@0: 
sl@0: #if defined(_MSC_VER) && (_MSC_VER >= 1020)
sl@0: # pragma once
sl@0: #endif
sl@0: 
sl@0: #include <boost/iostreams/detail/config/wide_streams.hpp>
sl@0: #ifndef BOOST_IOSTREAMS_NO_LOCALE
sl@0: # include <locale>
sl@0: #endif
sl@0: #include <string>                               // pathnames, char_traits.
sl@0: #include <boost/iostreams/categories.hpp>
sl@0: #include <boost/iostreams/detail/ios.hpp>       // openmode, seekdir, int types.
sl@0: #include <boost/iostreams/detail/fstream.hpp>
sl@0: #include <boost/iostreams/operations.hpp>       // seek.
sl@0: #include <boost/shared_ptr.hpp>      
sl@0: 
sl@0: // Must come last.
sl@0: #include <boost/iostreams/detail/config/disable_warnings.hpp>  // MSVC.
sl@0: 
sl@0: namespace boost { namespace iostreams {
sl@0: 
sl@0: template<typename Ch>
sl@0: class basic_file {
sl@0: public:
sl@0:     typedef Ch char_type;
sl@0:     struct category
sl@0:         : public seekable_device_tag,
sl@0:           public closable_tag,
sl@0:           public localizable_tag
sl@0:         { };
sl@0:     basic_file( const std::string& path,
sl@0:                 BOOST_IOS::openmode mode =
sl@0:                     BOOST_IOS::in | BOOST_IOS::out,
sl@0:                 BOOST_IOS::openmode base_mode =
sl@0:                     BOOST_IOS::in | BOOST_IOS::out );
sl@0:     std::streamsize read(char_type* s, std::streamsize n);
sl@0:     std::streamsize write(const char_type* s, std::streamsize n);
sl@0:     stream_offset seek( stream_offset off, BOOST_IOS::seekdir way, 
sl@0:                         BOOST_IOS::openmode which = 
sl@0:                             BOOST_IOS::in | BOOST_IOS::out );
sl@0:     void open( const std::string& path,
sl@0:                BOOST_IOS::openmode mode =
sl@0:                    BOOST_IOS::in | BOOST_IOS::out,
sl@0:                BOOST_IOS::openmode base_mode =
sl@0:                    BOOST_IOS::in | BOOST_IOS::out );
sl@0:     bool is_open() const;
sl@0:     void close();
sl@0: #ifndef BOOST_IOSTREAMS_NO_LOCALE
sl@0:     void imbue(const std::locale& loc) { pimpl_->file_.pubimbue(loc);  }
sl@0: #endif
sl@0: private:
sl@0:     struct impl {
sl@0:         impl(const std::string& path, BOOST_IOS::openmode mode)
sl@0:             { file_.open(path.c_str(), mode); }
sl@0:         ~impl() { if (file_.is_open()) file_.close(); }
sl@0:         BOOST_IOSTREAMS_BASIC_FILEBUF(Ch) file_;
sl@0:     };
sl@0:     shared_ptr<impl> pimpl_;
sl@0: };
sl@0: 
sl@0: typedef basic_file<char>     file;
sl@0: typedef basic_file<wchar_t>  wfile;
sl@0: 
sl@0: template<typename Ch>
sl@0: struct basic_file_source : private basic_file<Ch> {
sl@0:     typedef Ch char_type;
sl@0:     struct category
sl@0:         : input_seekable,
sl@0:           device_tag,
sl@0:           closable_tag
sl@0:         { };
sl@0:     using basic_file<Ch>::read;
sl@0:     using basic_file<Ch>::seek;
sl@0:     using basic_file<Ch>::is_open;
sl@0:     using basic_file<Ch>::close;
sl@0:     basic_file_source( const std::string& path,
sl@0:                        BOOST_IOS::openmode mode = 
sl@0:                            BOOST_IOS::in )
sl@0:         : basic_file<Ch>(path, mode & ~BOOST_IOS::out, BOOST_IOS::in)
sl@0:         { }
sl@0:     void open( const std::string& path,
sl@0:                BOOST_IOS::openmode mode = BOOST_IOS::in )
sl@0:     {
sl@0:         basic_file<Ch>::open(path, mode & ~BOOST_IOS::out, BOOST_IOS::in);
sl@0:     }
sl@0: };
sl@0: 
sl@0: typedef basic_file_source<char>     file_source;
sl@0: typedef basic_file_source<wchar_t>  wfile_source;
sl@0: 
sl@0: template<typename Ch>
sl@0: struct basic_file_sink : private basic_file<Ch> {
sl@0:     typedef Ch char_type;
sl@0:     struct category
sl@0:         : output_seekable,
sl@0:           device_tag,
sl@0:           closable_tag
sl@0:         { };
sl@0:     using basic_file<Ch>::write;
sl@0:     using basic_file<Ch>::seek;
sl@0:     using basic_file<Ch>::is_open;
sl@0:     using basic_file<Ch>::close;
sl@0:     basic_file_sink( const std::string& path,
sl@0:                      BOOST_IOS::openmode mode = BOOST_IOS::out )
sl@0:         : basic_file<Ch>(path, mode & ~BOOST_IOS::in, BOOST_IOS::out)
sl@0:         { }
sl@0:     void open( const std::string& path,
sl@0:                BOOST_IOS::openmode mode = BOOST_IOS::out )
sl@0:     {
sl@0:         basic_file<Ch>::open(path, mode & ~BOOST_IOS::in, BOOST_IOS::out);
sl@0:     }
sl@0: };
sl@0: 
sl@0: typedef basic_file_sink<char>     file_sink;
sl@0: typedef basic_file_sink<wchar_t>  wfile_sink;
sl@0:                                  
sl@0: //------------------Implementation of basic_file------------------------------//
sl@0: 
sl@0: template<typename Ch>
sl@0: basic_file<Ch>::basic_file
sl@0:     ( const std::string& path, BOOST_IOS::openmode mode, 
sl@0:       BOOST_IOS::openmode base_mode )
sl@0: { 
sl@0:     open(path, mode, base_mode);
sl@0: }
sl@0: 
sl@0: template<typename Ch>
sl@0: inline std::streamsize basic_file<Ch>::read
sl@0:     (char_type* s, std::streamsize n)
sl@0: { 
sl@0:     std::streamsize result = pimpl_->file_.sgetn(s, n); 
sl@0:     return result != 0 ? result : -1;
sl@0: }
sl@0: 
sl@0: template<typename Ch>
sl@0: inline std::streamsize basic_file<Ch>::write
sl@0:     (const char_type* s, std::streamsize n)
sl@0: { return pimpl_->file_.sputn(s, n); }
sl@0: 
sl@0: template<typename Ch>
sl@0: stream_offset basic_file<Ch>::seek
sl@0:     ( stream_offset off, BOOST_IOS::seekdir way, 
sl@0:       BOOST_IOS::openmode )
sl@0: { return iostreams::seek(pimpl_->file_, off, way); }
sl@0: 
sl@0: template<typename Ch>
sl@0: void basic_file<Ch>::open
sl@0:     ( const std::string& path, BOOST_IOS::openmode mode, 
sl@0:       BOOST_IOS::openmode base_mode )
sl@0: { 
sl@0:     pimpl_.reset(new impl(path, mode | base_mode));
sl@0: }
sl@0: 
sl@0: template<typename Ch>
sl@0: bool basic_file<Ch>::is_open() const { return pimpl_->file_.is_open(); }
sl@0: 
sl@0: template<typename Ch>
sl@0: void basic_file<Ch>::close() { pimpl_->file_.close(); }
sl@0: 
sl@0: //----------------------------------------------------------------------------//
sl@0: 
sl@0: } } // End namespaces iostreams, boost.
sl@0: 
sl@0: #include <boost/iostreams/detail/config/enable_warnings.hpp> // MSVC
sl@0: 
sl@0: #endif // #ifndef BOOST_IOSTREAMS_FILE_HPP_INCLUDED