CMake

笔记配套视频教程：从零开始详细介绍CMake_哔哩哔哩_bilibili 官网在线文档：Documentation | CMake 参考书籍：前言 - 《CMake菜谱（CMake Cookbook中文版）》

说明

cmake的定义是什么？-----高级编译配置工具

当多个人用不同的语言或者编译器开发一个项目，最终要输出一个可执行文件或者共享库（dll，so等等）这时候神器就出现了-----CMake！

所有操作都是通过编译CMakeLists.txt来完成的

官方网站是 www.cmake.org，可以通过访问官方网站获得更多关于 cmake 的信息

学习CMake的目的，为将来处理大型的C/C++/JAVA项目做准备

CMake安装

1、绝大多数的 linux 系统已经安装了 CMake，没有安装的话可以通过 yum install cmake 安装 2、Windows 或某些没有安装过的 linux 系统，去 http://www.cmake.org/HTML/Download.htm l 可以下载安装

CMake一个HelloWord

1、步骤一，写一个 HelloWord

#main.cpp
#include <iostream>

int main(){
std::cout <<  "hello word" << std::endl;
}

2、步骤二，写 CMakeLists. txt 注意文件名要严格区分大小写

#CMakeLists.txt

PROJECT (HELLO)

SET(SRC_LIST main.cpp)

MESSAGE(STATUS "This is BINARY dir " ${HELLO_BINARY_DIR})
MESSAGE(STATUS "This is SOURCE dir "${HELLO_SOURCE_DIR})

ADD_EXECUTABLE(hello ${SRC_LIST})

3、步骤三、使用 cmake，生成 makefile 文件

cmake .

输出：
[root@localhost cmake]# cmake .
CMake Warning (dev) in CMakeLists.txt:
  Syntax Warning in cmake code at

    /root/cmake/CMakeLists.txt:7:37

  Argument not separated from preceding token by whitespace.
This warning is for project developers.  Use -Wno-dev to suppress it.

-- The C compiler identification is GNU 10.2.1
-- The CXX compiler identification is GNU 10.2.1
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- This is BINARY dir /root/cmake
-- This is SOURCE dir /root/cmake
-- Configuring done
-- Generating done
-- Build files have been written to: /root/cmake

目录下就生成了这些文件-CMakeFiles, CMakeCache. txt, cmake_install. cmake 等文件，并且生成了 Makefile. 现在不需要理会这些文件的作用，以后你也可以不去理会。最关键的是，它自动生成了 Makefile.

4、使用 make 命令编译

root@localhost cmake]# make
Scanning dependencies of target hello
[100%] Building CXX object CMakeFiles/hello.dir/main.cpp.o
Linking CXX executable hello
[100%] Built target hello

5、最终生成了 Hello 的可执行程序

CMake 一个 HelloWord 的语法介绍

PROJECT 关键字

可以用来指定工程的名字和支持的语言，默认支持所有语言 PROJECT (HELLO) 指定了工程的名字，并且支持所有语言—建议 PROJECT (HELLO CXX) 指定了工程的名字，并且支持语言是 C++ PROJECT (HELLO C CXX) 指定了工程的名字，并且支持语言是 C 和 C++

该指定隐式定义了两个CMAKE的变量 <projectname>_BINARY_DIR，本例中是 HELLO_BINARY_DIR <projectname>_SOURCE_DIR，本例中是 HELLO_SOURCE_DIR

MESSAGE关键字就可以直接使用者两个变量，当前都指向当前的工作目录，后面会讲外部编译

问题：如果改了工程名，这两个变量名也会改变解决：又定义两个预定义变量：PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR，这两个变量和 HELLO_BINARY_DIR，HELLO_SOURCE_DIR 是一致的。所以改了工程名也没有关系

SET关键字

用来显示的指定变量的 SET(SRC_LIST main.cpp) SRC_LIST 变量就包含了 main.cpp 也可以 SET(SRC_LIST main.cpp t1.cpp t2.cpp)

MESSAGE关键字

massage 命令向终端输出用户自定义的信息，负责打印 log 主要包含三种信息： - SEND_ERROR，CMake错误，会继续执行，但是会跳过生成构建系统 - STATUS，比如提示当前使用的编译器 - FATAL_ERROR，CMake致命错误，会终止进程

ADD_EXECUTABLE关键字

生成可执行文件 ADD_EXECUTABLE(hello ${SRC_LIST}) 生成的可执行文件名是 hello，源文件读取变量 SRC_LIST 中的内容也可以直接写 ADD_EXECUTABLE(hello main.cpp)

上述例子可以简化的写成

PROJECT(HELLO)
ADD_EXECUTABLE(hello main.cpp)

注意：工程名的 HELLO 和生成的可执行文件 hello 是没有任何关系的

语法的基本原则

变量使用 ${} 方式取值，但是在 IF 控制语句中是直接使用变量名
指令 (参数 1 参数 2...) 参数使用括弧括起，参数之间使用空格或分号分开。以上面的 ADD_EXECUTABLE 指令为例，如果存在另外一个 func.cpp 源文件就要写成：ADD_EXECUTABLE(hello main.cpp func.cpp) 或者 ADD_EXECUTABLE(hello main.cpp; func.cpp)
指令是大小写无关的，参数和变量是大小写相关的。但，推荐你全部使用大写指令

语法注意事项

SET(SRC_LIST main.cpp) 可以写成 SET(SRC_LIST “main.cpp”)，如果源文件名中含有空格，就必须要加双引号
ADD_EXECUTABLE(hello main) 后缀可以不行，他会自动去找 .c 和 .cpp，最好不要这样写，因为可能会有这两个文件 main. cpp 和 main

内部构建和外部构建

上述例子就是内部构建，他生产的临时文件特别多，不方便清理
外部构建，就会把生成的临时文件放在 build 目录下，不会对源文件有任何影响强烈使用外部构建方式，所以一般采用外部构建的方式

外部构建方式举例

//例子目录，CMakeLists.txt和上面例子一致
[root@localhost cmake]# pwd
/root/cmake
[root@localhost cmake]# ll
total 8
-rw-r--r--. 1 root root 198 Dec 28 20:59 CMakeLists.txt
-rw-r--r--. 1 root root  76 Dec 28 00:18 main.cpp

建立一个 build 目录，可以在任何地方，建议在当前目录下
进入 build，运行 cmake .. 当然 .. 表示上一级目录，你可以写 CMakeLists.txt 所在的绝对路径，生产的文件都在 build 目录下了
在 build 目录下，运行 make 来构建工程

注意外部构建的两个变量 1. HELLO_SOURCE_DIR 还是工程路径 /root/cmake 2. HELLO_BINARY_DIR 编译路径也就是 /root/cmake/bulid

让Hello World看起来更像一个工程

为工程添加一个子目录 src，用来放置工程源代码
添加一个子目录 doc，用来放置这个工程的文档 hello.txt
在工程目录添加文本文件 COPYRIGHT, README
在工程目录添加一个 runhello.sh 脚本，用来调用 hello 二进制
将构建后的目标文件放入构建目录的 bin 子目录
将 doc 目录的内容以及 COPYRIGHT/README 安装到 /usr/share/doc/cmake/

每个目录下都要有一个CMakeLists.txt说明

[root@localhost cmake]# tree
.
├── build
├── CMakeLists.txt
└── src
    ├── CMakeLists.txt
    └── main.cpp

外层 CMakeLists.txt

PROJECT(HELLO)
ADD_SUBDIRECTORY(src bin)

src 下的 CMakeLists.txt

ADD_EXECUTABLE(hello main.cpp)

ADD_SUBDIRECTORY 指令

ADD_SUBDIRECTORY(source_dir [binary_dir] [EXCLUDE_FROM_ALL]) - 这个指令用于向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制存放的位置 - EXCLUDE_FROM_ALL 函数是将写的目录从编译中排除，如程序中的 example - ADD_SUBDIRECTORY(src bin) - 将 src 子目录加入工程并指定编译输出 (包含编译中间结果) 路径为 bin 目录 - 如果不进行 bin 目录的指定，那么编译结果 (包括中间结果) 都将存放在 build/src 目录

更改二进制的保存路径

SET 指令重新定义 EXECUTABLE_OUTPUT_PATH 和 LIBRARY_OUTPUT_PATH 变量来指定最终的目标二进制的位置 SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin) SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)

思考：ADD_SUBDIRECTORY 指令加在哪个 CMakeLists.txt 当中哪里要改变目标存放路径，就在哪里加入上述的定义，所以应该在 src 下的 CMakeLists.txt 下写

安装

一种是从代码编译后直接 make install 安装
一种是打包时的指定目录安装。
- 简单的可以这样指定目录：make install DESTDIR=/tmp/test
- 稍微复杂一点可以这样指定目录：./configure –prefix=/usr

如何安装HelloWord

使用CMAKE一个新的指令：INSTALL INSTALL的安装可以包括：二进制、动态库、静态库以及文件、目录、脚本等使用CMAKE一个新的变量：CMAKE_INSTALL_PREFIX

// 目录树结构
[root@localhost cmake]# tree
.
├── build
├── CMakeLists.txt
├── COPYRIGHT
├── doc
│   └── hello.txt
├── README
├── runhello.sh
└── src
    ├── CMakeLists.txt
    └── main.cpp

3 directories, 7 files

安装文件 COPYRIGHT 和 README

FILES：文件 INSTALL(FILES COPYRIGHT README DESTINATION share/doc/cmake/) - DESTINATION： - 可以写绝对路径 - 可以写相对路径，相对路径实际路径是：${CMAKE_INSTALL_PREFIX}/<DESTINATION 定义的路径> - 其中 CMAKE_INSTALL_PREFIX 默认是在 /usr/local/

cmake -D CMAKE_INSTALL_PREFIX=/usr 在 cmake 的时候指定 CMAKE_INSTALL_PREFIX 变量的路径

安装脚本 runhello. sh

PROGRAMS：非目标文件的可执行程序安装(比如脚本之类) INSTALL(PROGRAMS runhello.sh DESTINATION bin)

说明：实际安装到的是 /usr/bin

安装 doc 中的 hello.txt

通过在 doc 目录建立CMakeLists.txt，通过install下的file
直接在工程目录通过 INSTALL(DIRECTORY doc/ DESTINATION share/doc/cmake) 安装
- DIRECTORY 后面连接的是所在 Source 目录的相对路径

注意：abc 和 abc/有很大的区别 - 目录名不以/结尾：这个目录将被安装为目标路径下的 - 目录名以/结尾：将这个目录中的内容安装到目标路径

安装过程

cmake ..
make
make install

静态库和动态库的构建

任务： 1. 建立一个静态库和动态库，提供 HelloFunc 函数供其他程序编程使用，HelloFunc 向终端输出 Hello World 字符串。 2. 安装头文件与共享库。

静态库和动态库的区别 - 静态库的扩展名一般为“.a”或“.lib”；动态库的扩展名一般为“.so”或“.dll”。 - 静态库在编译时会直接整合到目标程序中，编译成功的可执行文件离开静态库后仍然可独立运行 - 动态库在编译时不会放到连接的目标程序中，即可执行文件无法单独运行。

构建实例

[root@localhost cmake2]# tree
.
├── build
├── CMakeLists.txt
└── lib
    ├── CMakeLists.txt
    ├── hello.cpp
    └── hello.h

hello.h中的内容

#ifndef HELLO_H
#define Hello_H

void HelloFunc();

#endif

hello.cpp中的内容

#include "hello.h"
#include <iostream>
void HelloFunc(){
    std::cout << "Hello World" << std::endl;
}

项目中的cmake内容

PROJECT(HELLO)
ADD_SUBDIRECTORY(lib bin)

lib 中 CMakeLists. txt 中的内容 - 第一行定义了一个变量，叫 LIBHELLO_SRC，该变量里面放了 hello.cpp

SET(LIBHELLO_SRC hello.cpp)
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

ADD_LIBRARY

ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC}) - hello：就是正常的库名，生成的名字前面会加上lib，最终产生的文件是libhello.so - SHARED，动态库；STATIC，静态库 - ${LIBHELLO_SRC} ：源文件

补充：静态库的文件拓展名通常为. lib（Windows）或者. a（Linux）；动态库的文件拓展名通常为. dll (Windows) 或者. so（Linux）

同时构建静态和动态库

// 如果用这种方式，只会构建一个动态库，不会构建出静态库，虽然静态库的后缀是.a
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
ADD_LIBRARY(hello STATIC ${LIBHELLO_SRC})

// 修改静态库的名字，这样是可以的，但是我们往往希望他们的名字是相同的，只是后缀不同而已
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})

SET_TARGET_PROPERTIES

这条指令可以用来设置输出的名称，对于动态库，还可以用来指定动态库版本和 API 版本

同时构建静态和动态库

SET(LIBHELLO_SRC hello.cpp)

ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})

//对hello_static的重名为hello
SET_TARGET_PROPERTIES(hello_static PROPERTIES  OUTPUT_NAME "hello")
//cmake 在构建一个新的target 时，会尝试清理掉其他使用这个名字的库，因为，在构建 libhello.so 时， 就会清理掉 libhello.a
SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)


ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

SET_TARGET_PROPERTIES(hello PROPERTIES  OUTPUT_NAME "hello")
SET_TARGET_PROPERTIES(hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)

动态库的版本号

一般动态库都有一个版本号的关联

libhello.so.1.2
libhello.so ->libhello.so.1
libhello.so.1->libhello.so.1.2

CMakeLists.txt 插入如下

SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1)

VERSION 指代动态库版本，SOVERSION 指代 API 版本。

安装共享库和头文件

本例中我们将 hello 的共享库安装到<prefix>/lib目录，将 hello.h 安装到<prefix>/include/hello 目录其中 ARCHIVE 特指静态库，LIBRARY 特指动态库，RUNTIME 特指可执行目标二进制。

//文件放到该目录下
INSTALL(FILES hello.h DESTINATION include/hello)

//二进制，静态库，动态库安装都用TARGETS
INSTALL(TARGETS hello hello_static LIBRARY DESTINATION lib ARCHIVE DESTINATION lib)

注意：安装的时候，指定一下路径，放到系统下 cmake -D CMAKE_INSTALL_PREFIX=/usr ..

使用外部共享库和头文件

准备工作，新建一个目录来使用外部共享库和头文件

[root@MiWiFi-R4CM-srv cmake3]# tree
.
├── build
├── CMakeLists.txt
└── src
    ├── CMakeLists.txt
    └── main.cpp

main.cpp

#include <hello.h>

int main(){
    HelloFunc();
}

解决：make 后头文件找不到的问题

PS：include <hello/hello.h> 这样include是可以，这么做的话，就没啥好讲的了

关键字：INCLUDE_DIRECTORIES 这条指令可以用来向工程添加多个特定的头文件搜索路径，路径之间用空格分割在CMakeLists.txt中加入头文件搜索路径 INCLUDE_DIRECTORIES(/usr/include/hello)

解决：找到引用的函数问题

报错信息：undefined reference to HelloFunc()

关键字：LINK_DIRECTORIES 添加非标准的共享库搜索路径指定第三方库所在路径，LINK_DIRECTORIES(/home/myproject/libs)
关键字：TARGET_LINK_LIBRARIES 添加需要链接的共享库 TARGET_LINK_LIBRARIES 的时候，只需要给出动态链接库的名字就行了。

在 CMakeLists. txt 中插入链接共享库，必须要插在 ADD_EXECUTABLE 的后面， TARGET_LINK_LIBRARIES(main libhello.so)

查看main的链接情况

[root@MiWiFi-R4CM-srv bin]# ldd main 
    linux-vdso.so.1 =>  (0x00007ffedfda4000)
    libhello.so => /lib64/libhello.so (0x00007f41c0d8f000)
    libstdc++.so.6 => /lib64/libstdc++.so.6 (0x00007f41c0874000)
    libm.so.6 => /lib64/libm.so.6 (0x00007f41c0572000)
    libgcc_s.so.1 => /lib64/libgcc_s.so.1 (0x00007f41c035c000)
    libc.so.6 => /lib64/libc.so.6 (0x00007f41bff8e000)
    /lib64/ld-linux-x86-64.so.2 (0x00007f41c0b7c000)

链接静态库

TARGET_LINK_LIBRARIES(main libhello.a)

特殊的环境变量 CMAKE_INCLUDE_PATH 和 CMAKE_LIBRARY_PATH

注意：这两个是环境变量而不是 cmake 变量，可以在linux的bash中进行设置

我们上面例子中使用了绝对路径 INCLUDE_DIRECTORIES(/usr/include/hello) 来指明 include 路径的位置

我们还可以使用另外一种方式，使用环境变量 export CMAKE_INCLUDE_PATH=/usr/include/hello

补充：生成 debug 版本的方法，后续可以使用 GDB 调试

cmake .. -D CMAKE_BUILD_TYPE=debug

其他补充教程以及参考资料

CMake 流程

注意：CMake 是没有带编译工具的，需要自己安装 C++的编译工具。如 Windows 下的 MSBuild 工具链或者直接安装 Visual Studio，在 Linux 下则需要安装 gcc 或者 clang 等等。

配置（Configure）

命令 cmake -S . -B build

在项目的根目录下创建 CMakeLists. txt 文件

对于一个最简单的只包含一个源文件的工程，以下三行并不可少

cmake_minimum_required(VERSION 3.25)  

project(Example)  

add_executable(Example main.cpp)

随后可以根据这个 CMakeLists 文件生成目标平台下的原生工程，这个过程在 CMake 中叫做“配置（Configure）”

构建（Build）

命令 cmake --build build 构建完成后会输出可执行文件

复杂项目的 CMakeLists. txt 样例

cmake_minimum_required(VERSION 3.5)

project(Blackhole)

list(APPEND CMAKE_MODULE_PATH ${CMAKE_BINARY_DIR})
list(APPEND CMAKE_PREFIX_PATH ${CMAKE_BINARY_DIR})

if(NOT EXISTS "${CMAKE_BINARY_DIR}/conan.cmake")
  message(STATUS "Downloading conan.cmake from https://github.com/conan-io/cmake-conan")
  file(DOWNLOAD "https://raw.githubusercontent.com/conan-io/cmake-conan/v0.16.1/conan.cmake"
                "${CMAKE_BINARY_DIR}/conan.cmake"
                EXPECTED_HASH SHA256=396e16d0f5eabdc6a14afddbcfff62a54a7ee75c6da23f32f7a31bc85db23484
                TLS_VERIFY ON)
endif()

include(${CMAKE_BINARY_DIR}/conan.cmake)

conan_cmake_configure(REQUIRES imgui/1.86 glfw/3.3.6 glew/2.2.0 glm/0.9.9.8 stb/cci.20210713
                      GENERATORS cmake_find_package)

conan_cmake_autodetect(settings)

conan_cmake_install(PATH_OR_REFERENCE .
                    BUILD missing
                    REMOTE conancenter
                    SETTINGS ${settings})

find_package(imgui REQUIRED)
find_package(glfw3 REQUIRED)
find_package(GLEW REQUIRED)
find_package(glm REQUIRED)
find_package(stb REQUIRED)

file(GLOB SRC_FILES
  "${PROJECT_SOURCE_DIR}/src/*.h"
  "${PROJECT_SOURCE_DIR}/src/*.cpp"
  "${PROJECT_SOURCE_DIR}/src/*.c"
  "${PROJECT_SOURCE_DIR}/src/*.cc")

add_executable(${CMAKE_PROJECT_NAME} ${SRC_FILES})

target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE imgui::imgui)
target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE glfw)
target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE GLEW::GLEW)
target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE glm::glm)
target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE stb::stb)

target_compile_features(${CMAKE_PROJECT_NAME} PRIVATE cxx_std_17)

# Copy assets files after build.
add_custom_command(
  TARGET ${CMAKE_PROJECT_NAME}
  POST_BUILD
  COMMAND ${CMAKE_COMMAND} -E copy_directory "${PROJECT_SOURCE_DIR}/assets"
          "$<TARGET_FILE_DIR:${CMAKE_PROJECT_NAME}>/assets")

add_custom_command(
  TARGET ${CMAKE_PROJECT_NAME}
  POST_BUILD
  COMMAND ${CMAKE_COMMAND} -E copy_directory "${PROJECT_SOURCE_DIR}/shader/"
          "$<TARGET_FILE_DIR:${CMAKE_PROJECT_NAME}>/shader")

微软开源包工具：vcpkg

参考资料： - CMake应用：CMakeLists.txt完全指南 - 知乎

CMake

说明

CMake安装

CMake一个HelloWord

CMake 一个 HelloWord 的语法介绍

PROJECT 关键字

SET关键字

MESSAGE关键字

ADD_EXECUTABLE关键字

语法的基本原则

语法注意事项

内部构建和外部构建

外部构建方式举例

让Hello World看起来更像一个工程

将目标文件放入构建目录的 bin 子目录

ADD_SUBDIRECTORY 指令

更改二进制的保存路径

安装

如何安装HelloWord

安装文件 COPYRIGHT 和 README

安装脚本 runhello. sh

安装 doc 中的 hello.txt

安装过程

静态库和动态库的构建

构建实例

ADD_LIBRARY

同时构建静态和动态库

SET_TARGET_PROPERTIES

动态库的版本号

安装共享库和头文件

使用外部共享库和头文件

解决：make 后头文件找不到的问题

解决：找到引用的函数问题

特殊的环境变量 CMAKE_INCLUDE_PATH 和 CMAKE_LIBRARY_PATH

其他补充教程以及参考资料

CMake 流程

配置（Configure）

构建（Build）