C++ 为path类专门化std::formatter

path类在文件系统库中被用来表示文件或目录路径。在POSIX兼容系统（如macOS和Linux）上，path对象使用char类型来表示文件名。在Windows上，path使用wchar_t。在Windows上，cout和format()不会显示wchar_t字符的原始字符串。这意味着没有简单的即用型方法来编写跨POSIX和Windows的可移植代码，这些代码使用了文件系统库。

我们可以使用预处理器指令为Windows编写特定的代码版本。对于某些代码库来说，这可能是一个合理的解决方案，但对于本书来说，这样做既混乱又不符合简单、可移植、可重用示例的目的。

优雅的解决方案是为path类编写一个C++20 formatter专门化。这允许我们以简单和可移植的方式显示path对象。

如何做……

在本示例中，我们将为fs::path类编写一个formatter专门化：

首先，为了方便起见，我们使用一个命名空间别名。所有文件系统名称都在std::filesystem命名空间中：

namespace fs = std::filesystem;

我们为path类编写的formatter专门化简单且简洁：

template<>  
struct std::formatter<fs::path>: std::formatter<std::string> {  
    template<typename FormatContext>  
    auto format(const fs::path& p, FormatContext& ctx) {  
        return format_to(ctx.out(), "{}", p.string());  
    }  
};

在这里，我们为fs::path类型专门化了formatter，使用其string()方法来获取可打印的表示形式。我们不能使用c_str()方法，因为它在Windows上与wchar_t字符不兼容。

本书中第1章“新的C++20特性”中有对formatter专门化的更完整解释。

在main()函数中，我们使用命令行传递文件名或路径：

int main(const int argc, const char** argv) {  
    // ... 省略了检查参数数量的代码 ...  
  
    fs::path dir{ argv[1] };  
  
    if(!fs::exists(dir)) {  
        cout << format("path: {} does not exist\n", dir);  
        return 1;  
    }  
  
    cout << format("path: {}\n", dir);  
    cout << format("filename: {}\n", dir.filename());  
    cout << format("cannonical: {}\n", fs::canonical(dir));  
}

argc和argv参数是标准的命令行参数。

argv[0]始终是可执行文件本身的完整目录路径和文件名。如果我们没有正确数量的参数，我们将显示argv[0]的文件名部分作为用法消息的一部分。

在这个示例中，我们使用了一些文件系统函数：

- fs::exists()函数检查目录或文件是否存在。

- dir是一个path对象。我们现在可以直接将它传递给format()，使用我们的专门化来显示路径的字符串表示形式。

- filename()方法返回一个新的path对象，我们直接将其传递给format()，使用我们的专门化。

- fs::canonical()函数接受一个path对象，并返回一个新的path对象，其中包含规范的绝对目录路径。我们将此path对象直接传递给format()，它显示从canonical()返回的目录路径。

输出示例：

$ ./formatter ./formatter.cpp  
path: ./formatter.cpp  
filename: formatter.cpp  
cannonical: /home/billw/working/chap10/formatter.cpp

它是如何工作的……

fs::path类在文件系统库中被用来表示目录路径和文件名。通过提供formatter专门化，我们可以轻松地在不同平台上一致地显示path对象。

path类提供了一些有用的方法。我们可以遍历一个路径来查看其组成部分：

fs::path p{ "~/include/bwprint.h" };  
cout << format("{}\n", p);  
for(auto& x : p) cout << format("[{}] ", x);  
cout << '\n';

迭代器返回路径中每个元素的path对象。

我们还可以获取路径的不同部分：

fs::path p{ "~/include/bwprint.h" };  
cout << format("{}\n", p);  
cout << format("{}\n", p.stem());  
cout << format("{}\n", p.extension());  
cout << format("{}\n", p.filename());  
cout << format("{}\n", p.parent_path());

在本章中，我们将继续使用这个为path类编写的formatter专门化。