CheckCXXSourceRuns¶
This module provides a command to check whether a C++ source can be built and run.
在 CMake 專案中使用以下命令載入該模組:
include(CheckCXXSourceRuns)
命令¶
This module provides the following command:
- check_cxx_source_runs¶
Checks once whether the given C++ source code compiles and links into an executable that can subsequently be run:
check_cxx_source_runs(<code> <variable>)
The C++ source supplied in
<code>must contain at least amain()function. The result of the check is stored in the internal cache variable specified by<variable>. If the code builds and runs with exit code0, success is indicated by a boolean true value. Failure to build or run is indicated by a boolean false value, such as an empty string or an error message.影響檢查的變數
可以在呼叫此命令之前設定以下變數,以修改檢查的執行方式:
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 版被加入.
如果此變數的值為布林真值,則與檢查相關的所有狀態訊息都將被抑制。
範例¶
The following example demonstrates how to check whether the C++ standard
library is functional and std::vector works at runtime. If the source
compiles, links, and runs successfully, internal cache variable
HAVE_WORKING_STD_VECTOR will be set to boolean true value. Code is
supplied using 方括號引數 for easier embedded quotes handling:
include(CheckCXXSourceRuns)
check_cxx_source_runs([[
#include <iostream>
#include <vector>
int main()
{
std::vector<int> v = {1, 2, 3};
if (v.size() != 3) return 1;
std::cout << "Vector works correctly." << std::endl;
return 0;
}
]] HAVE_WORKING_STD_VECTOR)
另請參見¶
The
CheckSourceRunsmodule for a more general command syntax.The
CheckSourceCompilesmodule to check whether a source code can be built.