碼上快樂

相關內容    簡體    繁體

CMakeLists.txt構建c++項目

本文轉載自   查看原文   2020-10-12 15:14   988    cmake

（轉自）原文出處：https://blog.csdn.net/afei__/article/details/81201039

一、Cmake 簡介

cmake 是一個跨平台、開源的構建系統。它是一個集軟件構建、測試、打包於一身的軟件。它使用與平台和編譯器獨立的配置文件來對軟件編譯過程進行控制。

 

二、常用命令

1. 指定 cmake 的最小版本

cmake_minimum_required(VERSION 3.4.1)

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

2. 設置項目名稱

project(demo)

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

3. 設置編譯類型

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

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

  • 在 Linux 下是：
    demo
    libcommon.a
    libcommon.so
  • 在 Windows 下是：
    demo.exe
    common.lib
    common.dll

4. 指定編譯包含的源文件

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

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

4.2 搜索所有的 cpp 文件

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

  1.  
    aux_source_directory(. SRC_LIST) # 搜索當前目錄下的所有.cpp文件
  2.  
    add_library(demo ${SRC_LIST})

4.3 自定義搜索規則

  1.  
    file(GLOB SRC_LIST "*.cpp" "protocol/*.cpp")
  2.  
    add_library(demo ${SRC_LIST})
  3.  
    # 或者
  4.  
    file(GLOB SRC_LIST "*.cpp")
  5.  
    file(GLOB SRC_PROTOCOL_LIST "protocol/*.cpp")
  6.  
    add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})
  7.  
    # 或者
  8.  
    aux_source_directory(. SRC_LIST)
  9.  
    aux_source_directory(protocol SRC_PROTOCOL_LIST)
  10.  
    add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})

5. 查找指定的庫文件

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

  1.  
    find_library( # Sets the name of the path variable.
  2.  
    log- lib
  3.  
     
  4.  
    # Specifies the name of the NDK library that
  5.  
    # you want CMake to locate.
  6.  
    log )

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

6. 設置包含的目錄

  1.  
    include_directories(
  2.  
    ${CMAKE_CURRENT_SOURCE_DIR}
  3.  
    ${CMAKE_CURRENT_BINARY_DIR}
  4.  
    ${CMAKE_CURRENT_SOURCE_DIR}/ include
  5.  
    )

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

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

7. 設置鏈接庫搜索目錄

  1.  
    link_directories(
  2.  
    ${CMAKE_CURRENT_SOURCE_DIR}/libs
  3.  
    )

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

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

8. 設置 target 需要鏈接的庫

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

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

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

  1.  
    target_link_libraries(demo libface.a) # 鏈接libface.a
  2.  
    target_link_libraries(demo libface.so) # 鏈接libface.so

8.2 指定全路徑

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

8.3 指定鏈接多個庫

  1.  
    target_link_libraries( demo
  2.  
    ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a
  3.  
    boost_system.a
  4.  
    boost_thread
  5.  
    pthread)

9. 設置變量

9.1 set 直接設置變量的值

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

9.2 set 追加設置變量的值

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

9.3 list 追加或者刪除變量的值

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

10. 條件控制

10.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)
示例：

  1.  
    if(MSVC)
  2.  
    set(LINK_LIBS common)
  3.  
    else()
  4.  
    set(boost_thread boost_log.a boost_system.a)
  5.  
    endif()
  6.  
    target_link_libraries(demo ${LINK_LIBS})
  7.  
    # 或者
  8.  
    if(UNIX)
  9.  
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -fpermissive -g")
  10.  
    else()
  11.  
    add_definitions(-D_SCL_SECURE_NO_WARNINGS
  12.  
    D_CRT_SECURE_NO_WARNINGS
  13.  
    -D_WIN32_WINNT=0x601
  14.  
    -D_WINSOCK_DEPRECATED_NO_WARNINGS)
  15.  
    endif()
  16.  
     
  17.  
    if(${CMAKE_BUILD_TYPE} MATCHES "debug")
  18.  
    ...
  19.  
    else()
  20.  
    ...
  21.  
    endif()

10.2 while…endwhile

  1.  
    while(condition)
  2.  
    ...
  3.  
    endwhile()

10.3 foreach…endforeach

  1.  
    foreach(loop_var RANGE start stop [step])
  2.  
    ...
  3.  
    endforeach(loop_var)

start 表示起始數，stop 表示終止數，step 表示步長，示例：

  1.  
    foreach(i RANGE 1 9 2)
  2.  
    message(${i})
  3.  
    endforeach(i)
  4.  
    # 輸出：13579

11. 打印信息

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

12. 包含其它 cmake 文件

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

 

三、常用變量

1. 預定義變量

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. 環境變量

使用環境變量

 $ENV{Name}

寫入環境變量

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

3. 系統信息

­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

4. 主要開關選項

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) # 參數之間用空格分隔

 

四、項目示例

1. 簡單項目（單個源文件）

一個經典的 C 程序，如何通過 cmake 來編譯呢？

1.1 新建文件 main.c

  1.  
    #include <stdio.h>
  2.  
    int main() {
  3.  
    printf("Hello World!\n");
  4.  
    return 0;
  5.  
    }

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

  1.  
    project( HELLO)
  2.  
    add_executable( hello main.c)

1.3 編譯和運行

新建一個 build 文件夾，目錄情況如下：

為什么要新建一個 build 文件夾？
        一般我們采用 cmake 的 out-of-source 方式來構建（即生成的中間產物和源代碼分離），這樣做可以讓生成的文件和源文件不會弄混，且目錄結構看起來也會清晰明了。所以推薦使用這種方式，至於這個文件夾的命名並無限制，我們習慣命名為 build。

依次執行以下命令：

  1.  
    cd build
  2.  
    cmake ..

首先進入到 build 目錄，然后就是 cmake .. 命令，另外要注意將 cmake 配置到環境變量中去才可直接使用，否則需要使用絕對路徑，.. 表示上一級目錄，cmake 會在上一級目錄下找到 CMakeLists.txt 文件並編譯，並生成如下圖所示的一些中間文件：

直接執行 make 命令，生成可執行程序，如下圖：

運行程序，如下所示：運行程序，如下所示：

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

目錄結構如下：

demo 根目錄下的 CMakeLists.txt 文件如下：

  1.  
    cmake_minimum_required (VERSION 2.8)
  2.  
    project(demo)
  3.  
    aux_source_directory(. DIR_SRCS)
  4.  
    # 添加math子目錄
  5.  
    add_subdirectory(math)
  6.  
    # 指定生成目標
  7.  
    add_executable(demo ${DIR_SRCS})
  8.  
    # 添加鏈接庫
  9.  
    target_link_libraries(demo MathFunctions)

math 目錄下的 CMakeLists.txt 文件如下：

  1.  
    aux_source_directory(. DIR_LIB_SRCS)
  2.  
    # 生成鏈接庫
  3.  
    add_library(MathFunctions ${DIR_LIB_SRCS})

3. 自定義編譯選項

cmake 允許為項目增加編譯選項，從而可以根據用戶的環境和需求選擇最合適的編譯方案。
例如，可以將 MathFunctions 庫設為一個可選的庫，如果該選項為 ON ，就使用該庫定義的數學函數來進行運算，否則就調用標准庫中的數學函數庫。
修改根目錄下的 CMakeLists.txt 文件如下：

  1.  
    # CMake 最低版本號要求
  2.  
    cmake_minimum_required (VERSION 2.8)
  3.  
    # 項目信息
  4.  
    project (Demo)
  5.  
    # 加入一個配置頭文件，用於處理 CMake 對源碼的設置
  6.  
    configure_file (
  7.  
    "${PROJECT_SOURCE_DIR}/config.h.in"
  8.  
    "${PROJECT_BINARY_DIR}/config.h"
  9.  
    )
  10.  
    # 是否使用自己的 MathFunctions 庫
  11.  
    option (USE_MYMATH
  12.  
    "Use provided math implementation" ON)
  13.  
    # 是否加入 MathFunctions 庫
  14.  
    if (USE_MYMATH)
  15.  
    include_directories ( "${PROJECT_SOURCE_DIR}/math")
  16.  
    add_subdirectory (math)
  17.  
    set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions)
  18.  
    endif (USE_MYMATH)
  19.  
    # 查找當前目錄下的所有源文件
  20.  
    # 並將名稱保存到 DIR_SRCS 變量
  21.  
    aux_source_directory(. DIR_SRCS)
  22.  
    # 指定生成目標
  23.  
    add_executable(Demo ${DIR_SRCS})
  24.  
    target_link_libraries (Demo ${EXTRA_LIBS})
  • configure_file 命令用於加入一個配置頭文件 config.h ，這個文件由 cmake 從 config.h.in 生成，通過這樣的機制，將可以通過預定義一些參數和變量來控制代碼的生成。
  • option 命令添加了一個 USE_MYMATH 選項，並且默認值為 ON 。根據 USE_MYMATH 變量的值來決定是否使用我們自己編寫的 MathFunctions 庫。

修改 main.cc 文件，讓其根據 USE_MYMATH 的預定義值來決定是否調用標准庫還是MathFunctions 庫：

  1.  
    #include "config.h"
  2.  
    #ifdef USE_MYMATH
  3.  
    #include "math/MathFunctions.h"
  4.  
    #else
  5.  
    #include <math.h>
  6.  
    #endif
  7.  
     
  8.  
    int main(int argc, char *argv[])
  9.  
    {
  10.  
    if (argc < 3){
  11.  
    printf("Usage: %s base exponent \n", argv[0]);
  12.  
    return 1;
  13.  
    }
  14.  
    double base = atof(argv[1]);
  15.  
    int exponent = atoi(argv[2]);
  16.  
     
  17.  
    #ifdef USE_MYMATH
  18.  
    printf("Now we use our own Math library. \n");
  19.  
    double result = power(base, exponent);
  20.  
    #else
  21.  
    printf("Now we use the standard library. \n");
  22.  
    double result = pow(base, exponent);
  23.  
    #endif
  24.  
    printf("%g ^ %d is %g\n", base, exponent, result);
  25.  
    return 0;
  26.  
    }

編寫 config.h.in 文件
注意 main.cc 的第一行，這里引用了一個 config.h 文件，這個文件預定義了 USE_MYMATH 的值。但我們並不直接編寫這個文件，為了方便從 CMakeLists.txt 中導入配置，我們編寫一個 config.h.in 文件，內容如下：

#cmakedefine USE_MYMATH

這樣 cmake 會自動根據 CMakeLists.txt 配置文件中的設置自動生成 config.h 文件。

​


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 windows CMakeLists.txt CMakeLists.txt的寫法 C/C++通用CMakeLists.txt --支持批量目標生成 cmake 學習-cmakelists.txt Ubuntu 16.04上源碼編譯和安裝pytorch教程，並編寫C++ Demo CMakeLists.txt | tutorial to compile and use pytorch on ubuntu 16.04 CMakeLists.txt實例運用(探索) ROS中CMakeLists.txt文件的主要內容 CMakeLists.txt添加多個源代碼 cmake編譯總結1——CMakeLists.txt文件寫法 Android下Native的so編譯：使用cmakelists.txt
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM