std::filesystem::canonical, std::filesystem::weakly_canonical

来自cppreference.com
 
 
 
定义于头文件 <filesystem>
path canonical( const std::filesystem::path& p,
                const std::filesystem::path& base = std::filesystem::current_path() );
(1) (C++17 起)
path canonical( const std::filesystem::path& p,
                std::error_code& ec );
(2) (C++17 起)
path canonical( const std::filesystem::path& p,

                const std::filesystem::path& base,

                std::error_code& ec );
(3) (C++17 起)
path weakly_canonical(const std::filesystem::path& p);
(4) (C++17 起)
path weakly_canonical(const std::filesystem::path& p,
                      std::error_code& ec);
(5) (C++17 起)
1-3) 转换路径 p 为规范绝对路径,即在其通用格式表示中无点、双点元素或符号链接的绝对路径。若 p 不是绝对路径,则该函数表现为首先用 absolute(p, base) 或对于 (2) 则是 absolute(p) ,将它设为绝对。路径 p 必须存在。
4-5) 返回由 operator/= 从不带 base 参数调用 canonical() 的结果,和以由 p 的存在的前导元素(如以 status(p)status(p, ec) 确定),若有这些,后随 p 的不存在元素组成,若有这些,组成的路径。产生的路径为正常形式

目录

[编辑] 参数

p - 可以为绝对或相对于 base 的路径,而且必须是存在的路径
base - 用于 p 为相对的情形的基础路径
ec - 存储错误状态的错误码

[编辑] 返回值

1-3) 解析到与 absolute(p, base) 为相同文件的绝对路径(或对于 (2)absolute(p) 相同)。
4-5) canonical(x)/y 形式的正常路径,其中 x 是由 p 中存在的元素的最长前导序列组成的路径,而 y 是由 p 中剩余尾随的不存在元素组成的路径

[编辑] 异常

不接受 std::error_code& 参数的重载在底层 OS API 错误时抛出 filesystem_error ,以第一 path 参数 p,第二 path 参数 base 和作为错误码参数的 OS 错误码构造。若 OS API 调用失败,则接受 std::error_code& 参数的重载设置该参数为 OS API 错误码,而若不出现错误则执行 ec.clear() 。若内存分配失败,则任何不标记为 noexcept 的重载可能抛出 std::bad_alloc

[编辑] 注意

函数 canonical() 模仿 POSIX realpath

引入函数 weakly_canonical() 以简化 relative() 的操作语义。

[编辑] 示例

#include <iostream>
#include <filesystem>
namespace fs = std::filesystem;
int main()
{
    fs::path p = fs::path("..") / ".." / "AppData";
    std::cout << "Current path is " << fs::current_path() << '\n'
              << "Canonical path for " << p << " is " << canonical(p) << '\n';
}

可能的输出:

Current path is "C:\Users\abcdef\AppData\Local\Temp"
Canonical path for "..\..\AppData" is "C:\Users\abcdef\AppData"

[编辑] 参阅

(C++17)
表示一个路径
(类) [编辑]
(C++17)
组成一个绝对路径
(函数) [编辑]
组成一个相对路径
(函数) [编辑]