CMake简述

1. CMake简介

  CMake是一个跨平台的安装编译工具,可以用简单的语句来描述所有平台的安装编译过程。它能够输出各种各样的makefile或者project文件,能测试编译器所支持的C++特性,类似UNIX下的automake。

  CMake的所有语句都写在一个叫CMakeLists.txt(组态档)的文件中。当CMakeLists.txt文件确定后,可以用cmake命令对相关的变量值进行配置。这个命令必须指向CMakeLists.txt所在的目录。配置完之后,应用cmake命令生成相应的makefile。

  CMake是一个跨平台的软件,在很多平台可以使用。这就有了CMake的用武之地,我们可以先编写一个CMakeLists.txt文件,将需要的.h和.cpp文件包含进来,然后在不同的平台使用CMake调用各自的编译器生成各自的工程。

2. CMake常用命令

  在 CMakeLists.txt中,命令名字是不区分大小写的,而参数和变量是大小写相关的。

   使用"#"表示注释该行代码。
   使用${}进行变量的引用

2.1 指定CMake的最小版本

cmake_minimun_required(VERSION  3.4.1)

  这行命令是可选的。但在有些情况下,如果 CMakeLists.txt 文件中使用了一些高版本 cmake 特有的一些命令的时候,就需要加上这样一行,提醒用户升级到该版本之后再执行 cmake。

2.2 设置项目名称

project(demo)

  这个命令不是强制的,但最好都加上。它会引入两个变量 demo_BINARY_DIR 和 demo_SOURCE_DIR,同时,cmake 自动定义了两个等价的变量 PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR。

2.3 设置编译类型

add_executable(demo demo.cpp)          #生成可执行文件
add_library(common STATIC util.cpp)    #生成静态库
add_library(common SHARED util.cpp)    #生成动态库或共享库

  add_library默认生成是静态库,通过以上命令生成文件名字,

  • 在Linux下是:
    demo
    libcommon.a
    libcommon.so
  • 在Windows下是:
    demo.exe
    common.lib
    common.dll

2.4 指定编译包含的源文件

2.4.1 明确指定包含哪些源文件
add_library(demo demo.cpp test.cpp util.cpp)
2.4.2 搜索所有的源文件

  aux_source_directory(dir VAR)发现一个目录下所有的源代码文件,并将列表存储在一个变量中。

aux_source_directory(. SRC_LIST)    #搜索当前目录下的所有源文件
add_library(demo ${SRC_LIST})
2.4.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})

2.5 查找指定的库文件

  find_library(VAR name path)查找到指定的预编译库,并将它的路径存储在变量中。

2.6 设置包含的目录

include_directories()

2.7 设置链接库搜索目录

link_directories(${CMAKE_CURRENT_SOURCE_DIR}/libs)

2.8 设置target需要连接的库

  在windows下,系统会根据链接库目录,搜索xxx.lib文件,Linux下会搜索xxx.so或者xxx.a文件,如果都存在会优先链接动态库。

target_link_libraries(# 目标库
                      demo
                      
                      # 目标库需要链接的库
                      # log-lib是上面find_library指定的变量名
                      ${log-lib}
)
2.8.1 指定链接动态库或静态库
target_link_libraries(demo libface.a)
target_link_libraries(demo libface.so)
2.8.2 指定全路径
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/lib/libface.a)
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/lib/libface.so)
2.8.3 指定链接多个库
target_link_libraries(demo
    ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a
    boost_system.a
    boost_thread
    pthread
)

2.9 设置变量

2.9.1 set直接设置变量的值
set(SRC_LIST main.cpp test.cpp)
add_executable(demo ${SRC_LIST})
2.9.2 set追加设置变量的值
set(SRC_LIST main.cpp)
set(SRC_LIST ${SRC_LIST} test.cpp)
add_executable(demo ${SRC_LIST})
2.9.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})

2.10 打印信息

message(${PROJECT_SOURCE_DIR})
message(WARNING "this is warnning message")

2.11 包含其它cmake文件

include(./common.cmake)               # 指定包含文件的全路径
include(def)                          # 在搜索路径中搜索def.cmake文件
set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)     # 设置include的搜索路径

3. 条件控制

3.1 if…elseif…else…endif

3.1.1 逻辑判断和比较
if (expression)
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新,文件名需使用全路径
if (IS_DIRECTORY dir)                 #当dir是目录时为真
if (DEFINED var)                      #如果变量被定义为真
if (var MATCHES regex)          #给定的变量或者字符串能够匹配正则表达式regex时为真,此处var可以用var名,也可以用${var}
if (string MATCHES regex)
3.1.2 数字比较
if (variable LESS number)          #LESS小于
if (variable GREATER number)       #GREATER大于
if (variable EQUAL number)         #EQUAL等于
3.1.3 字母表顺序比较
if (variable STRLESS string)
if (variable STRGREATER string)
if (variable STREQUAL string)

3.2 while…endwhile

while(condition)
    ...
endwhile()

3.3 foreach…endforeach

  start 表示起始数,stop 表示终止数,step 表示步长。

foreach(loop_var RANGE start stop [step])
    ...
endforeach(loop_var)

4. 常用变量

4.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模块所在的路径。
• EXECUTABLE_OUTPUT_PATH:重新定义目标二进制可执行文件的存放位置。
• LIBRARY_OUTPUT_PATH:重新定义目标链接库文件的存放位置。

4.2 环境变量

  使用环境变量

$ENV{Name}

  写入环境变量

set(ENV{Name} value)

4.3 系统信息

• 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;
• CMAKE_SYSTEM_NAME:不包含版本的系统名,比如 Linux;
• CMAKE_SYSTEM_VERSION:系统版本,比如 2.6.22;
• CMAKE_SYSTEM_PROCESSOR:处理器名称,比如 i686;
• UNIX:在所有的类 UNIX 平台下该值为 TRUE,包括 OS X 和 cygwin;
• WIN32:在所有的 win32 平台下该值为 TRUE,包括 cygwin。

4.4 主要开关选项

  • BUILD_SHARED_LIBS:这个开关用来控制默认的库编译方式,如果不进行设置,使用 add_library 又没有指定库类型的情况下,默认编译生成的库都是静态库。如果 set(BUILD_SHARED_LIBS ON) 后,默认生成的为动态库。
  • CMAKE_C_FLAGS:设置 C 编译选项,也可以通过指令 add_definitions() 添加。
  • CMAKE_CXX_FLAGS:设置 C++ 编译选项,也可以通过指令 add_definitions() 添加。