Chris@16: // (C) Copyright 2008 CodeRage, LLC (turkanis at coderage dot com)
Chris@16: // (C) Copyright 2003-2007 Jonathan Turkanis
Chris@16: // Distributed under the Boost Software License, Version 1.0. (See accompanying
Chris@16: // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt.)
Chris@16: 
Chris@16: // See http://www.boost.org/libs/iostreams for documentation.
Chris@16: 
Chris@16: // Inspired by fdstream.hpp, (C) Copyright Nicolai M. Josuttis 2001,
Chris@16: // available at http://www.josuttis.com/cppcode/fdstream.html.
Chris@16: 
Chris@16: #ifndef BOOST_IOSTREAMS_FILE_DESCRIPTOR_HPP_INCLUDED
Chris@16: #define BOOST_IOSTREAMS_FILE_DESCRIPTOR_HPP_INCLUDED
Chris@16: 
Chris@16: #if defined(_MSC_VER) && (_MSC_VER >= 1020)
Chris@16: # pragma once
Chris@16: #endif
Chris@16: 
Chris@16: #include <string>
Chris@16: #include <boost/cstdint.hpp>               // intmax_t.
Chris@16: #include <boost/iostreams/categories.hpp>  // tags.
Chris@16: #include <boost/iostreams/detail/config/auto_link.hpp>
Chris@16: #include <boost/iostreams/detail/config/dyn_link.hpp>
Chris@16: #include <boost/iostreams/detail/config/windows_posix.hpp>
Chris@16: #include <boost/iostreams/detail/file_handle.hpp>
Chris@16: #include <boost/iostreams/detail/ios.hpp>  // openmode, seekdir, int types.
Chris@16: #include <boost/iostreams/detail/path.hpp>
Chris@16: #include <boost/iostreams/positioning.hpp>
Chris@16: #include <boost/shared_ptr.hpp>
Chris@16: 
Chris@16: // Must come last.
Chris@16: #include <boost/config/abi_prefix.hpp>
Chris@16: 
Chris@16: namespace boost { namespace iostreams {
Chris@16: 
Chris@16: // Forward declarations
Chris@16: class file_descriptor_source;
Chris@16: class file_descriptor_sink;
Chris@16: namespace detail { struct file_descriptor_impl; }
Chris@16: 
Chris@16: enum file_descriptor_flags
Chris@16: {
Chris@16:     never_close_handle = 0,
Chris@16:     close_handle = 3
Chris@16: };
Chris@16: 
Chris@16: class BOOST_IOSTREAMS_DECL file_descriptor {
Chris@16: public:
Chris@16:     friend class file_descriptor_source;
Chris@16:     friend class file_descriptor_sink;
Chris@16:     typedef detail::file_handle  handle_type;
Chris@16:     typedef char                 char_type;
Chris@16:     struct category
Chris@16:         : seekable_device_tag,
Chris@16:           closable_tag
Chris@16:         { };
Chris@16: 
Chris@16:     // Default constructor
Chris@16:     file_descriptor();
Chris@16: 
Chris@16:     // Constructors taking file desciptors
Chris@16:     file_descriptor(handle_type fd, file_descriptor_flags);
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     file_descriptor(int fd, file_descriptor_flags);
Chris@16: #endif
Chris@16: 
Chris@16: #if defined(BOOST_IOSTREAMS_USE_DEPRECATED)
Chris@16:     // Constructors taking file desciptors
Chris@16:     explicit file_descriptor(handle_type fd, bool close_on_exit = false);
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     explicit file_descriptor(int fd, bool close_on_exit = false);
Chris@16: #endif
Chris@16: #endif
Chris@16: 
Chris@16:     // Constructor taking a std:: string
Chris@16:     explicit file_descriptor( const std::string& path,
Chris@16:                               BOOST_IOS::openmode mode =
Chris@16:                                   BOOST_IOS::in | BOOST_IOS::out );
Chris@16: 
Chris@16:     // Constructor taking a C-style string
Chris@16:     explicit file_descriptor( const char* path,
Chris@16:                               BOOST_IOS::openmode mode =
Chris@16:                                   BOOST_IOS::in | BOOST_IOS::out );
Chris@16: 
Chris@16:     // Constructor taking a Boost.Filesystem path
Chris@16:     template<typename Path>
Chris@16:     explicit file_descriptor( const Path& path,
Chris@16:                               BOOST_IOS::openmode mode =
Chris@16:                                   BOOST_IOS::in | BOOST_IOS::out )
Chris@16:     { 
Chris@16:         init();
Chris@16:         open(detail::path(path), mode); 
Chris@16:     }
Chris@16: 
Chris@16:     // Copy constructor
Chris@16:     file_descriptor(const file_descriptor& other);
Chris@16: 
Chris@16:     // open overloads taking file descriptors
Chris@16:     void open(handle_type fd, file_descriptor_flags);
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     void open(int fd, file_descriptor_flags);
Chris@16: #endif
Chris@16: 
Chris@16: #if defined(BOOST_IOSTREAMS_USE_DEPRECATED)
Chris@16:     // open overloads taking file descriptors
Chris@16:     void open(handle_type fd, bool close_on_exit = false);
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     void open(int fd, bool close_on_exit = false);
Chris@16: #endif
Chris@16: #endif
Chris@16: 
Chris@16:     // open overload taking a std::string
Chris@16:     void open( const std::string& path,
Chris@16:                BOOST_IOS::openmode mode =
Chris@16:                    BOOST_IOS::in | BOOST_IOS::out );
Chris@16: 
Chris@16:     // open overload taking C-style string
Chris@16:     void open( const char* path,
Chris@16:                BOOST_IOS::openmode mode =
Chris@16:                    BOOST_IOS::in | BOOST_IOS::out );
Chris@16: 
Chris@16:     // open overload taking a Boost.Filesystem path
Chris@16:     template<typename Path>
Chris@16:     void open( const Path& path,
Chris@16:                BOOST_IOS::openmode mode =
Chris@16:                    BOOST_IOS::in | BOOST_IOS::out )
Chris@16:     { open(detail::path(path), mode); }
Chris@16: 
Chris@16:     bool is_open() const;
Chris@16:     void close();
Chris@16:     std::streamsize read(char_type* s, std::streamsize n);
Chris@16:     std::streamsize write(const char_type* s, std::streamsize n);
Chris@16:     std::streampos seek(stream_offset off, BOOST_IOS::seekdir way);
Chris@16:     handle_type handle() const;
Chris@16: private:
Chris@16:     void init();
Chris@16: 
Chris@16:     // open overload taking a detail::path
Chris@16:     void open( const detail::path& path, 
Chris@16:                BOOST_IOS::openmode, 
Chris@16:                BOOST_IOS::openmode = BOOST_IOS::openmode(0) );
Chris@16: 
Chris@16:     typedef detail::file_descriptor_impl impl_type;
Chris@16:     shared_ptr<impl_type> pimpl_;
Chris@16: };
Chris@16: 
Chris@16: class BOOST_IOSTREAMS_DECL file_descriptor_source : private file_descriptor {
Chris@16: public:
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     typedef void*  handle_type;  // A.k.a HANDLE
Chris@16: #else
Chris@16:     typedef int    handle_type;
Chris@16: #endif
Chris@16:     typedef char   char_type;
Chris@16:     struct category
Chris@16:       : input_seekable,
Chris@16:         device_tag,
Chris@16:         closable_tag
Chris@16:       { };
Chris@16:     using file_descriptor::is_open;
Chris@16:     using file_descriptor::close;
Chris@16:     using file_descriptor::read;
Chris@16:     using file_descriptor::seek;
Chris@16:     using file_descriptor::handle;
Chris@16: 
Chris@16:     // Default constructor
Chris@16:     file_descriptor_source() { }
Chris@16: 
Chris@16:     // Constructors taking file desciptors
Chris@16:     explicit file_descriptor_source(handle_type fd, file_descriptor_flags);
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     explicit file_descriptor_source(int fd, file_descriptor_flags);
Chris@16: #endif
Chris@16: 
Chris@16: #if defined(BOOST_IOSTREAMS_USE_DEPRECATED)
Chris@16:     // Constructors taking file desciptors
Chris@16:     explicit file_descriptor_source(handle_type fd, bool close_on_exit = false);
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     explicit file_descriptor_source(int fd, bool close_on_exit = false);
Chris@16: #endif
Chris@16: #endif
Chris@16: 
Chris@16:     // Constructor taking a std:: string
Chris@16:     explicit file_descriptor_source( const std::string& path,
Chris@16:                                      BOOST_IOS::openmode mode = BOOST_IOS::in );
Chris@16: 
Chris@16:     // Constructor taking a C-style string
Chris@16:     explicit file_descriptor_source( const char* path,
Chris@16:                                      BOOST_IOS::openmode mode = BOOST_IOS::in );
Chris@16: 
Chris@16:     // Constructor taking a Boost.Filesystem path
Chris@16:     template<typename Path>
Chris@16:     explicit file_descriptor_source( const Path& path,
Chris@16:                                      BOOST_IOS::openmode mode = BOOST_IOS::in )
Chris@16:     { open(detail::path(path), mode); }
Chris@16: 
Chris@16:     // Copy constructor
Chris@16:     file_descriptor_source(const file_descriptor_source& other);
Chris@16: 
Chris@16:     // Constructors taking file desciptors
Chris@16:     void open(handle_type fd, file_descriptor_flags);
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     void open(int fd, file_descriptor_flags);
Chris@16: #endif
Chris@16: 
Chris@16: #if defined(BOOST_IOSTREAMS_USE_DEPRECATED)
Chris@16:     // open overloads taking file descriptors
Chris@16:     void open(handle_type fd, bool close_on_exit = false);
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     void open(int fd, bool close_on_exit = false);
Chris@16: #endif
Chris@16: #endif
Chris@16: 
Chris@16:     // open overload taking a std::string
Chris@16:     void open(const std::string& path, BOOST_IOS::openmode mode = BOOST_IOS::in);
Chris@16: 
Chris@16:     // open overload taking C-style string
Chris@16:     void open(const char* path, BOOST_IOS::openmode mode = BOOST_IOS::in);
Chris@16: 
Chris@16:     // open overload taking a Boost.Filesystem path
Chris@16:     template<typename Path>
Chris@16:     void open(const Path& path, BOOST_IOS::openmode mode = BOOST_IOS::in);
Chris@16: private:
Chris@16: 
Chris@16:     // open overload taking a detail::path
Chris@16:     void open(const detail::path& path, BOOST_IOS::openmode);
Chris@16: };
Chris@16: 
Chris@16: class BOOST_IOSTREAMS_DECL file_descriptor_sink : private file_descriptor {
Chris@16: public:
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     typedef void*  handle_type;  // A.k.a HANDLE
Chris@16: #else
Chris@16:     typedef int    handle_type;
Chris@16: #endif
Chris@16:     typedef char   char_type;
Chris@16:     struct category
Chris@16:       : output_seekable,
Chris@16:         device_tag,
Chris@16:         closable_tag
Chris@16:       { };
Chris@16:     using file_descriptor::is_open;
Chris@16:     using file_descriptor::close;
Chris@16:     using file_descriptor::write;
Chris@16:     using file_descriptor::seek;
Chris@16:     using file_descriptor::handle;
Chris@16: 
Chris@16:     // Default constructor
Chris@16:     file_descriptor_sink() { }
Chris@16: 
Chris@16:     // Constructors taking file desciptors
Chris@16:     file_descriptor_sink(handle_type fd, file_descriptor_flags);
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     file_descriptor_sink(int fd, file_descriptor_flags);
Chris@16: #endif
Chris@16: 
Chris@16: #if defined(BOOST_IOSTREAMS_USE_DEPRECATED)
Chris@16:     // Constructors taking file desciptors
Chris@16:     explicit file_descriptor_sink(handle_type fd, bool close_on_exit = false);
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     explicit file_descriptor_sink(int fd, bool close_on_exit = false);
Chris@16: #endif
Chris@16: #endif
Chris@16: 
Chris@16:     // Constructor taking a std:: string
Chris@16:     explicit file_descriptor_sink( const std::string& path,
Chris@16:                                    BOOST_IOS::openmode mode = BOOST_IOS::out );
Chris@16: 
Chris@16:     // Constructor taking a C-style string
Chris@16:     explicit file_descriptor_sink( const char* path,
Chris@16:                                    BOOST_IOS::openmode mode = BOOST_IOS::out );
Chris@16: 
Chris@16:     // Constructor taking a Boost.Filesystem path
Chris@16:     template<typename Path>
Chris@16:     explicit file_descriptor_sink( const Path& path,
Chris@16:                                    BOOST_IOS::openmode mode = BOOST_IOS::out )
Chris@16:     { open(detail::path(path), mode); }
Chris@16: 
Chris@16:     // Copy constructor
Chris@16:     file_descriptor_sink(const file_descriptor_sink& other);
Chris@16: 
Chris@16:     // open overloads taking file descriptors
Chris@16:     void open(handle_type fd, file_descriptor_flags);
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     void open(int fd, file_descriptor_flags);
Chris@16: #endif
Chris@16: 
Chris@16: #if defined(BOOST_IOSTREAMS_USE_DEPRECATED)
Chris@16:     // open overloads taking file descriptors
Chris@16:     void open(handle_type fd, bool close_on_exit = false);
Chris@16: #ifdef BOOST_IOSTREAMS_WINDOWS
Chris@16:     void open(int fd, bool close_on_exit = false);
Chris@16: #endif
Chris@16: #endif
Chris@16: 
Chris@16:     // open overload taking a std::string
Chris@16:     void open( const std::string& path, 
Chris@16:                BOOST_IOS::openmode mode = BOOST_IOS::out );
Chris@16: 
Chris@16:     // open overload taking C-style string
Chris@16:     void open( const char* path, 
Chris@16:                BOOST_IOS::openmode mode = BOOST_IOS::out );
Chris@16: 
Chris@16:     // open overload taking a Boost.Filesystem path
Chris@16:     template<typename Path>
Chris@16:     void open( const Path& path, 
Chris@16:                BOOST_IOS::openmode mode = BOOST_IOS::out )
Chris@16:     { open(detail::path(path), mode); }
Chris@16: private:
Chris@16: 
Chris@16:     // open overload taking a detail::path
Chris@16:     void open(const detail::path& path, BOOST_IOS::openmode);
Chris@16: };
Chris@16: 
Chris@16: } } // End namespaces iostreams, boost.
Chris@16: 
Chris@16: #include <boost/config/abi_suffix.hpp> // pops abi_suffix.hpp pragmas
Chris@16: 
Chris@16: #endif // #ifndef BOOST_IOSTREAMS_FILE_DESCRIPTOR_HPP_INCLUDED