1.cmake介绍
- 跨平台,支持Linux,mac和windows等不同操作系统
- 开放源代码
- 编译语言简单,易用,简化编译构建过程和编译过程
- 编程高效,可扩展
通过读取并执行CMakeLists.txt文件,来生成MakeFile文件。
2.cmake语法主体框架
3.cmake常用的指令
#为源文件的编译添加宏定义,-D连接宏
add_definitions(-DDEBUG)
#链接时被依赖的需要放在后面
link_libraries(parse tafservant tafutil)
#提供用户可以选择的选项
option(
USE_MYTH
"descrition"
ON
)
#为工程添加一条自定义的构建规则,可以用于生成文件或完成事务
#生成文件
add_custom_command(
OUTPUT COPY_RES
COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/config ${CMAKE_CURRENT_SOURCE_DIR}/etc
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/log.txt ${CMAKE_CURRENT_SOURCE_DIR}/etc
)
#完成事务
add_custom_command(
TARGET CopyTask
POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/config ${CMAKE_CURRENT_SOURCE_DIR}/etc
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/log.txt ${CMAKE_CURRENT_SOURCE_DIR}/etc
)
#其中使用OUTPUT参数时,需要在目标的构建中指定依赖于该OUTPUT
#如果使用的是TARGE参数,直接指定目标就可以
#添加自定义的命令CopyTask,用于执行文件夹复制和文件复制
add_custom_target(
CopyTask
COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/config ${CMAKE_CURRENT_SOURCE_DIR}/etc
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/log.txt ${CMAKE_CURRENT_SOURCE_DIR}/etc
)
#cmake时为用户打印一条消息,关键字默认为STATUS.区分大小写
message([STATUS|WARNING|AUTHOR_WARNING|FATAL_ERROR|SEND_ERROR] "your selfdefined message")
cmake中的文件操作
- 文件的读写/追加
- 文件的hash码
- 文件的收集
- 文件的重命名/删除/创建
#获取当前文件夹下的所有文件(包括文件夹)路径(绝对路径)
file(GLOB files *)
foreach(file IN LISTS files)
message(STATUS ${file})
endforeach(file)
#获取当前文件夹下的所有文件(不包括文件夹)路径(绝对路径)
file(GLOB files LIST_DIRECTORIES false *)
foreach(file IN LISTS files)
message(STATUS ${file})
endforeach(file)
#获取当前文件夹下的文件相对于CUR的路径
set(CUR ${CMAKE_CURRENT_SOURCE_DIR})
file(GLOB files LIST_DIRECTORIES false RELATIVE ${CUR}/.. *)
foreach(file IN LISTS files)
message(STATUS ${file})
endforeach(file)
#递归获取当前文件夹下的文件相对与CUR的路径
set(CUR ${CMAKE_CURRENT_SOURCE_DIR})
file(GLOB_RECURSE files FOLLOW_SYMLINKS LIST_DIRECTORIES true RELATIVE ${CUR}/.. *)
foreach(file IN LISTS files)
message(STATUS ${file})
endforeach(file)
#文件的重命名
file(RENAME <oldname> <newname>)
#文件的删除
file(REMOVE [<file1> <file2> ...])
#删除文件夹
file(REMOVE_RECURSE [<file1> <file2> ...])
#STRINGS 从文件中解析出ASCII字符串列表并存储在变量中。文件中的二进制数据将被忽略。回车符(CR)也会被忽略
file(STRINGS filename variable)
cmake中的列表的操作
#返回列表的长度
list(LENGTH <list><output variable>)
#返回列表中指定下标的元素
list(GET <list> <elementindex> [<element index> ...] <output variable>)
#添加新的元素到列表中
list(APPEND <list><element> [<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>)
cmake 中的include/macro/function
-
include
#nclude指令一般用于语句的复用,如果有一些语句需要在很多CMakeLists.txt文件中使用, #为避免重复编写,可以将其写在.cmake文件中, #然后在需要的CMakeLists.txt文件中进行include操作就行了 include(<file|module> [OPTIONAL] [RESULT_VARIABLE <var>] [NO_POLICY_SCOPE]) include(test.cmake)
-
macro和function
macro(<name> [arg1 [arg2 [arg3 ...]]]) COMMAND1(ARGS ...) # 命令语句 COMMAND2(ARGS ...) ... endmacro() function(<name> [arg1 [arg2 [arg3 ...]]]) COMMAND1(ARGS ...) # 命令语句 COMMAND2(ARGS ...) ... function() macro(Moo arg) message("arg = ${arg}") set(arg "abc") message("# After change the value of arg.") message("arg = ${arg}") endmacro() message("=== Call macro ===") Moo(${var}) function(Foo arg) message("arg = ${arg}") set(arg "abc") message("# After change the value of arg.") message("arg = ${arg}") endfunction() message("=== Call function ===") Foo(${var}) ##输出结果 -- The C compiler identification is GNU 5.4.0 -- The CXX compiler identification is GNU 5.4.0 -- Check for working C compiler: /usr/bin/cc -- Check for working C compiler: /usr/bin/cc -- works -- Detecting C compiler ABI info -- Detecting C compiler ABI info - done -- Detecting C compile features -- Detecting C compile features - done -- Check for working CXX compiler: /usr/bin/c++ -- Check for working CXX compiler: /usr/bin/c++ -- works -- Detecting CXX compiler ABI info -- Detecting CXX compiler ABI info - done -- Detecting CXX compile features -- Detecting CXX compile features - done === Call macro === arg = ABC # After change the value of arg. arg = ABC === Call function === arg = ABC # After change the value of arg. arg = abc -- Configuring done -- Generating done -- Build files have been written to: /home/yngzmiao/test/build #说明传入宏的参数仅作替换,不能对值进行修改。而函数缺什可以对传入的参数进行修改的
4.cmake中的预定义变量
cmake中的预定义变量
# 系统标志
UNIX
WIN32 for MINGW,CYGWIN,MSYS
APPLE
WATCOM
MSVC,MSVC_IDE,CMAKE_COMPILER_2005,MSVC60/70/71/80/90/10,针对不同的Visual C++
CMAKE_COMPILER_IS_GUNCXX/CMAKE_COMPILER_IS_GUNCC
#系统信息
CMAKE_MAJOR_VERSION cmake主版本号,如3.2.2中的3
CMAKE_MINOR_VERSION cmake次版本号,如3.2.2中的2
CMAKE_PATCH_VERSION cmake补丁等级,如3.2.2中的2
CMAKE_SYSTEM 系统名称,例如Linux-2.6.22
CAMKE_SYSTEM_NAME 不包含版本的系统名,如Linux
CMAKE_SYSTEM_VERSION 系统版本,如2.6.22
CMAKE_SYSTEM_PROCESSOR 处理器名称,如i686
#基本变量
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语句的书写方式
#环境变量
$ENV{HOME}
#设置环境变量的方式
set(ENV(NAME) value)
CMAKE_INCLUDE_PATH
CMAKE_LIBRARY_PATH
#编译选项
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
如果未进行设置,使用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