CheckPrototypeDefinition

This module provides a command to check if a C function has the expected prototype.

在 CMake 專案中使用以下命令載入該模組：

include(CheckPrototypeDefinition)

命令

This module provides the following command:

check_prototype_definition

Checks if a C function has the expected prototype:

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

<function>

The name of the function whose prototype is being checked.

<prototype>

The expected prototype of the function, provided as a string.

<return>

The return value of the function. This will be used as a return value in the function definition body of the generated test program to verify that the function's return type matches the expected type.

<headers>

A semicolon-separated list of header file names required for checking the function prototype.

<variable>

The name of the variable to store the check result. This variable will be created as an internal cache variable.

This command generates a test program and verifies that it builds without errors. The generated test program includes specified <headers>, defines a function with given literal <prototype> and <return> value and then uses the specified <function>. The simplified test program can be illustrated as:

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

影響檢查的變數

可以在呼叫此命令之前設定以下變數，以修改檢查的執行方式：

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

一個要新增到連結命令的程式庫的分號分隔列表。這些可以是系統程式庫的名稱，也可以是 Imported Targets`（詳情請參見 :command:`try_compile）。

CMAKE_REQUIRED_LINK_DIRECTORIES

在 3.31 版被加入.

一個要傳遞給連結器的程式庫搜尋路徑的分號分隔列表（詳情請參見 try_compile()）。

CMAKE_REQUIRED_QUIET

在 3.1 版被加入.

如果此變數的值為布林真值，則與檢查相關的所有狀態訊息都將被抑制。

範例

Checking if the getpwent_r() function on Solaris/illumos systems has the expected prototype:

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
)