CMake简明基础知识汇总及实例

CMake是一个跨平台的自动化构建系统，它使用名为CMakeLists.txt的配置文件来描述项目的构建过程。CMake能够生成标准的构建文件，如Makefile和Visual Studio项目文件，使得项目可以在不同的平台上进行编译和构建。本文将简要介绍CMake的基础知识、语法知识、构建过程，并给出一个简单的实例。

一、基础知识

1. 安装与使用

CMake的安装非常简便，可以直接下载二进制包解压使用，或者从源码编译安装。使用CMake时，通常通过命令行或CMake的图形界面（cmake-gui）来生成构建文件。基本命令格式为cmake [options] <path-to-source>，其中<path-to-source>是包含CMakeLists.txt的目录。

2. 基本概念

In-Source Build：在源代码目录中直接构建项目。

Out-of-Source Build：将构建输出文件与源文件放到不同目录中，这是推荐的做法，因为它可以保持源代码的清洁。

3. 基本结构

CMake的构建过程依赖于CMakeLists.txt文件，这是CMake的配置文件。一个项目可以包含多个CMakeLists.txt文件，通常每个子目录都会有一个，用于描述该子目录的构建规则。在根目录的CMakeLists.txt中，可以使用project命令指定项目名称，使用add_subdirectory命令添加子目录。

二、语法知识

1. 注释

CMake中的注释以#开头，直到行尾。

2. 变量

使用set命令定义和赋值变量。在if语句中可以直接使用变量名，在其他地方需要使用${}来引用变量。

3. 命令

CMake的命令不区分大小写，但参数通常区分大小写。命令的一般格式为command(args ...)，参数之间用空格分隔，如果参数中包含空格，可以使用双引号括起来。

4. 常用命令

project：指定项目名称。

add_executable：添加可执行程序。

add_library：添加库文件。

include_directories：指定头文件的搜索路径。

link_directories：指定链接库的搜索路径。

target_link_libraries：为目标添加链接库。

message：向终端输出信息。

5. 条件语句和循环

CMake支持if、else、elseif和endif语句进行条件判断，以及foreach和while循环进行重复操作。

三、构建过程

CMake的构建过程大致可以分为以下几个步骤：

准备：确定源代码目录和构建目录（如果是Out-of-Source Build）。

配置：在构建目录中执行cmake命令，根据CMakeLists.txt文件生成构建文件（如Makefile）。

构建：使用生成的构建文件（如make）进行项目的编译和链接。

安装（可选）：如果项目定义了安装规则，可以执行安装步骤。

四、实例

以下是一个简单的CMake示例，用于构建一个名为hello的C++程序。

1. 源代码

创建一个名为hello.cpp的C++文件，内容如下：

cpp

#include <iostream>  



int main() {  

   std::cout << "Hello, CMake!" << std::endl;  

   return 0;  

}

2. CMakeLists.txt

在同一目录下创建一个CMakeLists.txt文件，内容如下：

cmake

cmake_minimum_required(VERSION 3.10)  

project(Hello)  



# 设置C++标准  

set(CMAKE_CXX_STANDARD 11)  

set(CMAKE_CXX_STANDARD_REQUIRED True)  



# 添加可执行文件  

add_executable(hello hello.cpp)

3. 构建

在命令行中，首先进入源代码目录的父目录（或任意目录，但为方便管理，建议使用Out-of-Source Build），然后执行以下命令：

mkdir build  

cd build  

cmake ..  

make

这些命令会创建一个build目录（如果尚不存在），在其中生成Makefile，然后编译项目。

4. 运行

编译完成后，在build目录下会有一个名为hello的可执行文件，直接运行它即可看到输出：

./hello

输出应为：

Hello, CMake!

以上就是CMake的基础知识