cmake使用方法詳解

一、cmake是什麼

cmake是一款開源的跨平台自動化構建工具。它使用簡單的語句來描述構建過程，支持各種各樣的編譯器和操作系統，在編譯過程中可以使用多種不同的工具鏈。

cmake可以自動生成大量的編譯配置文件，從而將開發者從繁瑣的配置工作中解放出來，讓開發者更專註於程序的實現和功能的開發。

二、cmake的安裝

cmake的官方網站提供二進位、源碼和安裝包等安裝方式，其中二進位方式和源碼方式可在Linux和macOS中使用，安裝包可在Windows中使用。

以在macOS中使用二進位方式進行安裝為例，可以按照以下步驟進行：

1. 下載cmake二進位文件，例如文件名為cmake-3.21.1-macos-universal.tar.gz

curl -O https://cmake.org/files/v3.21/cmake-3.21.1-macos-universal.tar.gz

2. 解壓文件並進入解壓後的目錄

tar zxvf cmake-3.21.1-macos-universal.tar.gz
cd cmake-3.21.1-macos-universal

3. 將cmake加入系統的PATH中

export PATH=/path/to/cmake-3.21.1-macos-universal/CMake.app/Contents/bin:$PATH

完成以上步驟後，即可在終端中使用cmake命令。

三、cmake的基本使用

1. 編寫CMakeLists.txt文件

CMakeLists.txt文件是cmake的核心配置文件，用於描述整個工程的構建過程。

一個最簡單的CMakeLists.txt文件如下：

cmake_minimum_required(VERSION 3.0)
project(hello_world)
add_executable(hello hello.cpp)

以上代碼的意思是設置cmake的最低版本為3.0，工程名稱為hello_world，添加一個可執行文件hello，並將其與hello.cpp文件進行關聯。

2. 編譯工程

在編寫好CMakeLists.txt文件後，可以使用以下命令將工程編譯出可執行文件：

mkdir build
cd build
cmake .. 
make

以上命令的意思是，創建一個名為build的文件夾，在該文件夾下執行cmake ..命令，將會根據上述的CMakeLists.txt文件生成Makefile，最後執行make命令進行編譯。

3. 構建多個目標

有時候工程中需要構建多個目標文件，可以使用以下命令實現：

add_executable(target1 source1.cpp)
add_library(target2 source2.cpp)
add_library(target3 source3.cpp)
target_link_libraries(target1 target2 target3)

以上代碼的意思是，添加一個可執行文件target1，一個靜態庫target2和一個動態庫target3，最後將target1與target2、target3進行關聯。

4. 安裝和導出配置

在工程開發完成後，可以使用以下命令將可執行文件和庫文件安裝到系統目錄：

install(TARGETS myapp RUNTIME DESTINATION bin)
install(TARGETS mylib ARCHIVE DESTINATION lib LIBRARY DESTINATION lib)
install(DIRECTORY include/ DESTINATION include)

以上代碼的意思是，將名為myapp的可執行文件安裝到系統的bin目錄下，將名為mylib的庫文件安裝到系統的lib目錄下，並將工程中的include目錄安裝到系統的include目錄下。

同時，也可以使用以下命令將安裝的配置文件導出到指定路徑：

set(CMAKE_INSTALL_PREFIX /usr/local/myapp)
set(config_package_location ${CMAKE_INSTALL_PREFIX}/lib/cmake/MyApp)
install(EXPORT MyAppConfig DESTINATION ${config_package_location})
export(TARGETS mylib FILE MyLibConfig.cmake)

以上代碼的意思是，將工程安裝到/usr/local/myapp路徑下，並將配置文件導出到/usr/local/myapp/lib/cmake/MyApp路徑下。

四、cmake的高級特性

1. 添加依賴庫

在工程中，有可能需要使用到外部的庫文件，可以使用以下命令添加依賴庫：

find_package(OpenCV REQUIRED)
include_directories(${OpenCV_INCLUDE_DIRS})
target_link_libraries(myapp ${OpenCV_LIBS})

以上代碼的意思是，使用find_package命令尋找名為OpenCV的依賴庫，並將其包含路徑添加到工程中，最後將OpenCV庫文件鏈接到名為myapp的可執行文件中。

2. 多配置構建

在工程開發過程中，有可能需要在不同的平台、配置下構建工程，可以使用以下命令實現：

set(CMAKE_CONFIGURATION_TYPES Debug Release)
set(CMAKE_BUILD_TYPE Debug CACHE STRING "Build type")
if(CMAKE_BUILD_TYPE STREQUAL "Debug")
    add_definitions(-DDEBUG)
endif()

以上代碼的意思是，明確工程支持的所有配置類型為Debug和Release，設置默認的構建類型為Debug，並根據構建類型在代碼中添加宏定義。

3. 交叉編譯

在開發中，有時需要將代碼編譯到其他平台或嵌入式系統中，可以使用以下命令實現交叉編譯：

set(CMAKE_SYSTEM_NAME Linux)
set(CMAKE_C_COMPILER arm-linux-gcc)
set(CMAKE_CXX_COMPILER arm-linux-g++)
set(CMAKE_FIND_ROOT_PATH /path/to/rootfs)

以上代碼的意思是，設置編譯系統為Linux，使用arm-linux-gcc和arm-linux-g++編譯器進行編譯，並設置依賴庫尋找路徑為/path/to/rootfs。

4. 自定義模塊

在工程開發中，有時需要自定義模塊，可以在CMakeLists.txt文件中使用include命令引入自定義的模塊文件：

set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_SOURCE_DIR}/cmake/modules)
include(MyCustomModule)

以上代碼的意思是，將cmake/modules目錄添加到CMAKE_MODULE_PATH中，然後使用include命令引入名為MyCustomModule的自定義模塊。

總結

cmake是一個強大且簡單易用的跨平台自動化構建工具，可以大大簡化工程的構建過程，讓開發者更專註於程序功能的實現。本文從cmake的基本使用、高級特性等多個方面對其進行了詳細介紹，並給出了相應的代碼示例，希望能夠幫助讀者更好地理解和使用cmake。