std::filesystem::relative, std::filesystem::proximate

 

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 relative( const std::filesystem::path& p,                std::error_code& ec );	(1)	(C++17 起)
path relative( const std::filesystem::path& p,                const std::filesystem::path& base = std::filesystem::current_path() );	(2)	(C++17 起)
path relative( const std::filesystem::path& p,                const std::filesystem::path& base,                std::error_code& ec );	(3)	(C++17 起)
path proximate( const std::filesystem::path& p,                 std::error_code& ec );	(4)	(C++17 起)
path proximate( const std::filesystem::path& p,                 const std::filesystem::path& base = std::filesystem::current_path() );	(5)	(C++17 起)
path proximate( const std::filesystem::path& p,                 const std::filesystem::path& base,                 std::error_code& ec );	(6)	(C++17 起)

1) 返回 relative(p, current_path(), ec)。

2,3) 返回相对于 base 的 p。在其他处理之前，解析符号链接并规范化 p 和 base。有效地返回 std::filesystem::weakly_canonical(p).lexically_relative(std::filesystem::weakly_canonical(base)) 或 std::filesystem::weakly_canonical(p, ec).lexically_relative(std::filesystem::weakly_canonical(base, ec))，除了错误代码形式在发生第一个错误时（如果有）返回 path()。

4) 返回 proximate(p, current_path(), ec)。

5,6) 有效地返回 std::filesystem::weakly_canonical(p).lexically_proximate(std::filesystem::weakly_canonical(base)) 或 std::filesystem::weakly_canonical(p, ec).lexically_proximate(std::filesystem::weakly_canonical(base, ec))，除了错误代码形式在发生第一个错误时（如果有）返回 path()。

参数

p	-	一个已存在的路径
base	-	基础路径，相对于其将使 p 相对/近似
ec	-	用于存储错误状态的错误代码

返回值

1) 相对于 current_path() 的 p。

2,3) 相对于 base 的 p。

4) 近似于 current_path() 的 p。

5,6) 近似于 base 的 p。

异常

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

2,5) 在底层操作系统 API 错误时抛出 std::filesystem::filesystem_error，构造时 p 作为第一个路径参数， base 作为第二个路径参数，操作系统错误代码作为错误代码参数。

1,3,4,6) 如果操作系统 API 调用失败，将 std::error_code& 参数设置为操作系统 API 错误代码；如果没有发生错误，则执行 ec.clear()。

示例

运行此代码

#include <filesystem>
#include <iostream>
 
void show(std::filesystem::path x, std::filesystem::path y)
{
    std::cout << "x:\t\t " << x << "\ny:\t\t " << y << '\n'
              << "relative(x, y):  "
              << std::filesystem::relative(x, y) << '\n'
              << "proximate(x, y): "
              << std::filesystem::proximate(x, y) << "\n\n";
}
 
int main()
{
    show("/a/b/c", "/a/b");
    show("/a/c", "/a/b");
    show("c", "/a/b");
    show("/a/b", "c");
}

可能的输出

x:               "/a/b/c"
y:               "/a/b"
relative(x, y):  "c"
proximate(x, y): "c"
 
x:               "/a/c"
y:               "/a/b"
relative(x, y):  "../c"
proximate(x, y): "../c"
 
x:               "c"
y:               "/a/b"
relative(x, y):  ""
proximate(x, y): "c"
 
x:               "/a/b"
y:               "c"
relative(x, y):  ""
proximate(x, y): "/a/b"

参阅

path (C++17)	表示一个路径 (类)
absolute (C++17)	组成一个绝对路径 (函数)
canonicalweakly_canonical (C++17)	组成一个规范路径 (函数)
lexically_normallexically_relativelexically_proximate	将路径转换为规范形式 将路径转换为相对形式 将路径转换为近似形式 (std::filesystem::path 的公开成员函数)