CMake target_include_directories 范围的含义

Question

与CMake的target_include_directories相关的关键字PUBLIC、PRIVATE、INTERFACE是什么意思？

Answer 1

这些关键字用于告诉何时需要您传递给目标的包含目录列表。 when 表示是否需要这些包含目录：

• 编译该目标本身。
• 编译依赖于该目标的其他目标（例如使用其公共标头）。
• 在上述两种情况下。

当 CMake 编译目标时，它使用目标 INCLUDE_DIRECTORIES、COMPILE_DEFINITIONS 和 COMPILE_OPTIONS 属性。当您在 target_include_directories() 等中使用 PRIVATE 关键字时，您会告诉 CMake 填充这些目标属性。

当 CMake 检测到目标 A 和另一个目标 B 之间的依赖关系时（例如使用 target_link_libraries(A B) 命令时），它会将 B 使用要求传递到 A 目标。那些目标使用要求是依赖于B 的任何目标必须满足的包含目录、编译定义等。它们由上面列出的属性的INTERFACE_* 版本（如INTERFACE_INCLUDE_DIRECTORIES）指定，并在调用target_*() 命令时使用INTERFACE 关键字填充。

PUBLIC 关键字大致意思是PRIVATE + INTERFACE。

因此，假设您正在创建一个库 A，它使用了一些 Boost 标头。你会这样做：

• target_include_directories(A PRIVATE ${Boost_INCLUDE_DIRS}) 如果您只在源文件 (.cpp) 或私有头文件 (.h) 中使用这些 Boost 标头。
• target_include_directories(A INTERFACE ${Boost_INCLUDE_DIRS}) 如果您不在源文件中使用那些 Boost 头文件（因此，不需要它们来编译 A）。我真的想不出一个真实的例子。
• target_include_directories(A PUBLIC ${Boost_INCLUDE_DIRS}) 如果您在公共头文件中使用这些 Boost 头文件，这些头文件既包含在 A 的某些源文件中，也可能包含在您的 A 库的任何其他客户端中。

CMake 3.0 文档对此build specification and usage requirements 属性有更多详细信息。

Answer 2

需要 INTERFACE、PUBLIC 和 PRIVATE 关键字来指定 以下论点的范围。 PRIVATE 和 PUBLIC 项目将 填充 的 INCLUDE_DIRECTORIES 属性。公众和 INTERFACE 项目将填充 INTERFACE_INCLUDE_DIRECTORIES 的属性。以下参数指定包括 目录。

来自文档：http://www.cmake.org/cmake/help/v3.0/command/target_include_directories.html

用我自己的话改写文档：

• 您想将目录添加到目标的包含目录列表中
• 使用 PRIVATE 将目录添加到目标的包含目录中
• 使用 INTERFACE，目标不会被修改，但 INTERFACE_INCLUDE_DIRECTORIES 由目录扩展。该变量是库的公共包含目录列表。
• 使用 PUBLIC 会执行来自 PRIVATE 和 INTERFACE 的操作。