CMake

转自：HaHack以及netnote

Makefile:概述

概述

什么是makefile？或许不少Winodws的程序员都不知道这个东西，由于那些Windows的集成开发环境(integrated development environment, IDE)都为你作了这个工做，但我以为要做一个好的和professional的程序员，makefile仍是要懂。这就好像如今有这么多的HTML的编辑器，但若是你想成为一个专业人士，你仍是要了解HTML的标识的含义。特别在Unix下的软件编译，你就不能不本身写makefile了，会不会写makefile，从一个侧面说明了一我的是否具有完成大型工程的能力。

由于，makefile关系到了整个工程的编译规则。一个工程中的源文件不可胜数，而且按类型、功能、模块分别放在若干个目录中，makefile定义了一系列的规则来指定，哪些文件须要先编译，哪些文件须要后编译，哪些文件须要从新编译，甚至于进行更复杂的功能操做，由于makefile就像一个 Shell脚本同样，其中也能够执行操做系统的命令。

makefile带来的好处就是——“自动化编译”，一旦写好，只须要一个make命令，整个工程彻底自动编译，极大的提升了软件开发的效率。 make是一个命令工具，是一个解释makefile中指令的命令工具，通常来讲，大多数的IDE都有这个命令，好比：Delphi的make， Visual C++的nmake，Linux下GNU的make。可见，makefile都成为了一种在工程方面的编译方法。

如今讲述如何写makefile的文章比较少，这是我想写这篇文章的缘由。固然，不一样厂商的make各不相同，也有不一样的语法，但其本质都是在 “文件依赖性”上作文章，这里，我仅对GNU的make进行讲述，个人环境是RedHat Linux 8.0，make的版本是3.80。畢竟，这个 make是应用最为普遍的，也是用得最多的。并且其仍是最遵循于IEEE 1003.2-1992 标准的（POSIX.2）。

在这篇文档中，将以C/C++的源码做为咱们基础，因此必然涉及一些关于C/C++的编译的知识，相关于这方面的内容，还请各位查看相关的编译器的文档。这里所默认的编译器是UNIX下的GCC和CC。

关于程序的编译和连接

在此，我想多说关于程序编译的一些规范和方法，通常来讲，不管是C、C++、仍是pas，首先要把源文件编译成中间代码文件，在Windows下也就是 .obj 文件，UNIX下是 .o 文件，即 Object File，这个动做叫作编译（compile）。而后再把大量的 Object File合成执行文件，这个动做叫做连接（link）。

编译时，编译器须要的是语法的正确，函数与变量的声明的正确。对于后者，一般是你须要告诉编译器头文件的所在位置（头文件中应该只是声明，而定义应该放在C/C++文件中），只要全部的语法正确，编译器就能够编译出中间目标文件。通常来讲，每一个源文件都应该对应于一个中间目标文件（O文件或是 OBJ文件）。

连接时，主要是连接函数和全局变量，因此，咱们可使用这些中间目标文件（O文件或是OBJ文件）来连接咱们的应用程序。连接器并无论函数所在的源文件，只管函数的中间目标文件（Object File），在大多数时候，因为源文件太多，编译生成的中间目标文件太多，而在连接时须要明显地指出中间目标文件名，这对于编译很不方便，因此，咱们要给中间目标文件打个包，在Windows下这种包叫“库文件”（Library File)，也就是 .lib 文件，在UNIX下，是Archive File，也就是 .a 文件。

总结一下，源文件首先会生成中间目标文件，再由中间目标文件生成执行文件。在编译时，编译器只检测程序语法，和函数、变量是否被声明。若是函数未被声明，编译器会给出一个警告，但能够生成Object File。而在连接程序时，连接器会在全部的Object File中找寻函数的实现，若是找不到，那到就会报连接错误码（Linker Error），在VC下，这种错误通常是：Link 2001错误，意思说是说，连接器未能找到函数的实现。你须要指定函数的Object File.

 

什么是 CMake

All problems in computer science can be solved by another level of indirection.

David Wheeler

你或许听过好几种 Make 工具，例如 GNU Make ，QT 的 qmake ，微软的 MS nmake，BSD Make（pmake），Makepp，等等。这些 Make 工具遵循着不一样的规范和标准，所执行的 Makefile 格式也千差万别。这样就带来了一个严峻的问题：若是软件想跨平台，必需要保证可以在不一样平台编译。而若是使用上面的 Make 工具，就得为每一种标准写一次 Makefile ，这将是一件让人抓狂的工做。

CMake就是针对上面问题所设计的工具：它首先容许开发者编写一种平台无关的 CMakeList.txt 文件来定制整个编译流程，而后再根据目标用户的平台进一步生成所需的本地化 Makefile 和工程文件，如 Unix 的 Makefile 或 Windows 的 Visual Studio 工程。从而作到“Write once, run everywhere”。显然，CMake 是一个比上述几种 make 更高级的编译配置工具。一些使用 CMake 做为项目架构系统的知名开源项目有 VTK、ITK、KDE、OpenCV、OSG 等 ^[1]。

图 1 CMake

在 linux 平台下使用 CMake 生成 Makefile 并编译的流程以下：

1. 编写 CMake 配置文件 CMakeLists.txt 。
2. 执行命令 cmake PATH 或者 ccmake PATH 生成 Makefile ¹  。其中， PATH 是 CMakeLists.txt 所在的目录。                                          1 ccmake 和 cmake 的区别在于前者提供了一个交互式的界面。                        
3. 使用 make 命令进行编译。

 

CMake的使用

1、基本使用

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

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

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

2、概念

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

3、基本结构

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

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

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

4、语法

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

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

6、命令

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

7、说明

1，CMAKE生成的makefile可以处理好.h文件更改时只编译须要的cpp文件；

8、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