CheckSourceCompiles

在版本 3.19 中新增。

檢查原始碼是否可以針對給定的語言建置一次。

check_source_compiles

check_source_compiles(<lang> <code> <resultVar>
                      [FAIL_REGEX <regex1> [<regex2>...]]
                      [SRC_EXT <extension>])

檢查在 <code> 中提供的原始碼是否可以針對程式碼語言 <lang> 建置一次。結果儲存在由 <resultVar> 指定的內部快取變數中，成功為布林值 true，失敗為布林值 false。

如果提供了 FAIL_REGEX，則透過檢查編譯器輸出中是否有任何內容符合任何指定的正規表示式來判斷失敗。

預設情況下，測試原始檔將被賦予符合請求語言的副檔名。SRC_EXT 選項可用於使用 .<extension> 來覆寫此設定。

C 語言範例檢查編譯器是否支援 noreturn 屬性

set(CMAKE_TRY_COMPILE_TARGET_TYPE "STATIC_LIBRARY")

check_source_compiles(C
"#if !__has_c_attribute(noreturn)
#error \"No noreturn attribute\"
#endif"
HAVE_NORETURN)

Fortran 語言範例檢查編譯器是否支援 pure 程序屬性

set(CMAKE_TRY_COMPILE_TARGET_TYPE "STATIC_LIBRARY")

check_source_compiles(Fortran
"pure subroutine foo()
end subroutine"
HAVE_PURE)

在內部，try_compile() 用於編譯原始碼。如果 CMAKE_TRY_COMPILE_TARGET_TYPE 設定為 EXECUTABLE (預設值)，則原始碼會被編譯並連結為可執行程式。如果設定為 STATIC_LIBRARY，則原始碼會被編譯但不會連結。在任何情況下，所有函式都必須照常宣告。

另請參閱 check_source_runs() 以執行編譯後的原始碼。

編譯和連結命令可以透過在呼叫 check_source_compiles() 之前設定以下任何變數來影響

CMAKE_REQUIRED_FLAGS

要傳遞給編譯器的額外旗標字串。字串必須以空格分隔--;-清單 將不起作用。CMAKE_<LANG>_FLAGS 及其相關的組態特定變數的內容會自動新增到編譯器命令中，在 CMAKE_REQUIRED_FLAGS 的內容之前。

CMAKE_REQUIRED_DEFINITIONS

;-清單，包含 -DFOO 或 -DFOO=bar 形式的編譯器定義。也會自動新增由 <resultVar> 指定名稱的定義。

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 中新增。

如果此變數評估為布林值 true，則將會抑制與檢查相關聯的所有狀態訊息。