Define Boost-Filesystem-specific macros for platform API selection.

Because Boost.System has switched to define BOOST_POSIX_API on Cygwin[1],
Boost.Filesystem now defines its own set of macros for platform API
selection. At this time, we preserve the previous behavior, where
Cygwin is treated as Windows.

[1]: boostorg/system#137

Author: Lastique

doc/release_history.html

@@ -40,6 +40,11 @@
   </tr>
 </table>
 
+<h2>1.91.0</h2>
+<ul>
+  <li>Due to a change in Boost.System, Boost.Filesystem now defines and uses its own platform macros <code>BOOST_FILESYSTEM_POSIX_API</code> and <code>BOOST_FILESYSTEM_WINDOWS_API</code>. These macros may not necessarily match the old <code>BOOST_POSIX_API</code> and <code>BOOST_WINDOWS_API</code> macros defined by Boost.System.</li>
+</ul>
+
 <h2>1.90.0</h2>
 <ul>
   <li>Clear passed <code>error_code</code> argument on successful completion of the <code>permissions</code> operation. (<a href="https://github.com/boostorg/filesystem/pull/338">PR#338</a>)</li>

doc/tutorial.html

@@ -1000,9 +1000,9 @@ <h2><a name="Class path-iterators-etc">Class path: Iterators, observers, composi
     cout &lt;&lt; &quot;Usage: path_info path-element [path-element...]\n&quot;
             &quot;Composes a path via operator/= from one or more path-element arguments\n&quot;
             &quot;Example: path_info foo/bar baz\n&quot;
-#            ifdef BOOST_POSIX_API
+#            ifdef BOOST_FILESYSTEM_POSIX_API
             &quot;         would report info about the composed path foo/bar/baz\n&quot;;
-#            else  // BOOST_WINDOWS_API
+#            else  // BOOST_FILESYSTEM_WINDOWS_API
             &quot;         would report info about the composed path foo/bar\\baz\n&quot;;
 #            endif
     return 1;
@@ -1021,10 +1021,10 @@ <h2><a name="Class path-iterators-etc">Class path: Iterators, observers, composi
     cout &lt;&lt; &quot;  &quot; &lt;&lt; element &lt;&lt; '\n';
 
   cout  &lt;&lt;  &quot;\nobservers, native format:&quot; &lt;&lt; endl;
-# ifdef BOOST_POSIX_API
+# ifdef BOOST_FILESYSTEM_POSIX_API
   cout  &lt;&lt;  &quot;  native()-------------: &quot; &lt;&lt; p.native() &lt;&lt; endl;
   cout  &lt;&lt;  &quot;  c_str()--------------: &quot; &lt;&lt; p.c_str() &lt;&lt; endl;
-# else  // BOOST_WINDOWS_API
+# else  // BOOST_FILESYSTEM_WINDOWS_API
   wcout &lt;&lt; L&quot;  native()-------------: &quot; &lt;&lt; p.native() &lt;&lt; endl;
   wcout &lt;&lt; L&quot;  c_str()--------------: &quot; &lt;&lt; p.c_str() &lt;&lt; endl;
 # endif
@@ -1229,10 +1229,10 @@ <h2><a name="Class path-iterators-etc">Class path: Iterators, observers, composi
   <tr>
     <td>
       <pre><!-- include file "../example/path_info.cpp" -->  cout  &lt;&lt;  &quot;\nobservers, native format:&quot; &lt;&lt; endl;
-# ifdef BOOST_POSIX_API
+# ifdef BOOST_FILESYSTEM_POSIX_API
   cout  &lt;&lt;  &quot;  native()-------------: &quot; &lt;&lt; p.native() &lt;&lt; endl;
   cout  &lt;&lt;  &quot;  c_str()--------------: &quot; &lt;&lt; p.c_str() &lt;&lt; endl;
-# else  // BOOST_WINDOWS_API
+# else  // BOOST_FILESYSTEM_WINDOWS_API
   wcout &lt;&lt; L&quot;  native()-------------: &quot; &lt;&lt; p.native() &lt;&lt; endl;
   wcout &lt;&lt; L&quot;  c_str()--------------: &quot; &lt;&lt; p.c_str() &lt;&lt; endl;
 # endif

example/path_info.cpp

@@ -25,9 +25,9 @@ int main(int argc, char* argv[])
         cout << "Usage: path_info path-element [path-element...]\n"
                 "Composes a path via operator/= from one or more path-element arguments\n"
                 "Example: path_info foo/bar baz\n"
-#ifdef BOOST_POSIX_API
+#ifdef BOOST_FILESYSTEM_POSIX_API
                 "         would report info about the composed path foo/bar/baz\n";
-#else // BOOST_WINDOWS_API
+#else // BOOST_FILESYSTEM_WINDOWS_API
                 "         would report info about the composed path foo/bar\\baz\n";
 #endif
         return 1;
@@ -46,10 +46,10 @@ int main(int argc, char* argv[])
         cout << "  " << element << '\n';
 
     cout << "\nobservers, native format:" << endl;
-#ifdef BOOST_POSIX_API
+#ifdef BOOST_FILESYSTEM_POSIX_API
     cout << "  native()-------------: " << p.native() << endl;
     cout << "  c_str()--------------: " << p.c_str() << endl;
-#else // BOOST_WINDOWS_API
+#else // BOOST_FILESYSTEM_WINDOWS_API
     wcout << L"  native()-------------: " << p.native() << endl;
     wcout << L"  c_str()--------------: " << p.c_str() << endl;
 #endif

include/boost/filesystem/config.hpp

@@ -17,7 +17,6 @@
 // http://www.boost.org/more/separate_compilation.html
 
 #include <boost/config.hpp>
-#include <boost/system/api_config.hpp> // for BOOST_POSIX_API or BOOST_WINDOWS_API
 #include <boost/detail/workaround.hpp>
 
 #if defined(BOOST_FILESYSTEM_VERSION) && BOOST_FILESYSTEM_VERSION != 3 && BOOST_FILESYSTEM_VERSION != 4
@@ -54,6 +53,19 @@
 #error Both BOOST_FILESYSTEM_DEPRECATED and BOOST_FILESYSTEM_NO_DEPRECATED are defined
 #endif
 
+//  BOOST_FILESYSTEM_WINDOWS_API or BOOST_FILESYSTEM_POSIX_API -------------------------//
+
+#if defined(BOOST_FILESYSTEM_WINDOWS_API) || defined(BOOST_FILESYSTEM_POSIX_API)
+#error BOOST_FILESYSTEM_WINDOWS_API and BOOST_FILESYSTEM_POSIX_API must not be defined by users
+#endif
+
+// Cygwin is treated as Windows to minimize path character code conversions
+#if defined(_WIN32) || defined(__WIN32__) || defined(WIN32) || defined(__CYGWIN__)
+#define BOOST_FILESYSTEM_WINDOWS_API
+#else
+#define BOOST_FILESYSTEM_POSIX_API
+#endif
+
 //  throw an exception  ----------------------------------------------------------------//
 //
 //  Exceptions were originally thrown via boost::throw_exception().

include/boost/filesystem/cstdio.hpp

@@ -15,7 +15,7 @@
 #include <boost/filesystem/config.hpp>
 #include <boost/filesystem/path.hpp>
 #include <cstdio>
-#if defined(BOOST_WINDOWS_API)
+#if defined(BOOST_FILESYSTEM_WINDOWS_API)
 #include <wchar.h>
 #include <cstddef>
 #include <cstring>
@@ -27,7 +27,7 @@
 namespace boost {
 namespace filesystem {
 
-#if defined(BOOST_WINDOWS_API)
+#if defined(BOOST_FILESYSTEM_WINDOWS_API)
 
 inline std::FILE* fopen(filesystem::path const& p, const char* mode)
 {
@@ -70,14 +70,14 @@ inline std::FILE* fopen(filesystem::path const& p, const char* mode)
 #endif
 }
 
-#else // defined(BOOST_WINDOWS_API)
+#else // defined(BOOST_FILESYSTEM_WINDOWS_API)
 
 inline std::FILE* fopen(filesystem::path const& p, const char* mode)
 {
     return std::fopen(p.c_str(), mode);
 }
 
-#endif // defined(BOOST_WINDOWS_API)
+#endif // defined(BOOST_FILESYSTEM_WINDOWS_API)
 
 } // namespace filesystem
 } // namespace boost

include/boost/filesystem/detail/path_traits.hpp

@@ -55,7 +55,7 @@ class directory_entry;
 namespace detail {
 namespace path_traits {
 
-#if defined(BOOST_WINDOWS_API)
+#if defined(BOOST_FILESYSTEM_WINDOWS_API)
 typedef wchar_t path_native_char_type;
 #define BOOST_FILESYSTEM_DETAIL_IS_CHAR_NATIVE false
 #define BOOST_FILESYSTEM_DETAIL_IS_WCHAR_T_NATIVE true

include/boost/filesystem/directory.hpp

@@ -632,7 +632,7 @@ namespace detail {
 struct dir_itr_imp :
     public boost::intrusive_ref_counter< dir_itr_imp >
 {
-#ifdef BOOST_WINDOWS_API
+#ifdef BOOST_FILESYSTEM_WINDOWS_API
     bool close_handle;
     unsigned char extra_data_format;
     std::size_t current_offset;
@@ -641,7 +641,7 @@ struct dir_itr_imp :
     void* handle;
 
     dir_itr_imp() noexcept :
-#ifdef BOOST_WINDOWS_API
+#ifdef BOOST_FILESYSTEM_WINDOWS_API
         close_handle(false),
         extra_data_format(0u),
         current_offset(0u),

include/boost/filesystem/fstream.hpp

@@ -20,7 +20,7 @@
 
 #include <boost/filesystem/detail/header.hpp> // must be the last #include
 
-#if defined(BOOST_WINDOWS_API)
+#if defined(BOOST_FILESYSTEM_WINDOWS_API)
 // On Windows, except for standard libaries known to have wchar_t overloads for
 // file stream I/O, use path::string() to get a narrow character c_str()
 #if (defined(_CPPLIB_VER) && _CPPLIB_VER >= 405 && !defined(_STLPORT_VERSION)) || \
@@ -40,7 +40,7 @@
 // Use narrow characters, since wide not available
 #define BOOST_FILESYSTEM_C_STR(p) p.string().c_str()
 #endif
-#endif // defined(BOOST_WINDOWS_API)
+#endif // defined(BOOST_FILESYSTEM_WINDOWS_API)
 
 #if !defined(BOOST_FILESYSTEM_C_STR)
 #define BOOST_FILESYSTEM_C_STR(p) p.c_str()

include/boost/filesystem/operations.hpp

@@ -603,7 +603,7 @@ inline path temp_directory_path(system::error_code& ec)
 }
 
 inline path unique_path(path const& p =
-#if defined(BOOST_WINDOWS_API)
+#if defined(BOOST_FILESYSTEM_WINDOWS_API)
     L"%%%%-%%%%-%%%%-%%%%"
 #else
     "%%%%-%%%%-%%%%-%%%%"
@@ -617,7 +617,7 @@ inline path unique_path(system::error_code& ec)
 {
     return detail::unique_path
     (
-#if defined(BOOST_WINDOWS_API)
+#if defined(BOOST_FILESYSTEM_WINDOWS_API)
         L"%%%%-%%%%-%%%%-%%%%",
 #else
         "%%%%-%%%%-%%%%-%%%%",

include/boost/filesystem/path.hpp

@@ -108,7 +108,7 @@ struct path_algorithms
     BOOST_FILESYSTEM_DECL static path generic_path_v3(path const& p);
     BOOST_FILESYSTEM_DECL static path generic_path_v4(path const& p);
 
-#if defined(BOOST_WINDOWS_API)
+#if defined(BOOST_FILESYSTEM_WINDOWS_API)
     BOOST_FILESYSTEM_DECL static void make_preferred_v3(path& p);
     BOOST_FILESYSTEM_DECL static void make_preferred_v4(path& p);
 #endif
@@ -160,7 +160,7 @@ struct path_algorithms
 
 class path :
     public filesystem::path_detail::path_constants<
-#ifdef BOOST_WINDOWS_API
+#ifdef BOOST_FILESYSTEM_WINDOWS_API
         detail::path_traits::path_native_char_type, L'/', L'\\', L'.'
 #else
         detail::path_traits::path_native_char_type, '/', '/', '.'
@@ -865,7 +865,7 @@ class path :
     template< typename String >
     String string(codecvt_type const& cvt) const;
 
-#ifdef BOOST_WINDOWS_API
+#ifdef BOOST_FILESYSTEM_WINDOWS_API
     std::string string() const
     {
         std::string tmp;
@@ -884,7 +884,7 @@ class path :
     //  string_type is std::wstring, so there is no conversion
     std::wstring const& wstring() const { return m_pathname; }
     std::wstring const& wstring(codecvt_type const&) const { return m_pathname; }
-#else // BOOST_POSIX_API
+#else // BOOST_FILESYSTEM_POSIX_API
     //  string_type is std::string, so there is no conversion
     std::string const& string() const { return m_pathname; }
     std::string const& string(codecvt_type const&) const { return m_pathname; }
@@ -1012,7 +1012,7 @@ class path :
     bool is_relative() const { return !is_absolute(); }
     bool is_absolute() const
     {
-#if defined(BOOST_WINDOWS_API)
+#if defined(BOOST_FILESYSTEM_WINDOWS_API)
         return has_root_name() && has_root_directory();
 #else
         return has_root_directory();
@@ -1343,12 +1343,12 @@ inline typename std::enable_if<
     std::size_t
 >::type hash_value(Path const& p) noexcept
 {
-#ifdef BOOST_WINDOWS_API
+#ifdef BOOST_FILESYSTEM_WINDOWS_API
     std::size_t seed = 0u;
     for (typename Path::value_type const* it = p.c_str(); *it; ++it)
         hash_combine(seed, *it == L'/' ? L'\\' : *it);
     return seed;
-#else // BOOST_POSIX_API
+#else // BOOST_FILESYSTEM_POSIX_API
     return hash_range(p.native().begin(), p.native().end());
 #endif
 }
@@ -1416,7 +1416,7 @@ namespace detail {
 inline bool is_directory_separator(path::value_type c) noexcept
 {
     return c == path::separator
-#ifdef BOOST_WINDOWS_API
+#ifdef BOOST_FILESYSTEM_WINDOWS_API
         || c == path::preferred_separator
 #endif
         ;
@@ -1425,7 +1425,7 @@ inline bool is_directory_separator(path::value_type c) noexcept
 inline bool is_element_separator(path::value_type c) noexcept
 {
     return c == path::separator
-#ifdef BOOST_WINDOWS_API
+#ifdef BOOST_FILESYSTEM_WINDOWS_API
         || c == path::preferred_separator || c == L':'
 #endif
         ;
@@ -1621,7 +1621,7 @@ BOOST_FORCEINLINE path path::generic_path() const
 BOOST_FORCEINLINE path& path::make_preferred()
 {
     // No effect on POSIX
-#if defined(BOOST_WINDOWS_API)
+#if defined(BOOST_FILESYSTEM_WINDOWS_API)
     BOOST_FILESYSTEM_VERSIONED_SYM(detail::path_algorithms::make_preferred)(*this);
 #endif
     return *this;