使用 Buck 生成单包含 C++头文件

原文：https://medium.com/hackernoon/generating-a-single-include-c-header-file-using-buck-827f20be3f9d

TL；速度三角形定位法(dead reckoning)

使用 Buck 为你的库生成一个单包含头文件。这为您的用户提供了一个快速开发的选项，可以在以后进行优化。看看 GitHub 上的一个工作实例。

C++库中的一个常见模式是提供一个头文件，其中包含该库中所有其他的头文件。

例如，假设我们有一个带有这些头的库:

要使用这个库，我们需要包含我们需要的每个头文件:

或者，库设计者可以提供一个单包含头，为我们完成所有这些工作:

mathutils.hpp

用户所要做的就是包含这个标题:

这种方法当然更方便，但也有一些缺点。

首先，单包含头可能会增加编译时间。如果我们只使用来自add.hpp的定义，那么包含的所有内容将需要解析器和预处理器做更多不必要的工作。

第二，它掩盖了你实际上所依赖的头文件。例如，在检查包含图以更好地理解项目时，这会造成混乱。

所以这是两个大的缺点，但是如果你仍然在迭代你的代码，使用单包含可能是一个好主意。为什么要在确定需要哪些标题之前优化你的 includes 呢？

好的，作为一个库设计者，提供一个单包含头可能是一个好主意，但是我们怎样才能生成一个呢？

巴克建立可以在这里帮助我们。如果您不熟悉它，Buck 是来自脸书的高性能构建系统。与其他解决方案相比，使用降压构建的优势在于:

[## 使用降压构建的 7 个理由

Buck 构建脚本是用 Python 编写的，所以我们可以利用 Python 的 list 和 dictionary 函数来生成头。让我们开始吧…

如果你只是想直奔一个工作实例，那就看看GitHub repo。

首先，我们需要获取库中所有的头文件。Buck 为此提供了一个有用的效用函数，称为subdir_glob。

假设这种文件布局…

还有这个剧本…

…输出将是:

一旦我们有了头文件映射，我们需要把它转换成 C++头文件。这在 Python 中相当容易:

Python’s join function is weird!

然后，我们需要创建一个genrule，它接受single_header字符串并将其写入一个文件:

最后一步是将genrule的输出作为头部包含在我们的cxx_library中。幸运的是，Buck 允许我们通过规则的名称来处理规则的输出，从而简化了这一过程:

然而，我们也想要包含未生成的头；我们需要合并这两本词典。Python 没有为字典提供+操作符，但是我们可以编写一个小函数来完成这项工作:

因此，我们的mathutils目标将是:

如果您构建库，那么您将在构建文件夹中看到生成的标题:

这个解决方案最好的一点是它是自动的。如果您将一个.hpp文件添加到include文件夹，那么 Buck 会自动检测到这一点，并重新生成头文件。

我们创建了 Buckaroo 来使集成 C++库变得更容易。如果你想尝试一下，最好从文档开始。您可以在 Buckaroo.pm 或上浏览现有套餐，并在愿望清单上请求更多。

[## C++依赖管理的方法，或者我们为什么要建立 Buckaroo