如何使用CMake構建c++專案

1. c++專案構建與CMake簡介

在Windows系統上我們通常使用Visual Studio（VS）來生成我們的c++專案，我們只需在VS相應的層次目錄中添加相應的檔案即可，而不需要手動指定各個檔案的具體路徑及依賴包含關系，

在Linux系統上我們通常使用CMake來構建c++專案，cmake是一個跨平臺的編譯工具，CMake 的組態檔取名為 CMakeLists.txt，換一個通俗點的意思就是我只需要寫一個CMakeLists.txt檔案來指明與我的專案有關的檔案、依賴等，便可將這個專案正常編譯及生成可執行檔案，

注：CMake 并不直接建構出最終的軟體，而是產生標準的建構檔（如 Unix 的 Makefile 或 Windows Visual C++ 的 projects/workspaces），然后再依一般的建構方式使用，即當我們使用cmake命令后，我們還要使用make命令生成可執行檔案，

2.使用g++編譯cpp檔案

g++是GNU開發的C++編譯器，是GCC（GNU Compiler Collection）GNU編譯器套件的組成部分，對應一個簡單的c++程式，我們一般可以使用g++命令進行直接編譯，

/*檔案名為main.cpp*/
#include <iostream>
int main(){
        std::cout<<"hello,world\n";
        return 0;
}

我們可以使用如下命令進行編譯：

g++ -o hello main.cpp

我們可以看到程式正常編譯與執行：

當然g++以及gcc有較多的命令與功能，這里不再詳細展開說明，

3. Cmake入門

3.1 一個簡單的CMakeLists.txt：

cmake_minimum_required(VERSION 3.9) #最低版本

project(helloworld VERSION 1.0) #專案名稱及自定義版本號
add_executable(hello_cmake main.cpp) #添加生成可執行檔案

接下來我們使用cmake . &&make&&./hello_cmake便可編譯、生成與運行我們所編譯的檔案了，

• cmake .：在當前目錄下生成標準建構檔（可以理解為中間檔案）,這里的 “.” 指代的是當前目錄，

• make：編譯中間檔案，生成可執行檔案，

• ./hello_cmake：運行可執行檔案，

這樣，我們便使用CMake編譯與生成了第一個c++檔案，到目前為止它與上文中使用到的g++的作用是一樣的，而當一個c++專案越復雜時，使用CMake的優勢也將越來越明顯，

3.2 創建build檔案夾，不同檔案分離與有序化

如果你運行了cmake . &&make這兩個命令，你就會發現在你的源檔案所在的目錄下多出了很多其他的檔案，這些檔案是專案編譯中很重要的檔案，但其實你可以完全不用去管他，我們只需要關注CMakeLists.txt與源檔案，

上述問題的解決方法是在專案檔案夾中創建一個build檔案用于保存這些“無關緊要的編譯檔案”——mkdir build，

這樣你只需要進入build目錄使用cmake .. &&make便可以生成二進制檔案了（可執行檔案），

注：cmake ..中 ”..“ 指代上一級目錄，所以在build目錄中使用cmake ..指代的是：呼叫上一級目錄中的CMakeLists.txt檔案，并將生成的中間檔案保存在當前目錄，

附：對于較大型的c++專案，合理利用檔案夾分類檔案可以幫到我們很多，例如創建src檔案夾存放源檔案（源代碼），創建bin(binary)存放可執行檔案，創建include存放頭檔案，

3.3 CMake使專案中包含頭檔案

我們創建一個include目錄并在目錄下撰寫一個較為簡單的header:

#pragma once
#include <iostream>
class Blah{
	public:
	inline void boo(){
		std::cout<<"Boo!\n";
	}
};

然后再在源檔案中添加一個#include "header.h"來參考頭檔案，這時如果不改變CMakeLists.txt檔案，顯然源檔案并不知道這個header.h的具體位置，

所以，我們需要修改CMakeLists.txt檔案（事實上只需要添加一行陳述句）

cmake_minimum_required(VERSION 3.9)

project(helloworld VERSION 1.0)
add_executable(hello_cmake main.cpp)
target_include_directories(hello_cmake PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)

target_include_directories：指定編譯給定目標時要使用的include目錄，這里即在編譯生成hello_make可執行檔案時，使用CMakeLists.txt所在的目錄下的include目錄，（INTERFACE、PUBLIC和PRIVATE關鍵字用于指定target_include_directories的影響范圍），在參考庫路徑時使用這個命令更多，這里不在展開，

當然在CMake中include_directories也可以指定頭檔案目錄，其作用是：將給定的目錄添加到編譯器用來搜索頭檔案的目錄中，它的范圍相較于target_include_directories更大，不需要針對于某一個給定的目標，所有生成的可執行檔案都可以在include_directories指定的目錄下搜索查找頭檔案，

3.4 CMake處理多個源檔案的編譯

1. 修改add_executable,添加多個源檔案，例如：

add_executable(hello_cmake main.cpp src/Blah.cpp)

2. 通過修改CMakeLists.txt檔案指定源檔案的路徑，

? 在CMakeLists.txt中添加如下代碼即可：

file(GOLB_RECURSE SRC_FILES src/*.cpp)
add_executable(hello ${SRC_FILES})

這里的${}，相當于一個變數，在CMake中經常使用！

我們可以使用以下陳述句設定相應路徑變數，則MYLIB_INCLUDE_DIRS為設定的路徑，

set(MYLIB_INCLUDE_DIRS /tmp/customPATH/include)

3.5 CMake中參考相關檔案（library\package）

我們首先需要了解以下概念，

linux下有兩種庫:動態庫(.so)和靜態庫(.a)(共享庫)，二者的不同點在于代碼被載入的時刻不同，

• 靜態庫的代碼在編譯程序中已經被載入可執行程式,因此體積比較大，

• 動態庫(共享庫)的代碼在可執行程式運行時才載入記憶體，在編譯程序中僅簡單的參考，因此代碼體積比較小，

1. My own lib:

add_library(mylib STATIC lib/blah.cpp) #STATIC 靜態 #添加lib
add_executable(hello_cmake main.cpp) #生成可執行檔案
target_link_libraries(hello_cmake PUBLIC mylib) #鏈接庫檔案

2. external lib with find_package:

這里以sfml作為外部依賴包為例，它需要首先從軟體倉庫下載，再在CMakeLists.txt檔案中撰寫如下陳述句，

find_package(SFML 2 REQUIRED network audio graphics window system)
target_include_directories(hello_cmake PUBLIC ${SFML_INCLUDE_DIR}) 
target_link_libraries(hello_cmake PUBLIC ${SFML_LIBRARIES} ${SFML_DEPENDENCIES}) #鏈接庫檔案

這樣我們就可以在源檔案中加入相關include陳述句了，

#include <SFML/System.hpp>
#include <SFML/Main.hpp>

3. external lib manually (手動參考庫檔案)

find_library(MYLIB mylib)
find_library(MYLIB mylib PATHS /tmp/customPATH)

? find_library可以加入REQUIRED引數，它表示為如果未找到任何內容，則停止處理并顯示錯誤訊息，

3.6 CMake的嵌套使用

主要操作如下：

add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

作用：添加一個子目錄并構建該子目錄，

例如在庫檔案中，我們可能還需要添加頭檔案的路徑，而將其全部寫在外部的CMakeLists.txt檔案中又會略顯臃腫，

這時我們可以在lib檔案中，撰寫一個新的CMakeList.txt，然后僅僅將相關代碼放上去，例如

add_library(mylib STATIC blah.cpp) #STATIC 靜態 #添加lib
target_include_directories(hello_cmake PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include) #指定頭檔案

4. 案例代碼

cmake_minimum_required(VERSION 3.9)
project(example_test1)
set (EXECUTABLE_OUTPUT_PATH /home/tom/檔案/example_test1/bin)
aux_source_directory (/home/tom/檔案/example_test1/src SRC_LIST)
include_directories (/home/tom/檔案/example_test1/ltkcpp/include)

find_library(LIBLTKCPP libltkcpp_x86_64.a /home/tom/檔案/example_test1/ltkcpp/lib)
find_library(LIBLTKCPP_IMPINJ libltkcppimpinj_x86_64.a /home/tom/檔案/example_test1/ltkcpp/lib)
# it is not recommended to statically link for ssl and crypto libraries
find_library(LIBSSL ssl REQUIRED)
find_library(LIBCRYPTO crypto REQUIRED)
# The ETK does not contain a host static library for xml2.  Add the generic
# name 'xml2' to link against the dynmaic library when compiling for host.
find_library(LIBXML2 NAMES libxml2.a xml2 REQUIRED)
set(LIBS
    ${LIBLTKCPP}
    ${LIBLTKCPP_IMPINJ}
    ${LIBCRYPTO}
    ${LIBSSL}
    ${LIBXML2}
)

add_executable(main ${SRC_LIST})
target_link_libraries(main PRIVATE ${LIBS})

aux_source_directory (< dir > < variable >) 搜集所有在指定路徑下的源檔案的檔案名，將輸出結果串列儲存在指定的變數中，

本文來自博客園，作者：litecdows，作者在其他博客平臺均使用此昵稱！
轉載請注明原文鏈接：https://www.cnblogs.com/litecdows/p/cmake.html

標籤：Linux

上一篇：VMware ESXi 7.0 Update 3c SLIC 2.6 & Unlocker (2022 U3 Refresh)

下一篇：017 Linux 之啥是 ssh ？