在 C++ 中查找非实例化模板代码

Question

在 C++ 代码中查找未实例化模板的最佳方法是什么？

我有一个大量使用模板的代码库。 当然，我们希望确保测试覆盖率很高。 对于所有使用的代码，使用 gcov 效果非常好。

但是，未使用的模板会被 gcov 报告为不可执行。

经过一番谷歌搜索后，似乎没有办法强制 g++ 为这些模板发出代码（这只是逻辑上的，编译器应该如何猜测任何类型？） 似乎也没有办法让 gcov 将未实例化的模板代码识别为可运行代码。

是否有任何“开箱即用”的东西可以让我增强 GCC -ftest-coverage -fprofile-arcs 工具生成的文件？通过 GCC 的 gcov 选项文档 ，将整个模板函数体标记为一个块可能就足够了，因为执行永远不会在那里结束。

编辑（背景信息）：我正在开发一个仅包含标题的模板库。 我的目标是找到未使用/未经测试的功能。

我知道代码覆盖率是有缺陷的，但找到未实例化的代码是迈向更好地测试代码的非常重要的一步。 目前，我们将检查点宏放在每个函数的开头。 在测试模式下，它们扩展为将一对（文件，行）插入到一组已通过的检查点的全局中的代码。 运行测试后，我们手动读取所有文件并将到达的检查点与所有可用检查点集进行比较。

查找未实例化的代码很重要，例如，由于不直观的 C​​++ 模板优先行为，读者甚至作者希望使用的某个地方可能存在死代码。

Answer 1

我认为我们的 C++ 测试覆盖率 工具（不是基于 GCC 的）可以正确执行此操作你的观点。

它在编译器看到源代码之前对源代码进行检测；无论模板是否被使用，模板内的代码都会获得“覆盖探测”。该工具的测试覆盖率显示部分知道所有探针的位置；如果模板代码未实例化，则显然无法执行，这就是报告的内容。您不必执行任何“自定义”宏插入或其他，呃，废话。

缺点是，如果您有一个由多种不同类型参数化的模板，并且针对不同的实例化类型执行模板方法 m1 和 m2，则您对 m1 和 m2 的覆盖率将是 100%（毕竟，您执行了插装模板）。目前还不清楚这是否不好；只是这就是如何解释的。

Answer 2

好吧，因为我不太熟悉 GCC，所以这是一个乏味且非常耗时的解决方案，但至少它有效！ :)
该测试依赖于这样一个事实，即在实际实例化之前，即当模板参数中实际不存在依赖名称时，不会检测到模板代码中的某些错误：

template<class T>
struct Example{
  typedef typename T::_123344_non_existent_type instantiation_test;
};

将这样的 typedef 添加到您拥有的每个模板中，然后进行编译。从编译器显示错误的每个结构/类/函数中删除它，并且当代码最终编译时仍然包含此类 typedef 的每个模板永远不会被实例化。或者你很不幸，某些类型确实定义了这样的 _123344_non_existent_type，尽管我会私刑处死对此负责的同事。 ;)

Answer 3

我遇到了同样的问题，所以我编写了一个修改代码覆盖率报告以显示未实例化模板的程序。它不是最优雅的，但它确实有效。

有两个阶段：

• 在编译之前，您使用使用 Clang 的 Libtooling 编写的 C++ 程序来查找代码中的所有模板，并在它们之前和之后插入注释。
• 生成测试覆盖率报告后，您运行一个 python 脚本，该脚本会遍历该报告并修改步骤 1 中的注释所包含的行。

因此，基本上它利用了这样一个事实：即使留下了很多代码从二进制文件中，几乎所有内容都最终出现在最终的覆盖率报告中。这个问题中描述的宏是这种方法的灵感（它基本上是它们的自动化版本，不会使源代码混乱）。

到目前为止，我只在我自己的代码中使用过它，但它应该具有普遍性。欢迎提出问题和请求！