CheckPrototypeDefinition

检查一个 C 函数是否具有预期的原型。

check_prototype_definition
check_prototype_definition(<function> <prototype> <return> <headers> <variable>)
<function>

要检查其原型的函数的名称。

<prototype>

函数的预期原型,以字符串形式提供。

<return>

函数的返回值。这将用作生成的测试程序函数定义主体中的返回值,以验证函数的返回类型是否与预期类型匹配。

<headers>

用于检查函数原型的必需头文件名的分号分隔列表

<variable>

用于存储检查结果的变量名。此变量将创建为内部缓存变量。

此命令生成一个测试程序并验证它可以无错误地构建。生成的测试程序包括指定的 <headers>,定义一个具有给定字面量 <prototype><return> 值的函数,然后使用指定的 <function>。简化的测试程序可以示例如下

#include <headers>
// ...
<prototype> { return <return>; }
int main(...) { ...<function>()... }

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

CMAKE_REQUIRED_FLAGS

要传递给编译器的附加标志字符串。该字符串必须是空格分隔的——;-list 将不起作用。CMAKE_<LANG>_FLAGS 及其关联的特定于配置的变量的内容会自动添加到编译器命令中,然后再添加 CMAKE_REQUIRED_FLAGS 的内容。

CMAKE_REQUIRED_DEFINITIONS

形式为 -DFOO-DFOO=bar 的编译器定义的 ;-list。还将自动添加由 <resultVar> 指定的名称的定义。

CMAKE_REQUIRED_INCLUDES

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

CMAKE_REQUIRED_LINK_OPTIONS

在版本 3.14 中添加。

要添加到链接命令的选项的 ;-list (有关详细信息,请参阅 try_compile())。

CMAKE_REQUIRED_LIBRARIES

要添加到链接命令的库的 ;-list。这些可以是系统库的名称,也可以是 导入目标 (有关详细信息,请参阅 try_compile())。

CMAKE_REQUIRED_LINK_DIRECTORIES

在版本 3.31 中添加。

要传递给链接器的库搜索路径的 ;-list (有关详细信息,请参阅 try_compile())。

CMAKE_REQUIRED_QUIET

在版本 3.1 中添加。

如果此变量的值计算结果为布尔真值,则将禁止所有与检查关联的状态消息。

示例

检查 Solaris/illumos 系统上的 getpwent_r() 函数是否具有预期的原型

include(CheckPrototypeDefinition)

check_prototype_definition(
  getpwent_r
  "struct passwd *getpwent_r(struct passwd *src, char *buf, int buflen)"
  "NULL"
  "unistd.h;pwd.h"
  HAVE_SOLARIS_GETPWENT_R
)