有没有一个工具可以添加“覆盖”现有 C++ 的标识符代码

Question

任务

我正在尝试找出如何最好地添加 C++0x 的 override< 的 /a> 已在大量 C++ 代码中覆盖的所有现有方法的标识符，无需手动执行。

（我们有很多很多数十万行代码，手动执行完全不可能。）

当前的想法

我们的编码标准表明我们应该对所有隐式添加 virtual 关键字派生类中的虚拟方法，即使完全没有必要（以帮助理解）。

因此，如果我自己编写添加脚本，我会编写一个脚本来读取所有标头，找到所有以 virtual 开头的函数，并在下面的分号之前插入 override。然后在支持覆盖的编译器上进行编译，并修复基类中的所有错误。

但我真的不想使用这种本土方法，因为：

• 它显然会很乏味且容易出错。
• 并不是每个人都记得每次都添加 virtual 关键字，因此此方法会错过一些现有的覆盖

有现有的工具吗？

那么，是否已经有一个工具可以解析 C++ 代码、检测现有的重写方法并将 override 附加到其声明中？

（我知道诸如 PC-lint 之类的静态分析工具会警告看起来应该被覆盖的函数我所追求的是实际上会破坏我们的代码的东西，以便将来在编译时检测到覆盖中的错误，而不是稍后在静态分析中检测到）

（以防有人想指出 C++） 03 不支持“覆盖”...中实际上，我会添加一个宏，而不是实际的“覆盖”标识符，以便在不支持此功能的旧编译器上使用我们的代码，因此在添加标识符后，我会运行一个单独的脚本来替换。它与我们要使用的任何宏一起使用...）

提前致谢...

Answer 1

LLVM 项目正在开发一个名为“cpp11-migrate”的工具，目前具有以下功能：

• 将循环转换为基于范围的 for 循环
• 转换空指针常量（如 NULL 或 0 ) 到 C++11 nullptr
• 将变量声明中的类型说明符替换为 auto 类型说明符
• 将 override 说明符添加到适用的成员函数

这个工具是记录于此处，并应作为 clang 3.3 的一部分发布。
但是，您今天可以下载源代码并自行构建。

编辑

更多信息：

• 状态C++11 Migrator - 一篇博客文章，日期为 2013 年 4 月 15 日
• cpp11-migrate 用户手册

编辑 2：2013-09-07

“cpp11-migrate”已重命名为“clang 现代化"。对于 Windows 用户，它现在包含在新的 LLVM 快照版本中。

编辑 3：2020-10-07

“clang-modernize”已重命名为“Clang-Tidy"。

Answer 2

我们的 DMS 软件重新工程工具包及其支持 C++11 的C++ 前端 可以做到这一点。

DMS是一个用于任意编程语言的通用程序转换系统； C++ 前端允许它处理 C++。 DMS 解析、构建准确的 AST 和符号表（这对于 C++ 来说很难做到），提供对 AST 节点和树的属性查询的支持，允许在树上进行过程和源到源的转换。完成所有更改后，可以重新生成修改后的树并保留注释。

您的问题要求您找到派生的虚拟方法并更改它们。执行此操作的 DMS 源到源转换规则类似于：

    source domain Cpp.  -- tells DMS the following rules are for C++

    rule insert_virtual_keyword (n:identifier, a: arguments, s: statements):
       method_declaration -> method_declaration " =
       " void \n(\a) { \s } "  ->  " virtual void \n(\a) { \s }"
       if is_implicitly_virtual(n).

此类规则与语法树匹配，因此它们不会与注释、字符串或其他内容不匹配。有趣的引号不是 C++ 字符串引号；而是 C++ 字符串引号。它们是元引号，允许规则语言知道其中的内容必须被视为目标语言（“Cpp”）语法。反斜杠是目标语言文本的转义符，允许匹配任意结构，例如，\a 表示需要“a”，它被定义为句法类别“参数”。

您需要更多规则来处理函数返回非空结果等的情况，但您不应该需要很多规则。

有趣的部分是实现控制转换应用的谓词（返回 TRUE 或 FALSE）：is_implicitly_virtual。该谓词采用方法名称 n（其抽象语法树）。
该谓词将查阅完整的 C++ 符号表来确定 n 到底是什么。我们已经从其语法设置中知道它是一个方法，但我们想知道在什么类上下文中。
符号表提供了方法和类之间的联系，类的符号表信息告诉我们这个类继承自什么，对于那些类来说，它们包含哪些方法以及它们是如何声明的，最终导致发现（或不是）父类方法是虚拟的。执行此操作的代码必须作为违反 C++ 符号表 API 的过程代码来实现。然而，所有的努力都已经完成了；符号表是正确的，并且包含对所有其他所需数据的引用。 （如果您没有这些信息，您就不可能通过算法做出决定，并且任何代码更改都可能是错误的）。

过去，DMS 已被用来通过程序转换对 C++ 代码进行大规模更改。（查看网站上的论文页面以了解 C++ 重新架构主题）。

（我不是C++专家，只是DMS架构师，所以如果我有一些小细节错误，请原谅。）

Answer 3

几个月前，我用大约 3 MB 的代码做了类似的事情，虽然你说“手动完成这件事完全不可能”，但我认为这是唯一的方法。原因是您应该将 override 关键字应用于旨在覆盖基类方法的原型。任何添加它的工具都会将其放在实际上重写基类方法的原型上。编译器已经知道这些方法是哪些，因此添加关键字不会改变任何内容。 （请注意，我对新标准不是很熟悉，并且我假设 override 关键字是可选的。Visual Studio 至少从 VS2005 开始就支持 override。）

我在头文件中搜索“virtual”来找到大部分他们，我仍然偶尔会发现另一个缺少 override 关键字的原型。

我通过这个过程发现了两个错误。

Answer 4

Eclipse CDT 有一个可用的 C++ 解析器和语义实用程序。最新版本的 IIRC 还具有覆盖方法的标记。

不需要太多代码来编写一个基于此的插件，并在适当的情况下重写代码以包含 override 标记。

Answer 5

一种选择是

启用建议覆盖编译器警告然后编写脚本
它可以将 override 关键字插入到发出警告所指向的位置