CMake使用總結（轉的）+本身的實踐心得

來自https://www.mawenbao.com/note/cmake.html

總結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命令

list(APPEND SRC_LIST a.cpp b.cpp ) list(REMOVE_ITEM SRC_LIST a.cpp ) 

更多的例子

自定義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) 

閱讀資料

1. CMake文檔列表
2. CMake經常使用變量列表
3. CMake入門教程

個人編譯環境是gcc4.4.7，但爲了用到C++11特性，經過yum安裝了devtoolset-6，能夠仿照上面最後一個例子的方式來，不過要在COMMAND裏從新設置系統路徑PATH。由於傾向於用 scl enable devtoolset-6 bash來使gcc升級，因此就不用這種方式。