跨平台编译工具CMake语法详解

一、cmake 简介
cmake 是一个跨平台、开源的构建系统。它是一个集软件构建、测试、打包于一身的软件。它使用与平台和编译器独立的配置文件来对软件编译过程进行控制。
二、常用命令
1. 指定 cmake 的最小版本
cmake_minimum_required(version 3.4.1)
这行命令是可选的,我们可以不写这句话,但在有些情况下,如果 cmakelists.txt 文件中使用了一些高版本 cmake 特有的一些命令的时候,就需要加上这样一行,提醒用户升级到该版本之后再执行 cmake。
2. 设置项目名称
project(demo)  
这个命令不是强制性的,但最好都加上。它会引入两个变量 demo_binary_dir 和 demo_source_dir,同时,cmake 自动定义了两个等价的变量 project_binary_dir 和 project_source_dir。
3. 设置编译类型
add_executable(demo demo.cpp) # 生成可执行文件
add_library(common static util.cpp) # 生成静态库
add_library(common shared util.cpp) # 生成动态库或共享库
add_library 默认生成是静态库,通过以上命令生成文件名字
1.在 linux 下是:
demolibcommon.alibcommon.so  
2.在 windows 下是:
demo.execommon.libcommon.dll  
4. 指定编译包含的源文件
4.1 明确指定包含哪些源文件
add_library(demo demo.cpp test.cpp util.cpp)  
4.2 搜索所有的 cpp 文件
aux_source_directory(dir var) 发现一个目录下所有的源代码文件并将列表存储在一个变量中;aux_source_directory(. src_list) # 搜索当前目录下的所有.cpp文件;add_library(demo ${src_list});  
4.3 自定义搜索规则
file(glob src_list *.cpp protocol/*.cpp)add_library(demo ${src_list})# 或者file(glob src_list *.cpp)file(glob src_protocol_list protocol/*.cpp)add_library(demo ${src_list} ${src_protocol_list})# 或者aux_source_directory(. src_list)aux_source_directory(protocol src_protocol_list)add_library(demo ${src_list} ${src_protocol_list})  
5. 查找指定的库文件
find_library(var name path)查找到指定的预编译库,并将它的路径存储在变量中;
默认的搜索路径为 cmake 包含的系统库,因此如果是 ndk 的公共库只需要指定库的 name 即可;
find_library( # sets the name of the path variable. log-lib # specifies the name of the ndk library that # you want cmake to locate. log )类似的命令还有 find_file()、find_path()、find_program()、find_package()  
6. 设置包含的目录
include_directories( ${cmake_current_source_dir} ${cmake_current_binary_dir} ${cmake_current_source_dir}/include)  
linux 下还可以通过如下方式设置包含的目录:
set(cmake_cxx_flags ${cmake_cxx_flags} -i${cmake_current_source_dir})  
7. 设置链接库搜索目录
link_directories( ${cmake_current_source_dir}/libs)  
linux 下还可以通过如下方式设置包含的目录:
set(cmake_cxx_flags ${cmake_cxx_flags} -l${cmake_current_source_dir}/libs)  
8. 设置 target 需要链接的库
target_link_libraries( # 目标库 demo # 目标库需要链接的库 # log-lib 是上面 find_library 指定的变量名 ${log-lib} )  
在 windows 下,系统会根据链接库目录,搜索xxx.lib 文件,linux 下会搜索 xxx.so 或者 xxx.a 文件,如果都存在会优先链接动态库(so 后缀)
8.1 指定链接动态库或静态库
target_link_libraries(demo libface.a) # 链接libface.atarget_link_libraries(demo libface.so) # 链接libface.so  
8.2 指定全路径
target_link_libraries(demo ${cmake_current_source_dir}/libs/libface.a)target_link_libraries(demo ${cmake_current_source_dir}/libs/libface.so)  
8.3 指定链接多个库
target_link_libraries(demo ${cmake_current_source_dir}/libs/libface.a boost_system.a boost_thread pthread)  
9. 设置变量
9.1 set 直接设置变量的值
set(src_list main.cpp test.cpp)add_executable(demo ${src_list})  
9.2 set 追加设置变量的值
set(src_list main.cpp)set(src_list ${src_list} test.cpp)add_executable(demo ${src_list})  
9.3 list 追加或者删除变量的值
set(src_list main.cpp)list(append src_list test.cpp)list(remove_item src_list main.cpp)add_executable(demo ${src_list})  
10. 条件控制
10.1 if…elseif…else…endif
逻辑判断和比较:
if (expression):expression 不为空(0,n,no,off,false,notfound)时为真if (not exp):与上面相反if (var1 and var2)if (var1 or var2)if (command cmd):如果 cmd 确实是命令并可调用为真if (exists dir) if (exists file):如果目录或文件存在为真if (file1 is_newer_than file2):当 file1 比 file2 新,或 file1/file2 中有一个不存在时为真,文件名需使用全路径if (is_directory dir):当 dir 是目录时为真if (defined var):如果变量被定义为真if (var matches regex):给定的变量或者字符串能够匹配正则表达式 regex 时为真,此处 var 可以用 var 名,也可以用 ${var}if (string matches regex)  
数字比较:
if (variable less number):less 小于if (string less number)if (variable greater number):greater 大于if (string greater number)if (variable equal number):equal 等于if (string equal number)  
字母表顺序比较:
if (variable strless string)if (string strless string)if (variable strgreater string)if (string strgreater string)if (variable strequal string)if (string strequal string)  
示例:
if(msvc) set(link_libs common)else() set(boost_thread boost_log.a boost_system.a)endif()target_link_libraries(demo ${link_libs})# 或者if(unix) set(cmake_cxx_flags ${cmake_cxx_flags} -std=c++11 -fpermissive -g)else() add_definitions(-d_scl_secure_no_warnings d_crt_secure_no_warnings -d_win32_winnt=0x601 -d_winsock_deprecated_no_warnings)endif()if(${cmake_build_type} matches debug) ...else() ...endif()  
10.2 while…endwhile
while(condition) ...endwhile()  
10.3 foreach…endforeach
foreach(loop_var range start stop [step]) ...endforeach(loop_var)  
start 表示起始数,stop 表示终止数,step 表示步长,示例:
foreach(i range 1 9 2) message(${i})endforeach(i)# 输出:13579  
11. 打印信息
message(${project_source_dir})message(build with debug mode)message(warning this is warnning message)message(fatal_error this build has many error) # fatal_error 会导致编译失败  
12. 包含其它 cmake 文件
include(./common.cmake) # 指定包含文件的全路径include(def) # 在搜索路径中搜索def.cmake文件set(cmake_module_path ${cmake_current_source_dir}/cmake) # 设置include的搜索路径  
三、常用变量
1. 预定义变量
project_source_dir:工程的根目录
project_binary_dir:运行 cmake 命令的目录,通常是 ${project_source_dir}/build
project_name:返回通过 project 命令定义的项目名称
cmake_current_source_dir:当前处理的 cmakelists.txt 所在的路径
cmake_current_binary_dir:target 编译目录
cmake_current_list_dir:cmakelists.txt 的完整路径
cmake_current_list_line:当前所在的行
cmake_module_path:定义自己的 cmake 模块所在的路径,set(cmake_module_path ${project_source_dir}/cmake),然后可以用include命令来调用自己的模块
executable_output_path:重新定义目标二进制可执行文件的存放位置
library_output_path:重新定义目标链接库文件的存放位置
2. 环境变量
使用环境变量:
 $env{name}
写入环境变量:
 set(env{name} value) # 这里没有“$”符号
3. 系统信息
­cmake_major_version:cmake 主版本号,比如 3.4.1 中的 3
­cmake_minor_version:cmake 次版本号,比如 3.4.1 中的 4
­cmake_patch_version:cmake 补丁等级,比如 3.4.1 中的 1
­cmake_system:系统名称,比如 linux-­2.6.22
­cmake_system_name:不包含版本的系统名,比如 linux
­cmake_system_version:系统版本,比如 2.6.22
­cmake_system_processor:处理器名称,比如 i686
­unix:在所有的类 unix 平台下该值为 true,包括 os x 和 cygwin
­win32:在所有的 win32 平台下该值为 true,包括 cygwin
4. 主要开关选项
build_shared_libs:这个开关用来控制默认的库编译方式,如果不进行设置,使用 add_library 又没有指定库类型的情况下,默认编译生成的库都是静态库。如果 set(build_shared_libs on) 后,默认生成的为动态库
cmake_c_flags:设置 c 编译选项,也可以通过指令 add_definitions() 添加
cmake_cxx_flags:设置 c++ 编译选项,也可以通过指令 add_definitions() 添加
add_definitions(-denable_debug -dabc) # 参数之间用空格分隔
四、项目示例
1. 初试 cmake 的 helloworld
现在新建一个 hello.cpp 源码文件,代码如下:
#include int main(int argc, char* argv[]){ printf(hello cmake!);}  
之前都是采用 gcc hello.cpp -o hello 命令来生成可执行文件,但现在我们用 cmake 这种方式来生成,新建一个 cmakelists.txt 文件名大小写都按照这个来:
# 指定工程名project (hello)# 现阶段,你只需要了解 set 指令可以用来显式的定义变量即可# 将 hello.cpp 赋值给 src_list 变量,也可以指定多个源文件,用空格隔开# set(src_list hello.cpp add.cpp sub.cpp)set(src_list hello.cpp)# 输出打印构建目录message(status this is hello_binary_dir ${hello_binary_dir})# 输出打印资源目录message(status this is hello_source_dir ${hello_source_dir})# 输出打印资源目录,与hello_source_dir 一样 message(status this is project_source_dir ${project_source_dir})# 输出打印 cmake 资源目录,与 project_source_dir 一样 message(status this is cmake_source_dir ${cmake_source_dir})# 生成可执行文件 hello ,${src_list}是引用变量,也就是源文件 hello.cppadd_executable(hello ${src_list})  
新建 build 目录,cd 到 build 目录下,敲 cmake .. 命令,ls 一下会发现 cmake 帮我们生成了 makefile 等等一些文件。敲 make 命令生成 hello 可执行文件,ls 文件列表如下:
ubuntu@vm-0-9-ubuntu:~/ndk_day88/t1/build$ ls
cmakecache.txt  cmakefiles  cmake_install.cmake  hello  makefile
2. 构建生成 .so 动态库
上面的例子看不出有啥优势,甚至说还不如用 gcc hello.cpp -o hello 来得快,但像 ffmpeg 、opencv 等等,类似这样复杂的项目,我们敲命令去构建项目是很麻烦的。下面我们来讲一个稍微复杂一点的例子:
mkdir 新建 3 个目录分别为 src、libs、include 。src 用来存放源文件 add.ccp、sub.cpp、div.cpp。include 用来存放头文件 add.h、div.h、sub.h 。源码如下:
#include add.hint add(int num1, int num2){ return num1 + num2;}#include sub.h int sub(int num1, int num2){ return num1 - num2; }#include div.h int div(int num1, int num2){ return num1 / num2; }  
基于这些准备工作,我们想用 cmake 来构建一个 libmath.so 动态库,并且将其生成在 libs 目录文件夹下
# 指定 cmake 最低编译版本cmake_minimum_required(version 3.14)project (math)# 把当前工程目录下的 src 目录的下的所有 .cpp 和 .c 文件赋值给 src_list# aux_source_directory(${project_source_dir}/src src_list)file(glob src_list ${project_source_dir}/src/*.cpp)# 打印 src_list 文件列表# message(status ${src_list})# 指定头文件目录include_directories(${project_source_dir}/include)# 指定输出 .so 动态库的目录位置set(library_output_path ${project_source_dir}/lib)# 指定生成动态库add_library(math shared ${src_list})# 指定生成版本号,version指代动态库版本,soversion指代api版本# set_target_properties(math properties version 1.2 soversion 1)  
3. 链接外部动态库和头文件
将 libs 目录和 include 目录 copy 到 hello.cpp 同级目录下,修改 hello.cpp 源码如下:
#include #include add.h#include sub.h#include div.hint main(int argc, char* argv[]){ int a = 20; int b = 10; printf(%d+%d=%d,a,b,add(a,b)); printf(%d-%d=%d,a,b,sub(a,b)); printf(%d/%d=%d,a,b,div(a,b)); return 0;}  
现在我引用了 include 目录下的头文件,同时需要链接 libs 目录下的 libmath.so ,我们再次创建一个 cmakelists.txt 来生成可执行文件 hello
# 指定cmake最低编译版本cmake_minimum_required(version 3.14)# 指定工程的名称project(hello)#指定头文件目录位置include_directories(${project_source_dir}/include)#添加共享库搜索路径link_directories(${project_source_dir}/lib)#生成可执行文件add_executable(hello hello.cpp)#为hello添加共享库链接target_link_libraries(hello math)  
4. 基于 ffmpeg 开发的 cmakelists.txt
音视频的播放,在线直播,音视频通话开发,后面可能都得基于 ffmpeg 来写。那么首先我们需要编译 .so 动态库,然后把动态库和头文件 copy 到 as 来开发,这里我已经编译好了一个 3.3.9 的版本,至于怎么写 shell 编译脚本,会在下篇文章中介绍。目前大伙先直接拿过来用就行了。我把编译好的 .so 动态库和 include 目录拷贝到 as 工程的 jnilibs 目录下
# for more information about using cmake with android studio, read the# documentation: https://d.android.com/studio/projects/add-native-code.html# sets the minimum version of cmake required to build the native library.cmake_minimum_required(version 3.4.1)# 需要引入我们头文件,以这个配置的目录为基准include_directories(src/main/jnilibs/include)include_directories(src/main/jnilibs/other)# creates and names a library, sets it as either static# or shared, and provides the relative paths to its source code.# you can define multiple libraries, and cmake builds them for you.# gradle automatically packages shared libraries with your apk.#添加共享库搜索路径link_directories(${cmake_source_dir}/src/main/jnilibs/armeabi)# 指定源文件目录aux_source_directory(${cmake_source_dir}/src/main/cpp src_list)add_library( # sets the name of the library. native-lib # sets the library as a shared library. shared # provides a relative path to your source file(s). # src/main/cpp/native-lib.cpp ${src_list} )# searches for a specified prebuilt library and stores the path as a# variable. because cmake includes system libraries in the search path by# default, you only need to specify the name of the public ndk library# you want to add. cmake verifies that the library exists before# completing its build.find_library( # sets the name of the path variable. log-lib # specifies the name of the ndk library that # you want cmake to locate. log)# specifies libraries cmake should link to your target library. you# can link multiple libraries, such as libraries you define in this# build script, prebuilt third-party libraries, or system libraries.target_link_libraries( # specifies the target library. # 链接额外的 ffmpeg 的编译 native-lib # 编解码(最重要的库) avcodec-57 # 设备信息 avdevice-57 # 滤镜特效处理库 avfilter-6 # 封装格式处理库 avformat-57 # 工具库(大部分库都需要这个库的支持) avutil-55 # 后期处理 postproc-54 # 音频采样数据格式转换库 swresample-2 # 视频像素数据格式转换 swscale-4 -landroid # links the target library to the log library # included in the ndk. ${log-lib})


万名消费者“公投”激光电视品牌排行榜,谁是第一名?
微型雷达系统的设计方案分析
浊度余氯水质在线检测的方法
芯片断供危机给华为带来哪些影响?
验证与确认 重要但相互独立
跨平台编译工具CMake语法详解
区块链技术可能正是评论系统所需要的颠覆性创新
那些通过计算机新技能的先驱者以及他们取得的成就
MAX9271 GMSL串行器与同轴电缆
AI设计3D打印制造,实际效果非同一般
皮卫星智能航天电源系统设计
PLC和PC-based技术特点和优势对比
微软施压NVIDIA截杀,Intel如何拥抱人工智能?
数字PWM的新型超声波清洗电源发生器设计
翼辉信息联合晶心科技推出AndesCore™ A25系列RISC-V处理器
5G网络尚未成熟_6G宣传已不绝于耳
如何看待未来 手机接口是否统一
助听器电池使用要点
超声波焊接和电阻焊焊接的原理及差异
威迈斯IPO上市科创属性凸显 营收、利润均呈上升态势