2016-09-18 20:50:08 -07:00
|
|
|
#pragma once
|
|
|
|
|
2017-10-13 18:37:41 -07:00
|
|
|
#include <vcpkg/base/expected.h>
|
|
|
|
|
VS 2019 16.3 deprecates <experimental/filesystem>. (#6968)
VS 2019 16.3 will contain a couple of source-breaking changes:
* <experimental/filesystem> will be deprecated via an
impossible-to-miss preprocessor "#error The <experimental/filesystem>
header providing std::experimental::filesystem is deprecated by
Microsoft and will be REMOVED. It is superseded by the C++17
<filesystem> header providing std::filesystem. You can define
_SILENCE_EXPERIMENTAL_FILESYSTEM_DEPRECATION_WARNING to acknowledge
that you have received this warning."
* <filesystem> will no longer include <experimental/filesystem>.
In the long term, I believe that vcpkg should detect when it's being
built with VS 2017 15.7 or newer, compile in C++17 mode, include
<filesystem>, and use std::filesystem. (Activating this for VS 2019 16.0
or newer would also be reasonable.) Similarly for other toolsets
supporting std::filesystem.
In the short term, this commit makes vcpkg compatible with the upcoming
deprecation. First, we need to define the silencing macro before
including the appropriate header. I've chosen to define it
unconditionally (without checking for platform or version), since it
has no effect for other platforms or versions. Second, we need to deal
with <filesystem> no longer including <experimental/filesystem>.
I verified that VS 2015 Update 3 contained <experimental/filesystem>
(back then, it simply included the <filesystem> header, where the
experimental implementation was defined; this was later reorganized).
Therefore, all of vcpkg's supported MSVC toolsets have
<experimental/filesystem>, so we can simply always include it.
I've verified that this builds with both VS 2015 Update 3 and
VS 2019 16.1.3 (the current production version).
2019-06-20 11:46:55 -07:00
|
|
|
#define _SILENCE_EXPERIMENTAL_FILESYSTEM_DEPRECATION_WARNING
|
2017-10-16 11:44:04 -07:00
|
|
|
#include <experimental/filesystem>
|
2017-10-13 18:37:41 -07:00
|
|
|
|
|
|
|
namespace fs
|
|
|
|
{
|
|
|
|
namespace stdfs = std::experimental::filesystem;
|
|
|
|
|
|
|
|
using stdfs::copy_options;
|
|
|
|
using stdfs::file_status;
|
2018-02-16 15:40:22 -08:00
|
|
|
using stdfs::file_type;
|
2019-07-10 14:35:10 -07:00
|
|
|
using stdfs::perms;
|
2017-10-13 18:37:41 -07:00
|
|
|
using stdfs::path;
|
2017-11-20 19:15:47 -08:00
|
|
|
using stdfs::u8path;
|
2017-10-13 18:37:41 -07:00
|
|
|
|
2019-07-10 14:35:10 -07:00
|
|
|
/*
|
|
|
|
std::experimental::filesystem's file_status and file_type are broken in
|
|
|
|
the presence of symlinks -- a symlink is treated as the object it points
|
|
|
|
to for `symlink_status` and `symlink_type`
|
|
|
|
*/
|
|
|
|
|
|
|
|
using stdfs::status;
|
|
|
|
|
|
|
|
// we want to poison ADL with these niebloids
|
|
|
|
|
2019-07-10 16:28:56 -07:00
|
|
|
namespace detail {
|
|
|
|
struct symlink_status_t {
|
|
|
|
file_status operator()(const path& p, std::error_code& ec) const noexcept;
|
2019-07-11 15:01:29 -07:00
|
|
|
file_status operator()(const path& p, vcpkg::LineInfo li) const noexcept;
|
2019-07-10 16:28:56 -07:00
|
|
|
};
|
|
|
|
struct is_symlink_t {
|
|
|
|
inline bool operator()(file_status s) const {
|
|
|
|
return stdfs::is_symlink(s);
|
|
|
|
}
|
2019-07-11 15:01:29 -07:00
|
|
|
};
|
|
|
|
struct is_regular_file_t {
|
|
|
|
inline bool operator()(file_status s) const {
|
|
|
|
return stdfs::is_regular_file(s);
|
2019-07-10 16:28:56 -07:00
|
|
|
}
|
2019-07-11 15:01:29 -07:00
|
|
|
};
|
|
|
|
struct is_directory_t {
|
|
|
|
inline bool operator()(file_status s) const {
|
|
|
|
return stdfs::is_directory(s);
|
2019-07-10 16:28:56 -07:00
|
|
|
}
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
constexpr detail::symlink_status_t symlink_status{};
|
|
|
|
constexpr detail::is_symlink_t is_symlink{};
|
2019-07-11 15:01:29 -07:00
|
|
|
constexpr detail::is_regular_file_t is_regular_file{};
|
|
|
|
constexpr detail::is_directory_t is_directory{};
|
2017-10-13 18:37:41 -07:00
|
|
|
}
|
2016-09-18 20:50:08 -07:00
|
|
|
|
2019-07-10 14:35:10 -07:00
|
|
|
/*
|
|
|
|
if someone attempts to use unqualified `symlink_status` or `is_symlink`,
|
|
|
|
they might get the ADL version, which is broken.
|
|
|
|
Therefore, put `symlink_status` in the global namespace, so that they get
|
|
|
|
our symlink_status.
|
2019-07-11 15:01:29 -07:00
|
|
|
|
|
|
|
We also want to poison the ADL on is_regular_file and is_directory, because
|
|
|
|
we don't want people calling these functions on paths
|
2019-07-10 14:35:10 -07:00
|
|
|
*/
|
|
|
|
using fs::symlink_status;
|
|
|
|
using fs::is_symlink;
|
2019-07-11 15:01:29 -07:00
|
|
|
using fs::is_regular_file;
|
|
|
|
using fs::is_directory;
|
2019-07-10 14:35:10 -07:00
|
|
|
|
2017-01-05 12:47:08 -08:00
|
|
|
namespace vcpkg::Files
|
2016-09-18 20:50:08 -07:00
|
|
|
{
|
2017-10-16 11:44:04 -07:00
|
|
|
struct Filesystem
|
2017-04-08 16:26:26 -07:00
|
|
|
{
|
2019-06-19 11:49:57 -07:00
|
|
|
std::string read_contents(const fs::path& file_path, LineInfo linfo) const;
|
2017-04-08 20:19:35 -07:00
|
|
|
virtual Expected<std::string> read_contents(const fs::path& file_path) const = 0;
|
2017-04-12 23:00:42 -07:00
|
|
|
virtual Expected<std::vector<std::string>> read_lines(const fs::path& file_path) const = 0;
|
2017-04-08 20:19:35 -07:00
|
|
|
virtual fs::path find_file_recursively_up(const fs::path& starting_dir, const std::string& filename) const = 0;
|
2017-04-12 23:15:02 -07:00
|
|
|
virtual std::vector<fs::path> get_files_recursive(const fs::path& dir) const = 0;
|
|
|
|
virtual std::vector<fs::path> get_files_non_recursive(const fs::path& dir) const = 0;
|
2019-06-19 11:49:57 -07:00
|
|
|
void write_lines(const fs::path& file_path, const std::vector<std::string>& lines, LineInfo linfo);
|
|
|
|
virtual void write_lines(const fs::path& file_path,
|
|
|
|
const std::vector<std::string>& lines,
|
|
|
|
std::error_code& ec) = 0;
|
|
|
|
void write_contents(const fs::path& path, const std::string& data, LineInfo linfo);
|
2018-02-21 22:18:15 -08:00
|
|
|
virtual void write_contents(const fs::path& file_path, const std::string& data, std::error_code& ec) = 0;
|
2019-06-19 11:49:57 -07:00
|
|
|
void rename(const fs::path& oldpath, const fs::path& newpath, LineInfo linfo);
|
2018-03-19 15:45:35 -07:00
|
|
|
virtual void rename(const fs::path& oldpath, const fs::path& newpath, std::error_code& ec) = 0;
|
2018-06-27 17:40:51 -07:00
|
|
|
virtual void rename_or_copy(const fs::path& oldpath,
|
|
|
|
const fs::path& newpath,
|
|
|
|
StringLiteral temp_suffix,
|
|
|
|
std::error_code& ec) = 0;
|
2019-06-19 11:49:57 -07:00
|
|
|
bool remove(const fs::path& path, LineInfo linfo);
|
2017-04-11 15:16:39 -07:00
|
|
|
virtual bool remove(const fs::path& path, std::error_code& ec) = 0;
|
2019-07-11 15:01:29 -07:00
|
|
|
|
|
|
|
virtual std::uintmax_t remove_all(const fs::path& path, std::error_code& ec, fs::path& failure_point) = 0;
|
|
|
|
std::uintmax_t remove_all(const fs::path& path, LineInfo li);
|
2017-04-08 20:19:35 -07:00
|
|
|
virtual bool exists(const fs::path& path) const = 0;
|
|
|
|
virtual bool is_directory(const fs::path& path) const = 0;
|
|
|
|
virtual bool is_regular_file(const fs::path& path) const = 0;
|
|
|
|
virtual bool is_empty(const fs::path& path) const = 0;
|
|
|
|
virtual bool create_directory(const fs::path& path, std::error_code& ec) = 0;
|
2017-04-17 17:44:15 -07:00
|
|
|
virtual bool create_directories(const fs::path& path, std::error_code& ec) = 0;
|
2017-04-08 20:19:35 -07:00
|
|
|
virtual void copy(const fs::path& oldpath, const fs::path& newpath, fs::copy_options opts) = 0;
|
2017-10-16 11:44:04 -07:00
|
|
|
virtual bool copy_file(const fs::path& oldpath,
|
|
|
|
const fs::path& newpath,
|
|
|
|
fs::copy_options opts,
|
|
|
|
std::error_code& ec) = 0;
|
2018-10-17 12:46:27 -06:00
|
|
|
virtual void copy_symlink(const fs::path& oldpath, const fs::path& newpath, std::error_code& ec) = 0;
|
2017-04-11 15:16:39 -07:00
|
|
|
virtual fs::file_status status(const fs::path& path, std::error_code& ec) const = 0;
|
2018-10-17 12:46:27 -06:00
|
|
|
virtual fs::file_status symlink_status(const fs::path& path, std::error_code& ec) const = 0;
|
2018-02-21 22:18:15 -08:00
|
|
|
|
2018-06-27 16:29:16 -07:00
|
|
|
virtual std::vector<fs::path> find_from_PATH(const std::string& name) const = 0;
|
2017-04-08 16:26:26 -07:00
|
|
|
};
|
|
|
|
|
|
|
|
Filesystem& get_real_filesystem();
|
|
|
|
|
2018-04-12 00:47:17 -07:00
|
|
|
static constexpr const char* FILESYSTEM_INVALID_CHARACTERS = R"(\/:*?"<>|)";
|
2016-09-23 17:57:18 -07:00
|
|
|
|
2016-12-16 19:38:02 -08:00
|
|
|
bool has_invalid_chars_for_filesystem(const std::string& s);
|
2016-09-23 17:57:18 -07:00
|
|
|
|
2016-11-30 14:08:43 -08:00
|
|
|
void print_paths(const std::vector<fs::path>& paths);
|
2017-01-05 12:47:08 -08:00
|
|
|
}
|