CMAKE的使用

一、      基本使用

安装：下载二进制包后可直接解压使用

从源码安装则执行命令： ./bootstrap; make; make install ——尝试执行 bootstrap 失败

使用： cmake dir_path ，生成工程文件或 makefile 文件

二、      概念

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()

五、      内部变量

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 能够处理好 .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