通过bash-script查找和修改函数定义(c++)

Finding and modifying function definitions (C++) via bash-script

本文关键字：定义 c++ 函数 修改 bash-script 查找 通过      更新时间：2023-10-16

目前我正在做一个相当大的项目。为了提高代码的质量，我们决定对每个函数强制执行返回值(错误码)的处理。GCC支持关于函数返回值的警告，但是函数定义之前必须有以下标志。

static __attribute__((warn_unused_result)) ErrorCode test() { /* code goes here */ }

我想实现一个bashscript，解析整个源代码，并发出警告，如果

__attribute__((warn_unused_result))

是失踪。注意，所有需要这种修改的函数都返回一个名为ErrorCode的类型。您认为这可以通过bash脚本实现吗?

也许您可以使用sed与正则表达式。下面的方法在我尝试的几个测试文件上对我有效:

sed -r "s/ErrorCodes+w+s*(.*)s*{/__attribute__((warn_unused_result)) /g" test.cpp

如果你不熟悉regex，这个模式基本上可以翻译成:

ErrorCode，一些空格，一些字母数字(函数名)，可能一些空格，左括号，任何(参数)，右括号，可能一些空格，左花括号。

如果发现此模式，则以__attribute__((warn_unused_result))作为前缀。注意，这只适用于将左花括号始终与参数放在同一行并且在函数声明中没有换行符的情况。

我能想到的一个简单的方法是通过ctags。在所有源代码上创建一个标记文件，然后解析该标记文件。但是，我不太确定标签文件的格式。我在这里使用的变体(Exuberant Ctags 5.8)似乎在第四列中放了一个"f"，如果标记表示一个函数的话。所以在这种情况下，我将使用awk来过滤所有表示函数的标记，然后grep来丢弃所有没有__attribute__((warn_unused_result))的行。

简而言之，首先你要做

$ ctags **/*.c

这将在当前目录中创建一个名为"tags"的文件。该命令也可能是ctags-exuberant，这取决于您的变体。**/*.c是一个可能在您的shell中工作的glob模式-如果它不起作用，您必须以另一种方式提供源文件(查看ctags选项)。

然后过滤函数:

$ cat tags | awk -F 't' '$4 == "f" {print $0}' | grep -v "__attribute__((warn_unused_result))"

不，一般情况下是不可能的。c++语法是我所知道的所有语言中最复杂的，而且在一般情况下，c++不能通过正则表达式进行解析。如果你把自己限制在一组非常狭窄的用途上，你可能会成功，但我不确定这在你的情况下是否可行。我也不认为这个练习是值得的，因为有时忽略函数的结果是一个OK的事情。

相关文章：