笔记栏文章声明

Warning

笔记栏所记录文章往往未经校对，或包含错误认识或偏颇观点，亦或采用只有自身能够理解的记录。

donut有一个vfs的设计，思想可能来自于linux，继承自VFS的只需要实现最基本的几个接口就可以了。它主要是解决一个渲染框架去读取资源的问题。一般渲染框架都会带一个类似的方案，比如根据自身的exe所在的位置去搜索Resources目录之类的。

fs::path的路径格式

native format
generic_format

在posix下两种没有区别。在windows下，generic_format会用/，而native-format会用\\

https://github.com/MeouSker77/Cpp17/blob/master/markdown/src/ch20.md

一个有点意思的测试程序

#include <filesystem>
#include <iostream>
namespace fs = std::filesystem;
int main()
{
    std::string strpath = "C:\\file.txt";
    fs::path path(strpath);
    std::cout << path.u8string() << std::endl;
    std::cout << path.generic_string() << std::endl;

    std::string str2path = "C:/file.txt";
    path = str2path;
    std::cout << path.u8string() << std::endl;
    std::cout << path.generic_string() << std::endl;
}

这段程序在MSVC/Mingw64 gcc上输出

C:\file.txt
C:/file.txt

而在WSL的GCC上输出

C:\file.txt
C:\file.txt
C:/file.txt
C:/file.txt

说明generic_string的处理与平台有关，而与编译器无关。我一开始以为他会根据path的内容来转，实际上不是。

在WIndows平台上，generic_string会把\转成/
在Linux平台上，即使出现\字符串，也不会转成/

IFileSystem

  // Basic interface for the virtual file system.
    class IFileSystem
    {
    public:
        virtual ~IFileSystem() = default;
        virtual bool folderExists(const std::filesystem::path& name) = 0;
        virtual bool fileExists(const std::filesystem::path& name) = 0;
        virtual std::shared_ptr<IBlob> readFile(const std::filesystem::path& name) = 0;
        virtual bool writeFile(const std::filesystem::path& name, const void* data, size_t size) = 0;
        virtual int enumerateFiles(const std::filesystem::path& path, const std::vector<std::string>& extensions, enumerate_callback_t callback, bool allowDuplicates = false) = 0;
        virtual int enumerateDirectories(const std::filesystem::path& path, enumerate_callback_t callback, bool allowDuplicates = false) = 0;
    };

NativeFilesystem

NativeFilesystem基本上等于空实现，它要求传入的Path是系统Native的路径，比如C:\test.txt，/home/等这种路径。然后所有的API都是直接通过std::filesystem相关的功能实现。

RelativeFilesystem

RelativeFileSystem也没什么意思，他只是在其他的Filesystem上套了一层。构建的时候需要保存一个BasePath，然后调用所有的API的时候，RelativeFS都会拼接路径。

class RelativeFileSystem : public IFileSystem
{
private:
    std::shared_ptr<IFileSystem> m_UnderlyingFS;
    std::filesystem::path m_BasePath;
public:
    RelativeFileSystem(std::shared_ptr<IFileSystem> fs, const std::filesystem::path& basePath);

    [[nodiscard]] std::filesystem::path const& GetBasePath() const { return m_BasePath; }

    bool folderExists(const std::filesystem::path& name) override;
    bool fileExists(const std::filesystem::path& name) override;
    std::shared_ptr<IBlob> readFile(const std::filesystem::path& name) override;
    bool writeFile(const std::filesystem::path& name, const void* data, size_t size) override;
    int enumerateFiles(const std::filesystem::path& path, const std::vector<std::string>& extensions, enumerate_callback_t callback, bool allowDuplicates = false) override;
    int enumerateDirectories(const std::filesystem::path& path, enumerate_callback_t callback, bool allowDuplicates = false) override;
};

比如fileExists的实现

std::shared_ptr<IBlob> RelativeFileSystem::readFile(const std::filesystem::path& name)
{
    return m_UnderlyingFS->readFile(m_BasePath / name.relative_path());
}

最常见的使用方式是先构建一个NativeFileSystem作为底层，然后将某个路径传进去。这样可以通过直接输入文件名来访问 basePath /filename。

RootFileSystem

RootFileSystem是最接近Linux的，它允许我们将某个路径挂载到某个挂载点，然后通过挂载后的路径访问。

vfs::RootFileSystem rootFS;
rootFS.mount("/tests", "/home/user/");
rootFS.fileExists("/tests/CMakeLists.txt"); // 等于访问 /home/user/CMakeLists.txt

它的核心逻辑在

bool RootFileSystem::findMountPoint(const std::filesystem::path& path, std::filesystem::path* pRelativePath, IFileSystem** ppFS)
{
    // 传入Path /tests/CMakeLists.txt,正规化
    std::string spath = path.lexically_normal().generic_string();

    for (auto it : m_MountPoints) // m_MountPoints : pair{"/tests",IFileSystem*}
    {
        // 这里通过字符串去匹配前面的几个字符，要求完全匹配上
        if (spath.find(it.first, 0) == 0 && ((spath.length() == it.first.length()) || (spath[it.first.length()] == '/')))
        {
            // 这里返回CMakeLists.txt
            if (pRelativePath)
            {
                std::string relative = spath.substr(it.first.size() + 1);
                *pRelativePath = relative;
            }
            // 并且返回保存的IFileSystem
            if (ppFS)
            {
                *ppFS = it.second.get();
            }

            return true;
        }
    }

    return false;
}

所以RootFileSystem需要和RelativeFileSystem搭配着使用。因为它在访问/test/CMakeLists这种路径的时候，会把匹配上的mount point (/test)转为保存的IFileSystem,再通过CMakeLists.txt这个名字去访问。

如果是NativeFilesystem的话，需要通过愚蠢的路径去访问。

// 未测试
std::shared_ptr<NativeFileSystem> nativeFS = std::make_shared<NativeFileSystem>();
m_RootFs = std::make_shared<RootFileSystem>();
m_RootFs->mount("/native", nativeFS);
m_RootFs->fileExists("/native//home/user/CMakeLists.txt");