move implementations of file type to detail

Author: ashtum

include/boost/http_proto.hpp

@@ -18,12 +18,9 @@
 #include <boost/http_proto/fields_view.hpp>
 #include <boost/http_proto/fields_view_base.hpp>
 #include <boost/http_proto/file.hpp>
-#include <boost/http_proto/file_base.hpp>
-#include <boost/http_proto/file_posix.hpp>
+#include <boost/http_proto/file_mode.hpp>
 #include <boost/http_proto/file_sink.hpp>
 #include <boost/http_proto/file_source.hpp>
-#include <boost/http_proto/file_stdio.hpp>
-#include <boost/http_proto/file_win32.hpp>
 #include <boost/http_proto/header_limits.hpp>
 #include <boost/http_proto/message_base.hpp>
 #include <boost/http_proto/message_view_base.hpp>

include/boost/http_proto/file_posix.hpp …e/boost/http_proto/detail/file_posix.hppinclude/boost/http_proto/file_posix.hpp renamed to include/boost/http_proto/detail/file_posix.hpp include/boost/http_proto/file_posix.hpp renamed to include/boost/http_proto/detail/file_posix.hpp

@@ -7,8 +7,8 @@
 // Official repository: https://github.com/cppalliance/http_proto
 //
 
-#ifndef BOOST_HTTP_PROTO_FILE_POSIX_HPP
-#define BOOST_HTTP_PROTO_FILE_POSIX_HPP
+#ifndef BOOST_HTTP_PROTO_DETAIL_FILE_POSIX_HPP
+#define BOOST_HTTP_PROTO_DETAIL_FILE_POSIX_HPP
 
 #include <boost/http_proto/detail/config.hpp>
 
@@ -29,17 +29,15 @@
 #if BOOST_HTTP_PROTO_USE_POSIX_FILE
 
 #include <boost/http_proto/error.hpp>
-#include <boost/http_proto/file_base.hpp>
+#include <boost/http_proto/file_mode.hpp>
 #include <boost/system/error_code.hpp>
 #include <cstdint>
 
 namespace boost {
 namespace http_proto {
+namespace detail {
 
-/** An implementation of File for POSIX systems.
-
-    This class implements a <em>File</em> using POSIX interfaces.
-*/
+// Implementation of File for POSIX systems.
 class file_posix
 {
     int fd_ = -1;
@@ -50,141 +48,68 @@ class file_posix
     native_close(int& fd);
 
 public:
-    /** The type of the underlying file handle.
-
-        This is platform-specific.
-    */
     using native_handle_type = int;
 
-    /** Destructor
-
-        If the file is open it is first closed.
-    */
     BOOST_HTTP_PROTO_DECL
     ~file_posix();
 
-    /** Constructor
-
-        There is no open file initially.
-    */
     file_posix() = default;
 
-    /** Constructor
-
-        The moved-from object behaves as if default constructed.
-    */
     BOOST_HTTP_PROTO_DECL
     file_posix(
         file_posix&& other) noexcept;
 
-    /** Assignment
-
-        The moved-from object behaves as if default constructed.
-    */
     BOOST_HTTP_PROTO_DECL
     file_posix&
     operator=(
         file_posix&& other) noexcept;
 
-    /// Returns the native handle associated with the file.
     native_handle_type
     native_handle() const
     {
         return fd_;
     }
 
-    /** Set the native handle associated with the file.
-
-        If the file is open it is first closed.
-
-        @param fd The native file handle to assign.
-    */
     BOOST_HTTP_PROTO_DECL
     void
     native_handle(native_handle_type fd);
 
-    /// Returns `true` if the file is open
     bool
     is_open() const
     {
         return fd_ != -1;
     }
 
-    /** Close the file if open
-
-        @param ec Set to the error, if any occurred.
-    */
     BOOST_HTTP_PROTO_DECL
     void
     close(system::error_code& ec);
 
-    /** Open a file at the given path with the specified mode
-
-        @param path The utf-8 encoded path to the file
-
-        @param mode The file mode to use
-
-        @param ec Set to the error, if any occurred
-    */
     BOOST_HTTP_PROTO_DECL
     void
     open(char const* path, file_mode mode, system::error_code& ec);
 
-    /** Return the size of the open file
-
-        @param ec Set to the error, if any occurred
-
-        @return The size in bytes
-    */
     BOOST_HTTP_PROTO_DECL
     std::uint64_t
     size(system::error_code& ec) const;
 
-    /** Return the current position in the open file
-
-        @param ec Set to the error, if any occurred
-
-        @return The offset in bytes from the beginning of the file
-    */
     BOOST_HTTP_PROTO_DECL
     std::uint64_t
     pos(system::error_code& ec) const;
 
-    /** Adjust the current position in the open file
-
-        @param offset The offset in bytes from the beginning of the file
-
-        @param ec Set to the error, if any occurred
-    */
     BOOST_HTTP_PROTO_DECL
     void
     seek(std::uint64_t offset, system::error_code& ec);
 
-    /** Read from the open file
-
-        @param buffer The buffer for storing the result of the read
-
-        @param n The number of bytes to read
-
-        @param ec Set to the error, if any occurred
-    */
     BOOST_HTTP_PROTO_DECL
     std::size_t
     read(void* buffer, std::size_t n, system::error_code& ec) const;
 
-    /** Write to the open file
-
-        @param buffer The buffer holding the data to write
-
-        @param n The number of bytes to write
-
-        @param ec Set to the error, if any occurred
-    */
     BOOST_HTTP_PROTO_DECL
     std::size_t
     write(void const* buffer, std::size_t n, system::error_code& ec);
 };
 
+} // detail
 } // http_proto
 } // boost
 

include/boost/http_proto/detail/file_stdio.hpp

@@ -0,0 +1,94 @@
+//
+// Copyright (c) 2022 Vinnie Falco (vinnie.falco@gmail.com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+// Official repository: https://github.com/cppalliance/http_proto
+//
+
+#ifndef BOOST_HTTP_PROTO_DETAIL_FILE_STDIO_HPP
+#define BOOST_HTTP_PROTO_DETAIL_FILE_STDIO_HPP
+
+#include <boost/http_proto/detail/config.hpp>
+#include <boost/http_proto/error.hpp>
+#include <boost/http_proto/file_mode.hpp>
+#include <cstdio>
+#include <cstdint>
+
+namespace boost {
+namespace http_proto {
+namespace detail {
+
+// Implementation of File which uses cstdio.
+class file_stdio
+{
+    std::FILE* f_ = nullptr;
+
+public:
+    using native_handle_type = std::FILE*;
+
+    BOOST_HTTP_PROTO_DECL
+    ~file_stdio();
+
+    file_stdio() = default;
+
+    BOOST_HTTP_PROTO_DECL
+    file_stdio(
+        file_stdio&& other) noexcept;
+
+    BOOST_HTTP_PROTO_DECL
+    file_stdio&
+    operator=(
+        file_stdio&& other) noexcept;
+
+    std::FILE*
+    native_handle() const
+    {
+        return f_;
+    }
+
+    BOOST_HTTP_PROTO_DECL
+    void
+    native_handle(std::FILE* f);
+
+    bool
+    is_open() const
+    {
+        return f_ != nullptr;
+    }
+
+    BOOST_HTTP_PROTO_DECL
+    void
+    close(system::error_code& ec);
+
+    BOOST_HTTP_PROTO_DECL
+    void
+    open(char const* path, file_mode mode, system::error_code& ec);
+
+    BOOST_HTTP_PROTO_DECL
+    std::uint64_t
+    size(system::error_code& ec) const;
+
+    BOOST_HTTP_PROTO_DECL
+    std::uint64_t
+    pos(system::error_code& ec) const;
+
+    BOOST_HTTP_PROTO_DECL
+    void
+    seek(std::uint64_t offset, system::error_code& ec);
+
+    BOOST_HTTP_PROTO_DECL
+    std::size_t
+    read(void* buffer, std::size_t n, system::error_code& ec) const;
+
+    BOOST_HTTP_PROTO_DECL
+    std::size_t
+    write(void const* buffer, std::size_t n, system::error_code& ec);
+};
+
+} // detail
+} // http_proto
+} // boost
+
+#endif

include/boost/http_proto/detail/file_win32.hpp

@@ -0,0 +1,110 @@
+//
+// Copyright (c) 2022 Vinnie Falco (vinnie.falco@gmail.com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+// Official repository: https://github.com/cppalliance/http_proto
+//
+
+#ifndef BOOST_HTTP_PROTO_DETAIL_FILE_WIN32_HPP
+#define BOOST_HTTP_PROTO_DETAIL_FILE_WIN32_HPP
+
+#include <boost/http_proto/detail/config.hpp>
+
+#if ! defined(BOOST_HTTP_PROTO_USE_WIN32_FILE)
+# ifdef _WIN32
+#  define BOOST_HTTP_PROTO_USE_WIN32_FILE 1
+# else
+#  define BOOST_HTTP_PROTO_USE_WIN32_FILE 0
+# endif
+#endif
+
+#if BOOST_HTTP_PROTO_USE_WIN32_FILE
+
+#include <boost/http_proto/error.hpp>
+#include <boost/http_proto/file_base.hpp>
+#include <boost/winapi/basic_types.hpp>
+#include <boost/winapi/handles.hpp>
+#include <cstdio>
+#include <cstdint>
+
+namespace boost {
+namespace http_proto {
+namespace detail {
+
+// Implementation of File for Win32.
+class file_win32
+{
+    boost::winapi::HANDLE_ h_ =
+        boost::winapi::INVALID_HANDLE_VALUE_;
+
+public:
+    using native_handle_type = boost::winapi::HANDLE_;
+
+    BOOST_HTTP_PROTO_DECL
+    ~file_win32();
+
+    file_win32() = default;
+
+    BOOST_HTTP_PROTO_DECL
+    file_win32(
+        file_win32&& other) noexcept;
+
+    BOOST_HTTP_PROTO_DECL
+    file_win32&
+    operator=(
+        file_win32&& other) noexcept;
+
+    native_handle_type
+    native_handle()
+    {
+        return h_;
+    }
+
+    BOOST_HTTP_PROTO_DECL
+    void
+    native_handle(native_handle_type h);
+
+    bool
+    is_open() const
+    {
+        return h_ != boost::winapi::INVALID_HANDLE_VALUE_;
+    }
+
+    BOOST_HTTP_PROTO_DECL
+    void
+    close(system::error_code& ec);
+
+    BOOST_HTTP_PROTO_DECL
+    void
+    open(char const* path, file_mode mode, system::error_code& ec);
+
+    BOOST_HTTP_PROTO_DECL
+    std::uint64_t
+    size(system::error_code& ec) const;
+
+    BOOST_HTTP_PROTO_DECL
+    std::uint64_t
+    pos(system::error_code& ec);
+
+    BOOST_HTTP_PROTO_DECL
+    void
+    seek(std::uint64_t offset, system::error_code& ec);
+
+    BOOST_HTTP_PROTO_DECL
+    std::size_t
+    read(void* buffer, std::size_t n, system::error_code& ec);
+
+    BOOST_HTTP_PROTO_DECL
+    std::size_t
+    write(void const* buffer, std::size_t n, system::error_code& ec);
+};
+
+} // detail
+} // http_proto
+} // boost
+
+#endif
+
+#endif