作者:billy
版权声明:著作权归作者所有,商业转载请联系作者获得授权,非商业转载请注明出处
CMake简介
CMake是一个跨平台的、开源的构建工具。cmake是makefile的上层工具,它们的目的正是为了产生可移植的makefile,并简化自己动手写makefile时的巨大工作量。目前很多开源的项目都可以通过CMake工具来轻松构建工程,例如博客之前分享的openHMD、hidapi、OSVR-Core等等,代码的分享者提供源代码和相应的Cmake配置文件,使用者就可以非常方便的在自己的电脑上构建相应的工程,进行开发和调试。
Qmake VS Cmake
- qmake 是为 Qt 量身打造的,使用起来非常方便
- cmake 使用上不如qmake简单直接,但复杂换来的是强大的功能
- 内置的 out-of source 构建(目前QtCreator为qmake也默认启用了该功能,详情请搜索“Qt影子构建”)
- 为各种平台和场景提供条件编译
- 可处理多个可执行文件情况,和很好配合 QtTest 工作
如何选择构建方式?
Using CMake to Build Qt Projects 此书中提到:
对简单的Qt工程,采用 qmake
对复杂度超过 qmake 处理能力的,采用 cmake(例如程序中调用了很多第三方库)
接下来我们就一起来学习下CMake的语法和常用命令。
基本语法规则
- 变量使用 ${} 方式取值,但是在 IF 控制语句 中是直接使用变量名
- 指令(参数 1 参数 2…),参数使用括弧括起,参数之间使用空格或分号分开
- 指令是大小写无关的,参数和变量是大小写相关的,推荐全部使用大写指令
CMake常用命令
-
CMAKE_MINIMUM_REQUIRED (VERSION2.6 FATAL_ERROR)
功能:规定cmake程序的最低版本
这行命令是可选的,我们可以不写这句话,但在有些情况下,如果CMakeLists.txt文件中使用了一些高版本cmake特有的一些命令的时候,就需要加上这样一行,提醒用户升级到该版本之后再执行cmake -
PROJECT(<Name>)
功能:用于指定项目的名称
这条指令会自动创建两个变量:
<projectnam>_SOURCE_DIR(源代码路径) 和 <projectname>_BINARY_DIR(二进制文件保存路径)
cmake系统也帮助我们预定义了 PROJECT_SOURCE_DIR 和 PROJECT_BINARY_DIR 其值与上述对应相等
PROJECT_SOURCE_DIR 指向的目录同内部构建相同,仍然是项目目录
而 PROJECT_BINARY_DIR 则有所不同,指向<项目目录>/build目录 -
INCLUDE_DIRECTORIES ([AFTER|BEFORE] [SYSTEM] dir1 dir2 …)
功能:设置头文件位置
向工程添加多个特定的头文件搜索路径,路径之间用空格分隔,如果路径包含空格,可以使用双引号将它括起来,默认的行为是追加到当前头文件搜索路径的后面 -
ADD_LIBRARY(libname [SHARED|STATIC|MODULE] [EXCLUDE_FROM_ALL] source1 source2 … sourceN)
功能:添加动态静态库- 添加一个名为<libname>的库文件
- 指定STATIC, SHARED, MODULE参数来指定要创建的库的类型, STATIC对应的静态库(.a),SHARED对应共享动态库(.so)
- [EXCLUDE_FROM_ALL], 如果指定了这一属性,对应的一些属性会在目标被创建时被设置(指明此目录和子目录中所有的目标,是否应当从默认构建中排除, 子目录的IDE工程文件/Makefile将从顶级IDE工程文件/Makefile中排除)
- source1 source2 … sourceN用来指定源文件
-
ADD_SUBDIRECTORY(source_dir [binary_dir] [EXCLUDE_FROM_ALL])
功能:去子目录中查看可用的CMakeLists.txt文件
如果当前目录下还有子目录时可以使用add_subdirectory,子目录中也需要包含有CMakeLists.txt
EXCLUDE_FROM_ALL含义:将这个目录从编译过程中排除 -
ADD_EXECUTABLE( [WIN32] [MACOSX_BUNDLE] [EXCLUDE_FROM_ALL] [source1] [source2 …])
功能:添加可执行文件
例:ADD_EXECUTABLE(hello ${SRC_LIST})
定义了这个工程会生成一个文件名为 hello 的可执行文件,相关的源文件是 SRC_LIST 中定义的源文件列表
这里的 hello 和之前的项目名称没有任何关系,可以任意定义 -
ADD_DEPENDENCIES(target-name depend-target1 depend-target2 …)
功能:用于添加编译器命令行标志(选项),通常的情况下我们使用其来添加预处理器定义
让一个顶层目标依赖于其他的顶层目标,保证某个目标在其他的目标之前被构建 -
TARGET_LINK_LIBRARIES(<name> lib1 lib2 lib3)
功能:将若干库链接到目标库文件
例如:TARGET_LINK_LIBRARIES(hello log4cpp thrift)
这句话指定在链接目标文件的时候需要链接的外部库,其效果类似gcc的编译参数“-l”,可以解决外部库的依赖问题 -
SET_PROPERTY
功能:在给定的作用域内设置一个命名的属性,PROPERTY参数是必须的
set_property(<GLOBAL |
DIRECTORY [dir] |
TARGET [target ...] |
SOURCE [src1 ...] |
TEST [test1 ...] |
CACHE [entry1 ...]>
[APPEND]
PROPERTY <name> [value ...])
第一个参数决定了属性可以影响的作用域,必须为以下值:
GLOBAL 全局作作用域,不接受名字
DIRECTORY 默认为当前路径,但是同样也可以用[dir]指定路径
TARGET 目标作用,可以是0个或多个已有的目标
SOURCE 源作用域, 可以是0个过多个源文件
TEST 测试作用域, 可以是0个或多个已有的测试
CACHE 必须指定0个或多个cache中已有的条目
-
SET_DIRECTORY_PROPERTIES(PROPERTIES prop1 value1 prop2 value2)
功能:设置某个路径的一种属性
prop1 prop2代表属性,取值为:
INCLUDE_DIRECTORIES
LINK_DIRECTORIES
INCLUDE_REGULAR_EXPRESSION
ADDITIONAL_MAKE_CLEAN_FILES -
MESSAGE([STATUS|WARNING|AUTHOR_WARNING|FATAL_ERROR|SEND_ERROR] “message todisplay”…)
功能:向终端输出用户定义的信息或变量的值
SEND_ERROR 产生错误,生成过程被跳过
STATUS 输出前缀为—的信息
FATAL_ERROR 立即终止所有cmake过程 -
FIND_LIBRARY(<VAR> name1 [path1 path2 …])
功能:用于查找库文件 name1 的路径,如果找到则将路径保存在 VAR 中(此路径为一个绝对路径),如果没有找到则=结果为 <VAR>-NOTFOUND -
FIND_PACKAGE(<Name>)
功能:找相应库的模块
windows下并不是很重要,但是在Unix下就非常重要了,find_package可以根据cmake内置的.cmake的脚本去找相应的库的模块,内建了很多库的模块变量,当调用了FIND_PACKAGE之后会有相应的变量生效 -
SET(VAR [VALUE] [CACHE TYPEDOCSTRING [FORCE]])
功能:用于设置变量,相当于为变量取别名
SET(CMAKE_BUILE_TYPE DEBUG) 设置编译类型debug 或者release,debug 版会生成相关调试信息,可以使用GDB 进行调试;release不会生成调试信息
SET(CMAKE_C_FLAGS_DEBUG “-g -Wall”) 设置编译器的类型 -
FILE
功能:文件操作命令
# 将message写入filename文件中,会覆盖文件原有内容
file(WRITE filename "message")
# 将message写入filename文件中,会追加在文件末尾
file(APPEND filename "message")
# 从filename文件中读取内容并存储到var变量中,如果指定了numBytes和offset,
# 则从offset处开始最多读numBytes个字节,另外如果指定了HEX参数,则内容会以十六进制形式存储在var变量中
file(READ filename var [LIMIT numBytes] [OFFSET offset] [HEX])
# 重命名文件
file(RENAME <oldname> <newname>)
# 删除文件, 等于rm命令
file(REMOVE [file1 ...])
# 递归的执行删除文件命令, 等于rm -r
file(REMOVE_RECURSE [file1 ...])
# 根据指定的url下载文件
# timeout超时时间; 下载的状态会保存到status中; 下载日志会被保存到log; sum指定所下载文件预期的MD5值,如果指定会自动进行比对,如果不一致,则返回一个错误; SHOW_PROGRESS,进度信息会以状态信息的形式被打印出来
file(DOWNLOAD url file [TIMEOUT timeout] [STATUS status] [LOG log] [EXPECTED_MD5 sum] [SHOW_PROGRESS])
# 创建目录
file(MAKE_DIRECTORY [dir1 dir2 ...])
# 会把path转换为以unix的/开头的cmake风格路径,保存在result中
file(TO_CMAKE_PATH path result)
# 它会把cmake风格的路径转换为本地路径风格:windows下用"\",而unix下用"/"
file(TO_NATIVE_PATH path result)
# 将会为所有匹配查询表达式的文件生成一个文件list,并将该list存储进变量variable里, 如果一个表达式指定了RELATIVE, 返回的结果将会是相对于给定路径的相对路径, 查询表达式例子: *.cxx, *.vt?
NOTE: 按照官方文档的说法,不建议使用file的GLOB指令来收集工程的源文件
file(GLOB variable [RELATIVE path] [globbing expressions]...)
CMake常用变量
UNIX 如果为真,表示为 UNIX-like 的系统,包括 AppleOS X 和 CygWin
WIN32 如果为真,表示为 Windows 系统,包括 CygWin
APPLE 如果为真,表示为 Apple 系统
CMAKE_SIZEOF_VOID_P 表示 void* 的大小(例如为 4 或者 8),可以使用其来判断当前构建为 32 位还是 64 位
CMAKE_CURRENT_LIST_DIR 表示正在处理的CMakeLists.txt 文件的所在的目录的绝对路径(2.8.3 以及以后版本才支持)
CMAKE_ARCHIVE_OUTPUT_DIRECTORY 用于设置 ARCHIVE 目标的输出路径
CMAKE_LIBRARY_OUTPUT_DIRECTORY 用于设置 LIBRARY 目标的输出路径
CMAKE_RUNTIME_OUTPUT_DIRECTORY 用于设置 RUNTIME 目标的输出路径
简单的例子
新建一个Qt工程,没有做任何修改,在项目中添加 CMakeLists.txt 文件,编写完成之后按照下图配置以cmake编译