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

2024-08-26 04:04

本文主要是介绍在 CMake 中,find_package 是一个用于查找外部库或包的命令,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

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

1. 基本语法

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

2. 参数说明

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

3. find_package 的两种模式

  • Module 模式: CMake 在 CMAKE_MODULE_PATH 中查找名为 Find<PackageName>.cmake 的模块文件。如果找到了这个文件,CMake 就会执行该文件,通常这个文件会设置与库相关的变量(如 PackageName_INCLUDE_DIRSPackageName_LIBRARIES)。

    示例:

    find_package(Boost REQUIRED COMPONENTS system filesystem)
    
  • Config 模式: CMake 查找 <PackageName>Config.cmake<lowercasename>-config.cmake 文件。这种文件通常由包的安装过程生成,并包含包的所有信息。Config 模式是推荐的模式,特别是在使用现代 CMake 时。

    示例:

    find_package(Qt5 REQUIRED COMPONENTS Core Widgets)
    

4. 查找结果

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

  • <PackageName>_FOUND:如果找到了包,则该变量为 TRUE,否则为 FALSE
  • <PackageName>_INCLUDE_DIRS:包含该包的头文件目录。
  • <PackageName>_LIBRARIES:链接该包所需的库列表。
  • <PackageName>_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<PackageName>.cmake 模块。可以使用 CMAKE_MODULE_PATH 变量来指定自定义模块路径:

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

总结

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

这篇关于在 CMake 中,find_package 是一个用于查找外部库或包的命令的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1107493

相关文章

Linux join命令的使用及说明

《Linuxjoin命令的使用及说明》`join`命令用于在Linux中按字段将两个文件进行连接,类似于SQL的JOIN,它需要两个文件按用于匹配的字段排序,并且第一个文件的换行符必须是LF,`jo... 目录一. 基本语法二. 数据准备三. 指定文件的连接key四.-a输出指定文件的所有行五.-o指定输出

Linux jq命令的使用解读

《Linuxjq命令的使用解读》jq是一个强大的命令行工具,用于处理JSON数据,它可以用来查看、过滤、修改、格式化JSON数据,通过使用各种选项和过滤器,可以实现复杂的JSON处理任务... 目录一. 简介二. 选项2.1.2.2-c2.3-r2.4-R三. 字段提取3.1 普通字段3.2 数组字段四.

Python版本与package版本兼容性检查方法总结

《Python版本与package版本兼容性检查方法总结》:本文主要介绍Python版本与package版本兼容性检查方法的相关资料,文中提供四种检查方法,分别是pip查询、conda管理、PyP... 目录引言为什么会出现兼容性问题方法一:用 pip 官方命令查询可用版本方法二:conda 管理包环境方法

java中ssh2执行多条命令的四种方法

《java中ssh2执行多条命令的四种方法》本文主要介绍了java中ssh2执行多条命令的四种方法,包括分号分隔、管道分隔、EOF块、脚本调用,可确保环境配置生效,提升操作效率,具有一定的参考价值,感... 目录1 使用分号隔开2 使用管道符号隔开3 使用写EOF的方式4 使用脚本的方式大家平时有没有遇到自

Linux命令rm如何删除名字以“-”开头的文件

《Linux命令rm如何删除名字以“-”开头的文件》Linux中,命令的解析机制非常灵活,它会根据命令的开头字符来判断是否需要执行命令选项,对于文件操作命令(如rm、ls等),系统默认会将命令开头的某... 目录先搞懂:为啥“-”开头的文件删不掉?两种超简单的删除方法(小白也能学会)方法1:用“--”分隔命

linux查找java项目日志查找报错信息方式

《linux查找java项目日志查找报错信息方式》日志查找定位步骤:进入项目,用tail-f实时跟踪日志,tail-n1000查看末尾1000行,grep搜索关键词或时间,vim内精准查找并高亮定位,... 目录日志查找定位在当前文件里找到报错消息总结日志查找定位1.cd 进入项目2.正常日志 和错误日

Redis 的 SUBSCRIBE命令详解

《Redis的SUBSCRIBE命令详解》Redis的SUBSCRIBE命令用于订阅一个或多个频道,以便接收发送到这些频道的消息,本文给大家介绍Redis的SUBSCRIBE命令,感兴趣的朋友跟随... 目录基本语法工作原理示例消息格式相关命令python 示例Redis 的 SUBSCRIBE 命令用于订

防止Linux rm命令误操作的多场景防护方案与实践

《防止Linuxrm命令误操作的多场景防护方案与实践》在Linux系统中,rm命令是删除文件和目录的高效工具,但一旦误操作,如执行rm-rf/或rm-rf/*,极易导致系统数据灾难,本文针对不同场景... 目录引言理解 rm 命令及误操作风险rm 命令基础常见误操作案例防护方案使用 rm编程 别名及安全删除

Java使用jar命令配置服务器端口的完整指南

《Java使用jar命令配置服务器端口的完整指南》本文将详细介绍如何使用java-jar命令启动应用,并重点讲解如何配置服务器端口,同时提供一个实用的Web工具来简化这一过程,希望对大家有所帮助... 目录1. Java Jar文件简介1.1 什么是Jar文件1.2 创建可执行Jar文件2. 使用java

C#高效实现Word文档内容查找与替换的6种方法

《C#高效实现Word文档内容查找与替换的6种方法》在日常文档处理工作中,尤其是面对大型Word文档时,手动查找、替换文本往往既耗时又容易出错,本文整理了C#查找与替换Word内容的6种方法,大家可以... 目录环境准备方法一:查找文本并替换为新文本方法二:使用正则表达式查找并替换文本方法三:将文本替换为图