find_program¶
简写签名是
find_program (<VAR> name1 [path1 path2 ...])
通用签名是
find_program ( <VAR> name | NAMES name1 [name2 ...] [NAMES_PER_DIR] [HINTS [path | ENV var]...] [PATHS [path | ENV var]...] [REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)] [PATH_SUFFIXES suffix1 [suffix2 ...]] [VALIDATOR function] [DOC "cache documentation string"] [NO_CACHE] [REQUIRED] [NO_DEFAULT_PATH] [NO_PACKAGE_ROOT_PATH] [NO_CMAKE_PATH] [NO_CMAKE_ENVIRONMENT_PATH] [NO_SYSTEM_ENVIRONMENT_PATH] [NO_CMAKE_SYSTEM_PATH] [NO_CMAKE_INSTALL_PREFIX] [CMAKE_FIND_ROOT_PATH_BOTH | ONLY_CMAKE_FIND_ROOT_PATH | NO_CMAKE_FIND_ROOT_PATH] )
此命令用于查找程序。将创建一个由 <VAR>
命名的缓存条目,或者如果指定了 NO_CACHE
,则创建一个普通变量,用于存储此命令的结果。如果找到程序,结果将存储在变量中,并且除非清除该变量,否则不会重复搜索。如果未找到任何内容,则结果将为 <VAR>-NOTFOUND
。
选项包括
NAMES
指定程序的一个或多个可能的名称。
当使用此选项指定带版本后缀和不带版本后缀的名称时,我们建议首先指定不带版本的名称,以便可以先找到本地构建的软件包,然后再找到发行版提供的软件包。
HINTS
,PATHS
指定要搜索的目录,除了默认位置之外。
ENV var
子选项从系统环境变量中读取路径。在 3.24 版本中变更: 在
Windows
平台上,可以包含注册表查询作为目录的一部分,使用 专用语法。此类规范将在所有其他平台上被忽略。REGISTRY_VIEW
在 3.24 版本中添加。
指定必须查询的注册表视图。此选项仅在
Windows
平台上才有意义,在其他平台上将被忽略。如果未指定,当CMP0134
策略为NEW
时,将使用BOTH
视图。有关策略为OLD
时的默认视图,请参阅CMP0134
。64
查询 64 位注册表。在 32 位 Windows 上,它始终返回字符串
/REGISTRY-NOTFOUND
。32
查询 32 位注册表。
64_32
查询两个视图(
64
和32
)并为每个视图生成一个路径。32_64
查询两个视图(
32
和64
)并为每个视图生成一个路径。HOST
查询与主机架构匹配的注册表:在 64 位 Windows 上为
64
,在 32 位 Windows 上为32
。TARGET
查询与
CMAKE_SIZEOF_VOID_P
变量指定的架构匹配的注册表。如果未定义,则回退到HOST
视图。BOTH
查询两个视图(
32
和64
)。顺序取决于以下规则:如果定义了CMAKE_SIZEOF_VOID_P
变量,请根据此变量的内容使用以下视图8
:64_32
4
:32_64
如果未定义
CMAKE_SIZEOF_VOID_P
变量,则依赖于主机的架构64 位:
64_32
32 位:
32
PATH_SUFFIXES
指定要在其他考虑的每个目录位置下检查的其他子目录。
VALIDATOR
在 3.25 版本中添加。
指定一个
function()
,用于为找到的每个候选项目调用(不能提供macro()
,这将导致错误)。将向验证器函数传递两个参数:结果变量的名称和候选项目的绝对路径。除非该函数在调用范围内将结果变量中的值设置为 false,否则该项目将被接受,并且搜索将结束。当输入验证器函数时,结果变量将保存一个 true 值。function(my_check validator_result_var item) if(NOT item MATCHES ...) set(${validator_result_var} FALSE PARENT_SCOPE) endif() endfunction() find_program (result NAMES ... VALIDATOR my_check)
请注意,如果使用缓存结果,则会跳过搜索,并且任何
VALIDATOR
都将被忽略。缓存结果不需要通过验证函数。DOC
为
<VAR>
缓存条目指定文档字符串。NO_CACHE
在 3.21 版本中添加。
搜索结果将存储在普通变量中,而不是缓存条目中。
注意
如果在调用之前已设置变量(作为普通变量或缓存变量),则不会进行搜索。
警告
应谨慎使用此选项,因为它会大大增加重复配置步骤的成本。
REQUIRED
在 3.18 版本中添加。
如果未找到任何内容,则停止处理并显示错误消息,否则下次使用相同的变量调用 find_program 时将再次尝试搜索。
如果指定了 NO_DEFAULT_PATH
,则不会将其他路径添加到搜索中。如果未指定 NO_DEFAULT_PATH
,则搜索过程如下
如果从 find 模块或通过调用
find_package(<PackageName>)
加载的任何其他脚本中调用,则搜索当前正在查找的软件包的唯一前缀。请参阅策略CMP0074
。在 3.12 版本中添加。
具体而言,按顺序搜索以下变量指定的路径
<PackageName>_ROOT
CMake 变量,其中<PackageName>
是区分大小写的软件包名称。<PACKAGENAME>_ROOT
CMake 变量,其中<PACKAGENAME>
是大写的软件包名称。请参阅策略CMP0144
。在 3.27 版本中添加。
<PackageName>_ROOT
环境变量,其中<PackageName>
是区分大小写的软件包名称。<PACKAGENAME>_ROOT
环境变量,其中<PACKAGENAME>
是大写的软件包名称。请参阅策略CMP0144
。在 3.27 版本中添加。
软件包根变量维护为堆栈,因此如果从嵌套的 find 模块或配置软件包中调用,则将在当前模块或软件包的路径之后搜索父级的 find 模块或配置软件包的根路径。换句话说,搜索顺序将是
<CurrentPackage>_ROOT
、ENV{<CurrentPackage>_ROOT}
、<ParentPackage>_ROOT
、ENV{<ParentPackage>_ROOT}
等。如果传递了NO_PACKAGE_ROOT_PATH
或将CMAKE_FIND_USE_PACKAGE_ROOT_PATH
设置为FALSE
,则可以跳过此步骤。对于
<PackageName>_ROOT
CMake 变量和<PackageName>_ROOT
环境变量中的每个<prefix>
,如果从find_package(<PackageName>)
加载的 find 模块中调用,则为<prefix>/[s]bin
在 cmake 特定的缓存变量中指定的搜索路径。这些旨在与命令行上的
-DVAR=value
一起使用。这些值被解释为 分号分隔的列表。如果传递了NO_CMAKE_PATH
或将CMAKE_FIND_USE_CMAKE_PATH
设置为FALSE
,则可以跳过此步骤。对于
CMAKE_PREFIX_PATH
中的每个<prefix>
,<prefix>/[s]bin
在 cmake 特定的环境变量中指定的搜索路径。这些旨在在用户的 shell 配置中设置,因此使用主机本机路径分隔符(Windows 上为
;
,UNIX 上为:
)。如果传递了NO_CMAKE_ENVIRONMENT_PATH
或将CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH
设置为FALSE
,则可以跳过此步骤。对于
CMAKE_PREFIX_PATH
中的每个<prefix>
,<prefix>/[s]bin
搜索
HINTS
选项指定的路径。这些应该是系统自检计算的路径,例如已找到的另一项的位置提供的提示。硬编码的猜测应使用PATHS
选项指定。搜索标准系统环境变量。如果传递了
NO_SYSTEM_ENVIRONMENT_PATH
或将CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH
设置为FALSE
,则可以跳过此步骤。PATH
本身中的目录。
搜索在当前系统的平台文件中定义的 cmake 变量。如果传递了
NO_CMAKE_INSTALL_PREFIX
或将CMAKE_FIND_USE_INSTALL_PREFIX
设置为FALSE
,则可以跳过CMAKE_INSTALL_PREFIX
和CMAKE_STAGING_PREFIX
的搜索。如果传递了NO_CMAKE_SYSTEM_PATH
或将CMAKE_FIND_USE_CMAKE_SYSTEM_PATH
设置为FALSE
,则可以跳过所有这些位置。对于
CMAKE_SYSTEM_PREFIX_PATH
中的每个<prefix>
,<prefix>/[s]bin
这些变量包含的平台路径是通常包含已安装软件的位置。例如,基于 UNIX 的平台为
/usr/local
。搜索 PATHS 选项或命令的简写版本中指定的路径。这些通常是硬编码的猜测。
CMAKE_IGNORE_PATH
、CMAKE_IGNORE_PREFIX_PATH
、CMAKE_SYSTEM_IGNORE_PATH
和 CMAKE_SYSTEM_IGNORE_PREFIX_PATH
变量也可能导致忽略上述某些位置。
在 3.16 版本中添加: 添加了 CMAKE_FIND_USE_<CATEGORY>_PATH
变量以全局禁用各种搜索位置。
在 macOS 上,CMAKE_FIND_FRAMEWORK
和 CMAKE_FIND_APPBUNDLE
变量确定 Apple 风格和 unix 风格的软件包组件之间的优先级顺序。
CMake 变量 CMAKE_FIND_ROOT_PATH
指定一个或多个目录,这些目录将添加到所有其他搜索目录的前面。这有效地将整个搜索“重新扎根”到给定的位置下。作为 CMAKE_STAGING_PREFIX
后代的路径将从此重新扎根中排除,因为该变量始终是主机系统上的路径。默认情况下,CMAKE_FIND_ROOT_PATH
为空。
CMAKE_SYSROOT
变量也可以用于指定一个目录作为前缀。设置 CMAKE_SYSROOT
还有其他影响。有关更多信息,请参阅该变量的文档。
当交叉编译以指向目标环境的根目录时,这些变量特别有用,CMake 也将在那里搜索。默认情况下,首先搜索 CMAKE_FIND_ROOT_PATH
中列出的目录,然后搜索 CMAKE_SYSROOT
目录,然后搜索非根目录。可以通过设置 CMAKE_FIND_ROOT_PATH_MODE_PROGRAM
来调整默认行为。可以使用以下选项在每次调用时手动覆盖此行为
CMAKE_FIND_ROOT_PATH_BOTH
按上述顺序搜索。
NO_CMAKE_FIND_ROOT_PATH
不使用
CMAKE_FIND_ROOT_PATH
变量。ONLY_CMAKE_FIND_ROOT_PATH
仅搜索重新扎根的目录和
CMAKE_STAGING_PREFIX
下的目录。
默认搜索顺序旨在针对常见用例从最具体到最不具体。项目可以通过简单地多次调用命令并使用 NO_*
选项来覆盖顺序
find_program (<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH) find_program (<VAR> NAMES name)
一旦其中一个调用成功,结果变量将被设置并存储在缓存中,以便不再进行搜索。
当为 NAMES
选项提供多个值时,默认情况下,此命令将一次考虑一个名称,并在每个目录中搜索它。NAMES_PER_DIR
选项告诉此命令一次考虑一个目录,并在其中搜索所有名称。
被认为是程序的文件的集合是平台特定的
在 Windows 上,文件名后缀按
.com
、.exe
和无后缀的顺序考虑。在非 Windows 系统上,不考虑文件名后缀,但文件必须具有执行权限(请参阅策略
CMP0109
)。
要搜索脚本,请显式指定扩展名
if(WIN32)
set(_script_suffix .bat)
else()
set(_script_suffix .sh)
endif()
find_program(MY_SCRIPT NAMES my_script${_script_suffix})