当前位置: 首页 > news >正文

C++ 的 source_location

1 __FILE__ 和 __LINE__

​ 你一定看过这样的代码:

printf("Internal error at \"%s\" on line %d.\n", __FILE__, __LINE__); 

这行代码的作用就是打印出 printf() 函数调用发生时所在的源代码文件名(包含路径)和这行代码在这个源代码文件中的行数。__FILE____LINE__ 是 C 语言定义的标准预定义宏,编译器会在编译阶段将其展开替换成实际的位置信息。C99 又增加了一个表示当前函数名的宏,就是 __func__,有一些编译器,比如 GCC 也会使用 __FUNCTION_,除了一些细微的语义差别之外,它们的内容展开结果是一样的。

void ProcessLog(t) {printf("error at function: %s\n", __func__); //error at function: ProcessLog
}

2 #line 指令

​ 正常情况下,__FILE____LINE__ 表示的就是调用发生的地方的信息,但是也有例外。在一些复杂系统的编译体系中,部分源代码是通过脚本动态生成的(根据 OS、依赖库或其他信息动态生成支撑层代码),这种情况下预编译程序在替换这两个宏的时候,转换的位置信息与最终的源代码信息可能不一致,导致 C 的代码在脚本中的实际位置可能存在偏差。另外就是源代码文件的名称可能是动态拼接出来的,并不是预处理程序所感知的那个文件名,使得__FILE__的结果也与实际文件名不一致 。

​ 在这种情况下,为了让编译器最终得到准确的信息,需要使用#line预编译指令调整文件名和代码行数信息,这个指令的命令格式是(其中 filename 参数是可选参数):

#line linenum [filename]

linenum 是一个非负整数,表示从这个位置开始,这个文件的代码行从 linenum 指定的数字开始计数。比如这个例子:

#line 200 int main() {printf("Internal error at line %d\n", __LINE__); 
}

printf() 函数输出的结果是:

Internal error at line 203

​ 因为#line是预编译指令,它只影响从这行指令之后的代码中的预编译宏,对这条指令代码位置之前出现的__FILE____LINE__ 没有影响,比如这个例子:

void ProcessLog() {printf("error at function %s (%d).\n", __func__, __LINE__);
}#line 200 int main() {ProcessLog();printf("Internal error at line %d.\n", __LINE__); 
}

最终的输出结果是:

error at function ProcessLog (15).
Internal error at line 204.

可见,ProcessLog() 函数中的__LINE__没有受到这条指令的影响。

​ 如果要调整文件的名字,可以这样使用#line指令:

#line 200 "testfile.cpp"int main() {printf("Internal error at \"%s\" on line %d.\n", __FILE__, __LINE__); 
}

最后的输出结果是:

Internal error at "E:\workspace\01 Test\sl\testfile.cpp" on line 203.

3 std::source_location

​ C++ 也从 C 继承了这些预定义宏,在 C++ 代码中仍然可以使用它们。不过,C++ 20 提供了一个名为 std::source_location 的类,用于表示源代码相关的信息,比如文件名、行号、函数名等等。传统上使用__FILE____LINE__的地方,都可以用这个类代替,并且使用 std::source_location 可以获得更多信息,是更好的选择。

​ std::source_location 的基本用法就是通过这个类的静态函数 current() 可以获得当前调用位置的信息,然后使用 file_name()、line() 等成员方法获取这些信息:

void ProcessLog(const std::string_view message) {const std::source_location location = std::source_location::current();std::cout << "file: "<< location.file_name() << "("<< location.line() << ":"<< location.column() << ") `"<< location.function_name() << "`: "<< message << std::endl;
}

​ 除了多了一个 column 信息,std::source_location 的好处在什么地方?好处就是 std::source_location 能表示更多信息,比如函数,传统的__func__只能得到函数的基本信息,即函数的名称,而 std::source_location 类的 function_name() 可以获得更多的信息:

void ProcessLog(const std::string_view message) {const std::source_location location = std::source_location::current();std::cout << "function: " << location.function_name() << ", " << message << '\n';
}int main(int, char* []) {ProcessLog("Message");
}

上面的代码输出的信息是:

function: void log(std::string_view), Message

函数名包含详细的签名信息。对于函数模板,还会输出模板参数的替换和匹配信息,比如这段代码:

using namespace std::literals;template <typename T> 
void ProcessLog(T x) {const std::source_location location = std::source_location::current();std::cout << "function: " << location.function_name() << ", " << x << '\n';}int main(int, char* []) {ProcessLog("Message"s);
}

代码中的函数模板替换后模板参数 T 的类型就是 std::string,function_name() 的输出信息也包含这部分内容:

function: void ProcessLog(T) [with T = std::basic_string<char>], Message

​ 最后,说重点,第 2 节介绍的#line指令对 std::source_location 也会产生影响,所以,你应该能猜到是什么原因。还有一点就是,目前并不是所有的编译器都支持输出更详细的函数信息,尤其是函数模板参数的替换结果,经过测试,GCC 11 以后的版本支持。

4 参考资料

https://en.cppreference.com/w/cpp/preprocessor/line

https://gcc.gnu.org/onlinedocs/cpp/Line-Control.html#Line-Control

https://en.cppreference.com/w/cpp/utility/source_location

关注作者的算法专栏
https://blog.csdn.net/orbit/category_10400723.html

关注作者的出版物《算法的乐趣(第二版)》
https://www.ituring.com.cn/book/3180

http://www.lryc.cn/news/511083.html

相关文章:

  • [python SQLAlchemy数据库操作入门]-14.实时数据采集 记录股市动态
  • `we_chat_union_id IS NOT NULL` 和 `we_chat_union_id != ‘‘` 这两个条件之间的区别
  • 【和春笋一起学C++】文本输入与读取
  • D类音频应用EMI管理
  • 第N8周:使用Word2vec实现文本分类
  • 100天精通Python(爬虫篇)——第113天:爬虫基础模块之urllib详细教程大全
  • 光谱相机与普通相机的区别
  • Mysql数据 新增、修改和删除操作时,这些变化如何被转换为Kafka消息?
  • 《Python 机器视觉:开启智能视觉新时代》
  • uniapp实现为微信小程序扫一扫的功能
  • 【微信小程序】4plus|搜索框-历史搜索 | 我的咖啡店-综合实训
  • 使用FFmpeg进行拉流和推流操作
  • Unity微信小游戏接入开放数据域
  • Spring Boot的开发工具(DevTools)模块中的热更新特性导致的问题
  • Elasticsearch安装和数据迁移
  • Numpy指南:解锁Python多维数组与矩阵运算(下)
  • 路由器刷机TP-Link tp-link-WDR5660 路由器升级宽带速度
  • VB.NET在 Excel 二次开发中的全面应用
  • uni-app使用组件button遇到的问题
  • 如何在Express.js中处理异常情况?
  • CKA认证 | Day7 K8s存储
  • ArcGIS Pro地形图四至角图经纬度标注与格网标注
  • 策略模式以及优化
  • linux自动化一键批量检查主机端口
  • Vue3入门(9)
  • 《人工智能如何加速药物研发进程:从新药发现到临床试验的突破》
  • “鼎和财险一体化数据安全管控实践”入选信通院金融领域优秀案例
  • 探索多模态大语言模型(MLLMs)的推理能力
  • 72 mysql 的客户端和服务器交互 returnGeneratedKeys
  • 【连续学习之SSL算法】2018年论文Selfless sequential learning