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]
         )

此命令用於尋找指定名稱檔案的完整路徑。會建立一個由 <VAR> 命名的快取條目，或者如果指定 NO_CACHE，則會建立一個普通變數，以儲存此命令的結果。如果找到檔案的完整路徑，結果會儲存在變數中，除非變數被清除，否則不會重複搜尋。如果沒有找到任何東西，結果將是 <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，則搜尋過程如下

如果從 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 版本中新增。
套件根目錄變數會維護為堆疊，因此如果從巢狀尋找模組或組態套件中呼叫，則會在搜尋目前模組或套件的路徑之後，搜尋父項尋找模組或組態套件的根目錄路徑。換句話說，搜尋順序將為 <CurrentPackage>_ROOT、ENV{<CurrentPackage>_ROOT}、<ParentPackage>_ROOT、ENV{<ParentPackage>_ROOT} 等等。如果傳遞 NO_PACKAGE_ROOT_PATH 或將 CMAKE_FIND_USE_PACKAGE_ROOT_PATH 設定為 FALSE，則可以跳過此步驟。
- 如果設定了 CMAKE_LIBRARY_ARCHITECTURE，則為 <prefix>/include/<arch>；否則，對於 <PackageName>_ROOT CMake 變數和 <PackageName>_ROOT 環境變數中的每個 <prefix>，則為 <prefix>/include。此行為是在由 find_package(<PackageName>) 載入的 find 模組中呼叫時才會發生。
在 cmake 特定的快取變數中指定的搜尋路徑。這些變數旨在與 -DVAR=value 一起在命令列中使用。這些值會被解讀為以分號分隔的清單。如果傳遞了 NO_CMAKE_PATH 或將 CMAKE_FIND_USE_CMAKE_PATH 設定為 FALSE，則可以跳過此步驟。
- 如果設定了 CMAKE_LIBRARY_ARCHITECTURE，則為 <prefix>/include/<arch>；否則，對於 CMAKE_PREFIX_PATH 中的每個 <prefix>，則為 <prefix>/include。
- CMAKE_INCLUDE_PATH
- CMAKE_FRAMEWORK_PATH
在 cmake 特定的環境變數中指定的搜尋路徑。這些變數旨在於使用者的 shell 設定中設定，因此使用主機的原生路徑分隔符號（Windows 上為 ;，而 UNIX 上為 :）。如果傳遞了 NO_CMAKE_ENVIRONMENT_PATH 或將 CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH 設定為 FALSE，則可以跳過此步驟。
- 如果設定了 CMAKE_LIBRARY_ARCHITECTURE，則為 <prefix>/include/<arch>；否則，對於 CMAKE_PREFIX_PATH 中的每個 <prefix>，則為 <prefix>/include。
- CMAKE_INCLUDE_PATH
- CMAKE_FRAMEWORK_PATH
搜尋由 HINTS 選項指定的路徑。這些應該是由系統內省計算的路徑，例如已找到的另一個項目位置所提供的提示。硬式編碼的猜測應該使用 PATHS 選項來指定。
搜尋標準的系統環境變數。如果傳遞了 NO_SYSTEM_ENVIRONMENT_PATH 或將 CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH 設定為 FALSE，則可以跳過此步驟。
- 在 INCLUDE 和 PATH 中的目錄。
在 Windows 主機上，CMake 3.3 到 3.27 會搜尋其他路徑：如果設定了 CMAKE_LIBRARY_ARCHITECTURE，則為 <prefix>/include/<arch>，對於 PATH 中的每個 <prefix>/[s]bin，則為 <prefix>/include，以及對於 PATH 中的其他項目，則為 <entry>/include。此行為已在 CMake 3.28 中移除。
搜尋在目前系統的平台檔案中定義的 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，則可以跳過所有這些位置。
- 如果設定了 CMAKE_LIBRARY_ARCHITECTURE，則為 <prefix>/include/<arch>；否則，對於 CMAKE_SYSTEM_PREFIX_PATH 中的每個 <prefix>，則為 <prefix>/include。
- CMAKE_SYSTEM_INCLUDE_PATH
- CMAKE_SYSTEM_FRAMEWORK_PATH
這些變數包含的平台路徑是通常包含已安裝軟體的位置。例如，在基於 UNIX 的平台上為 /usr/local。
搜尋由 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)

一旦其中一個呼叫成功，結果變數將會被設定並儲存在快取中，以便下次不再搜尋。

find_file¶

上一主題

下一主題

本頁面