cmake 的使用
一，初识cmake
Cmake不再使你在构建项目时郁闷地想自杀了.
1，背景知识：
cmake是kitware公司以及一些开源开发者在开发几个工具套件(VTK)的过程中衍生品，最终形成体系，成为一个独立的开放源代码项目。项目的诞生时间是2001年。其官方网站是www.cmake.org，可以通过访问官方网站获得更多关于cmake的信息。cmake的流行其实要归功于KDE4的开发(似乎跟当年的svn一样，KDE将代码仓库从CVS迁移到SVN，同时证明了SVN管理大型项目的可用性)，在KDE开发者使用了近10年autotools之后，他们终于决定为KDE4选择一个新的工程构建工具，其根本原因用KDE开发者的话来说就是：只有少数几个“编译专家”能够掌握KDE现在的构建体系
(admin/Makefile.common)，在经历了unsermake, scons以及cmake的选型和尝试之后，KDE4决定
使用cmake作为自己的构建系统。在迁移过程中，进展异常的顺利，并获得了cmake开发者的支持。所以，目前的KDE4开发版本已经完全使用cmake来进行构建。像kdesvn,rosegarden等项目也开始使用
cmake，这也注定了cmake必然会成为一个主流的构建体系。
2，特点：
cmake的特点主要有：
1，开放源代码，使用类BSD许可发布。http://cmake.org/HTML/Copyright.html
2，跨平台，并可生成native编译配置文件，在Linux/Unix平台，生成makefile，在苹果平台，可
以生成xcode，在Windows平台，可以生成MSVC的工程文件。3，能够管理大型项目，KDE4就是最好的证明。
4，简化编译构建过程和编译过程。Cmake的工具链非常简单：cmake+make。
5，高效虑，按照KDE官方说法，CMake构建KDE4的kdelibs要比使用autotools来构建
KDE3.5.6的kdelibs快40%，主要是因为 Cmake在工具链中没有libtool。6，可扩展，可以为cmake编写特定功能的模块，扩充cmake功能。3，问题，难道就没有问题？
1，cmake很简单，但绝对没有听起来或者想象中那么简单。
2，cmake编写的过程实际上是编程的过程，跟以前使用autotools一样，不过你需要编写的是
CMakeLists.txt(每个目录一个)，使用的是”cmake语言和语法”。
3，cmake跟已有体系的配合并不是特别理想，比如pkgconfig，您在实际使用中会有所体会，虽然
有一些扩展可以使用，但并不理想。
4，个人的建议：
1，如果你没有实际的项目需求，那么看到这里就可以停下来了，因为cmake的学习过程就是实践
过程，没有实践，读的再多几天后也会忘记。
2，如果你的工程只有几个文件，直接编写Makefile是最好的选择。
3，如果使用的是C/C++/Java之外的语言，请不要使用cmake(至少目前是这样)
4，如果你使用的语言有非常完备的构建体系，比如java的ant，也不需要学习cmake，虽然有成功
的例子，比如QT4.3的csharp绑定qyoto。
5，如果项目已经采用了非常完备的工程管理工具，并且不存在维护问题，没有必要迁移到cmake4，如果仅仅使用qt编程，没有必要使用cmake，因为qmake管理Qt工程的专业性和自动化程度比
cmake要高很多。
CMake使用总结
总结CMake的常用命令，并介绍有用的CMake资源。
CMake意为cross-platform make，可用于管理c/c++工程。CMake解析配置文件CMakeLists.txt生成Makefile，相比直接用Makefile管理工程，CMake更灵活和简单。
简单的例子
一个完整的Demo可参考这里。
假设当前目录的结构为
./a.cpp ./b.cpp ./include/common.h ./include/defines.h ./other/c.cpp ./other/d.cpp ./lib/libB.a ./lib/libBd.a ./lib/libA.so ./lib/libAd.so ./lib/libB.so ./lib/libBd.so ./lib/libC.so ./lib/libCd.so
使用下面的CMakeLists.txt文件，目标是编译当前目录和./other目录下的所有源文件，并链接./lib目录下的相应库文件到最终的可执行文件./bin/hello(或./bin/hellod)。
cmake_minimum_required(VERSION 2.8)
project(helloworld)
set(CMAKE_VERBOSE_MAKEFILE on)
set(CMAKE_CXX_COMPILER "g++")
set(CMAKE_CXX_FLAGS "-Wall")
set(CMAKE_CXX_FLAGS_DEBUG "-g3")
set(CMAKE_CXX_FLAGS_RELEASE "-O2")
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
aux_source_directory(./ SRC_LIST)
aux_source_directory(./other OTHER_SRC_LIST)
list(APPEND SRC_LIST ${OTHER_SRC_LIST})
include_directories(${PROJECT_SOURCE_DIR}/include)
link_directories(${PROJECT_SOURCE_DIR}/lib)
if(${CMAKE_BUILD_TYPE} MATCHES "debug")
add_executable(hellod ${SRC_LIST})
target_link_libraries(hellod Ad Bd.a Cd.so)
else()
add_executable(hello ${SRC_LIST})
target_link_libraries(hello A B.a C.so)
endif()
执行命令
cmake -DCMAKE_BUILD_TYPE=debug .
生成Makefile，make之后生成./bin/hellod（调试版本），或执行
cmake .
最后生成./bin/hello。
常用的CMake变量
详细内容请参考CMake Useful Variables。
PROJECT_SOURCE_DIR 工程的源文件目录，通常是包含CMakeLists.txt（有Project命令的）的目录。
自定义变量
可在命令行下向CMake传递自定义变量
cmake -DMY_VAR=hello .
然后在CMakeLists.txt中使用，注意大小写。
message(${MY_VAR})
构建类型
cmake默认支持多种构建类型(build type)，每种构建类型都有专门的编译参数变量，详情见下表1:
| CMAKE_BUILD_TYPE | 对应的c编译选项变量 | 对应的c++编译选项变量 |
| None |
CMAKE_C_FLAGS |
CMAKE_CXX_FLAGS |
| Debug |
CMAKE_C_FLAGS_DEBUG |
CMAKE_CXX_FLAGS_DEBUG |
| Release |
CMAKE_C_FLAGS_RELEASE |
CMAKE_CXX_FLAGS_RELEASE |
| RelWithDebInfo |
CMAKE_C_FLAGS_RELWITHDEBINFO |
CMAKE_CXX_FLAGS_RELWITHDEBINFO |
| MinSizeRel |
CMAKE_C_FLAGS_MINSIZEREL |
CMAKE_CXX_FLAGS_MINSIZEREL |
在CMakeLists.txt中可以自定义编译选项变量
set(CMAKE_CXX_FLAGS_RELEASE "-O2")
然后运行cmake的时候，传入相应的构建类型即可
cmake -DCMAKE_BUILD_TYPE=Release
常用命令
详情可参考对应版本的CMake文档。
检查CMake版本
#cmake版本至少为2.8 cmake_minimum_required(VERSION 2.8)
定义工程名称
工程名为helloworld
project(helloworld)
查找源文件
查找当前目录下所有的源文件并保存到SRC_LIST变量里
aux_source_directory(. SRC_LIST)
查找src目录下所有以cmake开头的文件并保存到CMAKE_FILES变量里
file(GLOB CMAKE_FILES "src/cmake*")
file命令同时支持目录递归查找
file(GLOB_RECURSE CMAKE_FILES "src/cmake*")
按照官方文档的说法，不建议使用file的GLOB指令来收集工程的源文件，原文解释如下
We do not recommend using GLOB to collect a list of source files from your source tree. If no CMakeLists.txt file changes when a source is added or removed then the generated build system cannot know when to ask CMake to regenerate.
大意就是，GLOB收集的源文件增加或删除，而CMakeLists.txt没有发生修改时，CMake不能识别这些文件。其实，当CMakeLists.txt使用aux_source_directory和file glob查找工程源文件时，如果添加或删除源文件，都需要重新运行CMake。
set命令
经常配合set命令使用的CMake变量，使用set(variable value)进行设置。
CMAKE_VERBOSE_MAKEFILE on 输出详细的编译和链接信息
CMAKE_CXX_COMPILER "g++" c++编译器
CMAKE_CXX_FLAGS "-Wall" c++编译器参数
CMAKE_CXX_FLAGS_DEBUG 除CMAKE_CXX_FLAGS外，debug版本的额外编译器参数
CMAKE_CXX_FLAGS_RELEASE 除CMAKE_CXX_FLAGS外，release版本的额外编译器参数
EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin 可执行文件的输出目录
LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib 链接库的输出目录
set命令还可以设置自定义变量，比如
set(MY_GREETINGS "hello world")
包含目录和链接目录
将./include和./abc加入包含目录列表
include_directories( ./include ./abc )
将./lib加入编译器链接阶段的搜索目录列表
link_directories( ./lib )
添加生成目标
使用SRC_LIST源文件列表里的文件生成一个可执行文件hello
add_executable(hello ${SRC_LIST})
使用SRC_LIST源文件列表里的文件生成一个静态链接库libhello.a
add_library(hello STATIC ${SRC_LIST})
使用SRC_LIST源文件列表里的文件生成一个动态链接库libhello.so
add_library(hello SHARED ${SRC_LIST})
将若干库文件链接到生成的目标hello(libhello.a或libhello.so)
target_link_libraries(hello A B.a C.so)
需要注意的是，target_link_libraries里库文件的顺序符合gcc链接顺序的规则，即被依赖的库放在依赖它的库的后面，比如上面的命令里，libA.so可能依赖于libB.a和libC.so，如果顺序有错，链接时会报错。还有一点，B.a会告诉CMake优先使用静态链接库libB.a，C.so会告诉CMake优先使用动态链接库libC.so，也可直接使用库文件的相对路径或绝对路径。使用绝对路径的好处在于，当依赖的库被更新时，make的时候也会重新链接。
自定义链接选项
有时候需要自定义链接选项，比如需要单独对B.a使用--whole-archive选项，可以
target_link_libraryies(hello A -Wl,--whole-archive B.a -Wl,--no-whole-archive C.so)
自定义Makefile目标
运行下面的whatever目标make whatever，会先创建一个目录./hello，然后将当前目录的a.txt拷贝到新建的./hello目录里。
add_custom_command( OUTPUT ./hello/a.txt COMMAND mkdir -p ./hello cp a.txt ./hello DEPENDS a.txt )
add_custom_target(whatever DEPENDS ./hello/a.txt)
自定义目标还可以使用add_dependencies命令加入到其他目标的依赖列表里，当执行make demo时，whatever目标会被自动调用。
add_executable(demo ${SRC_LIST})
add_dependencies(demo whatever)
其他常用命令
包含其他目录的CMakeLists.txt
include(/path/to/another/CMakeLists.txt)
if命令
if(${CMAKE_BUILD_TYPE} MATCHES "debug")
...
else()
...
endif()
list命令
更多的例子
自定义Makefile目标的完整例子
下面的CMakeLists.txt添加一个自定义目标proto，该目标在编译工程前，会先调用protobuf程序编译先生成Google Protocol Buffers的消息解析器。
cmake_minimum_required(VERSION 2.6)
project(protobuf-demo)
# compile proto files
set(PROTO_IN news.proto)
set(PROTO_SRC news.pb.cc)
set(PROTO_OUT news.pb.h news.pb.cc proto/)
add_custom_command(
OUTPUT ${PROTO_OUT}
COMMAND protoc --cpp_out . --java_out . ${PROTO_IN}
DEPENDS ${PROTO_IN}
)
add_custom_target(proto DEPENDS ${PROTO_OUT})
aux_source_directory(. SRC_LIST)
list(APPEND SRC_LIST
${PROTO_SRC}
)
set(CMAKE_CXX_COMPILER "g++")
set(CMAKE_CXX_FLAGS "-Wall")
set(CMAKE_VERBOSE_MAKEFILE on)
add_executable(demo ${SRC_LIST})
add_dependencies(demo proto)
target_link_libraries(demo protobuf)
阅读资料
cmake教程
CMake文档列表
CMake常用变量列表
CMake入门教程
脚注
CMake Useful Variables: Compilers and Tools，引用于2014-05-06。