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。