1、各種關系

?

在各種開源項目中，經常會發現項目中除了代碼源文件，還包含了 CMakeList.txt、 Makefile 文件，在項目的編譯時候需要用到的命令有 cmake 、 make。我們本次想搞清楚他們之前的關系以及CMakeList的語法規則。

正常情況下，我們編寫程序的大體流程為：

1）用編輯器（vim、emacs等）編寫源代碼文件（.h、.cpp等）；

2）用編譯器編譯代碼生成目標文件（.o等）；

3）用鏈接器連接目標文件生成可執行文件（.exe等）。

一個程序在編寫時，可能需要編寫很多的代碼文件，以及依賴很多第三方的庫。在這種情況下，手動依次編譯每個文件會變的非常麻煩，效率低下。

make 是一個自動化的批量編譯工具，可以實現用一個命令構建整個工程的目的。但是其執行需要依賴一個規則文件，這個文件就是 Makefile。 Makefile 文件里詳細描述了構建的細節（文件的依賴關系，編譯的先后順序等）。

對于一個大工程來說，編寫 Makefile 文件也是一項非常復雜的事情。

cmake(Cross-platform Make)是一個可以自動生成 Makefile 文件的工具，當然它不只能生成 Makefile ，還能跨平臺生成主流IDE(VS, xcode…)構建工程所需的 project 文件。 cmake 的執行同樣需要依賴規則文件，這個文件就是 CMakeLists.txt 。

所以，為了能夠把一堆c，cc，cpp，h，hpp代碼變成可運行的庫或者程序，核心還是Makefile，CMakefiles.txt純粹是為了降低不懂Unix體系的人去編譯C/C++代碼做的一個自動系統和環境檢測和設置工具，同時幫你生成Makefile。

綜上所述，大致可以總結 cmake, make, CMakeList.txt, Makefile 之間的關系，如下圖所示：

2、CMakeList.txt規則

鑒于目前在開發中，主要遇到的是使用CMake和CMakeList.txt使用的問題，重點介紹下CMakeList.txt的編寫規則。

CMake是一個跨平臺的安裝(編譯)工具,可以用簡單的語句來描述所有平臺的安裝(編譯過程)。他能夠輸出各種各樣的makefile或者project文件,能測試編譯器所支持的C++特性,類似UNIX下的automake。

CMake的所有的語句都寫在一個叫:CMakeLists.txt的文件中。當CMakeLists.txt文件確定后,可以用ccmake命令對相關 的變量值進行配置。這個命令必須指向CMakeLists.txt所在的目錄。配置完成之后,應用cmake命令生成相應的makefile（在Unix like系統下）或者 project文件（指定用window下的相應編程工具編譯時）

2.1 常用命令

2.11 指定 cmake 的最小版本

這行命令是可選的，可以不寫這句話，但在有些情況下，如果 CMakeLists.txt 文件中使用了一些高版本 cmake 特有的一些命令的時候，就需要加上這樣一行，提醒用戶升級到該版本之后再執行 cmake。

cmake_minimum_required(VERSION 3.4.1)

2.12 設置項目名稱

這個命令不是強制性的，但最好都加上。它會引入兩個變量 demo_BINARY_DIR 和 demo_SOURCE_DIR，同時，cmake 自動定義了兩個等價的變量 PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR。

project(demo)

2.13 設置編譯類型

add_executable(demo test.cpp) # 生成可執行文件add_library(common STATIC test.cpp) # 生成靜態庫add_library(common SHARED test.cpp) # 生成動態庫或共享庫

add_library 默認生成是靜態庫，通過以上命令生成文件名字

在 Linux /Mac下是：

• demo

• libcommon.a

• libcommon.so

在 Windows 下是：

• demo.exe

• common.lib

• common.dll

2.14 執行編譯包含的源文件

2.14.1 明確指定包含哪些源文件

源文件少時可以這么做

add_library(demo demo.cpp test.cpp util.cpp)

2.14.2 搜索所有的 cpp 文件

aux_source_directory(dir VAR) 發現一個目錄下所有的源代碼文件并將列表存儲在一個變量中。

aux_source_directory(. SRC_LIST) # 搜索當前目錄下的所有.cpp文件，存儲在變量SRC_LIST中add_library(demo ${SRC_LIST})

2.14.3 自定義搜索規則

file(GLOB SRC_LIST "*.cpp" "protocol/*.cpp") #查找當前目錄下、及protocol目錄下所有cpp文件，保存在變量SEC_LIST中add_library(demo ${SRC_LIST})# 或者file(GLOB SRC_LIST "*.cpp") #查找當前目錄下所有cpp文件，保存在變量SRC_LIST中file(GLOB SRC_PROTOCOL_LIST "protocol/*.cpp")add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})# 或者file(GLOB_RECURSE SRC_LIST "*.cpp") #遞歸搜索FILE(GLOB SRC_PROTOCOL RELATIVE "protocol" "*.cpp") # 相對protocol目錄下搜索add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})# 或者aux_source_directory(. SRC_LIST)aux_source_directory(protocol SRC_PROTOCOL_LIST)add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})

2.15 查找指定的庫文件

ind_library(VAR name path)查找到指定的預編譯庫，并將它的路徑存儲在變量中。
默認的搜索路徑為 cmake 包含的系統庫，因此如果是 NDK 的公共庫只需要指定庫的 name 即可。

類似的命令還有 find_file()、find_path()、find_program()、find_package()。

find_library( # Sets the name of the path variable.log-lib# Specifies the name of the NDK library that# you want CMake to locate.log )

2.16 設置包含的目錄

include_directories(${CMAKE_CURRENT_SOURCE_DIR}${CMAKE_CURRENT_BINARY_DIR}${CMAKE_CURRENT_SOURCE_DIR}/include)

Linux和Mac下還可以通過如下方式設置包含的目錄

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -I${CMAKE_CURRENT_SOURCE_DIR}")

2.17 設置鏈接庫搜索目錄

link_directories(${CMAKE_CURRENT_SOURCE_DIR}/libs)

Linux和Mac下還可以通過如下方式設置鏈接庫搜索目錄

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -L${CMAKE_CURRENT_SOURCE_DIR}/libs")

2.18 設置 target 需要鏈接的庫

target_link_libraries( # 目標庫demo# 目標庫需要鏈接的庫# log-lib 是上面 find_library 指定的變量名${log-lib} )

在 Windows 下，系統會根據鏈接庫目錄，搜索xxx.lib 文件，Linux 下會搜索 xxx.so 或者 xxx.a 文件，如果都存在會優先鏈接動態庫（so 后綴）

2.18.1 指定鏈接靜態庫或動態庫

target_link_libraries(demo libface.a) # 鏈接libface.atarget_link_libraries(demo libface.so) # 鏈接libface.so

2.18.2 指定全路徑

target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a) target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.so)

2.18.3 指定鏈接多個庫

target_link_libraries(demo${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.aboost_system.aboost_threadpthread)

2.19 設置變量

2.19.1 set直接設置變量的值

set(SRC_LIST main.cpp test.cpp) # 兩個cpp文件，存儲在變量SRC_LIST中add_executable(demo ${SRC_LIST})

2.19.2 set追加設置變量的值

set(SRC_LIST main.cpp)set(SRC_LIST ${SRC_LIST} test.cpp)add_executable(demo ${SRC_LIST})

2.19.3 list追加或刪除變量的值

set(SRC_LIST main.cpp)list(APPEND SRC_LIST test.cpp)list(REMOVE_ITEM SRC_LIST main.cpp)add_executable(demo ${SRC_LIST})

2.110 條件控制

2.110.1 if…elseif…else…endif

邏輯判斷和比較：if (expression)：expression 不為空（0,N,NO,OFF,FALSE,NOTFOUND）時為真if (not exp)：與上面相反if (var1 AND var2)if (var1 OR var2)if (COMMAND cmd)：如果 cmd 確實是命令并可調用為真if (EXISTS dir) if (EXISTS file)：如果目錄或文件存在為真if (file1 IS_NEWER_THAN file2)：當 file1 比 file2 新，或 file1/file2 中有一個不存在時為真，文件名需使用全路徑if (IS_DIRECTORY dir)：當 dir 是目錄時為真if (DEFINED var)：如果變量被定義為真if (var MATCHES regex)：給定的變量或者字符串能夠匹配正則表達式 regex 時為真，此處 var 可以用 var 名，也可以用 ${var}if (string MATCHES regex)數字比較：if (variable LESS number)：LESS 小于if (string LESS number)if (variable GREATER number)：GREATER 大于if (string GREATER number)if (variable EQUAL number)：EQUAL 等于if (string EQUAL number)字母表順序比較：if (variable STRLESS string)if (string STRLESS string)if (variable STRGREATER string)if (string STRGREATER string)if (variable STREQUAL string)if (string STREQUAL string)

2.1100.2 while .. endwhile

while(condition)...endwhile()

2.110.3 foreach…endforeach

foreach(loop_var RANGE start stop [step])...endforeach(loop_var)foreach(i RANGE 1 9 2) # 從1到9，步長為2message(${i})endforeach(i)# 輸出：13579

2.111 打印信息

message(${PROJECT_SOURCE_DIR})message("build with debug mode")message(WARNING "this is warnning message")message(FATAL_ERROR "this build has many error") # FATAL_ERROR 會導致編譯失敗

2.112 包含其他cmake文件

include(./common.cmake) # 指定包含文件的全路徑include(def) # 在搜索路徑中搜索def.cmake文件set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake) # 設置include的搜索路徑

2.2 常用變量

2.21 預定義變量

PROJECT_SOURCE_DIR：工程的根目錄

PROJECT_BINARY_DIR：運行 cmake 命令的目錄，通常是 ${PROJECT_SOURCE_DIR}/build

PROJECT_NAME：返回通過 project 命令定義的項目名稱

CMAKE_CURRENT_SOURCE_DIR：當前處理的 CMakeLists.txt 所在的路徑

CMAKE_CURRENT_BINARY_DIR：target 編譯目錄

CMAKE_CURRENT_LIST_DIR：CMakeLists.txt 的完整路徑

CMAKE_CURRENT_LIST_LINE：當前所在的行

CMAKE_MODULE_PATH：定義自己的 cmake 模塊所在的路徑，SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)，然后可以用INCLUDE命令來調用自己的模塊

EXECUTABLE_OUTPUT_PATH：重新定義目標二進制可執行文件的存放位置

LIBRARY_OUTPUT_PATH：重新定義目標鏈接庫文件的存放位置

2.22 環境變量

使用環境變量

$ENV{Name}

寫入環境變量

set(ENV{Name} value) # 這里沒有“$”符號

2.23 系統變量

CMAKE_MAJOR_VERSION：cmake 主版本號，比如 3.4.1 中的 3

-CMAKE_MINOR_VERSION：cmake 次版本號，比如 3.4.1 中的 4

-CMAKE_PATCH_VERSION：cmake 補丁等級，比如 3.4.1 中的 1

-CMAKE_SYSTEM：系統名稱，比如 Linux--2.6.22

-CMAKE_SYSTEM_NAME：不包含版本的系統名，比如 Linux

-CMAKE_SYSTEM_VERSION：系統版本，比如 2.6.22

-CMAKE_SYSTEM_PROCESSOR：處理器名稱，比如 i686

-UNIX：在所有的類 UNIX 平臺下該值為 TRUE，包括 OS X 和 cygwin

-WIN32：在所有的 win32 平臺下該值為 TRUE，包括 cygwin

2.24 主要開關選項

BUILD_SHARED_LIBS：這個開關用來控制默認的庫編譯方式，如果不進行設置，使用 add_library 又沒有指定庫類型的情況下，默認編譯生成的庫都是靜態庫。如果 set(BUILD_SHARED_LIBS ON) 后，默認生成的為動態庫

CMAKE_C_FLAGS：設置 C 編譯選項，也可以通過指令 add_definitions() 添加

CMAKE_CXX_FLAGS：設置 C++ 編譯選項，也可以通過指令 add_definitions() 添加

add_definitions(-DENABLE_DEBUG -DABC) # 參數之間用空格分隔

3 實例搞起

3.1 單個源文件

cmaketest1.zip

以一段簡單C程序為例

#include <stdio.h>int main() {printf("某程序員退休后決定練習書法，于是重金購買文房四寶。一日，飯后突生雅興，一番研墨擬紙，并點上上好檀香。定神片刻，潑墨揮毫，鄭重地寫下一行字：\n");printf("Hello World!\n");return 0;}

新建文件 CMakeLists.txt（命名必須是 CMakeLists.txt，注意大小寫和不要漏字母）

編譯可執行文件

project(HELLO)add_executable(hello test.c) # 生成可執行文件#add_library(common STATIC test.c) # 生成靜態庫#add_library(common SHARED test.c) # 生成動態庫或共享庫

直接在當前文件夾執行cmake ..

彈出提示

?原來這個命令會去上級目錄找CMakeLists.txt

一般會新建一個build目錄，cd到build目錄

先執行cmake ..

再執行make

?可以看到在build目錄中產出了可執行文件，并且能執行成功

編譯靜態庫

project(HELLO)#add_executable(hello test.c) # 生成可執行文件add_library(common STATIC test.c) # 生成靜態庫#add_library(common SHARED test.c) # 生成動態庫或共享庫

編譯動態庫

project(HELLO)#add_executable(hello test.c) # 生成可執行文件#add_library(common STATIC test.c) # 生成靜態庫add_library(common SHARED test.c) # 生成動態庫或共享庫

但是發現編譯出來的是Mac下的動態庫文件格式，dylib

如何才能編譯出來so格式的動態庫呢，需要把CMAKE_SYSTEM_NAME設置為Android

set(CMAKE_SYSTEM_NAME Android)set(CMAKE_ANDROID_NDK "/Users/guozhenqian/Develop/android-ndk-r22b")set(CMAKE_TOOLCHAIN_FILE "/Users/guozhenqian/Develop/android-ndk-r22b/build/cmake/android.toolchain.cmake")set(ANDROID_TOOLCHAIN clang)set(ANDROID_NATIVE_API_LEVEL 14)set(ANDROID_ABI "armeabi-v7a")set(CMAKE_BUILD_TYPE Release)set(CMAKE_CROSSCOMPILING "TRUE")set(CMAKE_CXX_STANDARD 11) #c++標準project(HELLO)#add_executable(hello test.c) # 生成可執行文件#add_library(common STATIC test.c) # 生成靜態庫add_library(common SHARED test.c) # 生成動態庫或共享庫

3.2 復雜項目（多個目錄，多個源文件，多個項目）

關于多目錄+自定義編譯選項的，參考這篇文章足夠了

CMake入門-04-自定義編譯選項_binglingziyu的博客-CSDN博客_cmake 自定義選項

但是這篇文章有個錯誤的地方，導致自定義編譯選項不生效

option一定要在configure_file之前定義

cmaketest_3.zip

cmake_minimum_required(VERSION 3.15.0)# 項目名project(hello)# 查找當前目錄下的所有源文件，并將名稱保存到 SRC_LIST 變量aux_source_directory(. SRC_LIST)# 是否使用自己的 MathFunctions 庫# 這里設置的變量 USE_MYMATH、中間的提示文字、默認值，在 ccmake 命令中會展示# 這個option一定要在configure_file之前，不然生成的config.h文件默認是沒有define的option (USE_MYMATH"Use provided math implementation"ON)# 加入一個配置頭文件，用于處理 CMake 對源碼的設置configure_file ("${PROJECT_SOURCE_DIR}/config.h.in""${PROJECT_SOURCE_DIR}/config.h")# 是否加入 MathFunctions 庫if (USE_MYMATH)# 添加頭文件路徑include_directories ("${PROJECT_SOURCE_DIR}/math")# 添加 math 子目錄 (math 目錄里必須有 CMakeLists.txt)add_subdirectory (math)set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions)endif (USE_MYMATH)# 指定生成目標add_executable(hello ${SRC_LIST} ${MATH_SRC_LIST})# 添加鏈接庫target_link_libraries(hello ${EXTRA_LIBS})

3.3 復雜項目編譯動態庫

在cmaketest_3的基礎上升級，編譯出來動態庫

cmaketest_4.zip

cmake_minimum_required(VERSION 3.15.0)# 設置Android環境set(CMAKE_SYSTEM_NAME Android)set(CMAKE_ANDROID_NDK "/Users/guozhenqian/Develop/android-ndk-r22b")set(CMAKE_TOOLCHAIN_FILE "/Users/guozhenqian/Develop/android-ndk-r22b/build/cmake/android.toolchain.cmake")set(ANDROID_TOOLCHAIN clang)set(ANDROID_NATIVE_API_LEVEL 14)set(ANDROID_ABI "armeabi-v7a")set(CMAKE_BUILD_TYPE Release)set(CMAKE_CROSSCOMPILING "TRUE")set(CMAKE_CXX_STANDARD 11) #c++標準# 項目名project(hello)# 查找當前目錄下的所有源文件，并將名稱保存到 SRC_LIST 變量aux_source_directory(. SRC_LIST)# 打印一下SRC_LIST的值看看MESSAGE( STATUS "SRC_LIST contains = ${SRC_LIST}")# 查找 math 目錄下的所有源文件，并將名稱保存到 MATH_SRC_LIST 變量# aux_source_directory(${PROJECT_SOURCE_DIR}/math MATH_SRC_LIST)# 是否使用自己的 MathFunctions 庫# 這里設置的變量 USE_MYMATH、中間的提示文字、默認值，在 ccmake 命令中會展示# 這個option一定要在configure_file之前，不然生成的config.h文件默認是沒有define的option (USE_MYMATH "Use provided math implementation" ON)# 加入一個配置頭文件，用于處理 CMake 對源碼的設置configure_file ("${PROJECT_SOURCE_DIR}/config.h.in""${PROJECT_SOURCE_DIR}/config.h")# 是否加入 MathFunctions 庫if (USE_MYMATH)# 添加頭文件路徑include_directories ("${PROJECT_SOURCE_DIR}/math")# 添加 math 子目錄 (math 目錄里必須有 CMakeLists.txt)add_subdirectory (math)# 把MathFunctions追加設置到EXTRA_LIBS變量中set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions)MESSAGE( STATUS "EXTRA_LIBS contains = ${EXTRA_LIBS}")endif (USE_MYMATH)# 生成動態庫add_library(hello SHARED ${SRC_LIST})# 添加鏈接庫target_link_libraries(hello ${EXTRA_LIBS})

碼字不易，如果對您有幫助，還請賞個贊哇！

參考文章：

1、cmake, make, CMakeLists.txt, Makefile簡介 cmake, make, CMakeLists.txt, Makefile簡介_Northan的博客-CSDN博客_cmakelists.txt makefile

2、Makefile和CMakefiles.txt的那些事兒 https://www.jianshu.com/p/f51adf8430f0

3、CMakeLists.txt 語法介紹與實例演練（最后一個例子有問題） CMakeLists.txt 語法介紹與實例演練_阿飛__的博客-CSDN博客_cmakelist

4、cmake學習4--自定義編譯選項 cmake學習4--自定義編譯選項_小珊瑚的爸爸的博客-CSDN博客

5、CMake入門實戰（這篇才正宗，別的都是抄的吧）CMake&CMakeList.txt

總結

以上是生活随笔為你收集整理的CMakeCMakeList.txt的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。