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)，每种构建类型都有专门的编译参数变量，详情见下表

CMAKE_BUILD_TYPE对应的C编译选项变量对应的C++编译选项变量NoneCMAKE_C_FLAGSCMAKE_CXX_FLAGSDebugCMAKE_C_FLAGS_DEBUGCMAKE_CXX_FLAGS_DEBUGReleaseCMAKE_C_FLAGS_RELEASECMAKE_CXX_FLAGS_RELEASERelWithDebInfoCMAKE_C_FLAGS_RELWITHDEBUGINFOCMAKE_CXX_FLAGS_RELWITHDEBUGINFOMinSizeRelCMAKE_C_FLAGS_MINSIZERELCMAKE_CXX_FLAGS_MINSIZEREL在CMakeLists.txt中可以自定义编译选项变量

set(CMAKE_CXX_FLAGS_RELEASE "-O2")

然后运行cmake的时候，传入相应的构建类型即可

cmake -DCMAKE_BUILD_TYPE=Release

常用命令

1）检查CMake版本，cmake版本至少为2.8

cmake_minimum_required(VERSION 2.8)

2）定义工程名称，工程名为helloworld

project(helloworld)

3）查找源文件，

查找当前目录下所有的源文件并保存到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指令来收集工程的源文件，因为GLOB收集的源文件增加或删除，而CMakeLists.txt没有发生修改时，CMake不能识别这些文件。

4）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 链接库的输出目录

5）包含目录和链接目录，

// 将./include和./abc加入包含目录列表include_directories(    ./include    ./abc)// 将./lib加入编译器链接阶段的搜索目录列表link_directories(    ./lib)

5）添加生成目标

// 使用SRC_LIST源文件列表里的文件生成一个可执行文件helloadd_executable(hello ${SRC_LIST})// 使用SRC_LIST源文件列表里的文件生成一个静态链接库libhello.aadd_library(hello STATIC ${SRC_LIST})// 使用SRC_LIST源文件列表里的文件生成一个动态链接库libhello.soadd_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的时候也会重新链接。
6）自定义链接选项

有时候需要自定义链接选项，比如需要单独对B.a使用--whole-archive选项，可以

target_link_libraryies(hello A -Wl,--whole-archive B.a -Wl,--no-whole-archive C.so)

7）自定义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.txtinclude(/path/to/another/CMakeLists.txt)// if命令if(${CMAKE_BUILD_TYPE} MATCHES "debug")    ...else()    ...endif()// list命令list(APPEND SRC_LIST     a.cpp    b.cpp)list(REMOVE_ITEM SRC_LIST    a.cpp)

AND

另一篇参考：CMake 基本使用方法--写CMakeList.txt