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

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

文件系统库

类
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::file_time_type filesystem::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options
函数
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::temp_directory_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::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 );	(1)	(C++17 起)
path canonical( const std::filesystem::path& p,                 std::error_code& ec );	(2)	(C++17 起)
path weakly_canonical( const std::filesystem::path& p );	(3)	(C++17 起)
path weakly_canonical( const std::filesystem::path& p,                        std::error_code& ec );	(4)	(C++17 起)

1,2) 将路径 p 转换为规范的绝对路径，即在其通用格式表示中没有点、点点元素或符号链接的绝对路径。如果 p 不是绝对路径，则该函数的操作就如同它首先通过 std::filesystem::absolute(p) 变为绝对路径一样。路径 p 必须存在。

3,4) 返回一个由 operator/= 构成的路径，其结果来自对 p 中存在的（由 status(p) 或 status(p, ec) 确定）前导元素组成的路径调用 canonical()，如果存在的话，后面跟着 p 中不存在的元素。生成的路径为标准形式。

参数

p	-	一个可以是绝对路径或相对路径的路径；对于 canonical，它必须是现有路径
ec	-	用于存储错误状态的错误代码

返回值

1,2) 解析为与 std::filesystem::absolute(p) 相同文件的绝对路径。

3,4) 形式为 canonical(x)/y 的标准路径，其中 x 是由 p 中最长的现有元素序列组成的路径，而 y 是由 p 中剩余的非现有尾部元素组成的路径。

异常

任何未标记为 noexcept 的重载都可能在内存分配失败时抛出 std::bad_alloc。

1,3) 在底层 OS API 错误时抛出 std::filesystem::filesystem_error，使用 p 作为第一个路径参数，OS 错误码作为错误码参数来构造。

2,4) 如果 OS API 调用失败，将 std::error_code& 参数设置为 OS API 错误码；如果没有发生错误，则执行 ec.clear()。

注意

函数 canonical() 仿照 POSIX realpath。

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

示例

运行此代码

#include <filesystem>
#include <iostream>
 
int main()
{
    /* set up sandbox directories:
     a
     └── b
         ├── c1
         │   └── d <== current path
         └── c2
             └── e
    */
    auto old = std::filesystem::current_path();
    auto tmp = std::filesystem::temp_directory_path();
    std::filesystem::current_path(tmp);
    auto d1 = tmp / "a/b/c1/d";
    auto d2 = tmp / "a/b/c2/e";
    std::filesystem::create_directories(d1);
    std::filesystem::create_directories(d2);
    std::filesystem::current_path(d1);
 
    auto p1 = std::filesystem::path("../../c2/./e");
    auto p2 = std::filesystem::path("../no-such-file");
    std::cout << "Current path is "
              << std::filesystem::current_path() << '\n'
              << "Canonical path for " << p1 << " is "
              << std::filesystem::canonical(p1) << '\n'
              << "Weakly canonical path for " << p2 << " is "
              << std::filesystem::weakly_canonical(p2) << '\n';
    try
    {
        [[maybe_unused]] auto x_x = std::filesystem::canonical(p2);
        // NOT REACHED
    }
    catch (const std::exception& ex)
    {
        std::cout << "Canonical path for " << p2 << " threw exception:\n"
                  << ex.what() << '\n';
    }
 
    // cleanup
    std::filesystem::current_path(old);
    const auto count = std::filesystem::remove_all(tmp / "a");
    std::cout << "Deleted " << count << " files or directories.\n";
}

可能的输出

Current path is "/tmp/a/b/c1/d"
Canonical path for "../../c2/./e" is "/tmp/a/b/c2/e"
Weakly canonical path for "../no-such-file" is "/tmp/a/b/c1/no-such-file"
Canonical path for "../no-such-file" threw exception:
filesystem error: in canonical: No such file or directory [../no-such-file] [/tmp/a/b/c1/d]
Deleted 6 files or directories.

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告	应用于	发布时的行为	正确的行为
LWG 2956	C++17	canonical 有一个多余的 base 参数	已移除

参见

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