C++ `std::source_location` (C++20)：获取编译期代码位置信息

哈喽，各位好！今天咱们聊聊 C++20 引入的一个超实用的小工具：std::source_location。 顾名思义，它能让你在代码里轻松获取代码的位置信息，比如文件名、行号、函数名等等。 这玩意儿在调试、日志记录、代码生成等等场景下，简直不要太方便！

1. 什么是 std::source_location？

std::source_location 是一个结构体，它封装了代码的源位置信息。简单来说，它就像一个代码的 GPS 定位器，告诉你“我是谁，我在哪”。

• 包含的成员：

  • file_name(): 返回包含代码位置的源文件的路径（const char*）。
  • function_name(): 返回包含代码位置的函数的名称（const char*）。注意，如果是在lambda表达式中，这返回的是编译器生成的lambda表达式的名字，不是lambda表达式被赋值的变量名。
  • line(): 返回代码位置的行号（unsigned int）。
  • column(): 返回代码位置的列号（unsigned int）。不过，这个成员在 C++20 标准中并没有强制要求实现，所以有些编译器可能不支持。

• 默认参数特性：

  std::source_location::current() 可以作为一个函数或构造函数的默认参数。这意味着你可以在不显式传递任何参数的情况下，自动获取调用位置的信息。 这也是它最方便的地方之一。

2. 怎么用 std::source_location？

直接上代码，让你秒懂：

#include <iostream>
#include <source_location>

void log_message(const std::string& message,
                 const std::source_location& location = std::source_location::current()) {
  std::cout << "File: " << location.file_name() << std::endl;
  std::cout << "Line: " << location.line() << std::endl;
  std::cout << "Function: " << location.function_name() << std::endl;
  std::cout << "Message: " << message << std::endl;
  std::cout << "-------------------------" << std::endl;
}

void do_something() {
  log_message("Doing something...");
}

int main() {
  log_message("Program started.");
  do_something();
  log_message("Program finished.");

  auto lambda_func = []() {
      log_message("Inside lambda.");
  };

  lambda_func();

  return 0;
}

运行结果（大概）：

File: main.cpp
Line: 20
Function: main
Message: Program started.
-------------------------
File: main.cpp
Line: 14
Function: do_something
Message: Doing something...
-------------------------
File: main.cpp
Line: 22
Function: main
Message: Program finished.
-------------------------
File: main.cpp
Line: 27
Function: main::operator() const::{lambda()}
Message: Inside lambda.
-------------------------

看到了吗？ log_message 函数的第二个参数使用了 std::source_location::current() 作为默认参数。 这样，每次调用 log_message 时，它都会自动获取调用它的代码位置信息，并打印出来。 注意lambda表达式的函数名。

3. 应用场景大盘点

• 日志记录： 这是 std::source_location 最常见的用途。 在日志中记录代码位置，可以让你快速定位问题。

  #include <iostream>
  #include <fstream>
  #include <source_location>
  #include <string>
  
  void log_error(const std::string& message,
                 const std::source_location& location = std::source_location::current()) {
    std::ofstream log_file("error.log", std::ios::app); // Append to the log file
  
    if (log_file.is_open()) {
      log_file << "Error in " << location.file_name() << ":" << location.line()
               << " (" << location.function_name() << "): " << message << std::endl;
      log_file.close();
    } else {
      std::cerr << "Unable to open log file!" << std::endl;
    }
  }
  
  void risky_operation(int value) {
    if (value < 0) {
      log_error("Value is negative!");
      throw std::runtime_error("Negative value");
    }
    // ... do something with the value ...
  }
  
  int main() {
    try {
      risky_operation(-5);
    } catch (const std::exception& e) {
      std::cerr << "Exception caught: " << e.what() << std::endl;
    }
    return 0;
  }

  运行后，error.log 文件会包含类似这样的内容：

  Error in main.cpp:22 (risky_operation): Value is negative!

• 断言 (Assertions)： 当断言失败时，记录代码位置可以帮助你快速找到出错的地方。

  #include <iostream>
  #include <source_location>
  
  void my_assert(bool condition, const std::string& message,
                 const std::source_location& location = std::source_location::current()) {
    if (!condition) {
      std::cerr << "Assertion failed in " << location.file_name() << ":" << location.line()
                << " (" << location.function_name() << "): " << message << std::endl;
      std::abort(); // Terminate the program
    }
  }
  
  int main() {
    int x = 5;
    my_assert(x > 0, "x should be positive.");
  
    int y = -2;
    my_assert(y > 0, "y should be positive."); // This assertion will fail
    return 0;
  }

  运行这段代码，因为 y > 0 的断言失败，程序会输出错误信息并终止。

• 代码生成： 在代码生成器中，可以使用 std::source_location 来生成带有代码位置信息的代码，方便调试。

  #include <iostream>
  #include <fstream>
  #include <source_location>
  #include <string>
  
  std::string generate_code(const std::string& variable_name,
                            const std::source_location& location = std::source_location::current()) {
    std::string code = "// Generated code from: " + std::string(location.file_name()) + ":" +
                       std::to_string(location.line()) + "n";
    code += "int " + variable_name + " = 42;n";
    return code;
  }
  
  int main() {
    std::ofstream output_file("generated_code.cpp");
    if (output_file.is_open()) {
      output_file << generate_code("my_variable");
      output_file.close();
    } else {
      std::cerr << "Unable to open output file!" << std::endl;
    }
    return 0;
  }

  生成的 generated_code.cpp 文件会包含类似这样的内容：

  // Generated code from: main.cpp:11
  int my_variable = 42;

• 单元测试： 在单元测试框架中，记录测试用例的代码位置，可以帮助你快速定位失败的测试用例。

  #include <iostream>
  #include <source_location>
  
  void assert_equal(int expected, int actual, const std::string& message,
                    const std::source_location& location = std::source_location::current()) {
    if (expected != actual) {
      std::cerr << "Test failed in " << location.file_name() << ":" << location.line()
                << " (" << location.function_name() << "): " << message
                << ". Expected: " << expected << ", Actual: " << actual << std::endl;
    }
  }
  
  int add(int a, int b) {
    return a + b;
  }
  
  int main() {
    assert_equal(5, add(2, 3), "Test 1: 2 + 3 should be 5.");
    assert_equal(6, add(2, 3), "Test 2: 2 + 3 should be 6."); // This test will fail
    return 0;
  }

  如果第二个断言失败，程序会输出错误信息，告诉你哪个测试用例失败了。

• 自定义诊断信息： 可以用于创建自定义的编译器警告或错误，提供更详细的错误信息。 结合编译器提供的诊断 API (如果可用)，可以实现更强大的功能。

4. 注意事项

• 性能开销： 虽然 std::source_location 很方便，但也要注意它的性能开销。 每次调用 std::source_location::current() 都会产生一些开销，因为它需要获取代码位置信息。 在性能敏感的代码中，要谨慎使用。 不过，通常情况下，这种开销是可以忽略的。

• 编译器支持： std::source_location 是 C++20 的新特性，所以要确保你的编译器支持它。 主流的编译器（如 GCC、Clang、MSVC）都已经支持。

• column() 的可用性： column() 成员并不保证在所有编译器上都可用。 如果需要使用列号信息，最好先检查编译器是否支持。

• function_name() 的返回值： function_name() 返回的是函数的名称，但是对于 lambda 表达式，它返回的是编译器生成的 lambda 表达式的名字，而不是 lambda 表达式被赋值的变量名。

5. std::source_location 的优势和劣势

特性	优势	劣势
易用性	简单易用，通过 std::source_location::current() 可以方便地获取代码位置信息。	需要 C++20 支持，老版本的编译器无法使用。
默认参数	可以作为函数的默认参数，减少代码冗余。	存在一定的性能开销，虽然通常可以忽略，但在性能敏感的代码中需要谨慎使用。
信息丰富性	提供了文件名、行号、函数名等信息，方便定位问题。	column() 的可用性不保证，某些编译器可能不支持。function_name() 对 lambda 表达式返回编译器生成的名称，可能不够直观。
应用场景	适用于日志记录、断言、代码生成、单元测试等多种场景。

6. 替代方案 (C++20 之前)

在 C++20 之前，如果你需要获取代码位置信息，通常需要使用预处理器宏，比如 __FILE__、__LINE__、__FUNCTION__。 但是，这些宏有一些缺点：

• 可读性差： 宏的代码可读性通常比较差。
• 类型安全： 宏没有类型安全检查。
• 不能作为默认参数： 宏不能作为函数的默认参数。

#include <iostream>

void log_message(const std::string& message,
                 const char* file = __FILE__,
                 int line = __LINE__,
                 const char* function = __FUNCTION__) {
  std::cout << "File: " << file << std::endl;
  std::cout << "Line: " << line << std::endl;
  std::cout << "Function: " << function << std::endl;
  std::cout << "Message: " << message << std::endl;
  std::cout << "-------------------------" << std::endl;
}

void do_something() {
  log_message("Doing something...");
}

int main() {
  log_message("Program started.");
  do_something();
  log_message("Program finished.");
  return 0;
}

可以看到，使用宏的代码可读性比较差，而且需要显式地传递参数。相比之下，std::source_location 更加简洁易用。

7. 高级用法：自定义 source_location

虽然 std::source_location::current() 已经很方便了，但是有时候你可能需要自定义 source_location 对象。 比如，你可能需要创建一个 source_location 对象，表示一个特定的代码位置，而不是当前代码的位置。

#include <iostream>
#include <source_location>

int main() {
  // 创建一个表示 "my_file.cpp", line 10, function "my_function" 的 source_location 对象
  std::source_location my_location =
      std::source_location::current(); // 先获取一个默认的
  const std::source_location custom_location{
      my_location.line(), // 行号
      my_location.column(), // 列号，如果需要
      "my_file.cpp",      // 文件名
      "my_function"       // 函数名
  };

  std::cout << "File: " << custom_location.file_name() << std::endl;
  std::cout << "Line: " << custom_location.line() << std::endl;
  std::cout << "Function: " << custom_location.function_name() << std::endl;

  return 0;
}

注意：std::source_location的构造函数是constexpr的，这意味着你可以在编译期创建std::source_location对象，但是需要所有参数都是在编译期可知的。 这在某些高级应用场景下非常有用。

8. 总结

std::source_location 是 C++20 中一个非常实用的小工具，它可以让你在代码里轻松获取代码的位置信息。 它在调试、日志记录、代码生成等等场景下都有广泛的应用。 虽然它有一些性能开销，但是通常可以忽略。 如果你正在使用 C++20，那么不妨尝试一下 std::source_location，相信它会给你带来惊喜！

希望今天的讲解对你有所帮助。 下次再见！