C++20 的 std::source_location 与预定义的宏 __FILE__、__LINE__ 和 __FUNCTION__ 相比有什么优势？

Question

在我目前的项目中，我使用过：

Log(__LINE__, __FUNCTION__, message);

但是新的 C++20 实用程序类std::source_location 带有函数line()、column()、file_name()、function_name()，它们做同样的事情。因此，新的 C++20 方式将是：

log(std::string message,const std::source_location& location = std::source_location::current())
{
    std::cout << "Debug:"
              << location.file_name() << ':'
              << location.line() << ' '
              << message << '\n';
}

新的 C++20 方式与旧的标准双下划线宏 __LINE__、__FILE__、__func__ 相比有什么优势？ p>

我正在尝试确定优势是否如此之大，以至于有理由修改我当前项目中的代码以使用新的 std::source_location 对象而不是宏。

Answer 1

在 C++20 之前，您必须在冗长（手动将 __LINE__、__FILE__、__func__ 传递给每个调用）和使用宏为您完成这两者之间做出选择。

std::source_location 给你一个很好的调用语法，没有宏。没有其他隐藏的优势。

Answer 2

你的例子是我能想到的最好的动力。在过去，__LINE__ 和 _FILE__ 是使用宏进行调试日志的最佳借口。现在这不再成立了。

在过去，您基本上有两个 choiches。要么让调用者传递有关日志记录发生位置的信息：

log(__LINE__,__FILE__,"Hello World");

或使用宏来获得相同的输出

log("Hello World");
//^--- log must be a macro if we want this __LINE__ in the log

两者都非常不方便，因为要么用户必须在每次调用时传递必须相同的参数，要么我们需要使用具有所有已知缺点的宏。使用source_location，我们可以在不涉及任何宏的情况下获得log("Hello World");，但仍然包含调用的行和文件，因为在调用站点替换了默认参数。例如：

#include <source_location>
#include <string>
#include <iostream>

void log(std::string message,const std::source_location& location = std::source_location::current())
{
    std::cout << "Debug:"
              << location.file_name() << ':'
              << location.line() << ' '
              << message << '\n';
}


int main() {
    log("hello");
    log("world");
}

Output:

Debug:/app/example.cpp:15 hello
Debug:/app/example.cpp:16 world

Answer 3

std::source_location 的主要优点主要是方便，因为它表示具有单一、易于存储的结构的源位置。

它还具有不基于预处理器魔术的优点，因此对于该语言而言，它不仅仅是整数文字，而是有效类型，从类型安全的角度来看，这要好得多。

如果您对旧方法感到满意，则没有理由更改已经运行良好的代码。不过，这对于大多数新功能来说通常是正确的，不仅适用于 std::source_location。