【C++】CMake入门

CMake 是一个跨平台的构建系统生成工具，可以生成用于编译和链接应用程序的构建文件（如 Makefile 或 Visual Studio 工程文件）。

安装 CMake

Windows

• 可以从 CMake官网 下载并安装 Windows 版本的 CMake。
• 安装完成后，确保将 CMake 添加到系统 PATH 环境变量中。

Linux

sudo apt-get update
sudo apt-get install cmake

单个源文件项目

我们需要提供源文件和向CMake提供项目配置描述。该描述使用CMake完成，完整的文档可以在 https://cmake.org/cmake/help/latest/ 找到。

准备

创建一个简单的 C++ 项目，包含以下文件：

• CMakeLists.txt
• main.cpp

我们希望将 main.cpp 源代码编译为单个可执行文件：

#include<iostream>
int main(){std::cout<<"Hello world"<<std::endl;return 0;
}

CMakeLists.txt

# 设置CMake所需的最低版本。如果使用的CMake版本低于该版本，则会发出致命错误
cmake_minimum_required(VERSION 3.10)# 声明了项目的名称(Test)和支持的编程语言(CXX代表C++)
project(Test CXX)# 指示CMake创建一个新目标：可执行文件main。这个可执行文件是通过编译和链接源文件main生成的。CMake将为编译器使用默认设置，并自动选择生成工具
add_executable(main main.cpp)

生成

打开命令提示符，导航到项目目录，然后运行：

mkdir build
cd build
cmake ..

或者使用，具有相同效果：

# 该命令是跨平台的，使用了-H和-B为CLI选项。-H表示当前目录中搜索根CMakeLists.txt文件。-Bbuild告诉CMake在一个名为build的目录中生成所有的文件
cmake -H. -Bbuild

项目的配置已经在build目录中生成。我们现在可以编译可执行文件：

cmake --build .

切换生成器

CMake是一个构建系统生成器，可以使用单个CMakeLists.txt为不同平台上的不同工具集配置项目。您可以在CMakeLists.txt中描述构建系统必须运行的操作，以配置并编译代码。基于这些指令，CMake将为所选的构建系统(Unix Makefile、Ninja、Visual Studio等等)生成相应的指令。

• Visual Studio 编译器 (MSVC)：适用于 Windows 系统，常用生成器是 NMake Makefiles 或 Visual Studio.
• MinGW 或 MSYS2：适用于 Windows 系统，可以使用 MinGW Makefiles.
• Unix Makefiles：适用于类 Unix 系统，例如 Linux 或 macOS。

cmake -Bbuild -G "NMake Makefiles"

多个可执行文件和库项目

准备

目录结构如下：

MyProject/
├── include/
│   └── say.hpp
├── src/
│   ├── main.cpp
│   └── say.cpp
├── lib/
└── bin/

# main.cpp#include"say.hpp"
int main() {say();return 0;
}

# say.cpp#include<iostream>
#include"say.hpp"
void say(){std::cout<<"Hello world!"<<std::endl;
}

# say.hpp#pragma once
void say();

CMakeLists.txt

我们需要编写 CMakeLists.txt 文件来编译这些文件并链接库。

# 指定 CMake 的最低版本要求
cmake_minimum_required(VERSION 3.10)# 定义项目名称和版本
project(test VERSION 1.0.0)# 设置 C++ 标准
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED True)# 添加 include 目录到编译器的头文件搜索路径
include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)# 设置库和可执行文件输出路径
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/lib)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/lib)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/bin)# 创建静态库目标
add_library(messageSTATIC # 若动态库则参数为SHARED${CMAKE_CURRENT_SOURCE_DIR}/src/say.cpp
)# 添加可执行文件
add_executable(test${CMAKE_CURRENT_SOURCE_DIR}/src/main.cpp
)# 链接静态/动态库到可执行文件
target_link_libraries(test say)

生成

打开命令提示符或终端，导航到项目根目录：

cd Test

创建 build 目录并导航到其中：

mkdir build
cd build

运行 CMake 配置命令：

cmake ..

运行构建命令：

cmake --build .