cmake 學習筆記(三)

weixin_34342992發表於2018-12-07
筆記

接前面的 Cmake學習筆記(一) 與 Cmake學習筆記(二) 繼續學習 cmake 的使用。

學習一下cmake的 finder。

當編譯一個需要使用第三方庫的軟體時，我們需要知道：

去哪兒找標頭檔案 .h 對比GCC的 -I 引數
去哪兒找庫檔案 (.so/.dll/.lib/.dylib/...) 對比GCC的 -L 引數
需要連結的庫檔案的名字 對比GCC的 -l 引數

這也是一個 finder 需要返回的最基本的資訊。

比如說，我們需要一個第三方庫 curl，那麼我們的 CMakeLists.txt 需要指定標頭檔案目錄，和庫檔案，類似：

include_directiories(/usr/include)
target_link_libraries(myprogram curl)

如果藉助於cmake提供的finder會怎麼樣呢？使用cmake的Modules目錄下的FindCURL.cmake，相應的 CMakeList.txt 檔案：

find_package(CURL REQUIRED)
include_directories(${CURL_INCLUDE_DIR})
target_link_libraries(curltest ${CURL_LIBRARY})

或者

find_package(CURL)
if(CURL_FOUND)
include_directories(${CURL_INCLUDE_DIR})
target_link_libraries(curltest ${CURL_LIBRARY})
else(CURL_FOUND)
message(FATAL_ERROR "curl not found!")
endif(CURL_FOUND)

如果我們使用的finder，不是cmake自帶的怎麼辦？

  • 放置位置：工程根目錄下的 cmake/Modules/
  • 然後在 CMakeList.txt 中新增
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")

find_package 將會在module路徑下查詢 Find<name>.cmake。首先它搜尋 ${CMAKE_MODULE_PATH}中的所有路徑，然後搜尋 <CMAKE_ROOT>/share/cmake-x.y/Modules/

如果這個檔案未找到，它將會查詢 <Name>Config.cmake 或 <lower-case-name>-config.cmake 檔案。這兩個檔案是庫檔案安裝時自己安裝的，將自己的路徑硬編碼到其中。

前者稱為 module 模式，後者稱為 config 模式

每個模組一般都會提供一下幾個變數

  • <name>_FOUND

  • <name>_INCLUDE_DIR 或 <name>_INCLUDES

  • <name>_LIBRARY 或 <name>_LIBRARIES 或 <name>_LIBS

  • <name>_DEFINITIONS

  • 首先使用 find_package 探測本軟體包依賴的第三方庫(引數 QUIETLY 和 REQUIRED應該被傳遞)

  • 如果 pkg-config 可用，則可以用其去探測include/library路徑

  • 分別使用 find_path 和 find_library 查詢標頭檔案和庫檔案

    • pkg-config 提供的路徑僅作為參考
    • CMake 有很多硬編碼的路徑
    • 結果放到 <name>_INCLUDE_DIR 和 <name>_LIBRARY (注意：單數而不是複數)

  • 設定 <name>_INCLUDE_DIRS 為 <name>_INCLUDE_DIR <dependency1>_INCLUDE_DIRS ...

  • 設定 <name>_LIBRARIES 為 <name>_LIBRARY <dependency1>_LIBRARIES ...

    • 依賴使用複數，包自身使用單數形式（由find_path和find_library提供）

  • 呼叫巨集 find_package_handle_standard_args() 設定 <name>_FOUND 並列印或失敗資訊

相關文章