【Tools】CMAKE的使用

二、概念

out-of-source build，与in-source build相对，即将编译输出文件与源文件放到不同目录中；

三、基本结构

1，依赖CMakeLists.txt文件，项目主目标一个，主目录中可指定包含的子目录；

2，在项目CMakeLists.txt中使用project指定项目名称，add_subdirectory添加子目录

3，子目录CMakeLists.txt将从父目录CMakeLists.txt继承设置（TBD，待检验）

四、语法

• 1.# 注释

• 2.变量：使用set命令显式定义及赋值，在非if语句中，使用${}引用，if中直接使用变量名引用；后续的set命令会清理变量原来的值；

• 3.command (args ...) #命令不分大小写，参数使用空格分隔，使用双引号引起参数中空格

• 4.set(var a;b;c) <=>set(var a b c) #定义变量var并赋值为a;b;c这样一个string list

• 5.Add_executable(${var}) <=> Add_executable(a b c) #变量使用${xxx}引用

• 6.条件语句：

if(var) #var 非empty 0 N No OFF FALSE... #非运算使用NOT
       …
else()/elseif() … endif(var)

• 7.循环语句

Set(VAR a b c)

Foreach(f ${VAR}) 
…
Endforeach(f)

• 8.循环语句

WHILE() 
… 
ENDWHILE()

• 9.meaasge打印变量
  CMake之常用内置变量和message用法
  message输出变量值，括号内可以用双引号，也可以不用双引号，用双引号的话，会按照格式来打印内容，比如空格。不加双引号，就会自动去掉空格

message("--------------------------")

message("1.PROJECT_BINARY_DIR = ${PROJECT_BINARY_DIR}")
message("2.PROJECT_SOURCE _DIR = ${_DIR}")
message("3.CMAKE_CURRENT_SOURCE_DIR = ${CMAKE_CURRENT_SOURCE_DIR}")
message("4.CMAKE_CURRRENT_BINARY_DIR = ${CMAKE_CURRRENT_BINARY_DIR}")
message("5.CMAKE_CURRENT_LIST_FILE = ${CMAKE_CURRENT_LIST_FILE}")
message("6.CMAKE_CURRENT_LIST_LINE = ${CMAKE_CURRENT_LIST_LINE}")
message("7.CMAKE_MODULE_PATH = ${CMAKE_MODULE_PATH}")
message("8.CMAKE_SOURCE_DIR = ${CMAKE_SOURCE_DIR}")
message("9.EXECUTABLE_OUTPUT_PATH = ${EXECUTABLE_OUTPUT_PATH}")
message("10.LIBRARY_OUTPUT_PATH = ${LIBRARY_OUTPUT_PATH}")
message("11.PROJECT_NAME = ${PROJECT_NAME}")
message("12.PROJECT_VERSION_MAJOR = ${PROJECT_VERSION_MAJOR}")
message("13.PROJECT_VERSION_MINOR = ${PROJECT_VERSION_MINOR}")
message("14.PROJECT_VERSION_PATCH = ${PROJECT_VERSION_PATCH}")
message("15.CMAKE_SYSTEM = ${CMAKE_SYSTEM}")
message("16.CMAKE_SYSTEM_NAME = ${CMAKE_SYSTEM_NAME}")
message("17.CMAKE_SYSTEM_VERSION = ${CMAKE_SYSTEM_VERSION}")
message("18.BUILD_SHARED_LIBS = ${BUILD_SHARED_LIBS}")
message("19.CMAKE_C_FLAGS = ${CMAKE_C_FLAGS}")
message("20.CMAKE_CXX_FLAGS = ${CMAKE_CXX_FLAGS}")
message("21.CMAKE_SYSTEM_PROCESSOR   = ${CMAKE_SYSTEM_PROCESSOR}")
# 为了分行确定输出内容
message("--------------------------")

• 10.宏macro 和 函数Function
  cmake函数、宏和模块(七)

# 定义函数
Function(myfunction ag1 ag2 ag3)
message(STATUS "function ag is " ${ag1})
message(STATUS "function ag is " ${ag2})
message(STATUS "function ag is " ${ag3})
endfunction(myfunction)


# 定义宏
macro(mymacro ag1 ag2 ag3)
message(STATUS "macro ag is " ${ag1})
message(STATUS "macro ag is " ${ag2})
message(STATUS "macro ag is " ${ag3})
endmacro(mymacro)

# 调用函数
myfunction(1 2 3 4 5)

message(STATUS "\n")

# 调用宏
mymacro(1 2 3 4 5)

五、内部变量

CMAKE_C_COMPILER：指定C编译器

CMAKE_CXX_COMPILER：

CMAKE_C_FLAGS：编译C文件时的选项，如-g；也可以通过add_definitions添加编译选项

EXECUTABLE_OUTPUT_PATH：可执行文件的存放路径

LIBRARY_OUTPUT_PATH：库文件路径

CMAKE_BUILD_TYPE：build 类型(Debug, Release, …)，CMAKE_BUILD_TYPE=Debug

BUILD_SHARED_LIBS：Switch between shared and static libraries

内置变量的使用：

在CMakeLists.txt中指定，使用set

cmake命令中使用，如cmake -DBUILD_SHARED_LIBS=OFF

六、命令

project (HELLO) #指定项目名称，生成的VC项目的名称；

使用${HELLO_SOURCE_DIR}表示项目根目录

include_directories：指定头文件的搜索路径，相当于指定gcc的-I参数

include_directories (${HELLO_SOURCE_DIR}/Hello) #增加Hello为include目录

link_directories：动态链接库或静态链接库的搜索路径，相当于gcc的-L参数

link_directories (${HELLO_BINARY_DIR}/Hello) #增加Hello为link目录

add_subdirectory：包含子目录
add_subdirectory (Hello)

add_executable：编译可执行程序，指定编译，好像也可以添加.o文件
add_executable (helloDemo demo.cxx demo_b.cxx) #将cxx编译成可执行文件

add_definitions：添加编译参数

add_definitions(-DDEBUG)将在gcc命令行添加DEBUG宏定义；

add_definitions( "-Wall -ansi –pedantic –g")

target_link_libraries：添加链接库,相同于指定-l参数

target_link_libraries(demo Hello) #将可执行文件与Hello连接成最终文件demo

add_library:
add_library(Hello hello.cxx) #将hello.cxx编译成静态库如libHello.a

add_custom_target:

message( status|fatal_error, "message"):

set_target_properties( ... ): lots of properties… OUTPUT_NAME, VERSION, …

link_libraries( lib1 lib2 ...): All targets link with the same set of libs

七、说明

1.CMAKE生成的makefile能够处理好xx.h文件更改时只编译需要的cpp文件；

八、FAQ

• 1） 怎样获得一个目录下的所有源文件?
  aux_source_directory(<dir> <variable>)
  将dir中所有源文件（不包括头文件）保存到变量variable中，然后可以add_executable (ss7gw ${variable})这样使用。

• 2）怎样指定项目编译目标?
  project命令指定

• 3）怎样添加动态库和静态库?
  target_link_libraries命令添加即可

• 4）怎样在执行CMAKE时打印消息?
  message([SEND_ERROR | STATUS | FATAL_ERROR] "message to display" ...)
  注意大小写

• 5）怎样指定头文件与库文件路径?
  include_directories与link_directories
  可以多次调用以设置多个路径
  link_directories仅对其后面的targets起作用

• 6）怎样区分debug、release版本?
  建立debug、release两目录，分别在其中执行cmake -DCMAKE_BUILD_TYPE=Debug（或Release），需要编译不同版本时进入不同目录执行make即可；

Debug版会使用参数-g；Release版使用-O3 –DNDEBUG

另一种设置方法——例如DEBUG版设置编译参数DDEBUG

IF(DEBUG_mode)
    add_definitions(-DDEBUG)
ENDIF()

在执行cmake时增加参数即可，例如cmake -D DEBUG_mode=ON

• 7）怎样设置条件编译?
  例如debug版设置编译选项DEBUG，并且更改不应改变CMakelist.txt
  使用option command
  eg：

option(DEBUG_mode "ON for debug or OFF for release" ON)

IF(DEBUG_mode)
    add_definitions(-DDEBUG)
ENDIF()

使其生效的方法：首先cmake生成makefile，然后make edit_cache编辑编译选项；Linux下会打开一个文本框，可以更改，该完后再make生成目标文件——emacs不支持make edit_cache；

局限：这种方法不能直接设置生成的makefile，而是必须使用命令在make前设置参数；对于debug、release版本，相当于需要两个目录，分别先cmake一次，然后分别make edit_cache一次；

期望的效果：在执行cmake时直接通过参数指定一个开关项，生成相应的makefile——可以这样做，例如cmake –DDEBUGVERSION=ON

• 8）怎样添加编译宏定义?
  使用add_definitions命令，见命令部分说明

• 9）怎样添加编译依赖项?
  用于确保编译目标项目前依赖项必须先构建好
  add_dependencies

• 10）怎样指定目标文件目录?
  建立一个新的目录，在该目录中执行cmake生成Makefile文件，这样编译结果会保存在该目录——类似
  SET_TARGET_PROPERTIES(ss7gw PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${BIN_DIR}")

• 11）很多文件夹，难道需要把每个文件夹编译成一个库文件?
  可以不在子目录中使用CMakeList.txt，直接在上层目录中指定子目录

• 12）怎样设定依赖的cmake版本?
  cmake_minimum_required(VERSION 2.6)

• 13）相对路径怎么指定？
  ${projectname_SOURCE_DIR}表示根源文件目录，${ projectname _BINARY_DIR}表示根二进制文件目录？

• 14）怎样设置编译中间文件的目录?
  TBD

• 15）怎样在IF语句中使用字串或数字比较?
  数字比较LESS、GREATER、EQUAL，字串比STRLESS、STRGREATER、STREQUAL。
  Eg：

set(CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS ON)

set(AAA abc)

IF(AAA STREQUAL abc)
    message(STATUS "true")   #应该打印true
ENDIF()

• 16）更改h文件时是否只编译必须的cpp文件?
  是

• 17）机器上安装了VC7和VC8，CMAKE会自动搜索编译器，但是怎样指定某个版本？
  TBD

• 18）怎样根据OS指定编译选项?
  IF( APPLE ); IF( UNIX ); IF( WIN32 )

• 19）能否自动执行某些编译前、后命令?
  可以，TBD

• 20）怎样打印make的输出?
  make VERBOSE=1