C++ std::source_location::current _ 获取当前行号与文件名【详解】

C++ std::source_location::current() 全面解析：精准获取行号、文件名与最佳实践

为什么 C++20 的 std::source_location::current() 返回的行号总是 1？

许多开发者初次使用 std::source_location::current() 时会遇到行号始终为 1 的困惑，这通常源于对其工作原理的理解偏差。该函数本质上是一个编译期信息注入点，而非运行时动态计算。编译器会在宏或函数调用展开的位置直接嵌入源码的静态信息（如文件路径、行号、函数名）。这意味着，如果你将其封装在另一个普通函数内部，位置信息就会被“固化”在该封装函数的定义处。

以下是一个典型的错误示例：

std::source_location get_loc() {
    return std::source_location::current(); // ❌ 这里记录的是 get_loc 函数体内的行号（通常是函数定义的第一行）
}

此时，无论你在代码的哪个位置调用 get_loc()，其返回的 line() 值始终指向 get_loc 函数定义体的那一行（通常是第一行），而非实际调用的行号。这是 C++ 开发者最常遇到的陷阱之一。

• 核心原则：必须在需要记录位置的调用现场直接使用 std::source_location::current()。
• 位置信息无法自动传递——除非你将 std::source_location 对象作为函数参数显式传递，并在调用方构造该对象。
• 所有主流编译器（GCC 11+、Clang 12+、MSVC 19.30+）均严格遵循此设计，这并非编译器缺陷，而是 C++20 标准规定的必然行为。

如何正确地将 source_location 传递给日志函数？

实现日志函数自动捕获调用位置的标准方法是利用函数的默认参数。编译器会在每个调用点自动填充这个参数的值：

void log(const char* msg, const std::source_location loc = std::source_location::current()) {
    printf("[%s:%d] %s\n", loc.file_name(), loc.line(), msg);
}

这样，每次编写 log("error") 时，参数 loc 就会精确地对应到 log("error") 这行代码所在的源文件和行号。

立即学习“C++免费学习笔记（深入）”；

• 关键细节：默认参数必须是字面量表达式。值得注意的是，std::source_location::current() 是 C++ 标准中唯一被特别允许用作默认参数的“非常量”表达式。
• 避免陷阱：切勿写成 auto loc = std::source_location::current(); log("msg", loc); —— 这又落入了上一节所述的封装陷阱。
• 此方法对模板函数或声明为 inline 的函数同样有效。但需注意，如果函数定义在头文件之外且未标记为 inline，在极少数情况下可能因 ODR（单一定义规则）导致不同编译单元中生成不同的位置信息，虽然罕见，但值得留意。

file_name() 返回的路径为什么很长甚至包含绝对路径？

std::source_location::file_name() 返回的字符串内容完全由编译器内部实现决定，与编译时使用的 -I 包含路径选项、构建系统的工作目录以及源文件的引用方式直接相关。通常，GCC 和 Clang 倾向于输出绝对路径，而 MSVC 则更常见相对路径。

• 重要提醒：不要依赖返回路径的特定格式进行字符串匹配（例如使用 strstr(loc.file_name(), "src/")），因为其格式不具备跨编译器的稳定性。
• 如果仅需提取文件名部分（不含路径），建议在日志函数内部使用 C++17 的 std::filesystem::path 进行处理：std::filesystem::path(loc.file_name()).filename().string()。
• 某些构建系统（如 Bazel 或配置了特定编译选项的 CMake）可以配合编译器标志来控制路径的标准化输出，但这属于非标准扩展，可移植性有限。

在宏中封装 source_location 会影响调试信息吗？

不仅不会影响，这恰恰是推荐的最佳实践。宏的优势在于它能确保 current() 在用户代码行直接展开，从而精准捕获调用位置：

#define LOG(msg) do { \
    ::log(msg, std::source_location::current()); \
} while(0)

当你调用 LOG("timeout") 时，std::source_location::current() 捕获到的就是 LOG("timeout") 这行宏调用所在的准确位置。

• 宏提供了比默认参数更高的灵活性：你可以轻松地同时注入 __func__、日志级别、时间戳等上下文信息。
• 为了避免宏展开后可能产生的分号或作用域问题，使用 do { ... } while(0) 结构进行包裹是业界公认的稳妥做法。
• 如果使用 constexpr 函数进行封装，只要确保函数体是纯内联展开、不引入额外的函数调用栈帧，也能达到同样效果。一旦封装函数内部产生了实际的函数调用，位置信息就会发生偏移。

总结来说，真正的挑战不在于语法本身，而在于当 source_location 被无意中“封装”到某个中间层时，你会发现日志中的行号与预期存在几行的偏差，排查起来却颇为耗时。遇到这种情况，首要的排查步骤就是：检查是否多套了一层不必要的函数调用。理解其编译期注入的本质，是正确使用这一强大工具的关键。