cmake——简单介绍+代码实例-EW帮帮网

CMake 是一个 开源的跨平台构建工具，用于管理软件项目的 构建过程。它通过一个平台无关的配置文件 CMakeLists.txt 来生成本地化的构建文件（如 Makefile、Visual Studio 项目文件等），从而简化跨平台开发的构建流程。以下是 CMake 的详细介绍和代码示例。

一、CMake 的核心概念

1.CMakeLists.txt 文件—简单分析

【1基本概念】

CMakeLists.txt
1这是 CMake 的配置文件，用于定义项目的构建规则、依赖关系、编译选项等。。每个项目的根目录通常都会有一个 CMakeLists.txt 文件。

2文件内容由命令、注释和空格组成，命令不区分大小写，参数之间用空格分隔。

基本命令
	1.cmake_minimum_required(VERSION x.y)：指定所需的最低 CMake 版本。
	2.project(ProjectName)：定义项目名称。
	3.add_executable(TargetName SourceFiles...)：生成可执行文件并包含源文件。
	
	4.aux_source_directory(dir var)	
		aux_source_directory(. SRC_LIST) #当前目录下的 所有源文件放到变量SRC_LIST里;
		
	5.#新建变量来存放 需要的源文件
		set( SRC_LIST
			 ./main.c
			 ./test1.c
			 ./test.c)

	6.include_directories(Dir1  Dir2)：添加头文件搜索路径。

	7.add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])
		作用是增加编译子目录
		
	add_library(LibName [STATIC|SHARED|MODULE] SourceFiles...)：生成库文件。
	target_link_libraries(Target LibName)：为目标链接库。

变量
	CMake 使用 ${VAR} 语法引用变量。
	常用变量(预定义变量)：
		EXECUTABLE_OUTPUT_PATH ：目标二进制可执行文件的存放位置
		PROJECT_SOURCE_DIR：项目的根目录。
		CMAKE_CURRENT_SOURCE_DIR：当前处理的 CMakeLists.txt 所在目录。
		CMAKE_CXX_STANDARD：指定 C++ 标准（如 11、14、17）。

。
。

【2. 常用命令与语法】

(1) 指定CMake最低版本

cmake_minimum_required(VERSION 3.10)

(2) 定义项目名称和语言

project(MyProject LANGUAGES CXX)  # 指定项目名和语言（如C++）

(3) 设置C++标准

set(CMAKE_CXX_STANDARD 17)  # C++17标准
set(CMAKE_CXX_STANDARD_REQUIRED ON)  # 强制要求标准

(4) 添加可执行文件

add_executable(MyExecutable main.cpp utils.cpp)  # 指定可执行文件和源文件

(5) 添加库（静态库/动态库）

add_library(MyLibrary STATIC lib.cpp)  # 静态库

add_library(MyLibrary SHARED lib.cpp)  # 动态库

(6) 链接库到目标

target_link_libraries(MyExecutable PRIVATE MyLibrary)  # 链接库到可执行文件

(7) 添加头文件搜索路径

target_include_directories(MyExecutable PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include)

(8) 设置变量

set(MY_VAR "value")  # 定义变量
message(STATUS "Variable value: ${MY_VAR}")  # 输出变量

(9) 条件控制

if(CMAKE_BUILD_TYPE STREQUAL "Debug")
    message(STATUS "Debug build")
endif()

(10) 安装规则

install(TARGETS MyExecutable RUNTIME DESTINATION bin)  # 安装可执行文件到bin目录

。
。

【3.高级用法】

(1) 添加子目录

add_subdirectory(src)  # 添加子目录的CMakeLists.txt

(2) 查找外部库

find_package(Boost REQUIRED COMPONENTS filesystem)
target_link_libraries(MyExecutable PRIVATE Boost::filesystem)

(3) 生成器表达式

target_compile_options(MyExecutable PRIVATE
    $<$<CONFIG:Debug>:-O0 -g>  # Debug模式下添加调试选项
    $<$<CONFIG:Release>:-O3>   # Release模式下添加优化选项
)

(4) 自定义命令

add_custom_command(TARGET MyExecutable POST_BUILD
    COMMAND ${CMAKE_COMMAND} -E echo "Build completed!"
)

.
。

2.CMakeLists.txt 文件—举例分析---------重点

【1简单入门在同一个目录下有一个源文件】

假设项目结构如下：
MyProject/
├── CMakeLists.txt
└── main.c

CMakeLists.txt 内容：

#指定CMake最低版本
cmake_minimum_required(VERSION 2.8)

#定义项目名称和语言
project(MyProject)

# 添加可执行文件main
add_executable(main main.c)

分析：

1CMake版本，一般不需要改。有需求在改。
2.项目名称：在ubuntu中填写目录
3.添加可执行文件：会构建一个可执行文件，需要自己填写文件名称

运行步骤参考下文，项目实例

。

【2简单版本–在同一个目录下有多个源文件】

假设项目结构如下：
MyProject/
├── CMakeLists.txt
├── test.h
├── test.c
└── main.c

CMakeLists.txt 内容：

#指定CMake最低版本
cmake_minimum_required(VERSION 2.8)

#定义项目名称和语言
project(MyProject)

# 添加可执行文件main
add_executable(main main.c test.c)

分析：

1添加可执行文件add_executable要包含可执行文件、源文件.c.;所以把test.c添加进去。

运行步骤参考下文，项目实例
。

【3进阶版本—源文件太多了】

假设项目结构如下：
MyProject/
├── CMakeLists.txt
├── test.h
├── test.c
├── test1.h
├── test1.c
└── main.c

CMakeLists.txt 内容：

#指定CMake最低版本
cmake_minimum_required(VERSION 2.8)

#定义项目名称和语言
project(MyProject)

#当前目录下的所有源文件放到变量SRC_LIST里;
aux_source_directory(. SRC_LIST)

# 添加可执行文件
add_executable(main ${SRC_LIST})

分析：

源文件太多了，可以使用cmake提供了一个命令可以把指定目录下所有的源文件存储在一个变量中，这个命令就是

aux_source_directory(dir var)
	第一个参数dir是指定目录，
	第二个参数var是用于存放源文件列表的 变量。

使用aux_source_directory把当前目录下的源文件存列表存放到变量SRC_LIST里。
然后在add_executable里调用SRC_LIST（注意调用变量时的写法）。

aux_source_directory()也存在弊端，它会把指定目录下的所有源文件都加进来，可能会加入一些我们不需要的文件，此时我们可以使用set命令去新建变量来存放需要的源文件。

#指定CMake最低版本
cmake_minimum_required(VERSION 2.8)

#定义项目名称和语言
project(MyProject)

#新建变量来存放需要的源文件
set( SRC_LIST
	 ./main.c
	 ./testFunc1.c
	 ./testFunc.c)

# 添加可执行文件
add_executable(main ${SRC_LIST})

。

【4.在不同目录下有多个源文件】

假设项目结构如下：
MyProject/
├── CMakeLists.txt
├── main.c
├── test/
│   ├── test.c
│   └── test.h
└── matp/
    ├── matp.c
    └── matp.h

CMakeLists.txt 内容：

#指定CMake最低版本
cmake_minimum_required(VERSION 2.8)

#定义项目名称和语言
project(MyProject)

#指定头文件的搜索路径
include_directories (test_func test_func1)

#当前目录下的源文件存列表存放到变量里;
aux_source_directory (test_func SRC_LIST)
aux_source_directory (test_func1 SRC_LIST1)

# 添加可执行文件
add_executable (main main.c ${SRC_LIST} ${SRC_LIST1})

分析：

1这里出现了一个新的命令：include_directories。
该命令是用来向工程添加多个指定头文件的搜索路径，路径之间用空格分隔。
因为main.c里include了test.h和matp.h，如果没有这个命令来指定头文件所在位置，就会无法编译.

。

【5.项目级的组织结构】

正规一点来说，一般会把源文件放到src目录下，把头文件放入到include文件下，生成的对象文件放入到build目录下，最终输出的可执行程序文件会放到bin目录下，这样整个结构更加清晰。

假设项目结构如下：
MyProject/
├── CMakeLists.txt
├── build
├── bin
├── include/
│   ├── matp.h
│   └── test.h
└── src/
	├── main.c
    ├── matp.c
    └── test.c

CMakeLists.txt 内容：

#指定CMake最低版本
cmake_minimum_required(VERSION 2.8)

#定义项目名称和语言
project(MyProject)

#作用是增加编译子目录
add_subdirectory (src)

分析：

add_subdirectory：这个语句的作用是增加编译子目录。其基本语法格式是：

add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

一共有三个参数，后两个是可选参数.

source_dir 源代码目录

指定一个包含CMakeLists.txt和代码文件所在的目录，该目录可以是绝对路径，也可以是相对路径，对于后者相对路径的起点是CMAKE_CURRENT_SOURCE_DIR。此外，如果子目录再次包含的CMakeLists.txt，则将继续处理里层的CMakeLists.txt，而不是继续处理当前源代码。

binary_dir 二进制代码目录

这个目录是可选的，如果指定，cmake命令执行后的输出文件将会存放在此处，若没有指定，默认情况等于source_dir没有进行相对路径计算前的路径，也就是CMAKE_BINARY_DIR。

EXCLUDE_FROM_ALL标记

这个标志是可选的，如果传递了该参数表示新增加的子目录将会排除在ALL目录之外（可能是make系统中的make
all？），表示这个目录将从IDE的工程中排除。用户必须显式在子文件这个编译目标（手动cmake之类的）。指定了这个文件夹，表示这个文件夹是独立于源工程的，这些函数是有用但是不是必要的，比如说我们一系列的例子。

add_subdirectory 这个命令用于添加源文件子目录，同时还可以指定中间二进制和目标二进制的生成路径。EXCLUDE_FROM_ALL将会将这个目录从编译中排除，如工程的例子需要等待其他编译完成后再进行单独的编译。通常子目录应该包含自己的project()命令，这样以来整个编译命令将会产生各自的目标文件。如果把CMakeLists.txt与VS IDE比较，总的CMakeLists.txt就相当于解决方案，子CMakeLists.txt就相当于在解决方案下的工程文件。还有一个需要注意的是，如果编译父CMakeLists时依赖了子CMakeLists.txt中的源文件，那么该标志将会被覆盖（也就是也会处理），以满足编译任务。

这里指定src目录下存放了源文件，当执行cmake时，就会进入src目录下去找src目录下的CMakeLists.txt，所以在src目录下也建立一个CMakeLists.txt，内容如下:

src/CMakeLists.txt

#源文件放在变量里
aux_source_directory (. SRC_LIST)

#添加头文件的路径
include_directories (../include)

#生成可执行文件并包含源文件
add_executable (main ${SRC_LIST})

#设置可执行文件存放位置
set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)

这里的set其实是和前面的一样，只是EXECUTABLE_OUTPUT_PATH是个系统自带的预定义变量，其意义如下：

EXECUTABLE_OUTPUT_PATH ：目标二进制可执行文件的存放位置
PROJECT_SOURCE_DIR：工程的根目录

所以，这里set的意思是把存放可执行文件（elf）的位置设置为工程根目录下的bin目录。（cmake有很多预定义变量，详细的可以网上搜索一下）

添加好以上这2个CMakeLists.txt后，整体文件结构如下：

假设项目结构如下：
MyProject/
├── CMakeLists.txt
├── build
├── bin
├── include/
│   ├── matp.h
│   └── test.h
└── src/
	├── CMakeLists.txt
	├── main.c
    ├── matp.c
    └── test.c

这里解释一下为什么在build目录下运行cmake？
还记得在第一个例子里我让你着重看一下cmake和make之后会生成什么文件吗？这个过程中会生成很多文件，但是可惜的是跟我们的运行并没有什么关系，因此，如果能把编译隔离在某个文件夹，这样cmake的时候所有的中间文件都将在这个目录下生成，删除的时候也很好删除，非常方便。如果不这样做，cmake运行时生成的附带文件就会跟源码文件混在一起，这样会对程序的目录结构造成污染。

【另外一种写法：】
前面的工程使用了2个CMakeLists.txt，这次一个CMakeLists.txt。
最外层的CMakeLists.txt用于掌控全局，使用add_subdirectory来控制其它目录下的CMakeLists.txt的运行。

CMakeLists.txt

#指定所需的最低 CMake 版本
cmake_minimum_required (VERSION 2.8)

#定义项目名称
project (MyProject)

#设置可执行文件存放位置
set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)

#源文件放在变量里
aux_source_directory (src SRC_LIST)

#添加头文件的路径
include_directories (include)

#生成可执行文件并包含源文件
add_executable (main ${SRC_LIST})

。

标题----待补充

。

标题

。

标题

。

标题

二、CMake 项目代码示例

示例 1：单个源文件生成可执行文件

假设项目结构如下：
MyProject/
├── CMakeLists.txt
└── main.cpp

CMakeLists.txt 内容：

cmake_minimum_required(VERSION 3.10)
project(MyProject)

# 设置 C++ 标准
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
# 添加可执行文件
add_executable(MyProject main.cpp)

main.cpp 内容：

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

构建步骤：创建一个目录构建

1创建构建目录并进入：
	mkdir build && cd build

2运行 CMake 生成构建文件：
	cmake ..

3编译项目：
	cmake --build .

4运行生成的可执行文件：
	./MyProject

构建步骤：同目录构建

1运行 CMake 生成构建文件：
	cmake .

2编译项目：
	make
3运行生成的可执行文件：
	./MyProject
4.删除可执行文件：
	make clean

过程说明：
【1.cmake安装】
运行 CMake 生成构建文件： cmake … 出现下列情况，没有安装cmake。
在这里插入图片描述

安装cmake
	sudo apt install cmake
查看cmake版本
	cmake -version

在这里插入图片描述

【2运行 CMake 生成构建文件： cmake … 】
在这里插入图片描述
生成4个文件，其中就有Makefile文件。可以打开看看cat Makefie（注释有点多）。

【3.编译项目：cmake --build . 】
在这里插入图片描述
生成目标文件，也就是可执行文件MyProject。

输入make clean就可以删除这个可执行文件MyProject。然后重新make就生成了。

示例 2：多个源文件和库

假设项目结构如下：
	MyProject/
	├── CMakeLists.txt
	├── src/
	│   ├── main.cpp
	│   └── hello.cpp
	└── include/
	    └── hello.h

CMakeLists.txt 内容：

cmake_minimum_required(VERSION 3.10)
project(MyProject)
 
# 设置 C++ 标准
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
# 添加头文件目录
include_directories(${PROJECT_SOURCE_DIR}/include)
 
# 添加源文件
set(SOURCES
    src/main.cpp
    src/hello.cpp
)
 
# 添加可执行文件
add_executable(MyProject ${SOURCES})

hello.h 内容：

#ifndef HELLO_H
#define HELLO_H
 
#include <string>
std::string greet();
 
#endif // HELLO_H

hello.cpp 内容：

#include "hello.h"
std::string greet() {
    return "Hello, CMake!";
}

main.cpp 内容：

#include "hello.h"
#include <iostream>
int main() {
    std::cout << greet() << std::endl;
    return 0;
}

构建步骤：
与示例 1 相同。

参考链接

链接: 【C++】Cmake使用教程（看这一篇就够了）

cmake——简单介绍+代码实例

目录

一、CMake 的核心概念

1.CMakeLists.txt 文件—简单分析

【1基本概念】

【2. 常用命令与语法】

【3.高级用法】

2.CMakeLists.txt 文件—举例分析---------重点

【1简单入门在同一个目录下有一个源文件】

【2简单版本–在同一个目录下有多个源文件】

【3进阶版本—源文件太多了】

【4.在不同目录下有多个源文件】

【5.项目级的组织结构】

标题----待补充

标题

标题

标题

二、CMake 项目代码示例

示例 1：单个源文件生成可执行文件

示例 2：多个源文件和库

参考链接

网站公告

今日签到

热门文章

最新发布