CMake 常用命令查询
cmake 常用命令的一些整理
CMake 是什么我就不用再多说什么了,相信大家都有接触才会看一篇文章。对于不太熟悉的开发人员可以把这篇文章当个查找手册。
1.CMake 语法
1.1 指定 cmake 的最小版本
|
|
例如:
|
|
1.2 定义工程名称
|
|
例如:
|
|
1.3 显示定义变量
|
|
例如:
|
|
1.4 设置编译类型
|
|
例如:
|
|
1.5 指定静态库或者动态库编译输出目录
例如将当前编译的静态库或者动态库输出到当前项目文件夹 lib 子目录下
|
|
1.6 指定可执行程序编译输出目录
例如将当前可执行程序输出到当前项目文件夹的 bin 子目录下
|
|
1.7 设置链接库搜索目录
例如将链接库搜索目录设置为当前项目文件夹下 lib/linux 文件夹
|
|
1.8 设置包含目录
例如将包含目录设置为当前项目文件夹下 include 文件夹
|
|
1.9 设置宏定义
|
|
例如:
|
|
1.10 链接静态库
|
|
tips: link_libraries 和 target_link_libraries 链接库
注意: link_libraries 中的静态库为全路径,常与 1.7 link_directories 搭配使用,例如:
lib1.a
, lib2.a
在目录 ${PROJECT_SOURCE_DIR}/lib/linux
下,则先设置链接目录,再链接相应的库
|
|
1.11 链接动态库
|
|
例如
|
|
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
库
注意:
- windows 系统下,静态库后缀为
.lib
, 导入库的后缀为.lib
,动态库的后缀为.dll
- linux 系统写,静态库后缀为
.a
, 动态库的后缀为.so
1.13 file 语法
1.13.1 将文件夹所有的类型的文件添加到文件列表
例如将当前文件夹下所有.cpp 文件的文件名加入到 MAIN_SRC 中,将当前文件夹下所有.h 加入到 MAIN_HDR 中。
|
|
例如将当前文件夹子目录 src 文件夹下所有.cpp 文件的文件名加入到 MAIN_SRC 中,将当前文件夹子目录 src 文件夹下所有.h 加入到 MAIN_HDR 中。
|
|
1.13.2 递归搜索该文件夹,将文件夹下(包含子目录)符合类型的文件添加到文件列表
例如将当前文件夹下(包括子目录下)所有.cpp 文件的文件名加入到 MAIN_SRC 中,所有.h 加入到 MAIN_HDR 中
|
|
1.14 List 操作
常见的 List 操作包括:
|
|
1.14.1 List 移除指定项
例如从 MAIN_SRC 移除指定项
|
|
1.14.2 将两个 List 链接起来
|
|
1.15 添加子文件夹
例如
|
|
该语句会在执行完当前文件夹 CMakeLists.txt
之后执行 src 子目录下的 CMakeLists.txt
。
1.16 message 输出消息机制
输出正常:
|
|
输出警告
|
|
输出错误:
|
|
1.17 安装 install()
install 指令用于定义安装规则,安装的内容包括二进制可执行文件、动态库、静态库以及文件、目录、脚本等。
1.17.1 目标文件安装
例如:
|
|
ARCHIVE 指静态库,LIBRARY 指动态库,RUNTIME 指可执行目标二进制,上述示例的意思是:
如果目标 util
是可执行二进制目标,则安装到 {CMAKE_INSTALL_PREFIX}/lib 目录 如果目标 util 是动态库,则安装到安装到 ${CMAKE_INSTALL_PREFIX}/lib 目录
1.17.2 文件夹安装
|
|
这个语句的意思是将 include/
目录安装到 include/util
目录
1.18 设置编译选项
设置编译选项可以通过 add_compile_options 命令,也可以通过 set 命令修改 CMAKE_CXX_FLAGS 或 CMAKE_C_FLAGS。
方式 1
1
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -march=native -O3 -frtti -fpermissive -fexceptions -pthread")
方式 2
1
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—————————————————- 苹果操作系统;
例如操作系统判断方式一:
|
|
操作系统判断方式二:
|
|
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 环境变量
设置环境变量:
|
|
调用环境变量:
|
|
例如
|
|
1.19.5 CMAKE_INCLUDE_CURRENT_DIR
自动添加 CMAKE_CURRENT_BINARY_DIR
和 CMAKE_CURRENT_SOURCE_DIR
到当前处理的 CMakeLists.txt
。 相当于在每个 CMakeLists.txt
加入:
|
|
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
表示步长
|
|
1.21.2 while
|
|
1.22 自动检测编译器是否支持 C++11
|
|
1.23 CMake 生成 VS 解决方案将项目放置在设定文件夹下
例如,我们在工程中引用了许多的第三方开源库,这些库的源码与自己所写的代码需要进行区分和隔离,通常情况下会单独开一个 third 筛选器存储这些第三方库的项目,怎么做?
第一步:
在第三方库的 CMakeLists.txt
中 cmake_minimum_required(VERSION 2.6)
中加上 set_property(GLOBAL PROPERTY USE_FOLDERS On)
第二步:在生成编译目标的语法之后,如:
|
|
加入一句
|
|
1.24 CMake 常用变量
1)CMAKE_BINARY_DIR
、PROJECT_BINARY_DIR
、<projectname>_BINARY_DIR
三个变量指代的内容是一致的,如果是 in source
编译,指得就是工程顶层目录,如果是 out-of-source
编译,指的是工程编译发生的目录。PROJECT_BINARY_DIR 跟其他指令稍有区别,暂时可以理解为他们是一致的。
(2)CMAKE_SOURCE_DIR
、PROJECT_SOURCE_DIR
、<projectname>_SOURCE_DIR
这三个变量指代的内容是一致的,不论采用何种编译方式,都是工程顶层目录。也就是在 in source 编译时,他跟 CMAKE_BINARY_DIR 等变量一致。PROJECT_SOURCE_DIR 跟其他指令稍有区别,暂时理解为他们是一致的。
(3)CMAKE_CURRENT_SOURCE_DIR
指的是当前处理的 CMakeLists.txt
所在的路径。
(4)CMAKE_CURRRENT_BINARY_DIR
,如果是 in-source 编译,它跟 CMAKE_CURRENT_SOURCE_DIR
一致,如果是 out-of-source 编译,他指的是 target
编译目录。使用 ADD_SUBDIRECTORY(src bin)
可以更改这个变量的值。使用 SET(EXECUTABLE_OUTPUT_PATH <新路径>)
并不会对这个变量造成影响,它仅仅修改了最终目标文件存放的路径。
(5)CMAKE_CURRENT_LIST_FILE
输出调用这个变量的 CMakeLists.txt
的完整路径。
(6)CMAKE_CURRENT_LIST_LINE
输出这个变量所在的行。
(7)CMAKE_MODULE_PATH
这个变量用来定义自己的 cmake
模块所在的路径。如果你的工程比较复杂,有可能会自己编写一些 cmake 模块,这些 cmake 模块是随你的工程发布的,为了让 cmake 在处理 CMakeLists.txt
时找到这些模块,你需要通过 SET 指令,将自己的 cmake 模块路径设置一下。
比如:
SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
, 这时候你就可以通过 INCLUDE 指令来调用自己的模块了。
(8)EXECUTABLE_OUTPUT_PATH
和 LIBRARY_OUTPUT_PATH
分别用来重新定义最终结果的存放目录。
(9)PROJECT_NAME
返回通过 PROJECT
指令定义的项目名称。
1.25 target_sources()
来源: https://blog.csdn.net/guaaaaaaa/article/details/125601766
作用:使用 target_sources()
将当前文件夹下的所有.c
、.h
文件作为源文件添加到项目中
2 错误解决方案
2.1 Cannot specify link libraries for target “/…/…/lib/linux/libMyDll.a” which
这个问题要将生成执行文件、静态库、动态库的声明
|
|
放在
|
|
之前。
2.2 警告:检测到时钟错误。您的创建可能是不完整的。
在项目根目录下执行命令:
|
|
更新所有文件时间。
3 参考
[1].cmake 常用命令的一些整理
[2]. 简明教程
[3].CMake 命令行参数
[4].https://blog.csdn.net/geyichongchujianghu/article/details/124781090?spm=1001.2101.3001.6650.1&utm_medium=distribute.pc_relevant.none-task-blog-2%7Edefault%7ECTRLIST%7ERate-1-124781090-blog-85257728.235%5Ev40%5Epc_relevant_3m_sort_dl_base1&depth_1-utm_source=distribute.pc_relevant.none-task-blog-2%7Edefault%7ECTRLIST%7ERate-1-124781090-blog-85257728.235%5Ev40%5Epc_relevant_3m_sort_dl_base1&utm_relevant_index=2
[5].https://blog.csdn.net/Zhanganliu/article/details/85257728
[6].https://blog.csdn.net/llffss/article/details/120121617
[7].https://blog.csdn.net/wzj_110/category_10357507.html
[8].https://blog.csdn.net/fengbingchun/category_783053.html

