在 CMake 中，find_package 是一个用于查找外部库或包的命令

在 CMake 中，find_package 是一个用于查找外部库或包的命令。它使得你的 CMake 构建系统可以依赖于其他库或工具，并自动设置相关的编译和链接参数。find_package 是配置现代 CMake 项目的关键部分，特别是当你希望你的项目能够使用或依赖于第三方库时。

1. 基本语法

find_package( [version] [REQUIRED] [COMPONENTS components...] [OPTIONAL_COMPONENTS components...] [EXACT] [QUIET] [NO_MODULE] [MODULE])

2. 参数说明

• : 你要查找的包的名称。例如，Boost、OpenCV、Qt5 等。
• [version]: 指定包的最低版本。如果不指定，则接受任意版本。
• REQUIRED: 表示此包是必需的。如果找不到该包，CMake 将终止并报告错误。
• COMPONENTS: 列出你希望从该包中使用的特定组件。例如，在查找 Qt5 时，你可以指定使用 Core 和 Widgets 组件。
• OPTIONAL_COMPONENTS: 列出你希望查找但不是必需的组件。如果这些组件不可用，CMake 不会报错。
• EXACT: 要求版本号必须完全匹配。
• QUIET: 在找不到包时，抑制警告消息，但仍然会失败。
• NO_MODULE: 强制 CMake 仅使用 Config 模式查找包，而不是 Module 模式。
• MODULE: 强制 CMake 仅使用 Module 模式查找包。

3. find_package 的两种模式

• Module 模式: CMake 在 CMAKE_MODULE_PATH 中查找名为 Find.cmake 的模块文件。如果找到了这个文件，CMake 就会执行该文件，通常这个文件会设置与库相关的变量（如 PackageName_INCLUDE_DIRS、PackageName_LIBRARIES）。

  示例：

  find_package(Boost REQUIRED COMPONENTS system filesystem)
  

• Config 模式: CMake 查找 Config.cmake 或 -config.cmake 文件。这种文件通常由包的安装过程生成，并包含包的所有信息。Config 模式是推荐的模式，特别是在使用现代 CMake 时。

  示例：

  find_package(Qt5 REQUIRED COMPONENTS Core Widgets)
  

4. 查找结果

在调用 find_package 之后，通常会设置一组与包相关的变量，你可以在之后的 CMake 脚本中使用这些变量。例如：

• _FOUND：如果找到了包，则该变量为 TRUE，否则为 FALSE。
• _INCLUDE_DIRS：包含该包的头文件目录。
• _LIBRARIES：链接该包所需的库列表。
• _VERSION：找到的包的版本。

5. 示例

5.1 查找 Boost 库

find_package(Boost 1.70 REQUIRED COMPONENTS system filesystem)
if(Boost_FOUND)
    include_directories(${Boost_INCLUDE_DIRS})
    target_link_libraries(myTarget ${Boost_LIBRARIES})
endif()

5.2 查找 Qt5 库

find_package(Qt5 5.15 REQUIRED COMPONENTS Core Widgets)
if(Qt5_FOUND)
    target_link_libraries(myTarget Qt5::Core Qt5::Widgets)
endif()

6. 自定义 find_package 的模块路径

有时，你可能需要为特定的包编写自定义的 Find.cmake 模块。可以使用 CMAKE_MODULE_PATH 变量来指定自定义模块路径：

set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/modules/")
find_package(MyCustomPackage REQUIRED)

总结

find_package 是 CMake 中非常重要的命令，用于管理项目对外部库和包的依赖。理解它的用法和工作原理，对于编写健壮、可移植的 CMake 脚本至关重要。