find_program¶

簡短簽名為

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

通用簽名為

find_program (
          <VAR>
          name | NAMES name1 [name2 ...] [NAMES_PER_DIR]
          [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 時，將使用 BOTH 檢視。當政策為 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_program (result NAMES ... VALIDATOR my_check)

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

DOC

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

NO_CACHE

在 3.21 版本加入。

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

注意

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

警告

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

REQUIRED

在 3.18 版本加入。

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

如果指定了 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 版本加入。
套件根變數維護為堆疊，因此如果從巢狀 find 模組或組態套件中呼叫，則在搜尋當前模組或套件的路徑之後，將會搜尋父級 find 模組或組態套件的根路徑。換句話說，搜尋順序將為 <CurrentPackage>_ROOT、ENV{<CurrentPackage>_ROOT}、<ParentPackage>_ROOT、ENV{<ParentPackage>_ROOT} 等。如果傳遞了 NO_PACKAGE_ROOT_PATH 或將 CMAKE_FIND_USE_PACKAGE_ROOT_PATH 設定為 FALSE，則可以跳過此步驟。
- 如果從由 find_package(<PackageName>) 載入的 find 模組中呼叫，則針對 <PackageName>_ROOT CMake 變數和 <PackageName>_ROOT 環境變數中的每個 <prefix>，搜尋 <prefix>/[s]bin
搜尋 cmake 特定快取變數中指定的路徑。這些變數旨在透過命令列與 -DVAR=value 一起使用。這些值會被解釋為分號分隔的列表。如果傳遞了 NO_CMAKE_PATH 或將 CMAKE_FIND_USE_CMAKE_PATH 設定為 FALSE，則可以跳過此步驟。
- 針對 CMAKE_PREFIX_PATH 中的每個 <prefix>，搜尋 <prefix>/[s]bin
- CMAKE_PROGRAM_PATH
- CMAKE_APPBUNDLE_PATH
搜尋 cmake 特定環境變數中指定的路徑。這些變數旨在在使用者的 shell 組態中設定，因此使用主機的原生路徑分隔符號（Windows 上為 ;，UNIX 上為 :）。如果傳遞了 NO_CMAKE_ENVIRONMENT_PATH 或將 CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH 設定為 FALSE，則可以跳過此步驟。
- 針對 CMAKE_PREFIX_PATH 中的每個 <prefix>，搜尋 <prefix>/[s]bin
- CMAKE_PROGRAM_PATH
- CMAKE_APPBUNDLE_PATH
搜尋 HINTS 選項指定的路徑。這些路徑應為系統內省計算的路徑，例如已找到的另一個項目的位置提供的提示。硬編碼的猜測應使用 PATHS 選項指定。
搜尋標準系統環境變數。如果傳遞了 NO_SYSTEM_ENVIRONMENT_PATH 或將 CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH 設定為 FALSE，則可以跳過此步驟。
- PATH 本身中的目錄。
搜尋平台檔案中為目前系統定義的 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_SYSTEM_PREFIX_PATH 中的每個 <prefix>，搜尋 <prefix>/[s]bin
- CMAKE_SYSTEM_PROGRAM_PATH
- CMAKE_SYSTEM_APPBUNDLE_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_PROGRAM 來調整預設行為。可以使用以下選項在每次呼叫的基礎上手動覆寫此行為

CMAKE_FIND_ROOT_PATH_BOTH: 按照上述順序搜尋。
NO_CMAKE_FIND_ROOT_PATH: 不使用 CMAKE_FIND_ROOT_PATH 變數。
ONLY_CMAKE_FIND_ROOT_PATH: 僅搜尋重新紮根的目錄和 CMAKE_STAGING_PREFIX 下方的目錄。

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

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

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

當為 NAMES 選項提供多個值時，此命令預設情況下會一次考慮一個名稱，並在每個目錄中搜尋它。NAMES_PER_DIR 選項告訴此命令一次考慮一個目錄，並在其中搜尋所有名稱。

被視為程式的檔案集合是平台特定的

在 Windows 上，檔案名稱後綴會依序考慮 .com、.exe 和無後綴。
在非 Windows 系統上，不考慮檔案名稱後綴，但檔案必須具有執行權限（請參閱政策 CMP0109）。

若要搜尋腳本，請明確指定擴展名

if(WIN32)
  set(_script_suffix .bat)
else()
  set(_script_suffix .sh)
endif()

find_program(MY_SCRIPT NAMES my_script${_script_suffix})

find_program¶

上一主題

下一主題

本頁