cmake 中文教程（cmake documentation）

大家好，我是讯享网，很高兴认识大家。

点击上方“机械电子工程技术”关注我们

CMake是一个免费的多平台编译工具，旨在构建、测试和软件打包。CMake是用于控制软件使用简单的平台和编译器编译过程独立配置文件。CMake生成本机makefile和工作区，可以使用您所选择的编译器环境。

通过编写CMakeLists.txt，可以控制生成的Makefile，从而控制编译过程。CMake自动生成的Makefile不仅可以通过make命令构建项目生成目标文件，还支持安装（make install）、测试安装的程序是否能正确执行（make test，或者ctest）、生成当前平台的安装包（make package）、生成源码包（make package_source）、产生Dashboard显示数据并上传等高级功能，只要在CMakeLists.txt中简单配置，就可以完成很多复杂的功能，包括写测试用例。

如果有嵌套目录，子目录下可以有自己的CMakeLists.txt。

讯享网

1、宏功能

PROJECT_SOURCE_DIR

使用cmake命令后紧跟的目录，一般是工程的根目录

PROJECT_BINARY_DIR

执行cmake命令的目录

CMAKE_CURRENT_SOURCE_DIR

当前处理的CMakeLists.txt所在的路径

CMAKE_CURRENT_BINARY_DIR target 

编译目录

EXECUTABLE_OUTPUT_PATH

重新定义目标二进制可执行文件的存放位置

LIBRARY_OUTPUT_PATH

重新定义目标链接库文件的存放位置

PROJECT_NAME

返回通过PROJECT指令定义的项目名称

CMAKE_BINARY_DIR

项目实际构建路径，假设在build目录进行的构建，那么得到的就是这个目录的路径

2、常用命令

CMake 使用 # 进行行注释，可以放在任何位置。

CMake 使用 #[[ ]] 形式进行块注释。

指定使用的 cmake 的最低版本

cmake_minimum_required

定义工程会生成一个可执行程序

add_executable(可执行程序名源文件名称)

指定使用的C++标准

set(CMAKE_CXX_STANDARD 11)

定义变量

SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

set(SRC_LIST add.c  div.c   main.c  mult.c  sub.c)

set(SRC_LIST add.c;div.c;main.c;mult.c;sub.c)

add_executable(app  \({SRC_LIST})指定输出的路径set(HOME /home/robin/Linux/Sort)set(EXECUTABLE_OUTPUT_PATH \){HOME}/bin)

查找某个路径下的所有源文件

aux_source_directory(< dir > < variable >)

aux_source_directory(\({CMAKE_CURRENT_SOURCE_DIR}/src SRC_LIST)add_executable(app  \){SRC_LIST})

file(GLOB/GLOB_RECURSE 变量名要搜索的文件路径和文件类型)

file(GLOB MAIN_SRC \({CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp)file(GLOB MAIN_HEAD \){CMAKE_CURRENT_SOURCE_DIR}/include/*.h)

包含头文件

include_directories(headpath)

include_directories(\({PROJECT_SOURCE_DIR}/include)制作静态库add_library(库名称 STATIC 源文件1 [源文件2] ...) 制作动态库add_library(库名称 SHARED 源文件1 [源文件2] ...) 指定静态库和动态库输出的路径set(LIBRARY_OUTPUT_PATH \){PROJECT_SOURCE_DIR}/lib)

包含静态库文件

link_libraries(<static lib> [<static lib>…])

link_directories(<lib path>)

link_directories(\({PROJECT_SOURCE_DIR}/lib)link_libraries(calc)包含动态库文件target_link_libraries(A B C)target_link_libraries(D A) target_link_libraries(app pthread)宏定义add_definitions(-D宏名称) 3、案例 3.1单个源文件 <section style="text-indent: 2em;">第一步：编写源代码，demo1文件夹下只有一个源文件main.c，内容如下：</section><section class="code-snippet__fix code-snippet__js"><ul class="code-snippet__line-index code-snippet__js"><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li></ul><pre class="code-snippet__js" data-lang="cs"><code>#include <stdio.h></code><code>#include <stdlib.h></code><code> </code><code>/</code><code> * power - Calculate the power of number.</code><code> * @param base: Base value.</code><code> * @param exponent: Exponent value.</code><code> *</code><code> * @return base raised to the power exponent.</code><code> */</code><code>double power(double base, int exponent)</code><code>{</code><code> int result = base;</code><code> int i;</code><code> </code><code> if (exponent == 0) {</code><code> return 1;</code><code> }</code><code> </code><code> for(i = 1; i < exponent; ++i){</code><code> result = result * base;</code><code> }</code><code> </code><code> return result;</code><code>}</code><code> </code><code>int main(int argc, char *argv[])</code><code>{</code><code> if (argc < 3){</code><code> printf("Usage: %s base exponent \n", argv[0]);</code><code> return 1;</code><code> }</code><code> double base = atof(argv[1]);</code><code> int exponent = atoi(argv[2]);</code><code> double result = power(base, exponent);</code><code> printf("%g ^ %d is %g\n", base, exponent, result);</code><code> return 0;</code><code>}</code></pre></section>第二步：编写 CMakeLists.txt 文件，并保存在与 main.cc 源文件同个目录下：<section class="code-snippet__fix code-snippet__js"><ul class="code-snippet__line-index code-snippet__js"><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li></ul><pre class="code-snippet__js" data-lang="properties"><code># CMake 最低版本号要求</code><code>cmake_minimum_required (VERSION 2.8)</code><code> </code><code># 项目信息</code><code>project (Demo1)</code><code> </code><code># 指定生成目标</code><code>add_executable(Demo main.cc)</code></pre></section> <section style="text-indent: 2em;">CMakeLists.txt 的语法比较简单，由命令、注释和空格组成，其中命令是不区分大小写的。符号 # 后面的内容被认为是注释。命令由命令名称、小括号和参数组成，参数之间使用空格进行间隔。对于上面的 CMakeLists.txt 文件，依次出现了几个命令：</section><section style="text-indent: 2em;">cmake_minimum_required：指定运行此配置文件所需的 CMake 的最低版本；</section><section style="text-indent: 2em;">project：参数值是 Demo1，该命令表示项目的名称是 Demo1 。</section><section style="text-indent: 2em;">add_executable：将名为 main.cc 的源文件编译成一个名称为 Demo 的可执行文件。</section><section style="text-indent: 2em;">第三步：在当前目录执行 cmake . ，得到 Makefile 后再使用 make 命令编译得到 Demo1 可执行文件。</section> 注意：<ul style="padding-left: 32px;-webkit-font-smoothing: antialiased;list-style-position: outside;list-style-image: none;font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Ubuntu, "Helvetica Neue", Helvetica, Arial, "PingFang SC", "Hiragino Sans GB", "Microsoft YaHei UI", "Microsoft YaHei", "Source Han Sans CN", sans-serif, "Apple Color Emoji", "Segoe UI Emoji";margin-top: 14px;margin-bottom: 1em;font-size: 15px;line-height: 1.75;color: rgb(5, 7, 59);letter-spacing: normal;text-align: start;text-wrap: wrap;background-color: rgb(253, 253, 254);" class="list-paddingleft-1"><li>cmake .. 表示在上一级目录中查找 CMakeLists.txt 文件。</li><li>cmake . 表示在当前目录中查找 CMakeLists.txt 文件。 </li></ul><section>3.2同一目录，多个源文件</section>第一步：编写源代码，demo2文件夹下有三个文件，main.c/MathFunctions.c/MathFunctions.h<span style="background-color: inherit;font-family: Menlo, Monaco, Consolas, "Andale Mono", "lucida console", "Courier New", monospace;font-size: inherit;color: rgb(25, 27, 31);letter-spacing: normal;text-align: start;">第二步：编写 CMakeLists.txt 文件，并保存在与 main.cc 源文件同个目录下：<section class="code-snippet__fix code-snippet__js"><ul class="code-snippet__line-index code-snippet__js"><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li></ul><pre class="code-snippet__js" data-lang="properties"><code># CMake 最低版本号要求</code><code>cmake_minimum_required (VERSION 2.8)</code><code> </code><code># 项目信息</code><code>project (Demo2)</code><code> </code><code># 指定生成目标</code><code>add_executable(Demo main.cc MathFunctions.cc)</code></pre></section><section></section>查找指定目录下的所有源文件<section class="code-snippet__fix code-snippet__js"><ul class="code-snippet__line-index code-snippet__js"><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li><li></li></ul><pre class="code-snippet__js" data-lang="nginx"><code># CMake 最低版本号要求</code><code>cmake_minimum_required (VERSION 2.8)</code><code> </code><code># 项目信息</code><code>project (Demo2)</code><code> </code><code># 查找当前目录下的所有源文件</code><code># 并将名称保存到 DIR_SRCS 变量</code><code>aux_source_directory(. DIR_SRCS)</code><code> </code><code># 指定生成目标</code><code>add_executable(Demo \){DIR_SRCS})

第三步：在当前目录执行 cmake . ，

3.3多个目录，多个源文件

第一步：编写源代码，demo3文件夹下有一个文件main.c和一个文件夹math，math文件夹下有两个文件MathFunctions.c/MathFunctions.h

第二步：编写 CMakeLists.txt 文件，并保存在与 main.cc 源文件同个目录下：

# CMake 最低版本号要求cmake_minimum_required (VERSION 2.8)
# 项目信息project (Demo3)
# 查找当前目录下的所有源文件# 并将名称保存到 DIR_SRCS 变量aux_source_directory(. DIR_SRCS)
# 添加 math 子目录add_subdirectory(math)
# 指定生成目标 add_executable(Demo main.cc)
# 添加链接库target_link_libraries(Demo MathFunctions)

讯享网

第三步：在当前目录执行 cmake . ，

参考文献

1、https://subingwen.cn/cmake/CMake-primer/

想了解更多

赶紧扫码关注

cmake 中文教程（cmake documentation）

相关推荐