C++20 源代码信息类std::source_location 实现简易日志打印功能

最新推荐文章于 2025-03-11 00:00:00 发布

orbitgw

最新推荐文章于 2025-03-11 00:00:00 发布

阅读量1k

点赞数

分类专栏： C++ 文章标签： c++20 c++ c语言日志系统

本文链接：https://blog.csdn.net/weixin_43130747/article/details/129806684

版权

C++ 专栏收录该内容

13 篇文章

订阅专栏

文章介绍了传统通过预定义宏获取源代码信息的方法，如__LINE__、__FUNCTION__和__FILE__，并展示了如何通过宏简化日志系统的使用。然后，文章重点讨论了C++20引入的std::source_location类，这是一个表示源码位置的新工具，提供了获取行号、列号、文件名和函数名的成员函数，简化了获取代码上下文的操作。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

传统方法获取源代码信息

传统方法是使用预定义宏来获取，比如有__LINE__、__FUNCTION__和__FILE__。
比如一个简易的日志系统，我们的log方法用于打印日志信息：

void log(PSTR level, PSTR file, PSTR func, int line, PSTR fmt, ...){
    char str[256] = {0};
    va_list arglst;
    va_start(arglst,fmt);
    vsnprintf(str,sizeof(str), fmt, arglst);
    printf("[%s][%s] %s in function %s() at line:%d : %s\n",__TIME__, level, file, func, line, str);
    va_end(arglst);
}

每次都要传入__FILE__、__FUNCTION__和__LINE__非常麻烦，如果你使用默认的参数的话，因为其实宏，在预编译阶段就会解析为函数声明的行。而且如果你使用可变参数的话，就无法使用默认参数了。

在这里插入图片描述
所以我们可以通过声明宏函数来解决，解析时直接解析为调用行。然后我们简易的日志类实现如下：

#include <stdio.h>
#include <stdarg.h>

using PSTR = const char*;

#define DEBUG_LOG(...) log("DEBUG", __FILE__, __FUNCTION__, __LINE__, __VA_ARGS__)
#define WARNING_LOG(...) log("WARN", __FILE__, __FUNCTION__, __LINE__, __VA_ARGS__)
#define ERROR_LOG(...) log("ERROR", __FILE__, __FUNCTION__, __LINE__, __VA_ARGS__)

void log(PSTR level, PSTR file, PSTR func, int line, PSTR fmt, ...){
    char str[256] = {0};
    va_list arglst;
    va_start(arglst,fmt);
    vsnprintf(str,sizeof(str), fmt, arglst);
    printf("[%s][%s] %s in function %s() at line:%d : %s\n",__TIME__, level, file, func, line, str);
    va_end(arglst);
}

int main(){
    int a,b;
    printf("Type your division expression:");
    scanf("%d/%d",&a,&b);
    if(b!=0)
        printf("Result: %f",a/b);
    else
	    WARNING_LOG("The expression \'%d/%d\' is not right, cause you cannot divide by 0.",a,b);
	return 0;
}

样例1：

Type your division expression:2/7
Result: 0.000000

样例2：

Type your division expression:8/0
[00:01:00][WARN] D:\SingleSources\CPP\3.cpp in function main() at line:26 : The expression '8/0' is not right, cause you cannot divide by 0.

std::source_location

source_location 类于C++20被引入，它表示关于源码的具体信息，它的结构以及使用都非常简单。

成员函数

我们使用其构造函数和一个静态成员函数current()创建实例。此外还有访问域的函数：

line()：获取行号。
column()：获取列号。
file_name()：获取文件名。
function_name()：获取函数域名。

实例

废话不多说，直接上实例。

#include <iostream>
#include <string>
#include <source_location>
 
void log(std::string level, 
    std::string message,
    const std::source_location& location = std::source_location::current()){
    std::cout << level
              << location.file_name() << " in function "
              << location.function_name() << " at "
              << location.line() << ':' << location.column() << ": "
              << message << '\n';
}
 
int main()
{
    log("[DEBUG]","Test");
}

输出内容：

[DEBUG]2.cpp in function int main() at 17:8: Test