[摘]CMakeLists.txt常用语法之常用命令

前言

cmake 是一个跨平台、开源的构建系统。它是一个集软件构建、测试、打包于一身的软件。它使用与平台和编译器独立的配置文件来对软件编译过程进行控制。

正文

下面介绍常用的命令

制定cmake最小版本

cmake_minimum_required(VERSION 3.4.1)

这行命令是可选的，但在有些情况下，如果 CMakeLists.txt 文件中使用了一些高版本 cmake 特有的一些命令的时候，就需要加上这样一行，提醒用户升级到该版本之后再执行 cmake。

设置项目名称

project(demo)

这个命令不是强制性的，但最好都加上。它会引入两个变量demo_BINARY_DIR和demo_SOURCE_DIR，同时，cmake自动定义了两个等价的变量PROJECT_BINARY_DIR和PROJECT_SOURCE_DIR。

设置编译类型

add_executable(demo demo.cpp) # 生成可执行文件
add_library(common STATIC util.cpp) # 生成静态库 libcommon.a
add_library(common SHARED util.cpp) # 生成动态库或共享库 libcommon.so

add_library默认生成的是静态库

指定编译包含哪些源文件

1. 明确指定包含哪些源文件

add_library(demo demo.cpp test.cpp util.cpp)

2. 搜索所有的cpp文件

aux_source_directory(. SRC_LIST) # 搜索当前目录下的所有.cpp文件
add_library(demo ${SRC_LIST})
aux_source_directory(dir VAR) 发现一个目录下所有的源代码文件并将列表存储在一个变量中.

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})
   

查找指定的库文件

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().

设置包含的目录

include_directories(

${CMAKE_CURRENT_SOURCE_DIR}

${CMAKE_CURRENT_BINARY_DIR}

${CMAKE_CURRENT_SOURCE_DIR}/include

)

设置链接库搜索目录

link_directories( ${CMAKE_CURRENT_SOURCE_DIR}/libs )
Linux 下还可以通过如下方式设置包含的目录
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -L${CMAKE_CURRENT_SOURCE_DIR}/libs")

设置target需要链接的库

target_link_libraries(
# 目标库
demo
# 目标库需要链接的库 
# log-lib 是上面 find_library 指定的变量名
${log-lib} )

Linux 下会搜索 xxx.so 或者 xxx.a 文件，如果都存在会优先链接动态库。

1. 指定链接动态库或静态库

   target_link_libraries(demo libface.a) # 链接libface.a
   target_link_libraries(demo libface.so) # 链接libface.so
   

2. 指定全路径

target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a)
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.so)

3. 指定链接多个库

   target_link_libraries(demo
   ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a
   boost_system.a
   boost_thread
   pthread)
   

设置变量

1. set直接设置变量的值

set(SRC_LIST main.cpp test.cpp)
add_executable(demo ${SRC_LIST})

2. set追加设置变量的值

   set(SRC_LIST main.cpp)
   set(SRC_LIST ${SRC_LIST} test.cpp)
   add_executable(demo ${SRC_LIST})
   

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})
   

条件控制

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()
   
   

   2. while...endwhile

   while(condition)
   
   ...
   
   endwhile()
   

   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
   

打印信息

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 会导致编译失败

包含其他cmake文件

include(./common.cmake) # 指定包含文件的全路径

include(def) # 在搜索路径中搜索def.cmake文件

set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake) # 设置include的搜索路径

参考文章

1. 《CMakeLists.txt常用语法 - 简书 (jianshu.com)》
2. 《CMakeLists.txt常用语法_SSS_369的博客-CSDN博客》