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

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

文件系统库

类
filesystem::path filesystem::filesystem_error filesystem::directory_entry filesystem::directory_iterator filesystem::recursive_directory_iterator filesystem::file_status	filesystem::space_info filesystem::file_type filesystem::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options filesystem::file_time_type
函数
filesystem::absolute filesystem::canonicalfilesystem::weakly_canonical filesystem::relativefilesystem::proximate filesystem::copy filesystem::copy_file filesystem::copy_symlink filesystem::create_directory filesystem::create_directories filesystem::create_hard_link filesystem::create_symlink filesystem::create_directory_symlink filesystem::current_path	filesystem::exists filesystem::equivalent filesystem::file_size filesystem::hard_link_count filesystem::last_write_time filesystem::permissions filesystem::read_symlink filesystem::remove filesystem::remove_all filesystem::rename filesystem::resize_file filesystem::space filesystem::status filesystem::symlink_status filesystem::temp_directory_path
文件类型
filesystem::is_block_file filesystem::is_character_file filesystem::is_directory filesystem::is_empty filesystem::status_known	filesystem::is_fifo filesystem::is_other filesystem::is_regular_file filesystem::is_socket filesystem::is_symlink

 

定义于头文件 <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 的路径；对于 canonical 必须是存在的路径
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"

参阅

path (C++17)	表示路径 (类)
absolute (C++17)	组成一个绝对路径 (函数)
relativeproximate (C++17)	组成一个相对路径 (函数)