...one of the most highly
regarded and expertly designed C++ library projects in the
world.
—
Herb Sutter
and
Andrei
Alexandrescu
,
C++
Coding Standards
boost/filesystem/fstream.hpp
// boost/filesystem/fstream.hpp ------------------------------------------------------//
// Distributed under the Boost Software License, Version 1.0.
// See
http://www.boost.org/LICENSE_1_0.txt
// Library home page:
http://www.boost.org/libs/filesystem
//--------------------------------------------------------------------------------------//
#ifndef BOOST_FILESYSTEM_FSTREAM_HPP
#define BOOST_FILESYSTEM_FSTREAM_HPP
#include <
boost/filesystem/config.hpp
>
#include <
boost/filesystem/path.hpp
>
#include <cstddef>
#include <iosfwd>
#include <fstream>
#include <
boost/filesystem/detail/header.hpp
> // must be the last #include
#if defined(BOOST_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)) || \
(defined(_LIBCPP_VERSION) && _LIBCPP_VERSION >= 7000 && defined(_LIBCPP_HAS_OPEN_WITH_WCHAR))
// Use wide characters directly
// Note: We don't use C++17 std::filesystem::path as a means to pass wide paths
// to file streams because of various problems:
// - std::filesystem is available in gcc 8 but it is broken there (fails to compile path definition
// on Windows). Compilation errors seem to be fixed since gcc 9.
// - In gcc 10.2 and clang 8.0.1 on Cygwin64, the path attempts to convert the wide string to narrow
// and fails in runtime. This may be system locale dependent, and performing character code conversion
// is against the purpose of using std::filesystem::path anyway.
// - Other std::filesystem implementations were not tested, so it is not known if they actually work
// with wide paths.
#define BOOST_FILESYSTEM_C_STR(p) p.c_str()
#else
// Use narrow characters, since wide not available
#define BOOST_FILESYSTEM_C_STR(p) p.string().c_str()
#endif
#endif // defined(BOOST_WINDOWS_API)
#if !defined(BOOST_FILESYSTEM_C_STR)
#define BOOST_FILESYSTEM_C_STR(p) p.c_str()
#endif
#if defined(BOOST_MSVC)
#pragma warning(push)
// 'boost::filesystem::basic_fstream<Char>' : inherits 'std::basic_istream<_Elem,_Traits>::std::basic_istream<_Elem,_Traits>::_Add_vtordisp1' via dominance
#pragma warning(disable : 4250)
#endif
namespace boost {
namespace filesystem {
//--------------------------------------------------------------------------------------//
// basic_filebuf //
//--------------------------------------------------------------------------------------//
template< class Char, class Traits = std::char_traits< Char > >
class basic_filebuf :
public std::basic_filebuf< Char, Traits >
private:
typedef std::basic_filebuf< Char, Traits > base_type;
public:
BOOST_DEFAULTED_FUNCTION(basic_filebuf(), {})
#if !defined(BOOST_FILESYSTEM_DETAIL_NO_CXX11_MOVABLE_FSTREAMS)
#if !defined(BOOST_NO_CXX11_DEFAULTED_MOVES)
basic_filebuf(basic_filebuf&&) = default;
basic_filebuf& operator= (basic_filebuf&&) = default;
#else
basic_filebuf(basic_filebuf&& that) :
base_type(static_cast< base_type&& >(that)) {}
basic_filebuf& operator= (basic_filebuf&& that)
*static_cast< base_type* >(this) = static_cast< base_type&& >(that);
return *this;
#endif
#endif // !defined(BOOST_FILESYSTEM_DETAIL_NO_CXX11_MOVABLE_FSTREAMS)
BOOST_DELETED_FUNCTION(basic_filebuf(basic_filebuf const&))
BOOST_DELETED_FUNCTION(basic_filebuf const& operator= (basic_filebuf const&))
public:
basic_filebuf* open(path const& p, std::ios_base::openmode mode)
return base_type::open(BOOST_FILESYSTEM_C_STR(p), mode) ? this : NULL;
//--------------------------------------------------------------------------------------//
// basic_ifstream //
//--------------------------------------------------------------------------------------//
template< class Char, class Traits = std::char_traits< Char > >
class basic_ifstream :
public std::basic_ifstream< Char, Traits >
private:
typedef std::basic_ifstream< Char, Traits > base_type;
public:
BOOST_DEFAULTED_FUNCTION(basic_ifstream(), {})
// use two signatures, rather than one signature with default second
// argument, to workaround VC++ 7.1 bug (ID VSWhidbey 38416)
explicit basic_ifstream(path const& p) :
base_type(BOOST_FILESYSTEM_C_STR(p), std::ios_base::in) {}
basic_ifstream(path const& p, std::ios_base::openmode mode) :
base_type(BOOST_FILESYSTEM_C_STR(p), mode) {}
#if !defined(BOOST_FILESYSTEM_DETAIL_NO_CXX11_MOVABLE_FSTREAMS)
basic_ifstream(basic_ifstream&& that) :
base_type(static_cast< base_type&& >(that)) {}
basic_ifstream& operator= (basic_ifstream&& that)
*static_cast< base_type* >(this) = static_cast< base_type&& >(that);
return *this;
#endif
BOOST_DELETED_FUNCTION(basic_ifstream(basic_ifstream const&))
BOOST_DELETED_FUNCTION(basic_ifstream const& operator= (basic_ifstream const&))
public:
void open(path const& p)
base_type::open(BOOST_FILESYSTEM_C_STR(p), std::ios_base::in);
void open(path const& p, std::ios_base::openmode mode)
base_type::open(BOOST_FILESYSTEM_C_STR(p), mode);
//--------------------------------------------------------------------------------------//
// basic_ofstream //
//--------------------------------------------------------------------------------------//
template< class Char, class Traits = std::char_traits< Char > >
class basic_ofstream :
public std::basic_ofstream< Char, Traits >
private:
typedef std::basic_ofstream< Char, Traits > base_type;
public:
BOOST_DEFAULTED_FUNCTION(basic_ofstream(), {})
// use two signatures, rather than one signature with default second
// argument, to workaround VC++ 7.1 bug (ID VSWhidbey 38416)
explicit basic_ofstream(path const& p) :
base_type(BOOST_FILESYSTEM_C_STR(p), std::ios_base::out) {}
basic_ofstream(path const& p, std::ios_base::openmode mode) :
base_type(BOOST_FILESYSTEM_C_STR(p), mode) {}
#if !defined(BOOST_FILESYSTEM_DETAIL_NO_CXX11_MOVABLE_FSTREAMS)
basic_ofstream(basic_ofstream&& that) :
base_type(static_cast< base_type&& >(that)) {}
basic_ofstream& operator= (basic_ofstream&& that)
*static_cast< base_type* >(this) = static_cast< base_type&& >(that);
return *this;
#endif
BOOST_DELETED_FUNCTION(basic_ofstream(basic_ofstream const&))
BOOST_DELETED_FUNCTION(basic_ofstream const& operator= (basic_ofstream const&))
public:
void open(path const& p)
base_type::open(BOOST_FILESYSTEM_C_STR(p), std::ios_base::out);
void open(path const& p, std::ios_base::openmode mode)
base_type::open(BOOST_FILESYSTEM_C_STR(p), mode);
//--------------------------------------------------------------------------------------//
// basic_fstream //
//--------------------------------------------------------------------------------------//
template< class Char, class Traits = std::char_traits< Char > >
class basic_fstream :
public std::basic_fstream< Char, Traits >
private:
typedef std::basic_fstream< Char, Traits > base_type;
public:
BOOST_DEFAULTED_FUNCTION(basic_fstream(), {})
// use two signatures, rather than one signature with default second
// argument, to workaround VC++ 7.1 bug (ID VSWhidbey 38416)
explicit basic_fstream(path const& p) :
base_type(BOOST_FILESYSTEM_C_STR(p), std::ios_base::in | std::ios_base::out) {}
basic_fstream(path const& p, std::ios_base::openmode mode) :
base_type(BOOST_FILESYSTEM_C_STR(p), mode) {}
#if !defined(BOOST_FILESYSTEM_DETAIL_NO_CXX11_MOVABLE_FSTREAMS)
basic_fstream(basic_fstream&& that) :
base_type(static_cast< base_type&& >(that)) {}
basic_fstream& operator= (basic_fstream&& that)
*static_cast< base_type* >(this) = static_cast< base_type&& >(that);
return *this;
#endif
BOOST_DELETED_FUNCTION(basic_fstream(basic_fstream const&))
BOOST_DELETED_FUNCTION(basic_fstream const& operator= (basic_fstream const&))
public:
void open(path const& p)
base_type::open(BOOST_FILESYSTEM_C_STR(p), std::ios_base::in | std::ios_base::out);
void open(path const& p, std::ios_base::openmode mode)
base_type::open(BOOST_FILESYSTEM_C_STR(p), mode);
//--------------------------------------------------------------------------------------//
// typedefs //
//--------------------------------------------------------------------------------------//
typedef basic_filebuf< char > filebuf;
typedef basic_ifstream< char > ifstream;
typedef basic_ofstream< char > ofstream;
typedef basic_fstream< char > fstream;
typedef basic_filebuf< wchar_t > wfilebuf;
typedef basic_ifstream< wchar_t > wifstream;
typedef basic_ofstream< wchar_t > wofstream;
typedef basic_fstream< wchar_t > wfstream;
} // namespace filesystem
} // namespace boost
#if defined(BOOST_MSVC)
#pragma warning(pop)
#endif
#include <
boost/filesystem/detail/footer.hpp
>
#endif // BOOST_FILESYSTEM_FSTREAM_HPP
