find_file

簡短的簽名是

find_file (<VAR> name1 [path1 path2 ...])

一般的簽名是

find_file (
          <VAR>
          name | NAMES name1 [name2 ...]
          [HINTS [path | ENV var]...]
          [PATHS [path | ENV var]...]
          [REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]
          [PATH_SUFFIXES suffix1 [suffix2 ...]]
          [VALIDATOR function]
          [DOC "cache documentation string"]
          [NO_CACHE]
          [REQUIRED]
          [NO_DEFAULT_PATH]
          [NO_PACKAGE_ROOT_PATH]
          [NO_CMAKE_PATH]
          [NO_CMAKE_ENVIRONMENT_PATH]
          [NO_SYSTEM_ENVIRONMENT_PATH]
          [NO_CMAKE_SYSTEM_PATH]
          [NO_CMAKE_INSTALL_PREFIX]
          [CMAKE_FIND_ROOT_PATH_BOTH |
           ONLY_CMAKE_FIND_ROOT_PATH |
           NO_CMAKE_FIND_ROOT_PATH]
         )

此命令用於尋找具名檔案的完整路徑。一個快取條目，或者如果指定了 NO_CACHE 則為一般變數，以 <VAR> 命名，用於儲存此命令的結果。如果找到檔案的完整路徑，結果將儲存在變數中，並且除非清除該變數，否則不會重複搜尋。如果沒有找到任何內容，結果將為 <VAR>-NOTFOUND。

選項包括

NAMES

指定檔案完整路徑的一個或多個可能名稱。

當使用此選項指定帶有和不帶有版本後綴的名稱時，我們建議首先指定不帶版本的名稱，以便可以先找到本地建置的套件，然後再找到發行版提供的套件。

HINTS、PATHS

指定除了預設位置之外要搜尋的目錄。ENV var 子選項從系統環境變數中讀取路徑。

在 3.24 版本中變更：在 Windows 平台上，可以使用 專用語法 將登錄查詢包含為目錄的一部分。此類規格將在所有其他平台上被忽略。

REGISTRY_VIEW

在 3.24 版本中新增。

指定必須查詢哪些登錄檢視。此選項僅在 Windows 平台上才有意義，在其他平台上將被忽略。未指定時，當 CMP0134 政策為 NEW 時，將使用 TARGET 檢視。當政策為 OLD 時，請參閱 CMP0134 以了解預設檢視。

64

查詢 64 位元登錄。在 32 位元 Windows 上，它始終傳回字串 /REGISTRY-NOTFOUND。

32

查詢 32 位元登錄。

64_32

查詢兩個檢視 (64 和 32) 並為每個檢視產生一個路徑。

32_64

查詢兩個檢視 (32 和 64) 並為每個檢視產生一個路徑。

HOST

查詢與主機架構相符的登錄：在 64 位元 Windows 上為 64，在 32 位元 Windows 上為 32。

TARGET

查詢與 CMAKE_SIZEOF_VOID_P 變數指定的架構相符的登錄。如果未定義，則回退到 HOST 檢視。

BOTH

查詢兩個檢視 (32 和 64)。順序取決於以下規則：如果定義了 CMAKE_SIZEOF_VOID_P 變數，請根據此變數的內容使用以下檢視

  • 8: 64_32

  • 4: 32_64

如果未定義 CMAKE_SIZEOF_VOID_P 變數，則依賴主機的架構

  • 64 位元：64_32

  • 32 位元：32

PATH_SUFFIXES

指定要在每個目錄位置下方檢查的其他子目錄，否則將考慮這些子目錄位置。

VALIDATOR

在 3.25 版本中新增。

指定一個 function()，以便為找到的每個候選項調用（不能提供 macro()，那將導致錯誤）。將向驗證器函數傳遞兩個引數：結果變數的名稱和候選項目的絕對路徑。除非函數將呼叫範圍中結果變數的值設定為 false，否則項目將被接受並且搜尋將結束。當輸入驗證器函數時，結果變數將保留 true 值。

function(my_check validator_result_var item)
  if(NOT item MATCHES ...)
    set(${validator_result_var} FALSE PARENT_SCOPE)
  endif()
endfunction()

find_file (result NAMES ... VALIDATOR my_check)

請注意，如果使用快取結果，則會跳過搜尋，並且任何 VALIDATOR 都會被忽略。快取結果不需要通過驗證函數。

DOC

指定 <VAR> 快取條目的文件字串。

NO_CACHE

在 3.21 版本中新增。

搜尋結果將儲存在一般變數中，而不是快取條目中。

注意

如果變數在呼叫之前已設定（作為一般變數或快取變數），則不會進行搜尋。

警告

應謹慎使用此選項，因為它可能會大大增加重複設定步驟的成本。

REQUIRED

在 3.18 版本中新增。

如果沒有找到任何內容，則停止處理並顯示錯誤訊息，否則下次使用相同的變數調用 find_file 時，將再次嘗試搜尋。

如果指定了 NO_DEFAULT_PATH，則不會將其他路徑新增到搜尋中。如果未指定 NO_DEFAULT_PATH，則搜尋過程如下

  1. 如果從 find 模組或由調用 find_package(<PackageName>) 載入的任何其他腳本中調用，則搜尋當前正在尋找的套件的唯一前綴。請參閱政策 CMP0074。

    在 3.12 版本中新增。

    具體而言，依序搜尋以下變數指定的路徑

    1. <PackageName>_ROOT CMake 變數，其中 <PackageName> 是保留大小寫的套件名稱。

    2. <PACKAGENAME>_ROOT CMake 變數，其中 <PACKAGENAME> 是大寫的套件名稱。請參閱政策 CMP0144。

      在 3.27 版本中新增。

    3. <PackageName>_ROOT 環境變數，其中 <PackageName> 是保留大小寫的套件名稱。

    4. <PACKAGENAME>_ROOT 環境變數，其中 <PACKAGENAME> 是大寫的套件名稱。請參閱政策 CMP0144。

      在 3.27 版本中新增。

    套件根目錄變數維護為堆疊，因此如果從巢狀 find 模組或組態套件中調用，則在搜尋目前模組或套件的路徑之後，將搜尋父級 find 模組或組態套件的根目錄路徑。換句話說，搜尋順序將為 <CurrentPackage>_ROOT、ENV{<CurrentPackage>_ROOT}、<ParentPackage>_ROOT、ENV{<ParentPackage>_ROOT} 等。如果傳遞了 NO_PACKAGE_ROOT_PATH 或將 CMAKE_FIND_USE_PACKAGE_ROOT_PATH 設定為 FALSE，則可以跳過此步驟。

  2. 在 cmake 專用快取變數中指定的搜尋路徑。這些旨在與 -DVAR=value 一起在命令列上使用。這些值被解釋為 以分號分隔的清單。如果傳遞了 NO_CMAKE_PATH 或將 CMAKE_FIND_USE_CMAKE_PATH 設定為 FALSE，則可以跳過此步驟。

  3. 在 cmake 專用環境變數中指定的搜尋路徑。這些旨在在使用者的 shell 組態中設定，因此使用主機的原生路徑分隔符號（Windows 上為 ;，UNIX 上為 :）。如果傳遞了 NO_CMAKE_ENVIRONMENT_PATH 或將 CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH 設定為 FALSE，則可以跳過此步驟。

  4. 搜尋 HINTS 選項指定的路徑。這些應該是由系統內省計算的路徑，例如已找到的另一個項目位置提供的提示。硬編碼的猜測應使用 PATHS 選項指定。

  5. 搜尋標準系統環境變數。如果傳遞了 NO_SYSTEM_ENVIRONMENT_PATH 或將 CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH 設定為 FALSE，則可以跳過此步驟。

    • INCLUDE 和 PATH 中的目錄。

    在 Windows 主機上，CMake 3.3 到 3.27 搜尋了其他路徑：<prefix>/include/<arch> 如果設定了 CMAKE_LIBRARY_ARCHITECTURE，以及 <prefix>/include，適用於 PATH 中的每個 <prefix>/[s]bin，以及 <entry>/include，適用於 PATH 中的其他條目。此行為已在 CMake 3.28 中移除。

  6. 搜尋在目前系統的平台檔案中定義的 cmake 變數。如果傳遞了 NO_CMAKE_INSTALL_PREFIX 或將 CMAKE_FIND_USE_INSTALL_PREFIX 設定為 FALSE，則可以跳過 CMAKE_INSTALL_PREFIX 和 CMAKE_STAGING_PREFIX 的搜尋。如果傳遞了 NO_CMAKE_SYSTEM_PATH 或將 CMAKE_FIND_USE_CMAKE_SYSTEM_PATH 設定為 FALSE，則可以跳過所有這些位置。

    這些變數包含的平台路徑通常是包含已安裝軟體的位置。UNIX 平台的範例是 /usr/local。

  7. 搜尋 PATHS 選項或命令簡短版本中指定的路徑。這些通常是硬編碼的猜測。

CMAKE_IGNORE_PATH、CMAKE_IGNORE_PREFIX_PATH、CMAKE_SYSTEM_IGNORE_PATH 和 CMAKE_SYSTEM_IGNORE_PREFIX_PATH 變數也可能導致忽略上述某些位置。

在 3.16 版本中新增：新增 CMAKE_FIND_USE_<CATEGORY>_PATH 變數以全域停用各種搜尋位置。

在 macOS 上，CMAKE_FIND_FRAMEWORK 和 CMAKE_FIND_APPBUNDLE 變數決定 Apple 風格和 unix 風格套件元件之間的偏好順序。

CMake 變數 CMAKE_FIND_ROOT_PATH 指定一個或多個要附加到所有其他搜尋目錄的目錄。這有效地將整個搜尋「重新植根」在給定的位置下。身為 CMAKE_STAGING_PREFIX 後代的路徑會從此重新植根中排除，因為該變數始終是主機系統上的路徑。預設情況下，CMAKE_FIND_ROOT_PATH 為空。

CMAKE_SYSROOT 變數也可用於指定確切的一個目錄作為前綴。設定 CMAKE_SYSROOT 也會產生其他影響。請參閱該變數的文件以了解更多資訊。

這些變數在交叉編譯以指向目標環境的根目錄時特別有用，CMake 也將在那裡搜尋。預設情況下，首先搜尋 CMAKE_FIND_ROOT_PATH 中列出的目錄，然後搜尋 CMAKE_SYSROOT 目錄，然後將搜尋未植根的目錄。預設行為可以通過設定 CMAKE_FIND_ROOT_PATH_MODE_INCLUDE 進行調整。可以使用選項在每次調用時手動覆寫此行為

CMAKE_FIND_ROOT_PATH_BOTH

按照上述順序搜尋。

NO_CMAKE_FIND_ROOT_PATH

不使用 CMAKE_FIND_ROOT_PATH 變數。

ONLY_CMAKE_FIND_ROOT_PATH

僅搜尋重新植根的目錄和 CMAKE_STAGING_PREFIX 下方的目錄。

預設搜尋順序旨在針對常見用例，從最特定到最不特定。專案可以通過簡單地多次調用命令並使用 NO_* 選項來覆寫順序

find_file (<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
find_file (<VAR> NAMES name)

一旦其中一個調用成功，結果變數將被設定並儲存在快取中，以便沒有調用會再次搜尋。