CheckOBJCXXSourceCompiles

3.16 版新增。

此模块提供了一个命令,用于检查 Objective-C++ 源代码是否可以构建。

在 CMake 项目中加载此模块,使用

include(CheckOBJCXXSourceCompiles)

命令

此模块提供以下命令

check_objcxx_source_compiles

检查给定的 Objective-C++ 源代码是否可以构建。

check_objcxx_source_compiles(<code> <variable> [FAIL_REGEX <regexes>...])

此命令一次性检查在 <code> 中提供的源代码是否可以编译(并链接成可执行文件)。检查结果存储在由 <variable> 指定的内部缓存变量中。

参数为

<code>

要检查的 Objective-C++ 源代码。这必须是一个完整的程序,如同写入包含主体块的文件中一样。源代码中使用的所有符号都应像往常一样在其相应的头文件中声明。

<variable>

内部缓存变量的变量名,用于存储检查结果,成功为布尔真,失败为布尔假。

FAIL_REGEX <regexes>...

如果此选项提供一个或多个正则表达式,则通过检查编译器输出中是否有任何内容与指定的任何正则表达式匹配来确定失败。

影响检查的变量

在调用此命令之前,可以设置以下变量来修改检查的运行方式

CMAKE_REQUIRED_FLAGS

要传递给编译器的额外标志的空格分隔字符串。分号分隔列表将不起作用。CMAKE_<LANG>_FLAGS 及其关联的特定配置的 CMAKE_<LANG>_FLAGS_<CONFIG> 变量的内容会自动添加到编译器命令之前,然后是此变量的内容。

CMAKE_REQUIRED_DEFINITIONS

编译器定义的分号分隔列表,每个定义的形式为 -DFOO-DFOO=bar。还会自动添加一个由检查命令的结果变量参数指定的名称的定义。

CMAKE_REQUIRED_INCLUDES

要传递给编译器的头文件搜索路径的分号分隔列表。这些将是唯一使用的头文件搜索路径;INCLUDE_DIRECTORIES 目录属性的内容将被忽略。

CMAKE_REQUIRED_LINK_OPTIONS

3.14 版新增。

要添加到链接命令的选项的分号分隔列表(更多详情请参阅try_compile())。

CMAKE_REQUIRED_LIBRARIES

要添加到链接命令的库的分号分隔列表。这些可以是系统库的名称,也可以是导入目标(更多详情请参阅try_compile())。

CMAKE_REQUIRED_LINK_DIRECTORIES

在版本 3.31 中添加。

要传递给链接器的库搜索路径的分号分隔列表(更多详情请参阅try_compile())。

CMAKE_REQUIRED_QUIET

版本 3.1 中新增。

如果此变量评估为布尔真值,则与检查关联的所有状态消息都将被抑制。

CMAKE_TRY_COMPILE_TARGET_TYPE

在内部,使用try_compile() 命令执行检查,此变量控制它创建的目标类型。如果此变量设置为 EXECUTABLE(默认),则检查会将测试源代码编译并链接为可执行程序。如果设置为 STATIC_LIBRARY,则测试源代码只编译而不链接。

示例

在以下示例中,此模块用于检查提供的 Objective-C++ 源代码是否可以编译和链接。检查结果存储在内部缓存变量 HAVE_WORKING_CODE 中。

include(CheckOBJCXXSourceCompiles)

check_objcxx_source_compiles("
  #include <vector>
  #import <Foundation/Foundation.h>
  int main()
  {
    std::vector<int> v;
    NSObject *foo;
    return 0;
  }
" HAVE_WORKING_CODE)

另请参阅

  • CheckSourceCompiles 模块提供了一个更通用的命令来检查源代码是否可以构建。

  • CheckSourceRuns 模块用于检查源代码是否可以构建和运行。