CMakeLists完整解析（二）
这篇我们详细讲解一下CMakeLists.txt文件的编写
一、常用命令
1. 指定cmake最小版本
cmake_minimum_required(VERSION 3.24)
这行命令是可选的，我们可以不写这句话，但在有些情况下，如果 CMakeLists.txt 文件中使用了一些高版本 cmake 特有的一些命令的时候，就需要加上这样一行，提醒用户升级到该版本之后再执行 cmake。
2. 设置项目名称
project(demo)
这个命令不是强制性的，但最好都加上。它会引入两个变量 demo_BINARY_DIR 和 demo_SOURCE_DIR，同时，cmake 自动定义了两个等价的变量 PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR。
3. 设置编译类型
程序库
这里花点时间提前解释一下程序库的概念
所谓程序库，一般是软件作者为了发布方便、替换方便或二次开发目的，而发布的一组可以单独与应用
程序进行compile time或runtime链接的二进制可重定位目标码文件。通俗一点说，所谓一个库，就是一个
文件，这个文件可以在编译时由编译器直接链接到可执行程序中，也可以在运行时由操作系统的
runtime enviroment根据需要动态加载到内存中。一组库，就形成了一个发布包，当然，具体发布
多少个库，完全由库提供商自己决定。
下面区分一下静态库和动态库
所谓静态库，就是在静态编译时由编译器到指定目录寻找并且进行链接，一旦链接完成，最终的可执行程序中就包含了该库文件中的所有有用信息，包括代码段、数据段等。
所谓动态库，就是在应用程序运行时，由操作系统根据应用程序的请求，动态到指定目录下寻找并装载入内存中，同时需要进行地址重定向。
windows平台下，静态库通常后缀为.lib，动态库为.dll
linux平台下，静态库通常后缀为.a，动态库为.so
从本质上来说，由同一段程序编译出来的静态库和动态库，在功能上是没有区别的。不同之处仅仅在于其名字上，也就是“静态”和“动态”。
由上面的介绍不难看出，相对于动态库，静态库的优点在于直接被链接进可执行程序中，之后，该可执行程序就不再依赖于运行环境的设置了（当然仍然会依赖于 CPU指令集和操作系统支持的可执行文件格式等硬性限制）。而动态库的优点在于，用户甚至可以在程序运行时随时替换该动态库，这就构成了动态插件系统的基础。具体使用静态库和动态库，由程序员根据需要自己决定。
然后回到CMakeLists语句：
add_executable(demo demo.cpp) # 生成可执行文件
add_library(common STATIC util.cpp) # 生成静态库
add_library(common SHARED util.cpp) # 生成动态库或共享库
add_library 默认生成是静态库，通过以上命令生成文件名字，
add_library(<name> [STATIC | SHARED | MODULE]
[EXCLUDE_FROM_ALL]
[<source>...])
参数一：添加名为name的库，库的源文件可指定，也可用target_sources()后续指定。
参数二：库的类型是STATIC(静态库)/SHARED(动态库)/MODULE(模块库)之一。
name属性必须全局唯一
生成的library名会根据STATIC或SHARED成为name.a或name.lib
这里的STATIC和SHARED可不设置，通过全局的BUILD_SHARED_LIBS的FALSE或TRUE来指定
windows下，如果dll没有export任何信息，则不能使用SHARED，要标识为MODULE
4. 指定编译包含的源文件
4.1 明确指定包含哪些源文件
add_library(demo demo.cpp test.cpp util.cpp)
4.2 搜索所有的cpp文件
aux_source_directory(. SRC_LIST) # 搜索当前目录下的所有.cpp文件
add_library(demo ${SRC_LIST})
aux_source_directory(dir VAR) 意思是发现一个目录 dir 下所有的源代码文件，并将列表存储在一个变量 VAR 中。
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})
对于收集文件的指令
file(GLOB files LIST_DIRECTORIES false *)
其中，GLOB命令将所有匹配 globbing-expressions（可选,假如不写，毛都匹配不到）的文件挑选出来，默认以字典顺序排序。
5. 查找指定的库文件
find_library(VAR name path)
查找到指定的预编译库，并将它的路径存储在变量VAR中。
默认的搜索路径为 cmake 包含的系统库，因此如果是 NDK 的公共库只需要指定库的 name 即可。
find_library( log-lib log )
# Sets the name of the path variable.
# Specifies the name of the NDK library that you want CMake to locate.
类似的命令还有 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. 设置需要链接的库
划重点！划重点！划重点！
在cmake语法中，link_libraries和target_link_libraries是很重要的两个链接库的方式，虽然写法上很相似，但是功能上有很大区别：
1）link_libraries用在add_executable之前，target_link_libraries用在add_executable之后。
2）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.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_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})
二、常见变量
预定义变量
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： 重新定义目标链接库文件的存放位置
环境变量
使用环境变量
$ENV{Name}
写入环境变量
set(ENV{Name} value) # 这里没有“$”符号
系统信息
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
主要开关选项
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、https://blog.csdn.net/weixin_43837968/article/details/115257575
2、https://www.shuzhiduo.com/A/QW5YXk0MJm/
3、https://cmake.org/cmake/help/latest/command/add_library.html
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
