CMakeLists.txt 之C++
https://blog.codekissyoung.com/%E5%B8%B8%E7%94%A8%E8%BD%AF%E4%BB%B6/cmake
-
CMake 入门实战
-
CMake Official Tutorial——教程还是官方的好
-
cmake 教程 基本语法
-
一、什么是Cmake
CMake是一个跨平台的、开源的安装(编译)工具， 因为它使用和平台、编译器无关的配置文件（较为简单的语句）来描述编译控制，所以他能够输出各种各样的makefile或者project文件,能测试编译器所支持的C++特性,类似UNIX下的automake。
二、常用命令
1. 指定 cmake 的最小版本
cmake_minimum_required(VERSION 3.15)可选命令，如果 CMakeLists.txt 中使用了高版本 cmake 特有的命令，需要use这一行加以声明，会check and advice 升级到该版本或以上。
2. 设置项目名称
project(demo)这个命令不是强制性的，加上它会引入两个变量 demo_BINARY_DIR 和 demo_SOURCE_DIR，同时，cmake 自动定义了两个等价的变量 PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR。
3. 设置支持C++版本
set(CMAKE_CXX_STANDARD 14)这里CMake 3.1或者更高版本支持使用这个，更低版本使用如下：
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")也可以使用如下，我最早接触是这个：
add_definitions(-std=c++11)
#add_definitions("-Wall -std=c++14")
4. 设置编译器类型
set(CMAKE_CXX_COMPILER g++)
系统默认的gcc/g++在/usr/bin目录下。
我们升级安装的gcc目录在/usr/local/bin目录下，现在我们希望使用升级后的gcc。
通过百度搜索出来的结果，大多是如下操作:
在CMakeLists.txt中调用编译器之前添加：
SET(CMAKE_C_COMPILER "/usr/local/bin/gcc")
SET(CMAKE_CXX_COMPILER "/usr/local/bin/g++")
然而经过本人亲自实践，该方法不起作用，正确的做法是：
执行cmake命令之前，在shell终端先设置如下两个变量：
export CC=/usr/local/bin/gcc
export CXX=/usr/local/bin/g++
然后再执行cmake等后续命令，这样就可以用指定的编译器版本了。
具体更多的原因，请参考此处：https://stackoverflow.com/questions/17275348/how-to-specify-new-gcc-path-for-cmake
5. 设置目标文件支持系统总线架构（默认同编译系统一致）
set(CMAKE_CXX_FLAGS "-m64")
6. 设置生成目标类型
-
add_executable(demo demo.cpp) # 生成可执行文件demo | demo.exe -
add_library(common STATIC util.cpp) # 生成静态库libcommon.a | common.lib -
add_library(common SHARED util.cpp) # 生成动态库或共享库libcommon.so | common.dll
add_library 默认生成是静态库，通过以上命令生成文件名字，
7 指定编译包含的源文件
7.1 明确指定包含哪些源文件
add_library(demo demo.cpp test.cpp util.cpp)
#add_executable(demo src/demo.cpp)7.2 搜索方式添加cpp 文件
aux_source_directory(dir VAR) 发现一个目录下所有的源代码文件并将列表存储在一个变量中。
-
aux_source_directory(. SRC_LIST) # 搜索当前目录下的所有.cpp文件 -
add_library(demo ${SRC_LIST}) 或 add_library(demo SHARED ${SRC_LIST}) 或 add_executable(demo ${SRC_LIST})
7.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})
8. 查找指定的库文件
find_library(VAR name path)查找到指定的预编译库，并将它的路径存储在变量中。
默认的搜索路径为 cmake 包含的系统库，因此如果是公共库只需要指定库的 name 即可。
find_library( # Sets the name of the path variable.
log-lib
# you want CMake to locate.
log )find_path(HIREDIS_INCLUDE_DIR hiredis.h /usr/local/include/hiredis)
find_library(HIREDIS_LIBRARY NAMES hiredis PATH /usr/local/lib)
if(HIREDIS_INCLUDE_DIR AND HIREDIS_LIBRARY)
SET(HIREDIS_FOUND TRUE)
endif(HIREDIS_INCLUDE_DIR AND HIREDIS_LIBRARY)类似的命令还有 find_file()、find_path()、find_program()、find_package()。
9. 设置包含的目录
/*
include_directories(
${CMAKE_CURRENT_SOURCE_DIR}
${CMAKE_CURRENT_BINARY_DIR}
${CMAKE_CURRENT_SOURCE_DIR}/include
)
*/
set(INC_DIR include)
include_directories(${INC_DIR})Linux 下还可以通过如下方式设置包含的目录
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -I${CMAKE_CURRENT_SOURCE_DIR}")10. 设置链接库搜索目录
#link_directories(
#${CMAKE_CURRENT_SOURCE_DIR}/libs
#)
link_directories(${LINK_DIR})
link_libraries(library_name)
add_executable(project_name ${SOURCE_FILES})
target_link_libraries(project_name library_name)Linux 下还可以通过如下方式设置包含的目录
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -L${CMAKE_CURRENT_SOURCE_DIR}/libs")11. 设置 target 需要链接的库
target_link_libraries( # 目标库
demo
# 目标库需要链接的库
# log-lib 是上面 find_library 指定的变量名
${log-lib} )在 Windows 下，系统会根据链接库目录，搜索xxx.lib 文件，Linux 下会搜索 xxx.so 或者 xxx.a 文件，如果都存在会优先链接动态库（so 后缀）。
11.1 指定链接动态库或静态库
target_link_libraries(demo libface.a) # 链接libface.a
target_link_libraries(demo libface.so) # 链接libface.so11.2 指定全路径
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a)
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.so)11.3 指定链接多个库
target_link_libraries(demo
${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a
boost_system.a
boost_thread
pthread)12. 设置变量
12.1 set 直接设置变量的值
set(SRC_LIST main.cpp test.cpp)
add_executable(demo ${SRC_LIST})12.2 set 追加设置变量的值
-
set(SRC_LIST main.cpp) -
set(SRC_LIST ${SRC_LIST} test.cpp) -
add_executable(demo ${SRC_LIST})
12.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})
13. 条件控制
13.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)
foreach(i RANGE 1 9 2)
message(${i})
endforeach(i)
# 输出：13579start 表示起始数，stop 表示终止数，step 表示步长
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：重新定义目标链接库文件的存放位置
变量参考,项目目录相关:
# 构建发生的目录
CMAKE_BINARY_DIR
PROJECT_BINARY_DIR
_BINARY_DIR
# 不论采用何种编译方式，都是工程顶层目录
CMAKE_SOURCE_DIR
PROJECT_SOURCE_DIR
_SOURCE_DIR
CMAKE_CURRENT_SOURCE_DIR # 当前处理的CMakeLists.txt所在的路径
CMAKE_CURRRENT_BINARY_DIR # 内部编译: 跟CMAKE_CURRENT_SOURCE_DIR一致
# 外部编译: 指的是构建目录
# add_subdirectory(src bin) 会更改它的值为 bin
CMAKE_CURRENT_LIST_FILE # 当前输出所在的CMakeLists.txt的完整路径
CMAKE_CURRENT_LIST_LINE # 当前输出所在的行
CMAKE_MODULE_PATH # 模块所在路径
EXECUTABLE_OUTPUT_PATH # 可执行文件存放目录
LIBRARY_OUTPUT_PATH # 库存放目录
CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE # 将工程提供的头文件目录始终置于系统头文件目录的前面
CMAKE_INCLUDE_PATH # 头文件搜索目录
CMAKE_LIBRARY_PATH # 库搜索目录
2. 环境变量
使用环境变量
$ENV{Name}写入环境变量
set(ENV{Name} value) # 这里没有“$”符号3. 系统信息
CMAKE_MAJOR_VERSION # CMAKE主版本号，比如2.4.6中的2
CMAKE_MINOR_VERSION # CMAKE次版本号，比如2.4.6中的4
CMAKE_PATCH_VERSION # CMAKE补丁等级，比如2.4.6中的6
CMAKE_SYSTEM # 系统名称，比如Linux-2.6.22
CMAKE_SYSTEM_NAME # 不包含版本的系统名，比如Linux
CMAKE_SYSTEM_VERSION # 系统版本，比如2.6.22
CMAKE_SYSTEM_PROCESSOR # 处理器名称，比如i686
UNIX # 在所有的类Unix平台为TRUE，包括OSX和cygwin
WIN32 # 在所有的Win32平台为TRUE，包括cygwin
4. 主要开关选项
CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS # 用来控制IF ELSE语句的书写方式
CMAKE_INCLUDE_CURRENT_DIR # 自动将每个CMakeLists.txt的所在目录依次加入到 头文件搜索目录
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. 简单项目（单个源文件）
一个经典的 C 程序，如何通过 cmake 来编译呢？
依次执行以下命令：
-
cd build -
cmake ..
为什么要新建一个 build 文件夹？
一般我们采用 cmake 的 out-of-source 方式来构建（即生成的中间产物和源代码分离），这样做可以让生成的文件和源文件不会弄混，且目录结构看起来也会清晰明了。所以推荐使用这种方式，至于这个文件夹的命名并无限制，我们习惯命名为 build。
首先进入到 build 目录，然后就是 cmake .. 命令，另外要注意将 cmake 配置到环境变量中去才可直接使用，否则需要使用绝对路径，.. 表示上一级目录，cmake 会在上一级目录下找到 CMakeLists.txt 文件并编译，并生成如下图所示的一些中间文件：
直接执行 make 命令，生成可执行程序，如下图：
运行程序，如下所示：运行程序，如下所示：
2. 复杂项目（多个目录，多个源文件，多个项目）
目录结构如下：
demo 根目录下的 CMakeLists.txt 文件如下：
cmake_minimum_required (VERSION 2.8)
project(demo)
aux_source_directory(. DIR_SRCS)
# 添加math子目录
add_subdirectory(math)
# 指定生成目标
add_executable(demo ${DIR_SRCS})
# 添加链接库
target_link_libraries(demo MathFunctions)math 目录下的 CMakeLists.txt 文件如下：
aux_source_directory(. DIR_LIB_SRCS)
# 生成链接库
add_library(MathFunctions ${DIR_LIB_SRCS})3. 自定义编译选项
cmake 允许为项目增加编译选项，从而可以根据用户的环境和需求选择最合适的编译方案。
例如，可以将 MathFunctions 库设为一个可选的库，如果该选项为 ON ，就使用该库定义的数学函数来进行运算，否则就调用标准库中的数学函数库。
修改根目录下的 CMakeLists.txt 文件如下：
# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项目信息
project (Demo)
# 加入一个配置头文件，用于处理 CMake 对源码的设置
configure_file (
"${PROJECT_SOURCE_DIR}/config.h.in"
"${PROJECT_BINARY_DIR}/config.h"
)
# 是否使用自己的 MathFunctions 库
option (USE_MYMATH
"Use provided math implementation" ON)
# 是否加入 MathFunctions 库
if (USE_MYMATH)
include_directories ("${PROJECT_SOURCE_DIR}/math")
add_subdirectory (math)
set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions)
endif (USE_MYMATH)
# 查找当前目录下的所有源文件,并将名称保存到 DIR_SRCS 变量
aux_source_directory(. DIR_SRCS)
# 指定生成目标
add_executable(Demo ${DIR_SRCS})
target_link_libraries (Demo ${EXTRA_LIBS})- configure_file 命令用于加入一个配置头文件 config.h ，这个文件由 cmake 从 config.h.in 生成，通过这样的机制，将可以通过预定义一些参数和变量来控制代码的生成。
- option 命令添加了一个 USE_MYMATH 选项，并且默认值为 ON 。根据 USE_MYMATH 变量的值来决定是否使用我们自己编写的 MathFunctions 库。
修改 main.cc 文件，让其根据 USE_MYMATH 的预定义值来决定是否调用标准库还是MathFunctions 库：
#include "config.h"
#ifdef USE_MYMATH
#include "math/MathFunctions.h"
#else
#include
#endif
int main(int argc, char *argv[])
{
if (argc < 3){
printf("Usage: %s base exponent \n", argv[0]);
return 1;
}
double base = atof(argv[1]);
int exponent = atoi(argv[2]);
#ifdef USE_MYMATH
printf("Now we use our own Math library. \n");
double result = power(base, exponent);
#else
printf("Now we use the standard library. \n");
double result = pow(base, exponent);
#endif
printf("%g ^ %d is %g\n", base, exponent, result);
return 0;
} 编写 config.h.in 文件
注意 main.cc 的第一行，这里引用了一个 config.h 文件，这个文件预定义了 USE_MYMATH 的值。但我们并不直接编写这个文件，为了方便从 CMakeLists.txt 中导入配置，我们编写一个 config.h.in 文件，内容如下：
#cmakedefine USE_MYMATH这样 cmake 会自动根据 CMakeLists.txt 配置文件中的设置自动生成 config.h 文件。