CMake 使用
1. cmake_minimum_required
cmake_minimum_required(VERSION <min>[...<policy_max>] [FATAL_ERROR])
**释义：**需要最低版本的 cmake。如果 CMake 的运行版本低于<min>要求的版本，它将停止处理项目并报告错误。
例如：
cmake_minimum_required(VERSION 2.8.3)
2. project
project(<PROJECT-NAME> [<language-name>...])
**释义：**设置项目的名称，并将其存储在变量中 PROJECT_NAME. 从顶层调用时， CMakeLists.txt还将项目名称存储在变量中CMAKE_PROJECT_NAME。
同时这个指令隐式的定义了两个 cmake 变量: PROJECT_SOURCE_DIR，PROJECT_BINARY_DIR，同时也定义了这两个变量的路径<PROJECT-NAME>_SOURCE_DIR:项目源目录的绝对路径,<PROJECT-NAME>_BINARY_DIR:项目二进制目录的绝对路径。
例如：
project(HELLO_WORLD)
3. set
set有三种情况
1）设置正常变量
set(<variable> <value>... [PARENT_SCOPE])
2）设置缓存条目
set(<variable> <value>... CACHE <type> <docstring> [FORCE])
3）设置环境变量
set(ENV{<variable>} [<value>])
1）设置正常变量set(<variable> <value>... [PARENT_SCOPE])
- variable：只能有一个
- value：可以有0个，1个或多个，当value值为空时，方法同unset，用于取消设置的值
- PARENT_SCOPE(父作用域)：作用域，除PARENT_SCOPE外还有function scope(方法作用域)和directory scope(目录作用域)
例如:
set() 命令将多个值作为列表存储到目标变量中：
set(srcs a.c b.c c.c) # sets "srcs" to "a.c;b.c;c.c"
其他两种情况遇见较少，就不仔细介绍了。
4. find_package
find_package(<PackageName> [version] [EXACT] [QUIET] [MODULE]
[REQUIRED] [[COMPONENTS] [components...]]
[OPTIONAL_COMPONENTS components...]
[REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]
[GLOBAL]
[NO_POLICY_SCOPE]
[BYPASS_PROVIDER])
**释义：**找到一个包（通常由项目外部的东西提供），并加载其包特定的详细信息。
该命令有两种搜索包的模式：模块模式、配置模式。
**模块模式：**在这种模式下，CMake 搜索一个名为的Find<PackageName>.cmake文件，这个文件负责找到库所在的路径，为我们的项目引入头文件路径和库文件路径。首先在CMAKE_MODULE_PATH中查找，如果没有找到，然后在CMake 安装提供的Find Modules中查找。如果找到该文件，则由 CMake 读取并处理该文件。它负责查找包、检查版本并生成任何需要的消息。
**配置模式：**在这种模式下，CMake 会搜索一个名为 <lowercasePackageName>-config.cmake或者为<PackageName>Config.cmake的文件。它还将查找<lowercasePackageName>-config-version.cmake或 <PackageName>ConfigVersion.cmake是否指定了版本详细信息。
例子：
FIND_PACKAGE(PCL REQUIRED)
#required 意思是将PCL定义为工程必须的库
如果通过find_package找不到Config.cmake，就直接在根目录中搜索对应的库文件（例如找不到PCLConfig.cmake，就搜索这个文件地址，然后通过set去设置）
set(PCL_DIR "usr/local/share/pcl-1.9")
5. include_directories
include_directories([AFTER|BEFORE] [SYSTEM] dir1 [dir2 ...])
**释义：**即当前CMakeList.txt中的所有目标以及所有在其调用点之后添加的子目录中的所有目标将具有此头文件搜索路径。
例子1：
include_directories(/usr1/dirs)
例子2：
# CMakeList.txt
cmake_minimum_required(VERSION 3.18.2)
project(include_directories_test)
add_executable(test main.cpp)
//main.cpp
#include "test.h"
#include <stdio.h>
int main(int argc, char **argv)
{
printf("hello, world!\n");
return 0;
}
执行cmake --build .，会提示找不到头文件的错误：
fatal error: 'test.h' file not found
#include "test.h"
使用include_directories包含子目录sub,并在main.cpp里面包含"test.h"。
# CMakeList.txt
cmake_minimum_required(VERSION 3.18.2)
project(include_directories_test)
include_directories(sub) #与上个场景不同的地方在于此处
add_executable(test main.cpp)
//main.cpp
#include "test.h"
#include <stdio.h>
int main(int argc, char **argv)
{
printf("hello, world!\n");
return 0;
}
执行cmake --build .，会生成可执行文件test，使用./test执行后会输出打印hello, world!。当然，不使用include_directories(sub)，在main.cpp中直接使用#include "sub/test.h"也是可以的。
例子链接：https://www.jianshu.com/p/e7de3de1b0fa
总而言之，include_directories是用来提供找头文件路径的，打个比方，我现在想要#include"cv.h",但是这个cv.h的路径的地址是/usr/local/include/opencv,那么我总不能在主函数头前写#include “/usr/local/include/opencv/cv.h”吧，这个时候就用到include_directories了，它提供了一个搜索头文件暂时的根目录，即你可以在cmakelists中写上include_directories(/usr/local/include)来让库文件搜索以/usr/local/include为基础，即在main函数前写上#include “opencv/cv.h"即可。
6. target_include_directories
target_include_directories(<target> [SYSTEM] [AFTER|BEFORE]
<INTERFACE|PUBLIC|PRIVATE> [items1...]
[<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])
**释义：**指定目标包含的头文件路径。名称<target>必须是由命令创建的，例如add_executable()或者add_library()
例子：
target_include_directories(target_so PUBLIC /usr1/dirs)
7. link_libraries
link_libraries([item1 [item2 [...]]]
[[debug|optimized|general] <item>] ...)
**释义：**link_libraries用在add_executable之前，link_libraries用来链接静态库。
例子：
link_directories( ${PROJECT_SOURCE_DIR}/lib/linux)
8. target_link_libraries
target_link_libraries(<target> ... <item>... ...)
**释义：**target_link_libraries用在add_executable之后，target_link_libraries用来链接导入库
例如
#target_link_libraries(所需生成的文件名称 所需链接的动态库名称)
target_link_libraries(main dl)
9. add_executable
add_executable(<name> [WIN32] [MACOSX_BUNDLE]
[EXCLUDE_FROM_ALL]
[source1] [source2 ...])
**释义：**将指定的源文件构建成可执行目标
#add_executable(可执行程序名 代码文件名称)
add_executable(hello hello.cpp)
下面这部分是我在知乎看到比较不错的，借用下，原文链接在此，如有侵权，请联系我删除
1.CMake语法
1.1 指定cmake的最小版本
cmake_minimum_required(version 版本号)
例如：
cmake_minimum_required(version 2.8)
1.2 定义工程名称
#定义工程名称
project(项目名称)
例如：
project(MyTest)
1.3 显示定义变量
set(var [value])
例如：
# 第一种用法，生成代码文件列表
#先直接设置SRC_LIST的值
set(SRC_LIST add.h add.cpp)
#然后再在SRC_LIST中追加main.cpp
set(SRC_LIST ${SRC_LIST} main.cpp)
# 第二中用法，设置库生成目录或者可执行文件生成目录
set( LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib/linux)
set( EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
1.4 设置编译类型
# 编译静态库
add_library(库名称 STATIC 代码文件名称)
# 编译动态库
add_library(库名称 SHARED 代码文件名称)
# 编译可执行程序
add_executable(可执行程序名 代码文件名称)
例如：
# 编译静态库
add_library(add STATIC add.h add.cpp)
add_library(add STATIC ${ADD_SRC} ${ADD_HDR})
# 编译动态库
add_library(add SHARED add.h add.cpp)
add_library(add SHARED ${ADD_SRC} ${ADD_HDR})
# 编译可执行程序
add_executable(main add.h add.cpp mai.cpp)
add_executable(main ${MAIN_SRC} ${MAIN_HDR})
1.5 指定静态库或者动态库编译输出目录
例如将当前编译的静态库或者动态库输出到当前项目文件夹lib子目录下
set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)
1.6 指定可执行程序编译输出目录
例如将当前可执行程序输出到当前项目文件夹的bin子目录下
#设定可执行二进制文件的目录
set( EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
1.7 设置链接库搜索目录
例如将链接库搜索目录设置为当前项目文件夹下lib/linux文件夹
link_directories( ${PROJECT_SOURCE_DIR}/lib/linux)
1.8 设置包含目录
例如将包含目录设置为当前项目文件夹下include文件夹
include_directories(${PROJECT_SOURCE_DIR}/include)
1.9 设置宏定义
#预定义宏
add_definitions(-D宏名称)
例如：
add_definitions(-DWINDOWS)
add_definitions(-DLINUX)
1.10 链接静态库
link_libraries(
静态库1
静态库2
静态库3
...
)
注意，link_libraries中的静态库为全路径，常与1.7 link_directories 搭配使用，例如：
lib1.a lib2.a在目录${PROJECT_SOURCE_DIR}/lib/linux下，则先设置链接目录，再链接相应的库
#设置链接目录
link_directories( ${PROJECT_SOURCE_DIR}/lib/linux)
link_libraries(
lib1.a
lib2.a
)
1.11 链接动态库
target_link_libraries(所需生成的文件名称 所需链接的动态库名称)
例如
target_link_libraries(main dl)
1.12 link_libraries 和 target_link_libraries 区别
在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库
1.13 file语法
1.13.1 将文件夹所有的类型的文件添加到文件列表
例如将当前文件夹下所有.cpp文件的文件名加入到MAIN_SRC中，将当前文件夹下所有.h加入到MAIN_HDR中。
file(GLOB MAIN_SRC ${CMAKE_CURRENT_SOURCE_DIR}/*.cpp)
file(GLOB MAIN_HDR ${CMAKE_CURRENT_SOURCE_DIR}/*.h)
例如将当前文件夹子目录src文件夹下所有.cpp文件的文件名加入到MAIN_SRC中，将当前文件夹子目录src文件夹下所有.h加入到MAIN_HDR中。
file(GLOB MAIN_SRC ${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp)
file(GLOB MAIN_HDR ${CMAKE_CURRENT_SOURCE_DIR}/src/*.h)
1.13.2 递归搜索该文件夹，将文件夹下（包含子目录）符合类型的文件添加到文件列表
例如将当前文件夹下（包括子目录下）所有.cpp文件的文件名加入到MAIN_SRC中，所有.h加入到MAIN_HDR中
file(GLOB_RECURSE MAIN_SRC ${CMAKE_CURRENT_SOURCE_DIR}/*.cpp)
file(GLOB_RECURSE MAIN_HDR ${CMAKE_CURRENT_SOURCE_DIR}/*.h)
1.14 List操作
常见的List操作包括：
list(LENGTH <list> <output variable>)
list(GET <list> <element index> [<element index> ...]
<output variable>)
list(APPEND <list> [<element> ...])
list(FIND <list> <value> <output variable>)
list(INSERT <list> <element_index> <element> [<element> ...])
list(REMOVE_ITEM <list> <value> [<value> ...])
list(REMOVE_AT <list> <index> [<index> ...])
list(REMOVE_DUPLICATES <list>)
list(REVERSE <list>)
list(SORT <list>)
1.14.1 List移除指定项
例如从MAIN_SRC移除指定项
list(REMOVE_ITEM MAIN_SRC ${CMAKE_CURRENT_SOURCE_DIR}/add.cpp)
1.14.2 将两个List链接起来
# 搜索当前目录
file(GLOB MAIN_SRC ${CMAKE_CURRENT_SOURCE_DIR}/*.cpp)
file(GLOB MAIN_HDR ${CMAKE_CURRENT_SOURCE_DIR}/*.h)
# 递归搜索当前目录下src子目录
file(GLOB_RECURSE MAIN_SRC_ELSE ${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp)
file(GLOB_RECURSE MAIN_HDR_ELSE ${CMAKE_CURRENT_SOURCE_DIR}/src/*.h)
# 将MAIN_SRC_ELSE中的值添加到MAIN_SRC
# 将MAIN_HDR_ELSE中的值添加到MAIN_HDR
list(APPEND MAIN_SRC ${MAIN_SRC_ELSE})
list(APPEND MAIN_HDR ${MAIN_HDR_ELSE})
1.15 添加子文件夹
例如
add_subdirectory(src)
该语句会在执行完当前文件夹CMakeLists.txt之后执行src子目录下的CMakeLists.txt
1.16 message输出消息机制
输出正常：
message(STATUS "Enter cmake ${CMAKE_CURRENT_LIST_DIR}")
输出警告
message(WARNING "Enter cmake ${CMAKE_CURRENT_LIST_DIR}")
输出错误：
message(FATAL_ERROR "Enter cmake ${CMAKE_CURRENT_LIST_DIR}")
1.17 安装
install 指令用于定义安装规则，安装的内容包括二进制可执行文件、动态库、静态库以及文件、目录、脚本等。
1.17.1 目标文件安装
例如：
install(TARGETS util
RUNTIME DESTINATION bin
LIBRARY DESTINATION lib
ARCHIVE DESTINATION lib)
ARCHIVE指静态库，LIBRARY指动态库，RUNTIME指可执行目标二进制，上述示例的意思是：
如果目标util是可执行二进制目标，则安装到 C M A K E I N S T A L L P R E F I X / b i n 目录如果目标 u t i l 是静态库，则安装到安装到 {CMAKE_INSTALL_PREFIX}/bin目录 如果目标util是静态库，则安装到安装到 CMAKEINSTALLPREFIX/bin目录如果目标util是静态库，则安装到安装到{CMAKE_INSTALL_PREFIX}/lib目录 如果目标util是动态库，则安装到安装到${CMAKE_INSTALL_PREFIX}/lib目录
1.17.2 文件夹安装
install(DIRECTORY include/ DESTINATION include/util)
这个语句的意思是将include/目录安装到include/util目录
1.18 设置编译选项
设置编译选项可以通过add_compile_options命令，也可以通过set命令修改CMAKE_CXX_FLAGS或CMAKE_C_FLAGS。 方式1
set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -march=native -O3 -frtti -fpermissive -fexceptions -pthread")
方式2
add_compile_options(-march=native -O3 -fexceptions -pthread -fPIC)
这两种方式的区别在于：
add_compile_options命令添加的编译选项是针对所有编译器的(包括c和c++编译器)，而set命令设置CMAKE_C_FLAGS或CMAKE_CXX_FLAGS变量则是分别只针对c和c++编译器的。
1.19 预定义变量
1.19.1 基本变量
- PROJECT_SOURCE_DIR-----------------------------------------我们使用cmake命令后紧跟的目录，一般是工程的根目录；
- PROJECT_BINARY_DIR ------------------------------------------执行cmake命令的目录,通常是${PROJECT_SOURCE_DIR}/build；
- CMAKE_INCLUDE_PATH-----------------------------------------系统环境变量,非cmake变量；
- CMAKE_LIBRARY_PATH------------------------------------------系统环境变量,非cmake变量；
- CMAKE_CURRENT_SOURCE_DIR---------------------------当前处理的CMakeLists.txt所在的路径；
- CMAKE_CURRENT_BINARY_DIR-----------------------------target编译目录（使用ADD_SURDIRECTORY(src bin)可以更改此变量的值 ，SET(EXECUTABLE_OUTPUT_PATH <新路径>)并不会对此变量有影响,只是改变了最终目标文件的存储路径）；
- CMAKE_CURRENT_LIST_FILE--------------------------------输出调用这个变量的CMakeLists.txt的完整路径；
- CMAKE_CURRENT_LIST_LINE--------------------------------输出这个变量所在的行；
- CMAKE_MODULE_PATH-----------------------------------------定义自己的cmake模块所在的路径（这个变量用于定义自己的cmake模块所在的路径，如果你的工程比较复杂，有可能自己编写一些cmake模块，比如SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake),然后可以用INCLUDE命令来调用自己的模块）；
- EXECUTABLE_OUTPUT_PATH------------------------------重新定义目标二进制可执行文件的存放位置；
- LIBRARY_OUTPUT_PATH--------------------------------------重新定义目标链接库文件的存放位置；
- PROJECT_NAME-------------------------------------------------返回通过PROJECT指令定义的项目名称；
- CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS—用来控制IF ELSE语句的书写方式；
1.19.2 操作系统变量
- 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；
- CAMKE_SYSTEM_NAME-------------------------------操作系统名称，不包括版本名，如Linux；
- CMAKE_SYSTEM_VERSION--------------------------操作系统版本号,如2.6.22；
- CMAKE_SYSTEM_PROCESSOR--------------------电脑处理器名称，如i686；
- UNIX--------------------------------------------------------在所有的类UNIX平台为TRUE,包括OS X和cygwin，Linux/Unix操作系统；
- WIN32-----------------------------------------------------在所有的win32平台为TRUE,包括cygwin，Windows操作系统；
- APPLE----------------------------------------------------苹果操作系统；
例如操作系统判断方式一：
if(WIN32)
message(STATUS “This operating system is Windows.”)
elseif(UNIX)
message(STATUS “This operating system is Linux.”)
elseif(APPLE)
message(STATUS “This operating system is APPLE.”)
endif(WIN32)
操作系统判断方式二：
if (CMAKE_SYSTEM_NAME MATCHES "Linux")
message(STATUS "current platform: Linux ")
elseif (CMAKE_SYSTEM_NAME MATCHES "Windows")
message(STATUS "current platform: Windows")
elseif (CMAKE_SYSTEM_NAME MATCHES "FreeBSD")
message(STATUS "current platform: FreeBSD")
else ()
message(STATUS "other platform: ${CMAKE_SYSTEM_NAME}")
endif (CMAKE_SYSTEM_NAME MATCHES "Linux")
1.19.3 开关选项
- BUILD_SHARED_LIBS---------------------------------------------控制默认的库编译方式。如果未进行设置,使用ADD_LIBRARY时又没有指定库类型,默认编译生成的库都是静态库；
- CMAKE_C_FLAGS-------------------------------------------------设置C编译选项，也可以通过指令ADD_DEFINITIONS()添加；
- CMAKE_CXX_FLAGS----------------------------------------------设置C++编译选项，也可以通过指令ADD_DEFINITIONS()添加；
- CMAKE_C_COMPILER--------------------------------------------指定C编译器；
- CMAKE_CXX_COMPILER----------------------------------------指定C++编译器；
- CMAKE_BUILD_TYPE:：build 类型(Debug, Release, …)-CMAKE_BUILD_TYPE=Debug
1.19.4 环境变量
设置环境变量：
set(env{name} value)
调用环境变量：
$env{name}
例如
message(STATUS "$env{name}")
1.19.5 CMAKE_INCLUDE_CURRENT_DIR
自动添加CMAKE_CURRENT_BINARY_DIR和CMAKE_CURRENT_SOURCE_DIR到当前处理 的CMakeLists.txt。 相当于在每个CMakeLists.txt加入：
include_directories(${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR})
1.20 条件判断
1.20.1 逻辑判断和比较
- if (expression)：expression 不为空时为真，false的值包括（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)：给定的字符串能够匹配正则表达式regex时为真。
1.20.2 数字比较
- if (variable LESS number)：如果variable小于number时为真；
- if (string LESS number)：如果string小于number时为真；
- if (variable GREATER number)：如果variable大于number时为真；
- if (string GREATER number)：如果string大于number时为真；
- if (variable EQUAL number)：如果variable等于number时为真；
- if (string EQUAL number)：如果string等于number时为真。
1.20.3 字母表顺序比较
- if (variable STRLESS string)
- if (string STRLESS string)
- if (variable STRGREATER string)
- if (string STRGREATER string)
- if (variable STREQUAL string)
- if (string STREQUAL string)
1.21 循环
1.21.1 foreach
start 表示起始数，stop 表示终止数，step 表示步长
foreach(loop_var RANGE start stop [step])
...
endforeach(loop_var)
1.21.2 while
while(condition)
...
endwhile()
1.22 自动检测编译器是否支持C++11
include(CheckCXXCompilerFlag)
CHECK_CXX_COMPILER_FLAG("-std=c++11" COMPILER_SUPPORTS_CXX11)
CHECK_CXX_COMPILER_FLAG("-std=c++0x" COMPILER_SUPPORTS_CXX0X)
if(COMPILER_SUPPORTS_CXX11)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
elseif(COMPILER_SUPPORTS_CXX0X)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++0x")
else()
message(STATUS "The compiler ${CMAKE_CXX_COMPILER} has no C++11 support. Please use a different C++ compiler.")
endif()
1.23 CMake生成VS解决方案将项目放置在设定文件夹下
例如，我们在工程中引用了许多的第三方开源库，这些库的源码与自己所写的代码需要进行区分和隔离，通常情况下会单独开一个third筛选器存储这些第三方库的项目，怎么做？
第一步：
在第三方库的CMakeLists.txt中cmake_minimum_required(VERSION 2.6)中加上set_property(GLOBAL PROPERTY USE_FOLDERS On)
第二步：在生成编译目标的语法之后，如：
add_executable(demo demo.cpp) # 生成可执行文件
add_library(common STATIC util.cpp) # 生成静态库
add_library(common SHARED util.cpp) # 生成动态库或共享库
加入一句
set_target_properties(${第三方库项目名称} PROPERTIES FOLDER “目标文件夹名称”)
2 错误解决方案
2.1 Cannot specify link libraries for target “/…/…/lib/linux/libMyDll.a” which
这个问题要将生成执行文件、静态库、动态库的声明
add_executable(demo demo.cpp) # 生成可执行文件
add_library(common STATIC util.cpp) # 生成静态库
add_library(common SHARED util.cpp) # 生成动态库或共享库
放在
target_link_libraries()
之前。
2.2 警告：检测到时钟错误。您的创建可能是不完整的。
在项目根目录下执行命令：
touch *
更新所有文件时间。
参考链接:
https://cmake.org/cmake/help/latest/manual/cmake-commands.7.html
229
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
