CMake
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 并编译的流程如下：
- 编写 CMake 配置文件 CMakeLists.txt 。
- 执行命令
cmake PATH或者ccmake PATH生成 Makefile 1 。其中，PATH是 CMakeLists.txt 所在的目录。 1ccmake和cmake的区别在于前者提供了一个交互式的界面。 - 使用
make命令进行编译。
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
