CheckCXXSymbolExists

檢查符號是否存在於 C++ 中作為函式、變數或巨集。

check_cxx_symbol_exists
check_cxx_symbol_exists(<symbol> <files> <variable>)

檢查在包含給定標頭 <files> 後,<symbol> 是否可用,並將結果儲存在 <variable> 中。以分號分隔的列表形式在一個參數中指定檔案列表。check_cxx_symbol_exists() 可用於檢查 C++ 編譯器看到的符號,而不是 check_symbol_exists(),後者始終使用 C 編譯器。

如果標頭檔案將符號定義為巨集,則會認為它是可用的,並假設其可以正常工作。如果標頭檔案將符號宣告為函式或變數,則該符號也必須可用於連結。如果符號是類型、列舉值或 C++ 模板,則將無法識別:請考慮改用 CheckTypeSizeCheckSourceCompiles 模組。

注意

<symbol> (可能)是多載函式時,此命令不可靠。由於沒有可靠的方法來預測系統環境中的給定函式是否可能定義為多載函式,或者在其他系統上可能是多載函式,或者將來會變成這樣,因此通常建議使用 CheckSourceCompiles 模組來檢查任何函式符號(除非您確定檢查的函式在其他系統上不是多載的,或者將來不會是多載的)。

可以在呼叫此巨集之前設定以下變數,以修改檢查的執行方式

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

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

例如

include(CheckCXXSymbolExists)

# Check for macro SEEK_SET
check_cxx_symbol_exists(SEEK_SET "cstdio" HAVE_SEEK_SET)
# Check for function std::fopen
check_cxx_symbol_exists(std::fopen "cstdio" HAVE_STD_FOPEN)