1. 指定cmake最小版本
cmake_minimum_required(VERSION 3.0)
这行命令是可选的,我们可以不写这句话,但在有些情况下,如果 CMakeLists.txt 文件中使用了一些高版本 cmake 特有的一些命令的时候,就需要加上这样一行,提醒用户升级到该版本之后再执行 cmake。
2. 设置项目名称
project(demo)
这个命令不是强制性的,但最好都加上。
它会引入两个变量 demo_BINARY_DIR 和 demo_SOURCE_DIR
同时,cmake 自动定义了两个等价的变量 PROJECT_BINARY_DIR 和 PROJECT_SOURCE_D
3、编译类型
add_executable(demo demo.cpp) # 生成可执行文件
add_library(common STATIC util.cpp) # 生成静态库
add_library(common SHARED util.cpp) # 生成共享库(动态库)
- 在 Linux 下是:
demo
libcommon.a
libcommon.so - 在 Windows 下是:
demo.exe
common.lib
common.dll
4、指定编译包含的源文件
4.1、搜索
aux_source_directory(. SRC_LIST) # 搜索当前目录下的所有.cpp文件
add_library(demo ${SRC_LIST})
aux_source_directory(dir VAR) 意思是发现一个目录 dir 下所有的源代码文件,并将列表存储在一个变量 VAR 中。
4.2、自定义搜索规则
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})
对于收集文件的指令
file(GLOB files LIST_DIRECTORIES false *)
其中,GLOB命令将所有匹配(可选,假如不写,毛都匹配不到)的文件挑选出来,默认以字典顺序排序。
5、查找指定的库文件
默认的搜索路径为 cmake 包含的系统库,因此如果是 NDK 的公共库只需要指定库的 name 即可。
find_library( log-lib 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 “ C M A K E C X X F L A G S − I {CMAKE_CXX_FLAGS} -I CMAKECXXFLAGS−I{CMAKE_CURRENT_SOURCE_DIR}”)
7、设置链接库搜索目录
link_directories(${CMAKE_CURRENT_SOURCE_DIR}/libs)
Linux 下还可以通过如下方式设置包含的目录
set(CMAKE_CXX_FLAGS “ C M A K E C X X F L A G S − L {CMAKE_CXX_FLAGS} -L CMAKECXXFLAGS−L{CMAKE_CURRENT_SOURCE_DIR}/libs”)
8. 设置需要链接的库
在cmake语法中,link_libraries和target_link_libraries是很重要的两个链接库的方式,虽然写法上很相似,但是功能上有很大区别:
link_libraries用在add_executable之前,target_link_libraries用在add_executable之后。
link_libraries用来链接静态库,target_link_libraries用来链接导入库,即按照header file + .lib + .dll方式隐式调用动态库的.lib库。
link_libraries(${log-lib})
${log-lib}无需含有文件后缀,下同
target_link_libraries(demo ${log-lib} )
目标库
目标库需要链接的库
log-lib 是上面 find_library 指定的变量名
在 Windows 下,系统会根据链接库目录,搜索 xxx.lib 文件,Linux 下会搜索 xxx.so 或者 xxx.a 文件,如果都存在会优先链接动态库(so 后缀)
8.1 指定链接动态库或静态库
target_link_libraries(demo libface.a) # 链接libface.a
target_link_libraries(demo libface.so) # 链接libface.so
8.1 指定全路径
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_fun.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)
SRC_LIST中追加 test_fun.cpp
list(APPEND SRC_LIST test_fun.cpp)
SRC_LIST中删除 main.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
#start 表示起始数,stop 表示终止数,step 表示步长
foreach(loop_var RANGE start stop [step])
…
endforeach(loop_var)
示例:
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的搜索路径