find_path

簡短的簽名是

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

一般的簽名是

find_path (
          <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_path (result NAMES ... VALIDATOR my_check)

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

DOC

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

NO_CACHE

在 3.21 版本中新增。

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

注意

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

警告

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

REQUIRED

在 3.18 版本中新增。

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

如果指定 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 搜尋了其他路徑：如果設定了 CMAKE_LIBRARY_ARCHITECTURE，則為 <prefix>/include/<arch>，對於 PATH 中的每個 <prefix>/[s]bin，則為 <prefix>/include，對於 PATH 中的其他條目，則為 <entry>/include。此行為已在 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_path (<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
find_path (<VAR> NAMES name)

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

在搜尋框架時，如果檔案被指定為 A/b.h，則框架搜尋將會尋找 A.framework/Headers/b.h。如果找到，路徑將會被設定為框架的路徑。CMake 將會把此路徑轉換為正確的 -F 選項，以包含此檔案。