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_MAKEFILEon 輸出詳細的編譯和鏈接信息 -
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)閱讀資料
- CMake文檔列表
- CMake常用變量列表
- CMake入門教程
- CMake Useful Variables: Compilers and Tools，引用於2014-05-06。 ↩